TAG LINE
SMALL TITLE

Account / Contract / Tracking / Termination

(API Version v4)


This object contains any of the penalties generated by contract early termination.


What can you do with AccountContractTrackingTermination?


Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the AccountContractTrackingTermination
contractTerminationId
"contractTerminationId": 4
Type: Number
Unique identifier for the associated ContractTermination object.
contractTerminationName
"contractTerminationName": "Sample Name"
Type: String
The name of the object associated with the contractTerminationId property.
invoiceItemId
"invoiceItemId": 0
Type: Number
If a penalty charge was generated from this contract termination, 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.
processed
READ-ONLY
"processed": "2021-04-26T15:25:27.587Z"
Type: Date
The date in which this contract termination was processed.

Date and time values are specified in the ISO 8601 format.


End Points

GETapi/v4/Account/Contract/Tracking/Termination/
Retrieve all of the AccountContractTrackingTermination objects.
Retrieve all of the AccountContractTrackingTermination objects.
GET api/v4/Account/Contract/Tracking/Termination/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "contractTerminationId": 3,
            "contractTerminationName": "Sample Text Data",
            "invoiceItemId": 0,
            "invoiceItemName": "Sample Text Data",
            "processed": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETapi/v4/Account/Contract/Tracking/Termination/Paged
Retrieve all of the AccountContractTrackingTermination 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 AccountContractTrackingTermination objects in a paged fashion.
GET api/v4/Account/Contract/Tracking/Termination/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,
                "contractTerminationId": 5,
                "contractTerminationName": "Sample Text Data",
                "invoiceItemId": 7,
                "invoiceItemName": "Sample Text Data",
                "processed": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETapi/v4/Account/Contract/Tracking/Termination/{id}
Retrieve an instance of the AccountContractTrackingTermination object by its ID.
{id}Unique identifier for the AccountContractTrackingTermination object.
Retrieve an instance of the AccountContractTrackingTermination object by its ID.
GET api/v4/Account/Contract/Tracking/Termination/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "contractTerminationId": 6,
        "contractTerminationName": "Sample Text Data",
        "invoiceItemId": 14,
        "invoiceItemName": "Sample Text Data",
        "processed": "2021-04-26T15:25:27.587Z"
    }
}
POSTapi/v4/Account/Contract/Tracking/Termination/Search
Retreive a list of AccountContractTrackingTermination 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 AccountContractTrackingTermination objects based on search criteria.
POST api/v4/Account/Contract/Tracking/Termination/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,
            "contractTerminationId": 2,
            "contractTerminationName": "Sample Text Data",
            "invoiceItemId": 5,
            "invoiceItemName": "Sample Text Data",
            "processed": "2021-04-26T15:25:27.587Z"
        }
    ]
}