Skip to content

Ramp: Update a bill

Ramp bill.patchBillResource: arguments, response, policy and SDK examples.

← Bill operations · Get started

Operation ramp.patch_bill_resource

Provider route: PATCH /developer/v1/bills/{bill_id}. Alter supplies the connection’s credentials and routing.

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"]["patchBillResource"]>[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.patchBillResource(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.patch_bill_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.bill_idstringRequired within parent
bodyModelRequired within parentExpand Update a bill — request body — body

Referenced models: Update a bill — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Hold Bill — response body

Referenced models: Hold Bill — response body

17 more schemas are linked from the tables above, on the schema pages.

Update a bill — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
due_atstringOptionalDue date of the bill.
Format: date
entity_idstringOptionalAssociated business entity.
Format: uuid
inventory_line_itemsJSONOptional
inventory_line_items (anyOf 1)arrayAlternativeList of inventory line items associated with the bill. When provided, this will replace all existing inventory line items.
inventory_line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body inventory line items array item
inventory_line_items (anyOf 2)nullAlternative
invoice_numberstringOptionalThe invoice number on the bill.
Maximum length: 84
issued_atstringOptionalIssued date of the bill.
Format: date
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeList of line items related to the bill. When provided, this will replace all existing line items.
line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body line items array item
line_items (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo of the bill.
Maximum length: 1000
memo (anyOf 2)nullAlternative
payment_dateJSONOptional
payment_date (anyOf 1)stringAlternativeFor non-card payment methods, the date the payment is scheduled to be initiated. If the requested date is unavailable, such as a weekend, bank holiday, past date, or same-day cutoff miss, Ramp schedules the payment for the next available initiation date. Set to null to unschedule the payment.
Format: date
payment_date (anyOf 2)nullAlternative
payment_methodstringOptionalPayment 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_dateJSONOptional
posting_date (anyOf 1)stringAlternativeThe date the bill is posted to the accounting system.
Format: date
posting_date (anyOf 2)nullAlternative
purchase_order_idsarrayOptionalUnique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders.
purchase_order_ids[]stringEach itemFormat: uuid
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeAn ID that identifies the bill on client's side.
remote_id (anyOf 2)nullAlternative
vendor_contact_idstringOptionalUnique identifier of vendor contact, must be associated with passed vendor.
Format: uuid
vendor_idstringOptionalUnique identifier of bill vendor.
Format: uuid
vendor_memoJSONOptional
vendor_memo (anyOf 1)stringAlternativeMemo to the vendor.
Maximum length: 400
vendor_memo (anyOf 2)nullAlternative

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

Create a bill — request body — body accounting field selections item
FieldTypePresenceDescription and constraints
$objectRoot
field_external_idstringRequired within parentRemote ID of accounting field. This is the external ID, likely from ERP system.
field_option_external_idJSONOptional
field_option_external_id (anyOf 1)stringAlternativeRemote ID of accounting field option. This is the external ID, likely from ERP system. Required if free_form_text is not provided.
Default: null
field_option_external_id (anyOf 2)nullAlternative
free_form_textJSONOptional
free_form_text (anyOf 1)stringAlternativeFree form text for the accounting field selection. For DATE-type fields, use ISO format (YYYY-MM-DD). Required if field_option_external_id is not provided.
Default: null
Minimum length: 1
free_form_text (anyOf 2)nullAlternative
Update a bill — request body — body inventory line items array item
FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptional
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of an existing inventory line item on this bill. When provided, the updated line keeps this identifier; when omitted, a new identifier is assigned.
Default: null
Format: uuid
id (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeDefault: null
memo (anyOf 2)nullAlternative
purchase_order_line_item_idJSONOptional
purchase_order_line_item_id (anyOf 1)stringAlternativeUnique identifier of the purchase order line item to match this bill inventory line item to.
Default: null
Format: uuid
purchase_order_line_item_id (anyOf 2)nullAlternative
quantityJSONRequired within parentMinimum: 0
quantity (oneOf 1)stringAlternativeFormat: decimal
quantity (oneOf 2)numberAlternative
unit_priceJSONRequired within parent
unit_price (oneOf 1)stringAlternativeFormat: decimal
unit_price (oneOf 2)numberAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Update a bill — request body — body line items array item
FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptional
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
amountJSONRequired within parent
amount (oneOf 1)stringAlternativeFormat: decimal
amount (oneOf 2)numberAlternative
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of an existing line item on this bill. When provided, the updated line keeps this identifier; when omitted, a new identifier is assigned.
Default: null
Format: uuid
id (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeDefault: null
memo (anyOf 2)nullAlternative
purchase_order_line_item_idJSONOptional
purchase_order_line_item_id (anyOf 1)stringAlternativeUnique identifier of the purchase order line item to match this bill line item to.
Default: null
Format: uuid
purchase_order_line_item_id (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Hold Bill — response body — bill owner
FieldTypePresenceDescription and constraints
$objectRoot
first_namestringOptionalBill owner's first name.
idstringRequired within parentBill owner's ID.
Format: uuid
last_namestringOptionalBill owner's last name.
Hold Bill — response body — accounting field selections item
FieldTypePresenceDescription and constraints
$objectRoot
category_infoModelRequired within parentExpand Hold Bill — response body — accounting field selections item category info
information about the accounting category (or accounting field).
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeCustomer-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)nullAlternative
external_codeJSONOptional
external_code (anyOf 1)stringAlternativeexternal code of accounting field option; Code field displayed on the ERP.
external_code (anyOf 2)nullAlternative
external_idstringRequired within parentexternal id of accounting field option; It should uniquely identify an accounting field option on the client end.
idstringRequired within parentID that uniquely identifies an accounting field option within Ramp
namestringRequired within parentname of accounting field option
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting provider
Read only: true
provider_name (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item category info

SDK function policy ID: ramp.patch_bill_resource. Catalog operation: patch_bill_resource. 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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.