Ramp: Create a draft bill
Ramp bill.postDraftBillListWithPagination: arguments, response, policy and SDK examples.
← Bill operations · Get started
Operation ramp.post_draft_bill_list_with_pagination
Provider route: POST /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"]["postDraftBillListWithPagination"]>[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.postDraftBillListWithPagination(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.post_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 |
body | Model | Required within parent | Expand Create a draft bill — request body — body |
Referenced models: Create a draft bill — request body — body
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 Fetch a draft bill — response body |
Referenced models: Fetch a draft bill — response body
Schemas
Section titled “Schemas”9 more schemas are linked from the tables above, on the schema pages.
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
Create a draft bill — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
due_at | string | Optional | Due date of the bill. Format: date |
enable_accounting_sync | boolean | Optional | A flag you can set to False to prevent this bill from syncing to your ERP. |
entity_id | string | Optional | Associated business entity. Format: uuid |
inventory_line_items | JSON | Optional | |
inventory_line_items (anyOf 1) | array | Alternative | List of inventory line items associated with the bill. When provided, this will replace all existing inventory line items. |
inventory_line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body inventory line items array item |
inventory_line_items (anyOf 2) | null | Alternative | |
invoice_currency | string | Optional | Currency of the invoice. One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
invoice_number | string | Optional | The invoice number on the bill. Maximum length: 84 |
issued_at | string | Optional | Issued date of the bill. Format: date |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | List of line items related to the bill. When provided, this will replace all existing line items. |
line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body line items array item |
line_items (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo of the bill. Maximum length: 1000 |
memo (anyOf 2) | null | Alternative | |
payment_method | string | Optional | Payment method of the bill. One of: ACH, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DOMESTIC_WIRE, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, SWIFT |
posting_date | JSON | Optional | |
posting_date (anyOf 1) | string | Alternative | The date the bill is posted to the accounting system. Format: date |
posting_date (anyOf 2) | null | Alternative | |
purchase_order_ids | array | Optional | Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. |
purchase_order_ids[] | string | Each item | Format: uuid |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | An ID that identifies the bill on client's side. |
remote_id (anyOf 2) | null | Alternative | |
use_default_payment_method | boolean | Optional | When set to true, create the draft bill using the default payment method configured for the vendor. If set to true, payment_method and payment_details should not be provided. Default: false |
vendor_contact_id | string | Optional | Unique identifier of vendor contact, must be associated with passed vendor. Format: uuid |
vendor_id | string | Required within parent | Unique identifier of bill vendor. Format: uuid |
vendor_memo | JSON | Optional | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. Maximum length: 400 |
vendor_memo (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item, Update a bill — request body — body inventory line items array item, Update a bill — request body — body line items array item
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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_draft_bill_list_with_pagination. Catalog operation: post_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:write"]