Skip to main content
GET
Get one payable

Path Parameters

consumer_id
string<uuid>
required
payable_id
string
required

Query Parameters

include_attachments
enum<string> | null
default:false

Indicate if the payable's attachments (e.g. the invoice PDF, a receipt) should be included in the response, base64-encoded in the attachments field. By default they are not included and attachments is null.

Available options:
true,
false

Response

Successful Response

A single entity covering supplier invoices, supplier refunds (credit notes) and card purchases (including card refunds) -- these all come from the same underlying provider concept on Spendesk (a payable) and most connectors of this vertical are expected to share that shape, so this unifies what used to be two separate entities (SupplierInvoiceItem, CardPurchaseItem).

id
string
required

Id of the payable.

payable_type
enum<string>
required

Normalized classification of this payable.

Available options:
supplier_invoice,
supplier_refund,
card_purchase
currency
string
required
untaxed_amount
number
required
tax_amount
number
required
total
number
required
payable_date
string<date>
required

Invoice date, purchase date, or equivalent.

original_payable_type
string | null

The connector's own provider-specific type/subtype for this payable, passed through as-is (e.g. Spendesk's subType: invoice, creditNote, singlePurchase, multiUseCard, physical, subscription).

reversed
boolean
default:false

Whether this record is a reversal (a credit note against a previously issued invoice, or a refund against a previous card purchase) rather than the original document/purchase. Its amounts stay positive, as an accounting refund's: this flag carries the direction.

invoice_number
string | null

Supplier's own invoice number, when available.

description
string | null

Free text description (e.g. merchant/vendor name for a card purchase).

supplier_id
string | null

Id of the supplier/merchant, when known. Filled in based on payable_type: always relevant for supplier_invoice/supplier_refund, and also present on a card_purchase when the merchant is a known supplier.

employee_id
string | null

Id of the employee who submitted/owns the payable (the cardholder for a card_purchase), when known, regardless of payable_type.

accounting_date
string<date> | null

Accounting date

Example:

"2026-01-15"

due_date
string<date> | null

Payment due date, when relevant (supplier_invoice/supplier_refund).

start_date
string<date> | null

Start date of the period covered by the payable. Set when it relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins.

Example:

"2026-01-01"

end_date
string<date> | null

End date of the period covered by the payable. Set when it relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends.

Example:

"2026-01-31"

last_updated_on
string<date-time> | null
lines
PayableLineItem · object[]
attachments
PayableAttachmentItem · object[] | null

Attachments (e.g. the invoice PDF, a receipt). Only populated on get_payable when include_attachments=true was requested.

export_status
enum<string>
default:unknown

Whether this payable still needs to be synced to the target accounting system: 'not_ready' (not yet validated), 'to_export' (ready, not yet exported), 'exported', or 'unknown' when the connector cannot determine it.

Available options:
unknown,
not_ready,
to_export,
exported
allocations
PayableAllocationItem · object[]

How this payable's amount has been settled so far.