For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Invoice object
          • GET/invoices
          • POST/invoices
          • GET/invoices/{id}
          • PATCH/invoices/{id}
          • GET/invoices/line-items/remote-field-classes
          • GET/invoices/meta/patch/{id}
          • GET/invoices/meta/post
          • GET/invoices/remote-field-classes
          • POST/invoices/bulk
          • GET/invoices/bulk/{batch_id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsInvoices

The Invoice object

The Invoice Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "type": "ACCOUNTS_RECEIVABLE",
7  "contact": "string",
8  "number": "string",
9  "issue_date": "2023-01-01T00:00:00Z",
10  "due_date": "2023-01-01T00:00:00Z",
11  "paid_on_date": "2023-01-01T00:00:00Z",
12  "memo": "string",
13  "company": "string",
14  "employee": "string",
15  "currency": "XUA",
16  "exchange_rate": "string",
17  "payment_term": "string",
18  "total_discount": 1,
19  "sub_total": 1,
20  "status": "PAID",
21  "total_tax_amount": 1,
22  "total_amount": 1,
23  "balance": 1,
24  "remote_updated_at": "2023-01-01T00:00:00Z",
25  "tracking_categories": [
26    "string"
27  ],
28  "accounting_period": "string",
29  "purchase_orders": [
30    "string"
31  ],
32  "sales_orders": [
33    "string"
34  ],
35  "payments": [
36    "string"
37  ],
38  "applied_payments": [
39    "string"
40  ],
41  "line_items": [
42    {
43      "id": "string",
44      "remote_id": "string",
45      "created_at": "2023-01-01T00:00:00Z",
46      "modified_at": "2023-01-01T00:00:00Z",
47      "description": "string",
48      "unit_price": 1,
49      "quantity": 1,
50      "total_amount": 1,
51      "employee": "string",
52      "project": "string",
53      "contact": "string",
54      "currency": "XUA",
55      "exchange_rate": "string",
56      "item": "string",
57      "account": "string",
58      "tax_rate": "string",
59      "tracking_category": "string",
60      "tracking_categories": [
61        "string"
62      ],
63      "company": "string",
64      "remote_was_deleted": true,
65      "field_mappings": {},
66      "remote_fields": [
67        {
68          "remote_field_class": {
69            "id": "string",
70            "display_name": "string",
71            "remote_key_name": "string",
72            "description": "string",
73            "is_custom": true,
74            "is_common_model_field": true,
75            "is_required": true,
76            "field_type": "string",
77            "field_format": "string",
78            "field_choices": [
79              "string"
80            ],
81            "item_schema": {
82              "item_type": "string",
83              "item_format": "string",
84              "item_choices": [
85                "string"
86              ]
87            }
88          },
89          "value": {
90            "string": {}
91          }
92        }
93      ]
94    }
95  ],
96  "applied_credit_notes": [
97    {
98      "remote_id": "string",
99      "created_at": "2023-01-01T00:00:00Z",
100      "modified_at": "2023-01-01T00:00:00Z",
101      "credit_note": "string",
102      "applied_date": "2023-01-01T00:00:00Z",
103      "applied_amount": "string",
104      "remote_was_deleted": true
105    }
106  ],
107  "applied_vendor_credits": [
108    {
109      "remote_id": "string",
110      "created_at": "2023-01-01T00:00:00Z",
111      "modified_at": "2023-01-01T00:00:00Z",
112      "vendor_credit": "string",
113      "applied_date": "2023-01-01T00:00:00Z",
114      "applied_amount": "string",
115      "remote_was_deleted": true
116    }
117  ],
118  "inclusive_of_tax": true,
119  "remote_was_deleted": true,
120  "field_mappings": {},
121  "remote_data": [
122    {
123      "path": "string",
124      "data": {}
125    }
126  ],
127  "remote_fields": [
128    {
129      "remote_field_class": {
130        "id": "string",
131        "display_name": "string",
132        "remote_key_name": "string",
133        "description": "string",
134        "is_custom": true,
135        "is_common_model_field": true,
136        "is_required": true,
137        "field_type": "string",
138        "field_format": "string",
139        "field_choices": [
140          "string"
141        ],
142        "item_schema": {
143          "item_type": "string",
144          "item_format": "string",
145          "item_choices": [
146            "string"
147          ]
148        }
149      },
150      "value": {
151        "string": {}
152      }
153    }
154  ]
155}
Was this page helpful?
Previous

/income-statements/{id}

Next

/invoices

Built with

The Invoice object represents an itemized record of goods and/or services sold to a customer or bought from a vendor.

Represents a Bill when the Invoice type is ACCOUNTS_PAYABLE. References an Invoice when the Invoice type is ACCOUNTS_RECEIVABLE.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
typeenum or nullOptional

Whether the invoice is an accounts receivable or accounts payable. If type is ACCOUNTS_PAYABLE, the invoice is a bill. If type is ACCOUNTS_RECEIVABLE, it is an invoice.

  • ACCOUNTS_RECEIVABLE - ACCOUNTS_RECEIVABLE
  • ACCOUNTS_PAYABLE - ACCOUNTS_PAYABLE
Allowed values:
contactstring or nullOptionalformat: "uuid"
The invoice's contact.
numberstring or nullOptional
The invoice's number.
issue_datedatetime or nullOptional
The invoice's issue date.
due_datedatetime or nullOptional
The invoice's due date.
paid_on_datedatetime or nullOptional
The invoice's paid date.
memostring or nullOptional
The invoice's private note.
companystring or nullOptionalformat: "uuid"
The company the invoice belongs to.
employeestring or nullOptionalformat: "uuid"
The employee this overall transaction relates to.
currencyenum or nullOptional
The invoice's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The invoice's exchange rate.
payment_termstring or nullOptionalformat: "uuid"
The payment term that applies to this transaction.
total_discountdouble or nullOptional
The total discounts applied to the total cost.
sub_totaldouble or nullOptional
The total amount being paid before taxes.
statusenum or nullOptional

The status of the invoice.

  • PAID - PAID
  • DRAFT - DRAFT
  • SUBMITTED - SUBMITTED
  • PARTIALLY_PAID - PARTIALLY_PAID
  • OPEN - OPEN
  • VOID - VOID
total_tax_amountdouble or nullOptional
The total amount being paid in taxes.
total_amountdouble or nullOptional
The invoice's total amount.
balancedouble or nullOptional
The invoice's remaining balance.
remote_updated_atdatetime or nullOptional
When the third party's invoice entry was updated.
tracking_categorieslist of stringsOptional
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the Invoice was generated in.
purchase_orderslist of stringsOptional
sales_orderslist of stringsOptional
paymentslist of stringsOptional

Array of Payment object IDs.

applied_paymentslist of stringsOptional
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
line_itemslist of objectsOptionalRead-only
applied_credit_noteslist of objectsOptional

CreditNoteApplyLines applied to the Invoice.

applied_vendor_creditslist of objectsOptional

VendorCreditApplyLines applied to the Invoice.

inclusive_of_taxboolean or nullOptional

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

remote_was_deletedbooleanOptionalRead-only

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.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only