TAG LINE
SMALL TITLE
This object contains any of the penalties generated by contract commitments that have not been met.
identity READ-ONLY | "identity": 18 Type: Number This is the unique numeric identifier for the AccountContractTrackingCommitment |
contractCommitmentId | "contractCommitmentId": 17 Type: Number Unique identifier for the associated ContractCommitment object. |
contractCommitmentName | "contractCommitmentName": "Sample Name" Type: String The name of the object associated with the contractCommitmentId property. |
contractCommitmentPeriodId | "contractCommitmentPeriodId": 11 Type: Number Unique identifier for the associated ContractCommitmentPeriod object. |
contractCommitmentPeriodName | "contractCommitmentPeriodName": "Sample Name" Type: String The name of the object associated with the contractCommitmentPeriodId property. |
processed READ-ONLY | "processed": "2021-04-26T15:25:27.587Z" Type: Date The date in which this contract commitment was processed. Date and time values are specified in the ISO 8601 format. |
invoiceItemId | "invoiceItemId": 22 Type: Number If a penalty charge was generated from this contract commitment, this identifier references the invoice item representing that charge. Unique identifier for the associated InvoiceItem object. |
invoiceItemName | "invoiceItemName": "Sample Name" Type: String The name of the object associated with the invoiceItemId property. |
void | "void": true Type: Boolean |
invoiceId | "invoiceId": 2 Type: Number If a penalty charge was generated from this contract commitment, this identifier references the invoice representing that charge. Unique identifier for the associated Invoice object. |
invoiceName | "invoiceName": "Sample Name" Type: String The name of the object associated with the invoiceId property. |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| GET | api/v3/Account/Contract/Tracking/Commitment/ |
| Retrieve all of the AccountContractTrackingCommitment objects. | |
Retrieve all of the AccountContractTrackingCommitment objects. GET api/v3/Account/Contract/Tracking/Commitment/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"contractCommitmentId": 4,
"contractCommitmentName": "Sample Text Data",
"contractCommitmentPeriodId": 24,
"contractCommitmentPeriodName": "Sample Text Data",
"processed": "2021-04-26T15:25:27.587Z",
"invoiceItemId": 7,
"invoiceItemName": "Sample Text Data",
"void": true,
"invoiceId": 0,
"invoiceName": "Sample Text Data"
}
]
} | |
| GET | api/v3/Account/Contract/Tracking/Commitment/Paged |
| Retrieve all of the AccountContractTrackingCommitment objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the AccountContractTrackingCommitment objects in a paged fashion. GET api/v3/Account/Contract/Tracking/Commitment/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"contractCommitmentId": 14,
"contractCommitmentName": "Sample Text Data",
"contractCommitmentPeriodId": 3,
"contractCommitmentPeriodName": "Sample Text Data",
"processed": "2021-04-26T15:25:27.587Z",
"invoiceItemId": 25,
"invoiceItemName": "Sample Text Data",
"void": true,
"invoiceId": 7,
"invoiceName": "Sample Text Data"
}
]
}
} | |
| GET | api/v3/Account/Contract/Tracking/Commitment/{id} |
| Retrieve an instance of the AccountContractTrackingCommitment object by its ID. | |
| {id} | Unique identifier for the AccountContractTrackingCommitment object. |
Retrieve an instance of the AccountContractTrackingCommitment object by its ID. GET api/v3/Account/Contract/Tracking/Commitment/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"contractCommitmentId": 1,
"contractCommitmentName": "Sample Text Data",
"contractCommitmentPeriodId": 14,
"contractCommitmentPeriodName": "Sample Text Data",
"processed": "2021-04-26T15:25:27.587Z",
"invoiceItemId": 2,
"invoiceItemName": "Sample Text Data",
"void": true,
"invoiceId": 20,
"invoiceName": "Sample Text Data"
}
} | |