- Billing Templates
- Get Billing Template Object Definition
- Query and List Billing Templates
- Query and List Billing Templates (Legacy)
- Get Billing Template
- Get Billing Template by ID
- Create Billing Template
- Update Billing Template
- Delete Billing Template
- Billing Template Details
- Get Billing Template Detail Object Definition
- Query and List Billing Template Details
- Query and List Billing Template Details (Legacy)
- Get Billing Template Detail
A billing template defines the schedule to invoice the flat/fixed amount for a contract line over the contract term.
Billing Templates
Get Billing Template Object Definition
lookup
List all the fields and relationships for the billing template object:
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATE |
Query and List Billing Templates
query
List the record number and description for each billing template:
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATE |
filter | Optional | object | Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
select | Required | sequence | The names of the fields that you want included in the response, and an optional aggregate function such as count or sum . Returning all fields is not supported. |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> |
options | Optional | object | Query options:
|
pagesize | Optional | integer | Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
Query and List Billing Templates (Legacy)
readByQuery
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATE |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
query
Fields
Name | Required | Type | Description |
---|---|---|---|
STATUS | Optional | string | Status. Use T for Active, F fo Inactive |
Get Billing Template
read
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATE |
keys | Required | string | Comma-separated list of billing template RECORDNO to get |
fields | Optional | string | Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.For best performance and predictability, limit the number of fields. |
returnFormat | Optional | string | Data format for the response body:
|
Get Billing Template by ID
readByName
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATE |
keys | Required | string | Comma-separated list of billing template NAME to get |
fields | Optional | string | Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.For best performance and predictability, limit the number of fields. |
returnFormat | Optional | string | Data format for the response body:
|
Create Billing Template
History
Release | Changes |
---|---|
2019 Release 1 | Added METHOD and SOURCE |
create
Creates a billing template with predefined percentages:
Creates a billing template for project percent complete:
Parameters
Name | Required | Type | Description |
---|---|---|---|
CONTRACTBILLINGTEMPLATE | Required | object | Object to create |
CONTRACTBILLINGTEMPLATE
Name | Required | Type | Description |
---|---|---|---|
NAME | Required | string | Billing template name |
DESCRIPTION | Optional | string | Description |
STATUS | Optional | string | Status. Use active for Active otherwise use inactive for Inactive (Default: active ) |
METHOD | Optional | string | Template type. Use Predefined percentages , Project percent complete , or Task percent complete . (Default: Predefined percentages ) |
SOURCE | Optional | string | When creating Project percent complete , or Task percent complete templates, specifies whether to base the percentages on Estimated hours , Observed % completed , or Planned hours . Budgeted hours is also available for Project percent complete . (Default: Estimated hours ) |
CONTRACTBILLINGTEMPLATEENTRIES | Optional | CONTRACTBILLINGTEMPLATEENTRY[0...n] | Template detail when using predefined percentages. Percent to bill’s must add up to 100. |
CONTRACTBILLINGTEMPLATEENTRY
Name | Required | Type | Description |
---|---|---|---|
PERIODOFFSET | Required | integer | Number of months offset |
PERCENTBILLED | Required | decimal | Percent to bill |
Update Billing Template
History
Release | Changes |
---|---|
2019 Release 1 | Added METHOD and SOURCE |
When updating template details, you are providing a complete new set of entries (existing entries are deleted).
update
Parameters
Name | Required | Type | Description |
---|---|---|---|
CONTRACTBILLINGTEMPLATE | Required | object | Object to update |
CONTRACTBILLINGTEMPLATE
Name | Required | Type | Description |
---|---|---|---|
RECORDNO | Optional | integer | Record number of object. Required if not using NAME . |
NAME | Optional | string | Billing template name. Required if not using RECORDNO . |
DESCRIPTION | Optional | string | Description |
STATUS | Optional | string | Status. Use active for Active otherwise use inactive for Inactive (Default: active ) |
METHOD | Optional | string | Template type. Use Predefined percentages , Project percent complete , or Task percent complete . (Default: Predefined percentages ) |
SOURCE | Optional | string | When creating Project percent complete , or Task percent complete templates, specifies whether to base the percentages on Estimated hours , Observed % completed , or Planned hours . Budgeted hours is also available for Project percent complete . (Default: Estimated hours ) |
CONTRACTBILLINGTEMPLATEENTRIES | Optional | CONTRACTBILLINGTEMPLATEENTRY[0...n] | Template detail when using predefined percentages. Percent to bill’s must add up to 100. |
CONTRACTBILLINGTEMPLATEENTRY
Name | Required | Type | Description |
---|---|---|---|
PERIODOFFSET | Required | integer | Number of months offset |
PERCENTBILLED | Required | decimal | Percent to bill |
Delete Billing Template
delete
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATE |
keys | Required | string | Comma-separated list of billing template RECORDNO to delete |
Billing Template Details
Get Billing Template Detail Object Definition
lookup
List all the fields and relationships for the billing template detail object:
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATEENTRY |
Query and List Billing Template Details
query
List the record number and percent billed for each billing template detail:
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATEENTRY |
filter | Optional | object | Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
select | Required | sequence | The names of the fields that you want included in the response, and an optional aggregate function such as count or sum . Returning all fields is not supported. |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> |
options | Optional | object | Query options:
|
pagesize | Optional | integer | Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
Query and List Billing Template Details (Legacy)
readByQuery
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATEENTRY |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get Billing Template Detail
read
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use CONTRACTBILLINGTEMPLATEENTRY |
keys | Required | string | Comma-separated list of billing template detail RECORDNO to get |
fields | Optional | string | Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.For best performance and predictability, limit the number of fields. |
returnFormat | Optional | string | Data format for the response body:
|