invoices

Retrieve

Returns an Invoice object with the given id.<Footer>{/* BEGIN_ACCOUNTING_INVOICE_FETCH_SUPPORTED_FIELDS /}<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1bW28aOxD+K2gfIy5NaBIF6eiIAGmSUzZpQnvaU1WW8Q5g8Nob20sgVf/7kfcSLtlw60IgzROsPTu+fTPzzWB+WgRraAs5tEoWJkT4XFPetrKWKxxgVsm64H1BCVhZC3vUxi5MCKL+gZW1lO95QmpwzigwR51LaFklq+CCbEPO57RFwSmMXipQrqEtsaaCq8Ljy7lW8LaVtRjlPXDK4Qvz1YXiuahl6lEVGFXayloeVkp3pPDbnRu480EtoNnMjYELXGOWc7DGhTEtORmqSWozq3CAgQanijWuggZilhuN2NHaU6VCoQPMywej5x3oF4AXsNSUMFCFw+LJwfHJYS7SEoz+N2qzv/b3undN0TzeQ23CEPb36g0ysBsX93a3/d6uvB/YD58P7Yfeg93tvdtDbbxXb9QPrxrfilfV8v5VggC6Pfp68uW0enpp75GHWtHufru3G2S/3iC95sNF8fIDub88/zSwH74d1Kufi3ajdnj5QexfVW5UvXIj6uV83spa46dqlb7/HG+IgFNhgGXmVIiemnzhwsVtGNuY8ESwR3Oe32SU5FUxj138IDi+V3ki3IILDsWFQCEKFKLbOx9LQB9FW+S7Xjs+ASr44/ZbJatmn5ftSq06iYhyH1OGmwyskpY+PIG0VfoeW8JHyuFCg5t3QBFJvUBv9kkvfbSb6Z47H3NN9TChS4IrNCBz1rN7kYd1J0HE5/TOB0Qd4NqgWSbLaOTJcHJNzDAPvhFfSuDETMvxg1FMK1Vq9MAoB0Q1uOb0uO82A/2Tk06YZNREHeMqNNa+CnxGE2mhMbOyVvCJsGvM7vFR48FY09AD64dRdedTCc41ltgFDdKczI9f2SSwnUmAchuC91OA2jXDuiWk25IA2KhFKgRc70YPqx8O8h5fP+Yi35RwqtuIxvGDn+6bOvNFQSq4xkSvAFcXXDGOWg9TBwkeyy4F4ui775mXHYT1OLCnwbwaclUnRS850rdxJzl2TG+ITRWxHh4aYqLWCt7g0aGKpOua65RIoURLZ6pDjl1KVKZ4dJg59RXloFSmAlzLIDSkgP7HwVA8GCoeHaJ4MBQNhiqCCYlOBrWzo6PjHfXmBjvbZDJ4gGQI1yWtSUtMeibBiPITCmqezV2HBjHaXc9j1CA8HmNaYLSN0z2RbQVJT6hkzNqIcD3Mh79l26uRp9RNN3GTVzJowWHYpNJJl2s9qn0zx12MYFsRsVZAsw361qfh4n4fzDZoZbRF+cIMKNvlxsWX2vJArkhwqLaFhrLnsaE50Kfeb5ZQdEBJIiRoQ1w8K/E8/J83qBGmUiOMMCAdzNvwXMCZYaUKNSkLN3lhGw7qY8j3Ew3Nk6ILict7i8RJkXgSZIvH6a7wJccMGQY3nBnHvwB3hAzhO8NIZotFZpIsNJplcn8/aEXhUg2zGBVRPZBUOGNsY2w/VDIJiZsmtKopv70oT5k2HcoJ8xXtAxItwxiCpmB1yJdsyaQlmDLSII0Veb4kHawACekYF5xGJMAM1Ejf4gWmTXGjK4kJg8yZr6jgmQoTvpOp3VynE1xC5ShUjgLlqHZzjXJRpv/CxOlF0v9FuM/SLmrKB6ySS0z3TEJ/Rm9sCs+IBOtdo+eanOdcmXi2C7rBLfBt87zZRKyfU4+JPV16DHfJSnlqfuuTT0kvqBpmrrjZlnQ81khtLiqgf24dHJ0e778R45nEeOUc9E9gty9PYefEhz+S4abLZtfv5zfJWreibHeL2zBWdQ+oaXn8FkgK/t6MgU4r5finp3/6X/vF2+5GiOlb3W4Zi5lfrd5EQe9387ZVzeDC7BZJ6bJAAPpIYwz8fp/a6hi/YpqT1DsJjDkSMVhmiCUayCw+FScKmyhBuh4TQ0jyKLtRndypEuS2ULS5Cf4C+fkm6Fmqafz8pa2ZDW4y/18w5V8nTXyBqPgv7kPmjHLMCU3rLkb8w67Rjc5bzuDgnX77bXdR7/rSN5B2G85C9hw8TBnHodKNQPh5KrNVIF1HIrOys18PtNdzX/krSJEOOo2m3Ku/bbCF2cYOxZLdvSywdhr/RtV3uHD7KgtU/4mOSPNvU0bf0/8DvPBVgWfpzWvxqkuQn03dZV6FZP1J1vjj1/+MBFu3IjsAAA==" />{/ END_ACCOUNTING_INVOICE_FETCH_SUPPORTED_FIELDS */}</Footer>

