Accounts3

Approval Policies8

Bank Transfers4

Bills6

Budgets2

Cash Sales5

Classifications6

Classifications Lines1

Companies2

Contracts5

Custom Fields5

Customer Credits5

Customer Deposits5

Customer Payments5

Customer Prepayment Applications6

Customer Prepayments6

Customer Refunds5

Customers6

Data Exports3

Direct Expenses5

Exchange Rates1

Fixed Assets6

Health1

Inbox5

Invoices7

Items6

Journal Entries5

Paper Checks6

Purchase Orders5

Recurring Bills5

Recurring Invoices5

Recurring Journal Entries5

Sales Orders5

Statistical Journals5

Vendor Credits4

Vendor Payments4

Vendor Prepayment Applications4

Vendor Prepayments4

Vendor Refunds5

Vendors6

Webhooks8

Invoices

Get Invoice record

Retrieve a specific Invoice record by its record number with all related data.

get/public/v1/invoices/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

Query parameters

integration_sourcesIntegrationSourceSlug[] nullable

searchstring nullable

company_idinteger[] nullable

numberinteger[] nullable

codestring[] nullable

customer_idinteger[] nullable

start_datestring date nullable

end_datestring date nullable

due_datestring date nullable

due_date_untilstring date nullable

transaction_currencySystemCurrencies[] nullable

record_statusRecordStatus[] nullable

approval_statusstring[] nullable

approval_status_scopeRecordStatus[] nullable

number

string

number

string

number

string

number

string

amount_due_updated_at_gtestring date-time nullable

Return invoices whose amount_due_updated_at is greater than or equal to this timestamp.

amount_due_updated_at_ltestring date-time nullable

Return invoices whose amount_due_updated_at is less than or equal to this timestamp.

updated_afterstring date-time nullable

updated_beforestring date-time nullable

Response

bill_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

customer_namestring nullable

term_idinteger nullable required

term_namestring required

transaction_idsinteger[] required

bank_match_statusstring nullable

reconciliation_statusstring nullable

approval_statusstring nullable

internal_idinteger required

numberinteger required

codestring nullable

company_idinteger required

company_namestring required

company_currencystring required

customer_idinteger nullable required

currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

exchange_ratestring required

amountstring required

Total amount of transaction

amount_duestring required

Amount to be paid

paid_totalstring required

Amount that was already paid by Customer Repayment Applications or Customer Payments

amount_due_updated_atstring date-time required

Timestamp of the most recent change that could have affected amount_due. Moves whenever the invoice itself is edited, or whenever a posted Customer Payment or Customer Prepayment Application referencing this invoice is written.

memostring required

datestring date required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring date required

Transaction date (inception date) - the date when the transaction actually occurred

due_datestring date nullable required

record_status'draft' | 'posted' | 'archived' required

recurring_record_numberinteger nullable required

reference_numberstring required

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

Changes

Changed in 7 of the 15 revisions of this API.119

Sep 1, 20269201740fc0dd1See the full diff
- ○
  added the enum value sage_50 to the property items/ of the query request parameter integration_sources
  request-parameter-property-enum-value-added
Aug 22, 2026db5c5da9869c19See the full diff
- ▲
  the ////// response's property type changed from string to no type for status
  response-property-type-changed
- ○
  added to the ////// response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed the CESS enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the CGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the GST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the HST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the IGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the PST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the QST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the SGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
Aug 19, 2026187cbafd893e2See the full diff
- ○
  added the enum value monday to the property items/ of the query request parameter integration_sources
  request-parameter-property-enum-value-added
- ○
  added the enum value netsuite_rutter to the property items/ of the query request parameter integration_sources
  request-parameter-property-enum-value-added
Aug 15, 2026c7dac242a3412See the full diff
- ○
  added the new optional query request parameter amount_gte
  new-optional-request-parameter
- ○
  added the new optional query request parameter amount_lte
  new-optional-request-parameter
Aug 14, 2026307bce03508c2See the full diff
- ○
  added the new optional query request parameter code
  new-optional-request-parameter
- ○
  added the optional property to the response with the status
  response-optional-property-added
Aug 5, 202677cd3c6ec7192See the full diff
- ○
  added the new optional query request parameter approval_status_scope
  new-optional-request-parameter
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Jul 26, 202651b71d2b92131See the full diff
- ○
  added the enum value rippling to the property items/ of the query request parameter integration_sources
  request-parameter-property-enum-value-added

Full history