Skip to main content
GET
Get bill

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

bill_id
string<uuid>
required

Bill ID

business_id
string<uuid>
required

Business ID

Response

200 - application/json

Main bill serializer for list/fetch responses, aligned with existing API style

type
string
required
read-only

Always 'BillData' for type discrimination

id
string<uuid>
required
read-only
business_id
string<uuid>
required
read-only
status
string
required
read-only

Bill status: received, partially_paid, paid, voided

terms
string
required
read-only

Payment terms (NET_30, NET_60, DUE_ON_RECEIPT, etc.)

issue_date
string<date>
required
read-only

Date the bill was issued by vendor (from bill_date)

received_at
string<date-time>
required
read-only

Date/time bill was received

due_at
string<date-time>
required
read-only

Payment due date/time

paid_at
string<date-time>
required
read-only

Full payment completion date/time

voided_at
string<date-time>
required
read-only

Void action timestamp

is_overdue
boolean
required
read-only

True if bill is past due date and has outstanding balance

Example:

false

currency
string
required
read-only
vendor
object
required

Serializer for vendor objects returned by the vendors list endpoint

line_items
object[]
required
read-only
bill_payment_allocations
object[]
required
read-only

Payment allocations for this bill

vendor_credit_allocations
object[]
required
read-only

Vendor credit note allocations for this bill

vendor_refund_allocations
object[]
required
read-only

Vendor refund allocations for this bill

additional_sales_taxes
object[]
required
read-only

Additional tax entries not included in line items

additional_sales_taxes_total
integer
required
read-only

Total additional sales taxes in cents

subtotal
integer
required
read-only

Subtotal amount in cents before taxes

total_amount
integer
required
read-only

Total bill amount in cents including taxes

outstanding_balance
integer
required
read-only

Outstanding balance in cents

paid_by_bank_payments
integer
required
read-only

Amount paid via bank payments in cents (completed only)

paid_by_credits
integer
required
read-only

Amount paid via vendor credit notes in cents

needs_reconciliation
boolean
required
read-only

True if has unreconciled bank payments

document
object
required

Latest document with presigned URL

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
external_id
string
bill_number
string
vendor_bill_number
string
purchase_order_number
string
memo
string
reference_numbers
any
attachment_urls
any
metadata
any