Billing schedules

A contract billing schedule is a header containing multiple schedule lines. It is referenced by a contract line.

List contract billing schedules

get/objects/contracts/billing-schedule

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


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


 
 Example:  1843
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1576",
    • "id": "1576",
    • "contract": {
      • "key": "143",
      • "id": "Committed_Quantity_Billing",
      • "href": "/objects/contracts/contract/143"
      },
    • "contractLine": {
      • "id": "387",
      • "key": "387",
      • "href": "/objects/contracts/contract-line/387"
      },
    • "status": "inProgress",
    • "cancellationDate": null,
    • "audit": {
      • "createdDateTime": "2024-02-01T06:14:00Z",
      • "modifiedDateTime": "2024-02-01T06:14:00Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "estimateRevaluationDate": null,
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/contracts/billing-schedule/1576"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a contract billing schedule
patch/objects/contracts/billing-schedule/{key}
Updates an existing contract billing schedule by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  1843
Request Body schema: application/json
Array of objects
Contract billing schedule lines.


 
 Array 
scheduledBillingDate
string <date> 
The date the scheduled amount is expected to be invoiced.


 
 Example:  "2022-04-30"
actualBaseAmount
string or null <decimal-precision-2> 
The posted invoice amount in the company's base currency.


 
 Example:  "137.52"
actualExchangeRate
string or null <decimal-precision-12> 
The exchange rate used by the invoice when posted.


 
 Example:  "1.345"
sourceHours
string or null
The total source hours from the project or task. Used with approvedHours to determine the percent complete calculation for the corresponding billing schedule entry. This field is only applicable to percent complete billing templates.


 
 Example:  "118"
approvedHours
string or null
For percent complete billing templates:


The total hours from all approved hours associated with the project or task. Used with sourceHours to determine the percent complete calculation for the corresponding billing schedule entry. This field is only applicable to percent complete billing templates.


For project time contract lines:


The total number of approved hours combined for the project, project/item, or project/task that were billed in the corresponding invoice.


 
 Example:  "16"
servicePeriodStartDate
string or null <date> 
The beginning of the time frame during which the business' services are provided or consumed for this billing entry.


 
 Example:  "2022-04-01"
servicePeriodEndDate
string or null <date> 
The end of the time frame during which the business' services are provided or consumed for this billing entry.


 
 Example:  "2022-04-30"
object
Reference to a contract billing schedule.


 
object
Reference to a contract usage, indentifying usage of a quantity-based item.


 
scheduledAmount
string <decimal-precision-2> 
The schedule amount to be billed.


 
 Example:  "125.27"
scheduledBaseAmount
string <decimal-precision-2> 
The amount in the company's base currency.


 
 Example:  "137.52"
scheduledExchangeRate
string <decimal-precision-12> 
The exchange rate in effect on the contract line start date.


 
 Example:  "1.345"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "lines": [
    • {
      • "scheduledBillingDate": "2022-05-25",
      • "scheduledAmount": "125.34"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "2021-LV2",
    • "href": "/objects/contracts/billing-schedule/12"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query billing schedules
post/services/core/query
Use the query service to find billing schedules 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
    }
}