Invoices

Get Invoice record

Changed on

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

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

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v1/invoices/{record_number}/
  • Auth: none declared

Path parameters

record_numberinteger required

The number attribute of the record.

Query parameters

integration_sourcesIntegrationSourceSlug[] nullable
searchstring nullable
codestring[] nullable
company_idinteger[] nullable
numberinteger[] 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
payment_statusInvoicePaymentStatus[] nullable
recurring_record_numberinteger[] nullable
approval_statusstring[] nullable
approval_status_scopeRecordStatus[] nullable
number
OR
string
number
OR
string
number
OR
string
number
OR
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

OK

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.

supply_datestring date nullable required
place_of_supplystring nullable
tax_metadataRecordTaxMetadata
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
sales_order_numberinteger nullable

The number of the linked sales order.

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
contractedboolean required
contract_idinteger nullable
ar_account_idinteger nullable required
discount_type'PERCENTAGE' | 'FIXED' required
discount_valuestring 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

  • a74a611f93bbRevision changes
    • info

      added the enum value kintsugi to the property items/ of the query request parameter integration_sources

    • info

      added the optional property ///// to the response with the status

  • 15055bb59e72Revision changes
    • warning

      added the new kintsugi enum value to the ///// response property for the response status

    • warning

      added the new kintsugi enum value to the ///// response property for the response status