get/accounting/v1/invoices/{id}

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/accounting/v1/invoices/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

expandInvoicesIdGetParametersExpandSchemaItems[]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_databoolean

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsboolean

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databoolean

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fields'type'

Deprecated. Use show_enum_origins.

show_enum_origins'type'

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

idstring uuid
remote_idstring nullable

The third-party API ID of the matching object.

created_atstring date-time

The datetime that this object was created by Merge.

modified_atstring date-time

The datetime that this object was modified by Merge.

type'ACCOUNTS_RECEIVABLE' | 'ACCOUNTS_PAYABLE'
contactstring uuid nullable

The invoice's contact.

numberstring nullable

The invoice's number.

issue_datestring date-time nullable

The invoice's issue date.

due_datestring date-time nullable

The invoice's due date.

paid_on_datestring date-time nullable

The invoice's paid date.

memostring nullable

The invoice's private note.

companystring uuid nullable

The company the invoice belongs to.

employeestring uuid nullable

The employee this overall transaction relates to.

currency'XUA' | 'AFN' | 'AFA' | 'ALL' | 'ALK' | 'DZD' | 'ADP' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARS' | 'ARM' | 'ARP' | 'ARL' | 'AMD' | 'AWG' | 'AUD' | 'ATS' | 'AZN' | 'AZM' | 'BSD' | 'BHD' | 'BDT' | 'BBD' | 'BYN' | 'BYB' | 'BYR' | 'BEF' | 'BEC' | 'BEL' | 'BZD' | 'BMD' | 'BTN' | 'BOB' | 'BOL' | 'BOV' | 'BOP' | 'BAM' | 'BAD' | 'BAN' | 'BWP' | 'BRC' | 'BRZ' | 'BRE' | 'BRR' | 'BRN' | 'BRB' | 'BRL' | 'GBP' | 'BND' | 'BGL' | 'BGN' | 'BGO' | 'BGM' | 'BUK' | 'BIF' | 'XPF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'XAF' | 'CLE' | 'CLP' | 'CLF' | 'CNX' | 'CNY' | 'CNH' | 'COP' | 'COU' | 'KMF' | 'CDF' | 'CRC' | 'HRD' | 'HRK' | 'CUC' | 'CUP' | 'CYP' | 'CZK' | 'CSK' | 'DKK' | 'DJF' | 'DOP' | 'NLG' | 'XCD' | 'DDM' | 'ECS' | 'ECV' | 'EGP' | 'GQE' | 'ERN' | 'EEK' | 'ETB' | 'EUR' | 'XBA' | 'XEU' | 'XBB' | 'XBC' | 'XBD' | 'FKP' | 'FJD' | 'FIM' | 'FRF' | 'XFO' | 'XFU' | 'GMD' | 'GEK' | 'GEL' | 'DEM' | 'GHS' | 'GHC' | 'GIP' | 'XAU' | 'GRD' | 'GTQ' | 'GWP' | 'GNF' | 'GNS' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'IMP' | 'ISK' | 'ISJ' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'IEP' | 'ILS' | 'ILP' | 'ILR' | 'ITL' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'KGS' | 'LAK' | 'LVL' | 'LVR' | 'LBP' | 'LSL' | 'LRD' | 'LYD' | 'LTL' | 'LTT' | 'LUL' | 'LUC' | 'LUF' | 'MOP' | 'MKD' | 'MKN' | 'MGA' | 'MGF' | 'MWK' | 'MYR' | 'MVR' | 'MVP' | 'MLF' | 'MTL' | 'MTP' | 'MRU' | 'MRO' | 'MUR' | 'MXV' | 'MXN' | 'MXP' | 'MDC' | 'MDL' | 'MCF' | 'MNT' | 'MAD' | 'MAF' | 'MZE' | 'MZN' | 'MZM' | 'MMK' | 'NAD' | 'NPR' | 'ANG' | 'TWD' | 'NZD' | 'NIO' | 'NIC' | 'NGN' | 'KPW' | 'NOK' | 'OMR' | 'PKR' | 'XPD' | 'PAB' | 'PGK' | 'PYG' | 'PEI' | 'PEN' | 'PES' | 'PHP' | 'XPT' | 'PLN' | 'PLZ' | 'PTE' | 'GWE' | 'QAR' | 'XRE' | 'RHD' | 'RON' | 'ROL' | 'RUB' | 'RUR' | 'RWF' | 'SVC' | 'WST' | 'SAR' | 'RSD' | 'CSD' | 'SCR' | 'SLL' | 'XAG' | 'SGD' | 'SKK' | 'SIT' | 'SBD' | 'SOS' | 'ZAR' | 'ZAL' | 'KRH' | 'KRW' | 'KRO' | 'SSP' | 'SUR' | 'ESP' | 'ESA' | 'ESB' | 'XDR' | 'LKR' | 'SHP' | 'XSU' | 'SDD' | 'SDG' | 'SDP' | 'SRD' | 'SRG' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'STN' | 'STD' | 'TVD' | 'TJR' | 'TJS' | 'TZS' | 'XTS' | 'THB' | 'XXX' | 'TPE' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'TRL' | 'TMT' | 'TMM' | 'USD' | 'USN' | 'USS' | 'UGX' | 'UGS' | 'UAH' | 'UAK' | 'AED' | 'UYW' | 'UYU' | 'UYP' | 'UYI' | 'UZS' | 'VUV' | 'VES' | 'VEB' | 'VEF' | 'VND' | 'VNN' | 'CHE' | 'CHW' | 'XOF' | 'YDD' | 'YER' | 'YUN' | 'YUD' | 'YUM' | 'YUR' | 'ZWN' | 'ZRN' | 'ZRZ' | 'ZMW' | 'ZMK' | 'ZWD' | 'ZWR' | 'ZWL'

The currency code in ISO 4217 format.

exchange_ratestring decimal nullable

The invoice's exchange rate.

payment_termstring uuid nullable

The payment term that applies to this transaction.

total_discountnumber double nullable

The total discounts applied to the total cost.

sub_totalnumber double nullable

The total amount being paid before taxes.

status'PAID' | 'DRAFT' | 'SUBMITTED' | 'PARTIALLY_PAID' | 'OPEN' | 'VOID'
total_tax_amountnumber double nullable

The total amount being paid in taxes.

total_amountnumber double nullable

The invoice's total amount.

balancenumber double nullable

The invoice's remaining balance.

remote_updated_atstring date-time nullable

When the third party's invoice entry was updated.

tracking_categoriesstring[]
accounting_periodstring uuid nullable

The accounting period that the Invoice was generated in.

purchase_ordersstring[]
sales_ordersstring[]
paymentsstring[]

Array of Payment object IDs.

applied_paymentsstring[]

A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.

inclusive_of_taxboolean nullable

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

invoice_urlstring uri nullable

The 3rd party URL of the invoice.

remote_was_deletedboolean

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

Changes

No recorded changes to this operation across all 1 revision of this API.