Bill back templates

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.

List bill back templates

get/objects/accounts-receivable/billback-template

Returns a collection with a key, ID, and link for each bill back template. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a bill back template
post/objects/accounts-receivable/billback-template
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.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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 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.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Line items in the bill back template.


 
 Array 
memo
string
Memo about the line item.


 
 Example:  "Line number 2"
object
The GL account to use for associated invoice line items.


 
object
The GL account to use for associated bill line items.


 
object
Department to include on associated invoices.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "BBT-FR2US",
  • "description": "BBT France to US",
  • "enableInterEntityPostings": true,
  • "lines": [
    • {
      • "invoiceGLAccount": {
        },
      • "billGLAccount": {
        },
      • "department": {
        },
      • "memo": "For France"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "26",
    • "id": "BBT-FR2US",
    • "href": "/objects/accounts-receivable/billback-template/26"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a bill back template
get/objects/accounts-receivable/billback-template/{key}
Returns detailed information for a specified bill back template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bill back template.


 
 Example:  17
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "26",
    • "id": "BBT-FR2US",
    • "description": "BBT France to US",
    • "status": "active",
    • "enableInterEntityPostings": true,
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/billback-template/26"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a bill back template
patch/objects/accounts-receivable/billback-template/{key}
Updates an existing bill back template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bill back template.


 
 Example:  17
Request Body schema: application/json
description
string
Description of the template.


 
 Example:  "Bill back template for India 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.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Line items in the bill back template.


 
 Array 
memo
string
Memo about the line item.


 
 Example:  "Line number 2"
object
The GL account to use for associated invoice line items.


 
object
The GL account to use for associated bill line items.


 
object
Department to include on associated invoices.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "active",
  • "lines": [
    • {
      • "invoiceGLAccount": {
        },
      • "billGLAccount": {
        },
      • "department": {
        },
      • "memo": "line 1-1"
      },
    • {
      • "invoiceGLAccount": {
        },
      • "billGLAccount": {
        },
      • "department": {
        },
      • "memo": "line 1-2"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "BBT-AU2IN",
    • "href": "/objects/accounts-receivable/billback-template/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a bill back template
delete/objects/accounts-receivable/billback-template/{key}
Deletes a bill back template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the bill back template.


 
 Example:  17
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}