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.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

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.

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.

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.

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

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "accounts-receivable/billback-template"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

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 asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

  • and by itself means that all conditions must be true.
  • or by itself means that at least one condition must be true.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
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
property name*
additional property
string
Enum: "asc" "desc"
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
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "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
    }
}