Billback 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 billback templates

get/objects/accounts-receivable/billback-template

Returns a collection with a key, ID, and link for each billback template.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Line items of the billback template.


 
 Array 
memo
string
Memo


 
 Example:  "Line number 2"
object
The account for the line item in the invoice


 
object
The bill GL Account is used in the corresponding line item of generated bill.


 
object
Department


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "BBT-NextGen-9",
  • "description": "BBT Next Gen template-9",
  • "enableInterEntityPostings": true,
  • "lines": [
    • {
      • "invoiceGLAccount": {
        },
      • "billGLAccount": {
        },
      • "department": {
        },
      • "memo": "line 1"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "26",
    • "id": "BBT-NextGen-9",
    • "href": "/objects/accounts-receivable/billback-template/26"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a billback template
get/objects/accounts-receivable/billback-template/{key}
Returns detailed information for a particular billback template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the billback template.


 
 Example:  111
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "bbt1",
    • "description": "Billback template 2",
    • "status": "active",
    • "enableInterEntityPostings": true,
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/billback-template/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a billback template
patch/objects/accounts-receivable/billback-template/{key}
Updates an existing billback template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the billback template.


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


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Line items of the billback template.


 
 Array 
memo
string
Memo


 
 Example:  "Line number 2"
object
The account for the line item in the invoice


 
object
The bill GL Account is used in the corresponding line item of generated bill.


 
object
Department


 
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-NextGen-1",
    • "href": "/objects/accounts-receivable/billback-template/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a billback template
delete/objects/accounts-receivable/billback-template/{key}
Deletes a billback template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the billback template.


 
 Example:  111
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
    }
}
Query billback templates
post/services/core/query
Use the query service to find billback templates that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}