Create a bill back template for each recurring bill back transaction. The template provides line item information needed in the bill back transaction, including invoice line items and corresponding line items in the system-generated bill.
Returns a collection with a key, ID, and link for each billback template.
OK
Bad Request
{- "ia::result": [
- {
- "key": "11",
- "id": "BBT-NextGen-2",
- "href": "/objects/accounts-receivable/billback-template/11"
}, - {
- "key": "14",
- "id": "BBT-NextGen-5",
- "href": "/objects/accounts-receivable/billback-template/14"
}, - {
- "key": "25",
- "id": "BBT-NextGen-8",
- "href": "/objects/accounts-receivable/billback-template/25"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new billback template.
id required | string BillBack Template ID Example: "Template 1" | ||||||||
description required | string Description Example: "Billback template for sales account" | ||||||||
enableInterEntityPostings | boolean Default: false Set to true to post directly to the mapped inter-entity offset accounts instead of the Accounts Receivable and Accounts Payable offset accounts. Example: true | ||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||
Array of objects Line items of the billback template. | |||||||||
Array
|
Created
Bad Request
{- "id": "BBT-NextGen-9",
- "description": "BBT Next Gen template-9",
- "enableInterEntityPostings": true,
- "lines": [
- {
- "invoiceGLAccount": {
- "key": "194"
}, - "billGLAccount": {
- "key": "109"
}, - "department": {
- "key": "9"
}, - "memo": "line 1"
}
]
}
{- "ia::result": {
- "key": "26",
- "id": "BBT-NextGen-9",
- "href": "/objects/accounts-receivable/billback-template/26"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a particular billback template.
key required | string System-assigned key for the billback template. |
OK
Bad Request
{- "ia::result": {
- "key": "1",
- "id": "bbt1",
- "description": "Billback template 2",
- "status": "active",
- "enableInterEntityPostings": true,
- "lines": [
- {
- "key": "1",
- "id": "1",
- "billbackTemplate": {
- "id": "1",
- "key": "1",
- "href": "/objects/accounts-receivable/billback-template/1"
}, - "lineNumber": "0",
- "invoiceGLAccount": {
- "key": "194",
- "id": "4000",
- "name": "Sales",
- "href": "/objects/general-ledger/account/194"
}, - "billGLAccount": {
- "key": "207",
- "id": "5001",
- "name": "Construction",
- "href": "/objects/general-ledger/account/207"
}, - "department": {
- "key": "9",
- "id": "11",
- "name": "Accounting",
- "href": "/objects/company-config/department/9"
}, - "memo": "line 1",
- "href": "/objects/accounts-receivable/billback-template-line/1"
}
], - "href": "/objects/accounts-receivable/billback-template/1"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing billback template by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the billback template. |
description | string Description Example: "Billback template for sales account" | ||||||||
enableInterEntityPostings | boolean Default: false Set to true to post directly to the mapped inter-entity offset accounts instead of the Accounts Receivable and Accounts Payable offset accounts. Example: true | ||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||
Array of objects Line items of the billback template. | |||||||||
Array
|
OK
Bad Request
{- "status": "active",
- "lines": [
- {
- "invoiceGLAccount": {
- "key": "194"
}, - "billGLAccount": {
- "key": "109"
}, - "department": {
- "key": "9"
}, - "memo": "line 1-1"
}, - {
- "invoiceGLAccount": {
- "key": "194"
}, - "billGLAccount": {
- "key": "109"
}, - "department": {
- "key": "9"
}, - "memo": "line 1-2"
}
]
}
{- "ia::result": {
- "key": "5",
- "id": "BBT-NextGen-1",
- "href": "/objects/accounts-receivable/billback-template/5"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a billback template.
key required | string System-assigned key for the billback template. |
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/billback-template" | ||||||||
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
}
}