TAG LINE
TAG LINE
SMALL TITLE
This object contains any of the penalties generated by contract commitments that have not been met.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the AccountContractTrackingCommitment |
contractCommitmentId | "contractCommitmentId": 3 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": 26 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": 23 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 Identifies if the contract commitment is void or not. |
invoiceId | "invoiceId": 8 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. |
GET | Account/Contract/Tracking/Commitment/ |
Retrieve all of the AccountContractTrackingCommitment objects. | |
Retrieve all of the AccountContractTrackingCommitment objects. GET 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": 26, "invoiceItemName": "Sample Text Data", "void": true, "invoiceId": 22, "invoiceName": "Sample Text Data" } ] } |
GET | 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 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": 15, "contractCommitmentName": "Sample Text Data", "contractCommitmentPeriodId": 26, "contractCommitmentPeriodName": "Sample Text Data", "processed": "2021-04-26T15:25:27.587Z", "invoiceItemId": 3, "invoiceItemName": "Sample Text Data", "void": true, "invoiceId": 15, "invoiceName": "Sample Text Data" } ] } } |
GET | 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 Account/Contract/Tracking/Commitment/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "contractCommitmentId": 10, "contractCommitmentName": "Sample Text Data", "contractCommitmentPeriodId": 27, "contractCommitmentPeriodName": "Sample Text Data", "processed": "2021-04-26T15:25:27.587Z", "invoiceItemId": 16, "invoiceItemName": "Sample Text Data", "void": true, "invoiceId": 18, "invoiceName": "Sample Text Data" } } |