A billing template defines the rules to use to invoice the flat or fixed amount of a contract line item.
Returns a collection with a key, ID, and link for each billing template. This operation is mostly for use in testing. Use query to fnd objects that meet certain criteria and to specify properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "7",
- "id": "BILLINGBEGPERCUST2",
- "href": "/objects/contracts/billing-template/7"
}, - {
- "key": "19",
- "id": "18M_Straitline_Beg",
- "href": "/objects/contracts/billing-template/19"
}, - {
- "key": "14",
- "id": "4P_25PER_MBEGIN",
- "href": "/objects/contracts/billing-template/14"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new billing template.
id required | string Name or other unique identifier for the billing template. Example: "12P_BeginningPeriod" | ||||||||||
description | string Description of the billing template. Example: "12P Beginning Period" | ||||||||||
method | string Default: "predefinedPercentages" Template type Example: "predefinedPercentages" | ||||||||||
source | string or null Default: null Specifies the data source to use to determine the percentage of completeness for the project or task. Example: "estimatedHours" | ||||||||||
isStepBilling | boolean Default: false Indicates whether to define billing thresholds to determine the percentage of the flat/fixed amount to invoice. Example: false | ||||||||||
Array of objects Contract billing template details. | |||||||||||
Array
| |||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "id": "BILLINGBEGPERCUST3",
- "description": "Custom percent billing beginning of 3,6,9,12 periods",
- "status": "active",
- "method": "predefinedPercentages",
- "source": "estimatedHours",
- "isStepBilling": false,
- "lines": [
- {
- "periodOffset": "3",
- "percentBilled": "5",
- "stepPercent": null
}, - {
- "periodOffset": "6",
- "percentBilled": "25",
- "stepPercent": null
}, - {
- "periodOffset": "9",
- "percentBilled": "45",
- "stepPercent": null
}, - {
- "periodOffset": "12",
- "percentBilled": "25",
- "stepPercent": null
}
]
}
{- "ia::result": {
- "key": "22",
- "id": "BILLINGBEGPERCUST3",
- "href": "/objects/contracts/billing-template/22"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified billing template.
key required | string System-assigned key for the billing template. |
OK
Bad Request
{- "ia::result": {
- "key": "7",
- "id": "BILLINGBEGPERCUST2",
- "description": "Custom percent billing beginning of 3,6,9,12 periods",
- "status": "active",
- "method": "predefinedPercentages",
- "source": "",
- "isStepBilling": false,
- "audit": {
- "modifiedDateTime": "2016-05-13T18:22:29Z",
- "createdDateTime": "2016-05-13T18:22:29Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "lines": [
- {
- "id": "44",
- "key": "44",
- "contractBillingTemplate": {
- "key": "7",
- "href": "/objects/contracts/billing-template/7"
}, - "periodOffset": "3",
- "percentBilled": "5",
- "stepPercent": null,
- "href": "/objects/contracts/billing-template-entry/44"
}, - {
- "id": "45",
- "key": "45",
- "contractBillingTemplate": {
- "key": "7",
- "href": "/objects/contracts/billing-template/7"
}, - "periodOffset": "6",
- "percentBilled": "25",
- "stepPercent": null,
- "href": "/objects/contracts/billing-template-line/45"
}, - {
- "id": "46",
- "key": "46",
- "contractBillingTemplate": {
- "key": "7",
- "href": "/objects/contracts/billing-template/7"
}, - "periodOffset": "9",
- "percentBilled": "45",
- "stepPercent": null,
- "href": "/objects/contracts/billing-template-line/46"
}, - {
- "id": "47",
- "key": "47",
- "contractBillingTemplate": {
- "key": "7",
- "href": "/objects/contracts/billing-template/7"
}, - "periodOffset": "12",
- "percentBilled": "25",
- "stepPercent": null,
- "href": "/objects/contracts/billing-template-line/47"
}
], - "href": "/objects/contracts/billing-template/7"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing billing template by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the billing template. |
description | string Description of the billing template. Example: "12P Beginning Period" | ||||||||||
method | string Default: "predefinedPercentages" Template type Example: "predefinedPercentages" | ||||||||||
source | string or null Default: null Specifies the data source to use to determine the percentage of completeness for the project or task. Example: "estimatedHours" | ||||||||||
isStepBilling | boolean Default: false Indicates whether to define billing thresholds to determine the percentage of the flat/fixed amount to invoice. Example: false | ||||||||||
Array of objects Contract billing template details. | |||||||||||
Array
| |||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "description": "Custom percent billing beginning of 3,6,9,12 periods",
- "status": "active",
- "method": "predefinedPercentages",
- "source": "estimatedHours",
- "isStepBilling": false,
- "lines": [
- {
- "key": "135",
- "periodOffset": "3",
- "percentBilled": "5",
- "stepPercent": null
}, - {
- "key": "136",
- "periodOffset": "6",
- "percentBilled": "25",
- "stepPercent": null
}, - {
- "key": "137",
- "periodOffset": "9",
- "percentBilled": "45",
- "stepPercent": null
}, - {
- "key": "138",
- "periodOffset": "12",
- "percentBilled": "25",
- "stepPercent": null
}
]
}
{- "ia::result": {
- "key": "22",
- "id": "BILLINGBEGPERCUST3",
- "href": "/objects/contracts/billing-template/22"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a billing template.
key required | string System-assigned key for the billing template. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "contracts/billing-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 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 response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}