Billing template lines

Line items in a contract billing schedule specify the percentages complete at which you want to invoice. You create, update, and delete billing template line objects through operations on the owning contract billing template.

List billing template lines

get/objects/contracts/billing-template-line

Returns up to 100 object references from the collection with a key, ID, and link for each billing template line. This operation is mostly for use in testing; use query 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": "7",
      • "id": "7",
      • "href": "/objects/contracts/billing-template-line/7"
      }
    ],
  • "ia::meta": {
    • "totalCount": 1,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a billing template line
get/objects/contracts/billing-template-line/{key}
Returns detailed information for a specified billing template line.


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


 
 Example:  7
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "contractBillingTemplate": {
      • "key": "37",
      • "id": "37",
      • "href": "/objects/contracts/billing-template/37"
      },
    • "periodOffset": "1",
    • "stepPercent": "1.00000000",
    • "percentToBill": "50.00000000",
    • "href": "/objects/contracts/billing-template-line/7"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query billing template lines
post/services/core/query
Use the query service to find billing template lines 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
    }
}