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 bill back template. 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 Bill back templates |
OK
Bad Request
{- "ia::result": [
- {
- "key": "11",
- "id": "BBT-AU2I",
- "href": "/objects/accounts-receivable/billback-template/11"
}, - {
- "key": "14",
- "id": "BBT-AU2US",
- "href": "/objects/accounts-receivable/billback-template/14"
}, - {
- "key": "25",
- "id": "BBT-FR2US",
- "href": "/objects/accounts-receivable/billback-template/25"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new bill back template. Several configuration steps must be completed before creating bill back templates. For more information, see Set up inter-entity bill back in the Sage Intacct Help Center.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Add Bill back templates |
id required | string Unique ID for the bill back template. Example: "Template 1" | ||||||||
description required | string Description of the template. Example: "Bill back template for India sales account" | ||||||||
enableInterEntityPostings | boolean Default: false Set to 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 in the bill back template. | |||||||||
Array
|
Created
Bad Request
{- "id": "BBT-FR2US",
- "description": "BBT France to US",
- "enableInterEntityPostings": true,
- "lines": [
- {
- "invoiceGLAccount": {
- "key": "194"
}, - "billGLAccount": {
- "key": "109"
}, - "department": {
- "key": "9"
}, - "memo": "For France"
}
]
}
{- "ia::result": {
- "key": "26",
- "id": "BBT-FR2US",
- "href": "/objects/accounts-receivable/billback-template/26"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified bill back template.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View Bill back templates |
key required | string System-assigned unique key for the bill back template. Example: 17 |
OK
Bad Request
{- "ia::result": {
- "key": "26",
- "id": "BBT-FR2US",
- "description": "BBT France to US",
- "status": "active",
- "enableInterEntityPostings": true,
- "entity": {
- "key": null,
- "id": null,
- "name": null
}, - "lines": [
- {
- "key": "1",
- "id": "1",
- "billbackTemplate": {
- "id": "BBT-FR2US",
- "key": "26",
- "href": "/objects/accounts-receivable/billback-template/26"
}, - "lineNumber": "1",
- "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/26"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing bill back template by setting field values. Any fields not provided remain unchanged.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Edit Bill back templates |
key required | string System-assigned unique key for the bill back template. Example: 17 |
description | string Description of the template. Example: "Bill back template for India sales account" | ||||||||
enableInterEntityPostings | boolean Default: false Set to 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 in the bill back 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-AU2IN",
- "href": "/objects/accounts-receivable/billback-template/5"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a bill back template.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Delete Bill back templates |
key required | string System-assigned unique key for the bill back template. Example: 17 |
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
}
}
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 has (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 result set, 4000 maximum. Example: 100 |
OK
Bad Request
{- "object": "accounts-receivable/billback-template",
- "filters": [
- {
- "$eq": {
- "enableInterEntityPostings": true
}
}
], - "fields": [
- "id",
- "href",
- "description",
- "status"
]
}
{- "ia::result": [
- {
- "id": "3",
- "href": "/objects/accounts-receivable/billback-template/3",
- "description": "BBT US to FR",
- "status": "active"
}, - {
- "id": "4",
- "href": "/objects/accounts-receivable/billback-template/4",
- "description": "BBT US to AU",
- "status": "active"
}, - {
- "id": "8",
- "href": "/objects/accounts-receivable/billback-template/8",
- "description": "BBT US to DE",
- "status": "active"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}