Ramp: List draft bills
Ramp bill.getDraftBillListWithPagination: arguments, response, policy and SDK examples.
← Bill operations · Get started
Operation ramp.get_draft_bill_list_with_pagination
Provider route: GET /developer/v1/bills/drafts. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["getDraftBillListWithPagination"]>[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.getDraftBillListWithPagination(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_draft_bill_list_with_pagination(arguments) result = await call.wait() return result.body_json()| 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.invoice_number | string | Optional | |
query.remote_id | string | Optional | |
query.vendor_id | string | Optional | Format: uuid |
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.start | string | Optional | |
query.page_size | integer | Optional | Default: 20 |
Response
Section titled “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 draft bills — response body |
Referenced models: List draft bills — response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
List draft bills — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a draft bill — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a draft bill — response body
List bills — response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
Fetch a draft bill — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_date | JSON | Required within parent | |
accounting_date (anyOf 1) | string | Alternative | The date for the bill for accounting purposes. If not specified, falls back to the bill issue date. Format: date-time Read only: true |
accounting_date (anyOf 2) | null | Alternative | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount of the bill, represented in the lowest denomination of the currency (e.g., cents for USD). Read only: true |
amount (anyOf 2) | null | Alternative | |
bill_owner | JSON | Required within parent | |
bill_owner (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — bill owner Information about the bill owner. |
bill_owner (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The date the bill was created. Format: date-time |
due_at | JSON | Required within parent | |
due_at (anyOf 1) | string | Alternative | The date the bill is due. Format: date-time |
due_at (anyOf 2) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Associated business entity. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
inventory_line_items | array | Required within parent | List of inventory line items related to the bill. |
inventory_line_items[] | Model | Each item | Expand Fetch a draft bill — response body — inventory line items item |
invoice_number | JSON | Required within parent | |
invoice_number (anyOf 1) | string | Alternative | The invoice number on the bill. |
invoice_number (anyOf 2) | null | Alternative | |
invoice_urls | array | Required within parent | Pre-signed urls to download invoice files. Read only: true |
invoice_urls[] | string | Each item | |
issued_at | JSON | Required within parent | |
issued_at (anyOf 1) | string | Alternative | The date the bill was issued on invoice. Format: date-time |
issued_at (anyOf 2) | null | Alternative | |
line_items | array | Required within parent | List of line items related to the bill. |
line_items[] | Model | Each item | Expand Fetch a draft bill — response body — line items item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the bill. |
memo (anyOf 2) | null | Alternative | |
posting_date | JSON | Required within parent | |
posting_date (anyOf 1) | string | Alternative | The date the bill was posted to the ERP. Alternatively known as accounting date, accounting sync date. Format: date-time |
posting_date (anyOf 2) | null | Alternative | |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The external ID that identifies the bill on the client's side. |
remote_id (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | Payment status of the bill. Always DRAFT for provisional bills. Default: DRAFT |
sync_status | JSON | Required within parent | Sync status of the bill. Always NOT_SYNCED for drafts. Default: NOT_SYNCED |
vendor | JSON | Required within parent | |
vendor (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — vendor Vendor information of the bill. |
vendor (anyOf 2) | null | Alternative | |
vendor_memo | JSON | Required within parent | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. |
vendor_memo (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — bill owner, Hold Bill — response body — accounting field selections item, Hold Bill — response body — vendor, Fetch a draft bill — response body — inventory line items item, Fetch a draft bill — response body — line items item, Hold Bill — response body — amount
Hold Bill — response body — bill owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Optional | Bill owner's first name. |
id | string | Required within parent | Bill owner's ID. Format: uuid |
last_name | string | Optional | Bill owner's last name. |
Hold Bill — response body — accounting field selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_info | Model | Required within parent | Expand Hold Bill — response body — accounting field selections item category info information about the accounting category (or accounting field). |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Customer-set display name for the accounting field option in Ramp. When the customer renames an option inside Ramp, this returns the new label while `name` continues to return the ERP-source name. May be null if no Ramp-side override is set. |
display_name (anyOf 2) | null | Alternative | |
external_code | JSON | Optional | |
external_code (anyOf 1) | string | Alternative | external code of accounting field option; Code field displayed on the ERP. |
external_code (anyOf 2) | null | Alternative | |
external_id | string | Required within parent | external id of accounting field option; It should uniquely identify an accounting field option on the client end. |
id | string | Required within parent | ID that uniquely identifies an accounting field option within Ramp |
name | string | Required within parent | name of accounting field option |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting provider Read only: true |
provider_name (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item category info
Hold Bill — response body — vendor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the vendor. Format: uuid |
name | string | Required within parent | Name of the vendor. |
remote_code | string | Optional | Code of the vendor; usually it is a unique identifier for the vendor in the remote ERP system. |
remote_id | string | Optional | External ID that uniquely identifies the vendor on the client's side. |
remote_name | string | Optional | Name of the vendor. |
type | string | Optional | Known values: BUSINESS, INDIVIDUAL |
Hold Bill — response body — accounting field selections item category info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Required within parent | external id of accounting field; It should uniquely identify an accounting field on the client end. |
id | string | Required within parent | ID that uniquely identifies an accounting field within Ramp |
name | string | Required within parent | name of accounting field |
type | string | Required within parent | accounting field type Known values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_draft_bill_list_with_pagination. Catalog operation: get_draft_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"]