TAG LINE
SMALL TITLE

Account / Contract / Tracking / Commitment

(API Version v4)


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


What can you do with AccountContractTrackingCommitment?


Properties

Property Details
identity
READ-ONLY
"identity": 17
Type: Number
This is the unique numeric identifier for the AccountContractTrackingCommitment
contractCommitmentId
"contractCommitmentId": 27
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": 13
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": 26
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": 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.


End Points

GETapi/v4/Account/Contract/Tracking/Commitment/
Retrieve all of the AccountContractTrackingCommitment objects.
Retrieve all of the AccountContractTrackingCommitment objects.
GET api/v4/Account/Contract/Tracking/Commitment/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "contractCommitmentId": 0,
            "contractCommitmentName": "Sample Text Data",
            "contractCommitmentPeriodId": 26,
            "contractCommitmentPeriodName": "Sample Text Data",
            "processed": "2021-04-26T15:25:27.587Z",
            "invoiceItemId": 18,
            "invoiceItemName": "Sample Text Data",
            "void": true,
            "invoiceId": 6,
            "invoiceName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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/v4/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": 3,
                "contractCommitmentName": "Sample Text Data",
                "contractCommitmentPeriodId": 17,
                "contractCommitmentPeriodName": "Sample Text Data",
                "processed": "2021-04-26T15:25:27.587Z",
                "invoiceItemId": 20,
                "invoiceItemName": "Sample Text Data",
                "void": true,
                "invoiceId": 17,
                "invoiceName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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/v4/Account/Contract/Tracking/Commitment/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "contractCommitmentId": 0,
        "contractCommitmentName": "Sample Text Data",
        "contractCommitmentPeriodId": 5,
        "contractCommitmentPeriodName": "Sample Text Data",
        "processed": "2021-04-26T15:25:27.587Z",
        "invoiceItemId": 25,
        "invoiceItemName": "Sample Text Data",
        "void": true,
        "invoiceId": 25,
        "invoiceName": "Sample Text Data"
    }
}
POSTapi/v4/Account/Contract/Tracking/Commitment/Search
Retreive a list of AccountContractTrackingCommitment objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of AccountContractTrackingCommitment objects based on search criteria.
POST api/v4/Account/Contract/Tracking/Commitment/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "contractCommitmentId": 15,
            "contractCommitmentName": "Sample Text Data",
            "contractCommitmentPeriodId": 5,
            "contractCommitmentPeriodName": "Sample Text Data",
            "processed": "2021-04-26T15:25:27.587Z",
            "invoiceItemId": 20,
            "invoiceItemName": "Sample Text Data",
            "void": true,
            "invoiceId": 2,
            "invoiceName": "Sample Text Data"
        }
    ]
}