UNunified
accounting
invoice

List all invoices

Changed on

Returns a list of AccountingInvoices. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/accounting/{connection_id}/invoice

Request

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

paid_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

refunded_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

cancelled_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

posted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
invoice_numberstring

External identifier (ie. reference) for this invoice

referencestring
contact_idstring

(reference to AccountingContact)

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'

@deprecated use payment_terms instead

payment_terms'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'
paymentterm_idstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
urlstring

The public URL for the invoice to send to a customer to view or pay.

payment_collection_method'send_invoice' | 'charge_automatically'

When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.

type'INVOICE' | 'CREDITMEMO'

BILL removed (use AccountingBill); remaining values: INVOICE, CREDITMEMO

sendboolean
organization_idstring
category_idsstring[]
project_idstring

(reference to TaskProject)

sub_total_amountnumber

Total before tax

exchange_ratenumber

Exchange rate to the base/home currency at the document date

is_inclusive_of_taxboolean

True when the document amounts already include tax

salesorder_idsstring[]

refs -> AccountingSalesorder; the sales orders this invoice was raised from

rawobject

Changes