Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
accounting
invoice

List all invoices

get/accounting/{connection_id}/invoice

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

org_idstring

The org ID to filter by (reference to AccountingOrganization)

typestring
start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
due_atstring date-time
paid_atstring date-time
refunded_atstring date-time
cancelled_atstring date-time
posted_atstring date-time
total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
invoice_numberstring
referencestring
contact_idstring
currencystring
notesstring
refund_reasonstring
term'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'
payment_terms'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
urlstring
payment_collection_method'send_invoice' | 'charge_automatically'
type'BILL' | 'INVOICE' | 'CREDITMEMO'
sendboolean
organization_idstring
category_idsstring[]
rawobject