Returns a collection with a key, ID, and link for each invoice. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Accounts Receivable |
---|---|
User ype | Business, Employee, Approver |
Permissions | List, View Invoices |
OK
Bad Request
{- "ia::result": [
- {
- "key": "498",
- "id": "498",
- "href": "/objects/accounts-receivable/invoice/498"
}, - {
- "key": "501",
- "id": "501",
- "href": "/objects/accounts-receivable/invoice/501"
}, - {
- "key": "978",
- "id": "978",
- "href": "/objects/accounts-receivable/invoice/978"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Creates a new invoice. For the invoice to be posted, you must specify at least the account and an amount for each line item.
Subscription | Accounts Receivable |
---|---|
User ype | Business, Employee, Approver |
Permissions | Add Invoices |
invoiceDate required | string <date> Date the invoice was created. Example: "2022-12-06" | ||||||||||||||||
dueDate required | string <date> Date the invoice is due. Example: "2022-12-31" | ||||||||||||||||
invoiceNumber | string Specify a unique invoice number while creating an invoice unless document sequencing is configured, in which case the number is auto-generated. Example: "INV-001" | ||||||||||||||||
referenceNumber | string Customer purchase order number or another reference number. Example: "PO6917" | ||||||||||||||||
description | string Description of the invoice, which prints on the Customer Ledger report. Example: "Regular invoice" | ||||||||||||||||
documentId | string ID of the associated document. Example: "Sales Invoice-SI-00188" | ||||||||||||||||
object Currency details for this invoice. | |||||||||||||||||
| |||||||||||||||||
customerMessageId | string Example: "Greeting01" | ||||||||||||||||
object Associated contacts | |||||||||||||||||
| |||||||||||||||||
object If AR is configured for inter-entity bill back, the template to use to create a matching bill. | |||||||||||||||||
| |||||||||||||||||
object Supporting document attached to the invoice. | |||||||||||||||||
| |||||||||||||||||
object Customer to receive the invoice. Example: "1" | |||||||||||||||||
| |||||||||||||||||
object Term details for the invoice. | |||||||||||||||||
| |||||||||||||||||
object Summary details for this invoice. Summaries are collections of the same types of transactions grouped together for processing. | |||||||||||||||||
| |||||||||||||||||
Array of objects Line items of the invoice. Example: ["100"] | |||||||||||||||||
Array
|
Created
Bad Request
{- "invoiceNumber": "SI-0034",
- "customer": {
- "id": "C-00019"
}, - "customerMessageId": "Greeting01",
- "referenceNumber": "B9R456",
- "description": "Regular invoice",
- "term": {
- "id": "N15"
}, - "invoiceDate": "2022-12-06",
- "dueDate": "2022-12-31",
- "currency": {
- "txnCurrency": "USD",
- "exchangeRate": {
- "date": "2022-12-06",
- "typeId": "Intacct Daily Rate",
- "rate": 0.05112
}
}, - "contacts": {
- "payTo": {
- "id": "Power Aerospace Materials(C1)"
}, - "returnTo": {
- "id": "Power Aerospace Materials(C1)"
}
}, - "lines": [
- {
- "txnAmount": "100.40",
- "glAccount": {
- "id": "5004"
}, - "accountLabel": {
- "id": "SWL001"
}, - "dimensions": {
- "department": {
- "id": "SA"
}, - "location": {
- "id": "CA"
}, - "customer": {
- "id": "1652"
}
}
}, - {
- "txnAmount": "-10",
- "glAccount": {
- "id": "5004"
}, - "accountLabel": {
- "id": "SWL001"
}, - "dimensions": {
- "department": {
- "id": "SA"
}, - "location": {
- "id": "CA"
}, - "customer": {
- "id": "1652"
}
}
}
]
}
{- "ia::result": {
- "id": "2091",
- "key": "2091",
- "href": "/objects/accounts-receivable/invoice/2091"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified invoice.
Subscription | Accounts Receivable |
---|---|
User ype | Business, Employee, Approver |
Permissions | List, View Invoices |
key required | string System-assigned key for the invoice. |
OK
Bad Request
{- "ia::result": {
- "id": "2091",
- "key": "2091",
- "recordType": "ri",
- "invoiceNumber": "newInv10",
- "state": "posted",
- "customer": {
- "id": "C-00019",
- "key": "14",
- "name": "Power Aerospace Materials",
- "emailOption": false,
- "customerDue": "20106.8",
- "deliveryOptions": "print",
- "href": "/objects/accounts-receivable/customer/14"
}, - "customerMessageId": "Greeting01",
- "customerMessage": "Thank your for your business.",
- "referenceNumber": "B9R456",
- "description": "Regular invoice",
- "orderEntry": {
- "documentId": "Sales Invoice B9-R456"
}, - "term": {
- "id": "N15",
- "key": "1",
- "href": "/objects/accounts-receivable/term/1"
}, - "invoiceDate": "2022-12-06",
- "audit": {
- "createdDateTime": "2022-12-06T00:00:00Z",
- "modifiedDateTime": "2023-04-18T16:59:05Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "invoiceSummary": {
- "glPostingDate": "2022-12-06",
- "title": "Invoices: 2023/03/21 22:04:36:8980 Batch",
- "key": "854",
- "id": "854",
- "isSummaryOpen": "open",
- "isSummaryPosted": "false"
}, - "discountCutOffDate": "2022-12-13",
- "dueDate": "2022-12-31",
- "paymentInformation": {
- "fullyPaidDate": null,
- "totalBaseAmountSelectedForPayment": "0",
- "totalBaseAmountPaid": "0",
- "totalTxnAmountSelectedForPayment": "0",
- "totalTxnAmountPaid": "0"
}, - "currency": {
- "baseCurrency": "USD",
- "txnCurrency": "MXN",
- "exchangeRate": {
- "date": "2022-12-06",
- "typeId": "Intacct Daily Rate",
- "rate": 0.05112
}
}, - "totalBaseAmount": "4.62",
- "totalBaseAmountDue": "4.62",
- "totalTxnAmount": "90.4",
- "totalTxnAmountDue": "90.4",
- "contacts": {
- "payTo": {
- "id": "Power Aerospace Materials(C1)",
- "key": "725"
}, - "returnTo": {
- "id": "Power Aerospace Materials(C1)",
- "key": "725"
}
}, - "moduleKey": "accountsReceivable",
- "recurringSchedule": {
- "key": "20"
}, - "isSystemGeneratedDocument": false,
- "billbackTemplate": {
- "id": "BBT-error5",
- "key": "18"
}, - "dueInDays": 108,
- "attachment": {
- "id": "11",
- "key": "11"
}, - "dunningCount": 0,
- "lines": [
- {
- "id": "4338",
- "key": "4338",
- "invoice": {
- "id": "2091",
- "key": "2091",
- "href": "/objects/accounts-receivable/invoice/2091"
}, - "glAccount": {
- "key": "218",
- "id": "5004",
- "name": "Commissions Paid",
- "href": "/objects/gl-account/218"
}, - "overrideOffsetGLAccount": {
- "key": "36",
- "id": "1200",
- "name": "Accounts Receivable",
- "href": "/objects/general-ledger/account/36"
}, - "accountLabel": {
- "name": "Commissions Paid",
- "key": "14",
- "id": "Accounts Receivable - Microcomputer"
}, - "createdDate": "2022-12-06",
- "baseAmount": "5.13",
- "txnAmount": "100.40",
- "dimensions": {
- "department": {
- "key": "31",
- "id": "SA",
- "name": "Sales",
- "href": "/objects/company-config/department/31"
}, - "location": {
- "key": "10",
- "id": "North America",
- "name": "North America",
- "href": "/objects/company-config/location/10"
}, - "customer": {
- "key": "1",
- "id": "1",
- "name": "Power Aerospace Materials",
- "href": "/objects/company-config/customer/1"
}, - "baseLocation": {
- "name": "North America",
- "key": "10",
- "href": "/objects/company-config/location/10"
}
}, - "memo": "hello line 1",
- "currency": {
- "exchangeRate": {
- "date": "2022-06-12",
- "typeId": "-1",
- "rate": 0.05112
}, - "txnCurrency": "MXN",
- "baseCurrency": "USD"
}, - "allocation": {
- "id": "22",
- "key": "22",
- "name": "Premium allocation"
}, - "lineNumber": 1,
- "paymentInformation": {
- "totalBaseAmountPaid": ".51",
- "totalTxnAmountPaid": "10",
- "totalBaseAmountSelectedForPayment": "0",
- "totalTxnAmountSelectedForPayment": "0"
}, - "isSubtotal": null,
- "audit": {
- "createdDateTime": "2023-04-18T16:54:13Z",
- "modifiedDateTime": "2023-04-18T16:59:05Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/accounts-receivable/invoice-line/4338"
}, - {
- "id": "4340",
- "key": "4340",
- "invoice": {
- "id": "2091",
- "key": "2091",
- "href": "/objects/accounts-receivable/invoice/2091"
}, - "glAccount": {
- "key": "218",
- "id": "5004",
- "name": "Commissions Paid",
- "href": "/objects/gl-account/218"
}, - "overrideOffsetGLAccount": {
- "key": "36",
- "id": "1200",
- "name": "Accounts Receivable",
- "href": "/objects/gl-account/36"
}, - "accountLabel": {
- "name": "Commissions Paid",
- "key": "14",
- "id": "Accounts Receivable - Microcomputer"
}, - "createdDate": "2022-12-06",
- "baseAmount": "-.51",
- "txnAmount": "-10.00",
- "dimensions": {
- "department": {
- "key": "31",
- "id": "SA",
- "name": "Sales",
- "href": "/objects/department/31"
}, - "location": {
- "key": "10",
- "id": "North America",
- "name": "North America",
- "href": "/objects/location/10"
}, - "customer": {
- "key": "1",
- "id": "1",
- "name": "Power Aerospace Materials",
- "href": "/objects/customer/1"
}
}, - "baseLocation": {
- "name": "North America",
- "key": "10",
- "href": "/objects/location/10"
}, - "memo": "Current Q1 charges",
- "currency": {
- "exchangeRate": {
- "date": "2022-06-12",
- "typeId": "-1",
- "rate": 0.05112
}, - "txnCurrency": "MXN",
- "baseCurrency": "USD"
}, - "allocation": {
- "id": "22",
- "key": "22",
- "name": "Premium allocation"
}, - "lineNumber": 2,
- "paymentInformation": {
- "totalBaseAmountPaid": "-.51",
- "totalTxnAmountPaid": "-10",
- "totalBaseAmountSelectedForPayment": "0",
- "totalTxnAmountSelectedForPayment": "0"
}, - "isSubtotal": null,
- "audit": {
- "createdDateTime": "2023-04-18T16:54:13Z",
- "modifiedDateTime": "2023-04-18T16:59:05Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/accounts-receivable/invoice-line/4340"
}
], - "href": "/objects/accounts-receivable/invoice/2091"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing invoice by setting field values. Any fields not provided remain unchanged. Allowed edits depend on the state an invoice is in. For more information, see About editing invoices.
Subscription | Accounts Receivable |
---|---|
User ype | Business, Employee, Approver |
Permissions | Edit Invoices |
key required | string System-assigned key for the invoice. |
invoiceNumber | string Specify a unique invoice number while creating an invoice unless document sequencing is configured, in which case the number is auto-generated. Example: "INV-001" | ||||||||||||||||
referenceNumber | string Customer purchase order number or another reference number. Example: "PO6917" | ||||||||||||||||
description | string Description of the invoice, which prints on the Customer Ledger report. Example: "Regular invoice" | ||||||||||||||||
documentId | string ID of the associated document. Example: "Sales Invoice-SI-00188" | ||||||||||||||||
invoiceDate | string <date> Date the invoice was created. Example: "2022-12-06" | ||||||||||||||||
dueDate | string <date> Date the invoice is due. Example: "2022-12-31" | ||||||||||||||||
object Currency details for this invoice. | |||||||||||||||||
| |||||||||||||||||
customerMessageId | string Example: "Greeting01" | ||||||||||||||||
object Associated contacts | |||||||||||||||||
| |||||||||||||||||
object If AR is configured for inter-entity bill back, the template to use to create a matching bill. | |||||||||||||||||
| |||||||||||||||||
object Supporting document attached to the invoice. | |||||||||||||||||
| |||||||||||||||||
object Customer to receive the invoice. | |||||||||||||||||
| |||||||||||||||||
object Term details for the invoice. | |||||||||||||||||
| |||||||||||||||||
object Summary details for this invoice. Summaries are collections of the same types of transactions grouped together for processing. | |||||||||||||||||
| |||||||||||||||||
Array of objects Line items of the invoice. | |||||||||||||||||
Array
|
OK
Bad Request
{- "description": "Special off-cycle order"
}
{- "ia::result": {
- "id": "2091",
- "key": "2091",
- "href": "/objects/accounts-receivable/invoice/2091"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an invoice. Only invoices with a draft
or posted
state can be deleted.
Subscription | Accounts Receivable |
---|---|
User ype | Business, Employee, Approver |
Permissions | Delete Invoices |
key required | string System-assigned key for the invoice. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "accounts-receivable/invoice" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-receivable/invoice",
- "filters": [
- {
- "$eq": {
- "state": "posted"
}
}
], - "fields": [
- "key",
- "id",
- "documentId",
- "customer.name",
- "customer.customerDue"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "294",
- "id": "294",
- "documentId": "Sales Invoice-SI-00331",
- "customer.name": "Burns Textiles Corp of America",
- "customer.customerDue": "14152925.84"
}, - {
- "key": "312",
- "id": "312",
- "documentId": "Sales Invoice-SI-00751",
- "customer.name": "Pinto Construction Inc.",
- "customer.customerDue": "18000.00"
}, - {
- "key": "316",
- "id": "316",
- "document.Id": "Sales Invoice-SI-00747",
- "customer.name": "Dickens Doers",
- "customer.customerDue": "873.00"
}, - {
- "key": "325",
- "id": "325",
- "document.Id": "Sales Invoice-SI-00743",
- "customer.name": "Grand Isle Hotels & Resorts Ltd",
- "customer.customerDue": "5462.50"
}, - {
- "key": "313",
- "id": "313",
- "document.Id": "Sales Invoice-SI-00746",
- "customer.name": "University of Midland",
- "customer.customerDue": "4330.00"
}
], - "ia::meta": {
- "totalCount": 5,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}