TAG LINE
SMALL TITLE

Contract / Commitment

(API Version v2)


This entity is the top level container for a Contract Commitment that is associated with an Account Contract.


What can you do with ContractCommitment?


Properties

Property Details
identity
READ-ONLY
"identity": 25
Type: Number
This is the unique numeric identifier for the ContractCommitment
accountContractId
"accountContractId": 5
Type: Number
Unique identifier for the associated AccountContract object.
accountContractName
"accountContractName": "Sample Name"
Type: String
The name of the object associated with the accountContractId property.
contractCommitmentTypeId
"contractCommitmentTypeId": 2
Type: Number
Unique identifier for the associated ContractCommitmentType object.
contractCommitmentTypeName
"contractCommitmentTypeName": "Sample Name"
Type: String
The name of the object associated with the contractCommitmentTypeId property.
penaltyServiceId
"penaltyServiceId": 3
Type: Number
Unique identifier for the associated Service object.
penaltyServiceName
"penaltyServiceName": "Sample Name"
Type: String
The name of the object associated with the penaltyServiceId property.
penaltyDescription
"penaltyDescription": "Minimum quantity commit."
Type: String
User friendly description for a penalty applied for this commitment
includeChildAccounts
"includeChildAccounts": true
Type: Boolean
Whether or not child accounts should be considered in this rule.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • identity
  • accountContractId
  • contractCommitmentTypeId
  • penaltyServiceId
  • penaltyDescription
  • includeChildAccounts

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the ContractCommitment object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Contract/Commitment/{id}
Delete an instance of the ContractCommitment object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the ContractCommitment object.
Delete an instance of the ContractCommitment object.
DELETE api/v2/Contract/Commitment/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "contractCommitment"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Contract/Commitment/
Retrieve all of the ContractCommitment objects.
Retrieve all of the ContractCommitment objects.
GET api/v2/Contract/Commitment/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountContractId": 23,
            "accountContractName": "Sample Text Data",
            "contractCommitmentTypeId": 13,
            "contractCommitmentTypeName": "Sample Text Data",
            "penaltyServiceId": 16,
            "penaltyServiceName": "Sample Text Data",
            "penaltyDescription": "Minimum quantity commit.",
            "includeChildAccounts": true
        }
    ]
}
GETapi/v2/Contract/Commitment/Paged
Retrieve all of the ContractCommitment 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 ContractCommitment objects in a paged fashion.
GET api/v2/Contract/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,
                "accountContractId": 5,
                "accountContractName": "Sample Text Data",
                "contractCommitmentTypeId": 19,
                "contractCommitmentTypeName": "Sample Text Data",
                "penaltyServiceId": 22,
                "penaltyServiceName": "Sample Text Data",
                "penaltyDescription": "Minimum quantity commit.",
                "includeChildAccounts": true
            }
        ]
    }
}
GETapi/v2/Contract/Commitment/Paged/Detail
Retrieve all of the ContractCommitment objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the ContractCommitment objects in a paged fashion with all object details.
GET api/v2/Contract/Commitment/Paged/Detail
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,
                "accountContractId": 12,
                "accountContractName": "Sample Text Data",
                "contractCommitmentTypeId": 14,
                "contractCommitmentTypeName": "Sample Text Data",
                "penaltyServiceId": 2,
                "penaltyServiceName": "Sample Text Data",
                "penaltyDescription": "Minimum quantity commit.",
                "includeChildAccounts": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v2/Contract/Commitment/{id}
Retrieve an instance of the ContractCommitment object by its ID.
{id}Unique identifier for the ContractCommitment object.
Retrieve an instance of the ContractCommitment object by its ID.
GET api/v2/Contract/Commitment/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountContractId": 3,
        "accountContractName": "Sample Text Data",
        "contractCommitmentTypeId": 5,
        "contractCommitmentTypeName": "Sample Text Data",
        "penaltyServiceId": 5,
        "penaltyServiceName": "Sample Text Data",
        "penaltyDescription": "Minimum quantity commit.",
        "includeChildAccounts": true
    }
}
GETapi/v2/Contract/Commitment/{id}/Detail
Retrieve deep detail of the ContractCommitment object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the ContractCommitment object.
Retrieve deep detail of the ContractCommitment object by its ID.
GET api/v2/Contract/Commitment/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountContractId": 23,
        "accountContractName": "Sample Text Data",
        "contractCommitmentTypeId": 19,
        "contractCommitmentTypeName": "Sample Text Data",
        "penaltyServiceId": 19,
        "penaltyServiceName": "Sample Text Data",
        "penaltyDescription": "Minimum quantity commit.",
        "includeChildAccounts": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v2/Contract/Commitment/{id}
Update or Add the ContractCommitment object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the ContractCommitment object.
Update or Add the ContractCommitment object and optionally make changes to any child objects.
PATCH api/v2/Contract/Commitment/{id}

{
    "details": {},
    "contractCommitments": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "accountContractId": 10,
                "contractCommitmentTypeId": 27,
                "penaltyServiceId": 10,
                "penaltyDescription": "Minimum quantity commit.",
                "includeChildAccounts": true
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "contractCommitment",
                "instance": {
                    "identity": 1,
                    "accountContractId": 16,
                    "accountContractName": "Sample Text Data",
                    "contractCommitmentTypeId": 0,
                    "contractCommitmentTypeName": "Sample Text Data",
                    "penaltyServiceId": 0,
                    "penaltyServiceName": "Sample Text Data",
                    "penaltyDescription": "Minimum quantity commit.",
                    "includeChildAccounts": true
                }
            }
        ]
    }
}
POSTapi/v2/Contract/Commitment/
Create a new instance of the ContractCommitment object.
Create a new instance of the ContractCommitment object.
POST api/v2/Contract/Commitment/

{
    "accountContractId": 14,
    "contractCommitmentTypeId": 15,
    "penaltyServiceId": 19,
    "penaltyDescription": "Minimum quantity commit.",
    "includeChildAccounts": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountContractId": 27,
                "accountContractName": "Sample Text Data",
                "contractCommitmentTypeId": 14,
                "contractCommitmentTypeName": "Sample Text Data",
                "penaltyServiceId": 16,
                "penaltyServiceName": "Sample Text Data",
                "penaltyDescription": "Minimum quantity commit.",
                "includeChildAccounts": true
            }
        ]
    }
}
PUTapi/v2/Contract/Commitment/{id}
Update an existing instance of the ContractCommitment object.
Update an existing instance of the ContractCommitment object.
PUT api/v2/Contract/Commitment/{id}

{
    "identity": 1,
    "accountContractId": 22,
    "contractCommitmentTypeId": 13,
    "penaltyServiceId": 6,
    "penaltyDescription": "Minimum quantity commit.",
    "includeChildAccounts": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountContractId": 20,
                "accountContractName": "Sample Text Data",
                "contractCommitmentTypeId": 3,
                "contractCommitmentTypeName": "Sample Text Data",
                "penaltyServiceId": 5,
                "penaltyServiceName": "Sample Text Data",
                "penaltyDescription": "Minimum quantity commit.",
                "includeChildAccounts": true
            }
        ]
    }
}