Accounts3

Approval Policies8

Bank Connections7

Bank Match8

Bank Transfers4

Bills6

Budgets2

Cash Sales5

Classifications6

Classifications Lines1

Companies2

Contracts11

Custom Fields5

Customer Credits5

Customer Deposits5

Customer Payments5

Customer Prepayment Applications6

Customer Prepayments6

Customer Refunds5

Customers6

Data Exports3

Depreciation Books2

Direct Expenses5

Fixed Assets7

GST Tax Rates2

Health1

Inbox5

Intercompany Journal Entries4

Invoices7

Items6

Journal Entries5

OAuth3

Paper Checks6

Product Tax Codes5

Purchase Orders5

Recurring Bills5

Recurring Invoices5

Recurring Journal Entries5

Sales Orders5

Statistical Journals5

VAT Rates2

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/v2/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 14 revisions of this API.1221

Aug 28, 202648edcb3acb7423See the full diff
- ●
  removed the optional property has_more_lines from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property lines_count from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id get_InvoiceV2_record removed and replaced with get_Invoice_record
  api-operation-id-removed
- ○
  the response property items became required for the status 200
  response-property-became-required
- ○
  the items response's property default value was removed for the status 200
  response-property-default-value-removed
This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 2026dcb8297898a219See the full diff
- ▲
  the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  added GstComponentType TaxFamily to the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed the CESS enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the CGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the GST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the HST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the IGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the PST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the QST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the SGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
Aug 19, 2026f338ec8b3f522See 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, 2026eddf3ef279e22See 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, 2026b97119cb9f422See the full diff
- ○
  added the new optional query request parameter code
  new-optional-request-parameter
- ○
  added the optional property code to the response with the 200 status
  response-optional-property-added
Aug 5, 2026525a590a98f82See the full diff
- ○
  added the new optional query request parameter approval_status_scope
  new-optional-request-parameter
- ○
  added the optional property items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_metadata to the response with the 200 status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 202664136e8e19bb1See 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
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history