Billing schedule lines

Line items in a contract billing schedule represent a single billing for a contract line. You create, update, and delete billing schedule line objects through operations on the owning contract billing schedule.

List billing schedule lines

get/objects/contracts/billing-schedule-line

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


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


 
 Example:  349
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "1243",
    • "key": "1243",
    • "contractBillingSchedule": {
      • "id": "147",
      • "key": "147",
      • "href": "/objects/contracts/billing-schedule/147"
      },
    • "scheduledOperationKey": null,
    • "scheduledAmount": "2400.00",
    • "scheduledBaseAmount": "2400.00",
    • "actualBaseAmount": null,
    • "scheduledExchangeRate": "1.000000000000",
    • "actualExchangeRate": null,
    • "scheduledBillingDate": "2017-01-01",
    • "actualBillingDate": null,
    • "billed": false,
    • "isHistorical": false,
    • "state": "open",
    • "computationMemo": null,
    • "approvedHours": null,
    • "sourceHours": null,
    • "linkedBillingScheduleLine": {
      • "id": null,
      • "key": null
      },
    • "documentId": null,
    • "audit": {
      • "createdDateTime": "2017-11-02T19:48:54Z",
      • "modifiedDateTime": "2024-03-28T04:14:00Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": null
      },
    • "contractUsage": {
      • "id": null,
      • "key": null
      },
    • "servicePeriodStartDate": null,
    • "servicePeriodEndDate": null,
    • "href": "/objects/contracts/billing-schedule-line/1243"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}