Advances record an advance payment from a customer before creating an invoice, for example, when a customer provides a retainer.
Returns a collection with a key, ID, and link for each advance.
Subscription | Accounts Receivable |
---|---|
User type | Business, Employee, Project Manager, and Warehouse |
Permissions | List, View Advances |
OK
Bad Request
{- "ia::result": [
- {
- "key": "621",
- "id": "621",
- "href": "/objects/accounts-receivable/advance/621"
}, - {
- "key": "777",
- "id": "777",
- "href": "/objects/accounts-receivable/advance-line/777"
}, - {
- "key": "802",
- "id": "802",
- "href": "/objects/accounts-receivable/advance-line/802"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new advance.
Subscription | Accounts Receivable |
---|---|
User type | Business (with all admin privileges), Employee, CRM |
Permissions | List, View, Add Advances |
paymentMethod required | string Payment method for the advance. Example: "printedCheck" | ||||||||||||||||
paymentDate required | string <date> The date on which the advance transaction occurred. For example, if the payment was received by check, the payment date is the date on the check. Example: "2021-01-25" | ||||||||||||||||
receiptDate required | string <date> The date on which the check, cash, credit card, or bank transfer for the advance was received. Example: "2024-01-25" | ||||||||||||||||
financialEntity required | string Financial entity. Example: "BOA" | ||||||||||||||||
referenceNumber | string This is a number that might be useful in searches or reports, such as a transaction number from the bank, a purchase order number, or an account number. This number is listed in the GL Details report. Example: "INV-902852" | ||||||||||||||||
description | string Brief description of the advance payment. Example: "08/31/21 Subscription charges" | ||||||||||||||||
state | string Default: "posted" State to update the entry to. Posted to post to the GL Example: "draft" | ||||||||||||||||
totalEntered | string <decimal-precision-2> Total amount of the AR advance. Example: "100.00" | ||||||||||||||||
txnTotalEntered | string <decimal-precision-2> Total transaction amount of the AR advance. Example: "200.20" | ||||||||||||||||
object Payment information for the AR advance. | |||||||||||||||||
object Reconciliation information for the advance transaction. | |||||||||||||||||
| |||||||||||||||||
isSystemGenerated | boolean Default: false Indicates whether the advance is system-generated. Example: false | ||||||||||||||||
accountType | string Default: "bank" Type of account associated with the payment method. Example: "bank" | ||||||||||||||||
object The payment summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing. | |||||||||||||||||
| |||||||||||||||||
object Customer from whom the advance was received. Example: "1" | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
| |||||||||||||||||
object GL account associated with the advance. | |||||||||||||||||
| |||||||||||||||||
object Supporting document for the advance. | |||||||||||||||||
| |||||||||||||||||
Array of objects Line items of the advance. Example: ["100"] | |||||||||||||||||
Array
|
Created
Bad Request
{- "customer": {
- "id": "C-00019"
}, - "paymentDate": "2024-04-25",
- "receiptDate": "2024-04-01",
- "financialEntity": "CHK0001",
- "paymentMethod": "printedCheck",
- "items": [
- {
- "glAccount": {
- "id": "2200"
}, - "txnAmount": "100",
- "dimensions": {
- "location": {
- "id": "CA"
}
}
}
]
}
{- "ia::result": {
- "key": "799",
- "id": "799",
- "href": "/objects/accounts-receivable/advance/799",
- "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
}
Returns detailed information for a specified advance.
Subscription | Accounts Receivable |
---|---|
User type | Business, Employee, Project Manager, and Warehouse users |
Permissions | List, View Advances |
key required | string System-assigned unique key for the advance. |
OK
Bad Request
{- "ia::result": {
- "key": "799",
- "id": "799",
- "advanceSummary": {
- "key": "239",
- "id": "239",
- "name": "Q2 summary",
- "isSummaryOpen": "open",
- "href": "/objects/accounts-receivable/summary/239"
}, - "glAccount": {
- "undepositedGLAccountNumber": ""
}, - "paymentMethod": "printedCheck",
- "customer": {
- "id": "C-00039",
- "key": "C-00039",
- "name": "Team Salsa",
- "href": "/objects/accounts-receivable/customer/C-00039"
}, - "referenceNumber": "Advance04",
- "description": "",
- "currency": {
- "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRateDate": "2024-04-25",
- "exchangeRateTypeId": "",
- "exchangeRate": 1
}, - "receiptDate": "2024-04-25",
- "paymentDate": "2024-04-25",
- "recordType": "rr",
- "state": "posted",
- "totalEntered": "190.00",
- "txnTotalEntered": "190.00",
- "paymentInformation": {
- "totalSelected": "0.00",
- "txnTotalSelected": "0.00",
- "totalPaid": "0.00",
- "txnTotalPaid": "0.00",
- "paidDate": "2024-04-25"
}, - "totalDue": "190.00",
- "totalTxnAmountDue": "190.00",
- "audit": {
- "modifiedDateTime": "2024-06-13T07:31:51Z",
- "createdBy": "1",
- "modifiedBy": "1",
- "createdDateTime": "2024-04-25T00:00:00Z"
}, - "reconciliationGroup": {
- "cleared": "false",
- "clearingdDate": ""
}, - "isSystemGenerated": false,
- "attachment": {
- "id": null,
- "key": null
}, - "items": [
- {
- "key": "2067",
- "id": "2067",
- "advance": {
- "id": "799",
- "key": "799",
- "recordType": "rr",
- "href": "/objects/accounts-receivable/advance/799"
}, - "glAccount": {
- "key": "156",
- "id": "2200",
- "name": "Customer Advances",
- "href": "/objects/general-ledger/account/156"
}, - "accountLabel": {
- "name": "Customer Advances",
- "id": "Presales"
}, - "baseAmount": "100.00",
- "txnAmount": "100.00",
- "dimensions": {
- "department": {
- "key": "31",
- "id": "SA",
- "name": "Sales",
- "href": "/objects/company-config/department/31"
}, - "location": {
- "key": "1",
- "id": "1",
- "name": "United States of America",
- "href": "/objects/company-config/location/1"
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "customer": {
- "key": "11",
- "id": "11",
- "name": "PAMS",
- "href": "/objects/company-config/location/11"
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}
}, - "baseLocation": {
- "name": "United States of America",
- "key": "1",
- "href": "/objects/company-config/location/1"
}, - "createdDate": "2024-04-25",
- "memo": null,
- "currency": {
- "exchangeRate": {
- "date": "2023-04-25",
- "typeId": null,
- "rate": 1
}, - "baseCurrency": "USD",
- "txnCurrency": "USD"
}, - "lineNumber": 1,
- "paymentInformation": {
- "totalPaid": "0.00",
- "txnTotalPaid": "0.00",
- "totalSelected": "0.00",
- "txnTotalSelected": "0.00"
}, - "audit": {
- "createdDateTime": "2023-06-13T06:42:36Z",
- "modifiedDateTime": "2023-06-13T07:31:51Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/accounts-receivable/advance-line/2067"
}
], - "href": "/objects/accounts-receivable/advance/799"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing advance by setting field values. Any fields not provided remain unchanged. Advances that have not yet been applied to an invoice can be updated. The General Ledger account book for the advance must also be open. If an advance was applied to an invoice and later unapplied, it cannot be updated.
Subscription | Accounts Receivable |
---|---|
User type | Business, Employee, Project Manager, and Warehouse users |
Permissions | List, View, Edit Advances |
key required | string System-assigned unique key for the advance. |
referenceNumber | string This is a number that might be useful in searches or reports, such as a transaction number from the bank, a purchase order number, or an account number. This number is listed in the GL Details report. Example: "INV-902852" | ||||||||||||||||
description | string Brief description of the advance payment. Example: "08/31/21 Subscription charges" | ||||||||||||||||
receiptDate | string <date> The date on which the check, cash, credit card, or bank transfer for the advance was received. Example: "2024-01-25" | ||||||||||||||||
paymentDate | string <date> The date on which the advance transaction occurred. For example, if the payment was received by check, the payment date is the date on the check. Example: "2021-01-25" | ||||||||||||||||
state | string Default: "posted" State to update the entry to. Posted to post to the GL Example: "draft" | ||||||||||||||||
totalEntered | string <decimal-precision-2> Total amount of the AR advance. Example: "100.00" | ||||||||||||||||
txnTotalEntered | string <decimal-precision-2> Total transaction amount of the AR advance. Example: "200.20" | ||||||||||||||||
object Payment information for the AR advance. | |||||||||||||||||
object Reconciliation information for the advance transaction. | |||||||||||||||||
| |||||||||||||||||
isSystemGenerated | boolean Default: false Indicates whether the advance is system-generated. Example: false | ||||||||||||||||
accountType | string Default: "bank" Type of account associated with the payment method. Example: "bank" | ||||||||||||||||
object The payment summary details for this advance. Summaries are collections of the same types of transactions grouped together for processing. | |||||||||||||||||
| |||||||||||||||||
object Customer from whom the advance was received. | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
| |||||||||||||||||
financialEntity | string Financial entity. Example: "BOA" | ||||||||||||||||
object GL account associated with the advance. | |||||||||||||||||
| |||||||||||||||||
paymentMethod | string Payment method for the advance. Example: "printedCheck" | ||||||||||||||||
object Supporting document for the advance. | |||||||||||||||||
| |||||||||||||||||
Array of objects Line items of the advance. | |||||||||||||||||
Array
|
OK
Bad Request
{- "referenceNumber": "DOC1234"
}
{- "ia::result": {
- "key": "799",
- "id": "799",
- "href": "/objects/accounts-receivable/advance/799",
- "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "accounts-receivable/advance" | ||||||||
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-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}