Ramp: List bills

← bill operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation ramp.get_bill_list_with_pagination

Provider route: GET /developer/v1/bills. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";

async function execute(input: Parameters<RampIntegration["bill"]["getBillListWithPagination"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.bill.getBillListWithPagination(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.bill.get_bill_list_with_pagination(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.entity_id	string	Optional	Format: uuid
query.customer_friendly_payment_id	string	Optional
query.draft_bill_id	string	Optional	Format: uuid
query.invoice_number	string	Optional
query.remote_id	string	Optional
query.accounting_field_selection_id	string	Optional	Format: uuid
query.status_summaries	array	Optional
query.status_summaries[]	string	Each item	One of: APPROVAL_PENDING, APPROVAL_REJECTED, ARCHIVED, AWAITING_PAYMENT, AWAITING_RELEASE, BLOCKED, HELD_BY_PROVIDER, ON_HOLD, PAYMENT_COMPLETED, PAYMENT_DETAILS_MISSING, PAYMENT_ERROR, PAYMENT_NOT_INSTRUCTED, PAYMENT_PROCESSING, PAYMENT_READY, PAYMENT_SCHEDULED, PENDING_VENDOR_APPROVAL, WAITING_FOR_TRANSACTION_MATCH, WAITING_FOR_TRANSFER_MATCH, WAITING_FOR_VENDOR
query.payment_id	JSON	Optional
query.payment_id (anyOf 1)	string	Alternative	Default: null Format: uuid
query.payment_id (anyOf 2)	null	Alternative
query.purchase_order_id	string	Optional	Format: uuid
query.vendor_id	string	Optional	Format: uuid
query.is_accounting_sync_enabled	boolean	Optional
query.is_payment_sync_ready	boolean	Optional
query.approval_status	string	Optional	One of: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED
query.payment_method	string	Optional	One of: ACH, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DOMESTIC_WIRE, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, SWIFT
query.payment_status	string	Optional	One of: OPEN, PAID
query.sync_status	string	Optional	One of: BILL_AND_PAYMENT_SYNCED, BILL_SYNCED, NOT_SYNCED
query.sync_ready	boolean	Optional
query.payment_details_missing	JSON	Optional
query.payment_details_missing (anyOf 1)	boolean	Alternative	Default: null
query.payment_details_missing (anyOf 2)	null	Alternative
query.is_archived	boolean	Optional	Default: false
query.from_created_at	string	Optional	Format: date-time
query.to_created_at	string	Optional	Format: date-time
query.from_due_date	string	Optional	Format: date-time
query.to_due_date	string	Optional	Format: date-time
query.from_issued_date	string	Optional	Format: date-time
query.to_issued_date	string	Optional	Format: date-time
query.from_paid_at	string	Optional	Format: date-time
query.to_paid_at	string	Optional	Format: date-time
query.from_payment_date	string	Optional	Format: date
query.to_payment_date	string	Optional	Format: date
query.min_amount	JSON	Optional
query.min_amount (oneOf 1)	string	Alternative	Format: decimal
query.min_amount (oneOf 2)	number	Alternative
query.max_amount	JSON	Optional
query.max_amount (oneOf 1)	string	Alternative	Format: decimal
query.max_amount (oneOf 2)	number	Alternative
query.start	string	Optional
query.page_size	integer	Optional	Default: 20

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List bills — response body

Referenced models: List bills — response body

Policy, approvals and errors

SDK function policy ID: ramp.get_bill_list_with_pagination. Catalog operation: get_bill_list_with_pagination. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["bills:read"]

Official provider source