Account / Contract / Tracking / Commitment

(API Version v10)

This object contains any of the penalties generated by contract commitments that have not been met.

What can you do with AccountContractTrackingCommitment?

GET Account/Contract/Tracking/Commitment/
Retrieve all of the AccountContractTrackingCommitment objects.
GET Account/Contract/Tracking/Commitment/Paged
Retrieve all of the AccountContractTrackingCommitment objects in a paged fashion.
GET Account/Contract/Tracking/Commitment/{id}
Retrieve an instance of the AccountContractTrackingCommitment object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 15 Type: Number This is the unique numeric identifier for the AccountContractTrackingCommitment
contractCommitmentId	"contractCommitmentId": 10 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": 17 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": 3 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": 15 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.

End Points

Retrieve all of the AccountContractTrackingCommitment objects.

GET Account/Contract/Tracking/Commitment/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "contractCommitmentId": 15,
            "contractCommitmentName": "Sample Text Data",
            "contractCommitmentPeriodId": 19,
            "contractCommitmentPeriodName": "Sample Text Data",
            "processed": "2021-04-26T15:25:27.587Z",
            "invoiceItemId": 22,
            "invoiceItemName": "Sample Text Data",
            "void": true,
            "invoiceId": 8,
            "invoiceName": "Sample Text Data"
        }
    ]
}

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

View Sample Response

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": 11,
                "contractCommitmentName": "Sample Text Data",
                "contractCommitmentPeriodId": 14,
                "contractCommitmentPeriodName": "Sample Text Data",
                "processed": "2021-04-26T15:25:27.587Z",
                "invoiceItemId": 15,
                "invoiceItemName": "Sample Text Data",
                "void": true,
                "invoiceId": 20,
                "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} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "contractCommitmentId": 8, "contractCommitmentName": "Sample Text Data", "contractCommitmentPeriodId": 7, "contractCommitmentPeriodName": "Sample Text Data", "processed": "2021-04-26T15:25:27.587Z", "invoiceItemId": 11, "invoiceItemName": "Sample Text Data", "void": true, "invoiceId": 23, "invoiceName": "Sample Text Data" } }