v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Accounts Payable

Retrieve Accounting Bill

    Retrieve a single accounting bill by ID with complete detail including all line items, payments, and related data.

    This endpoint returns comprehensive bill information including:
    - Full bill details with vendor, entity, and customer information
    - All line items with account details, departments, tags, and amortization schedules
    - Complete payment history with journal entry references
    - Calculated fields including total amounts, amounts paid, amounts due, and payment status
    - Journal entry references for accounting integration
    - Exchange rate information for multi-currency bills
    
get/coa/api/v1/bill/{id}/

Path parameters

idstring required

Response

idinteger required
payment_journal_entriesinteger[] required
statusstring required
past_due_daysinteger nullable required
entity_namestring required
entity_currencystring required
vendor_namestring required
ap_account_namestring nullable required

Return AP account name with number in 'number - name' format, similar to name_and_number.

total_amountnumber double required
amount_duenumber double required
amount_paidnumber double required
item_datestring date nullable
migrated_journal_idinteger nullable
voided_datestring date required
voided_journal_entry_orderstring required
amortizationsstring required
last_modified_atstring date-time required
ramp_use_sandboxstring required
navan_regionstring nullable required

Navan data region (US/EU) for a Navan-sourced bill, else None.

Mirrors ramp_use_sandbox: the frontend builds the "Open in Navan" deep link from source_id and uses this to pick the web-app host (US -> app.navan.com, EU -> app-fra.navan.com). Navan bills carry no FK to their connection, so the region is resolved per customer and memoized to avoid an N+1 lookup across a bill list.

zip_metadatastring required
is_deletedboolean required
deleted_atstring date-time nullable required
payment_term_namestring required
chat_uuidstring uuid
withholding_infoobject nullable required

Withholding context for the bill's entity (AP side).

estimated_withholding_amount covers only the remaining amount due (null once fully paid); withheld_to_date is the signed sum of posted withholding (AP legs are credits, reversals debits), so actuals replace the estimate as payments post. Certificate-based schemes estimate from the vendor certificate's rate valid today (falling back to the scheme default).

search_vectorstring nullable required
search_textstring nullable required
mailing_addressstring nullable
bill_numberstring required
bill_datestring date required
due_datestring date required
paid_datestring date nullable
message_on_billstring nullable
ita_allocation_numberstring nullable
source_idstring nullable
sourcestring nullable
{"stackTrail":"components:schemas:AccountingBill:properties:source_bill_data","oasType":"schema","type":"unknown","nullable":true}
external_ramp_idstring nullable
currencystring
exchange_ratenumber double nullable
exchange_rate_booknumber double nullable
created_atstring date-time required
bill_type'BILL' | 'PAYROLL' | 'REIMBURSEMENT'
  • BILL - Bill
  • PAYROLL - Payroll
  • REIMBURSEMENT - Reimbursement
chat_idinteger nullable
customerinteger required
entityinteger required
vendorinteger nullable required
payment_terminteger nullable

Payment term for this bill

journal_entryinteger nullable
source_fileinteger nullable
tax_rateinteger nullable
ap_accountinteger nullable

Accounts Payable account for this bill

voided_journal_entryinteger nullable