Accounts Receivable (AR) terms are the rules a company establishes for extending credit to customers. Terms can be associated with AR transactions and with customers.
Returns a collection with a key, ID, and link for each AR term. 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 type | Business |
Permissions | List, View AR terms |
OK
Bad Request
{- "ia::result": [
- {
- "key": "5",
- "id": "N15",
- "href": "/objects/accounts-receivable/term/5"
}, - {
- "key": "8",
- "id": "N30",
- "href": "/objects/accounts-receivable/term/8"
}, - {
- "key": "9",
- "id": "NET15",
- "href": "/objects/accounts-receivable/term/9"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Creates a new AR term.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Add AR terms |
id required | string Name or other unique identifier for the term. Example: "2% 10 Net 30" | ||||||||||||
description required | string Note about the purpose and use of the term. Example: "2% discount if paid 10 days from invoice. Due on day 30." | ||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||
object The due date is a combination of a number of days and a reference point. For example, to set terms that reference the number of days from the invoice date, set the number of days in | |||||||||||||
| |||||||||||||
object A discount is a combination of the days, what the days reference, the dollar or percent discount, and the number of grace days. | |||||||||||||
| |||||||||||||
object Penalty for paying after the due date. | |||||||||||||
|
Created
Bad Request
{- "id": "2-10 Net 30",
- "description": "N30 with discount",
- "due": {
- "days": 30,
- "from": "fromInvoiceDate"
}, - "discount": {
- "days": 4,
- "amount": 2,
- "from": "fromInvoiceDate",
- "calculateOn": "lineItemsTotal",
- "unit": "percentage",
- "graceDays": 10
}, - "penalty": {
- "cycle": "weekly",
- "amount": 1,
- "unit": "percentage",
- "graceDays": 20
}
}
{- "ia::result": {
- "key": "18",
- "id": "2-10 Net 30",
- "href": "/objects/accounts-receivable/term/18"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified term.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View AR terms |
key required | string System-assigned unique key for the term. |
OK
Bad Request
{- "ia::result": {
- "id": "2-10 Net 30",
- "description": "N30 with discount",
- "value": ":0/10:10#0/10#100:O:10",
- "status": "active",
- "key": "18",
- "due": {
- "days": 30,
- "from": "fromInvoiceDate"
}, - "discount": {
- "days": 4,
- "from": "fromInvoiceDate",
- "amount": 2,
- "unit": "percentage",
- "graceDays": 10,
- "calculateOn": "lineItemsTotal"
}, - "penalty": {
- "cycle": "weekly",
- "amount": 1,
- "unit": "percentage",
- "graceDays": 20
}, - "audit": {
- "modifiedDateTime": "2024-03-06T09:23:41Z",
- "createdDateTime": "2024-03-06T09:23:41Z",
- "modifiedBy": "1",
- "createdBy": "1"
}, - "href": "/objects/accounts-receivable/term/18"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing AR term by setting field values. Any fields not provided remain unchanged.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Edit AR terms |
key required | string System-assigned unique key for the term. |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||||||
description | string Note about the purpose and use of the term. Example: "2% discount if paid 10 days from invoice. Due on day 30." | ||||||||||||
object The due date is a combination of a number of days and a reference point. For example, to set terms that reference the number of days from the invoice date, set the number of days in | |||||||||||||
| |||||||||||||
object A discount is a combination of the days, what the days reference, the dollar or percent discount, and the number of grace days. | |||||||||||||
| |||||||||||||
object Penalty for paying after the due date. | |||||||||||||
|
OK
Bad Request
{- "description": "NA customer term"
}
{- "ia::result": {
- "key": "18",
- "id": "N30",
- "href": "/objects/accounts-receivable/term/18",
- "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
}
Deletes a term. Delete terms that are no longer in use to avoid cluttering the list of active terms.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Delete AR terms |
key required | string System-assigned unique key for the term. |
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/term" | ||||||||
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/term",
- "filters": [
- {
- "$eq": {
- "penalty.cycle": "noPenalty"
}
}
], - "fields": [
- "id",
- "description",
- "status",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "60 Days",
- "description": "Net 60 Days",
- "status": "active",
- "href": "/objects/accounts-receivable/term/1"
}, - {
- "id": "N30",
- "description": "Net 30 days",
- "status": "active",
- "href": "/objects/accounts-receivable/term/15"
}, - {
- "id": "Net 10",
- "description": "Due in 10 Days",
- "status": "active",
- "href": "/objects/accounts-receivable/term/6"
}, - {
- "id": "Net20",
- "description": "Due in 20 Days",
- "status": "active",
- "href": "/objects/accounts-receivable/term/8"
}
], - "ia::meta": {
- "totalCount": 4,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}