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. Example: 111 |
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. Example: 111 |
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. Example: 111 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Use the query service to find billback templates that meet certain criteria and to specify the properties that are returned.
OK
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}