TAG LINE
SMALL TITLE

Account / Contract

(API Version v3)


An Account Contract object contains contract details that have been assigned to an account. There is a one-to-many relationship from an Account to multiple Account Contracts.


What can you do with AccountContract?


Properties

Property Details
identity
READ-ONLY
"identity": 14
Type: Number
This is the unique numeric identifier for the AccountContract
ownerId
READ-ONLY
"ownerId": 0
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "My Contract"
Type: String
The name of this Contract.
accountId
"accountId": 17
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
accountContractStatusTypeId
"accountContractStatusTypeId": 1
Type: Number
Unique identifier for the associated AccountContractStatusType object.
accountContractStatusTypeName
"accountContractStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the accountContractStatusTypeId property.
start
"start": "2021-04-26T15:25:27.587Z"
Type: Date
The start date for the term of the Contract.

Date and time values are specified in the ISO 8601 format.
frequency
"frequency": 0
Type: Number
Number of units this contract spans based on the frequency type. For example for a term of 1 month, the frequency would be 1.
frequencyTypeId
"frequencyTypeId": 12
Type: Number
Unique identifier for the associated FrequencyType object.
frequencyTypeName
"frequencyTypeName": "Sample Name"
Type: String
The name of the object associated with the frequencyTypeId property.
accountContractRenewalTypeId
"accountContractRenewalTypeId": 25
Type: Number
Unique identifier for the associated AccountContractRenewalType object.
accountContractRenewalTypeName
"accountContractRenewalTypeName": "Sample Name"
Type: String
The name of the object associated with the accountContractRenewalTypeId property.
renewalAccountContractId
"renewalAccountContractId": 19
Type: Number
If the contract's renew type is a new contract, then this identifier will specify the contract that that will be used on renewal.

Unique identifier for the associated AccountContract object.
renewalAccountContractName
"renewalAccountContractName": "Sample Name"
Type: String
The name of the object associated with the renewalAccountContractId property.
contractTerminationId
"contractTerminationId": 22
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.
terminationAccountContractStatusTypeId
"terminationAccountContractStatusTypeId": 15
Type: Number
Unique identifier for the associated AccountContractStatusType object.
terminationAccountContractStatusTypeName
"terminationAccountContractStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the terminationAccountContractStatusTypeId property.
renewalAccountContractStatusTypeId
"renewalAccountContractStatusTypeId": 26
Type: Number
Unique identifier for the associated AccountContractStatusType object.
renewalAccountContractStatusTypeName
"renewalAccountContractStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the renewalAccountContractStatusTypeId property.
earlyTermination
"earlyTermination": "2021-04-26T15:25:27.587Z"
Type: Date
If the contract has been terminated early, this date will specify the date of termination.

Date and time values are specified in the ISO 8601 format.
earlyTerminationComment
"earlyTerminationComment": "Hello World"
Type: String
termTypeId
"termTypeId": 26
Type: Number
Unique identifier for the associated TermType object.
termTypeName
"termTypeName": "Sample Name"
Type: String
The name of the object associated with the termTypeId property.
extendedStart
READ-ONLY
"extendedStart": "2021-04-26T15:25:27.587Z"
Type: Date
If new packages are added to the account with package contract commitment terms that end past the current account contract term, this date will be extended to match that of the added package.

Date and time values are specified in the ISO 8601 format.
version
"version": 17
Type: Number


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:

  • name
  • accountId
  • accountContractStatusTypeId
  • start
  • frequency
  • frequencyTypeId
  • accountContractRenewalTypeId
  • renewalAccountContractId
  • contractTerminationId
  • terminationAccountContractStatusTypeId
  • renewalAccountContractStatusTypeId
  • earlyTermination
  • earlyTerminationComment
  • termTypeId

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 AccountContract object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/Account/Contract/{id}
Delete an instance of the AccountContract 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 AccountContract object.
Delete an instance of the AccountContract object.
DELETE api/v3/Account/Contract/{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": "accountContract"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Account/Contract/
Retrieve all of the AccountContract objects.
Retrieve all of the AccountContract objects.
GET api/v3/Account/Contract/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 13,
            "ownerName": "Sample Text Data",
            "name": "My Contract",
            "accountId": 9,
            "accountName": "Sample Text Data",
            "accountContractStatusTypeId": 25,
            "accountContractStatusTypeName": "Sample Text Data",
            "start": "2021-04-26T15:25:27.587Z",
            "frequency": 6,
            "frequencyTypeId": 5,
            "frequencyTypeName": "Sample Text Data",
            "accountContractRenewalTypeId": 5,
            "accountContractRenewalTypeName": "Sample Text Data",
            "renewalAccountContractId": 22,
            "renewalAccountContractName": "Sample Text Data",
            "contractTerminationId": 11,
            "contractTerminationName": "Sample Text Data",
            "terminationAccountContractStatusTypeId": 24,
            "terminationAccountContractStatusTypeName": "Sample Text Data",
            "renewalAccountContractStatusTypeId": 10,
            "renewalAccountContractStatusTypeName": "Sample Text Data",
            "earlyTermination": "2021-04-26T15:25:27.587Z",
            "earlyTerminationComment": "Sample Text Data",
            "termTypeId": 15,
            "termTypeName": "Sample Text Data",
            "extendedStart": "2021-04-26T15:25:27.587Z",
            "version": 7
        }
    ]
}
GETapi/v3/Account/Contract/Paged
Retrieve all of the AccountContract 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 AccountContract objects in a paged fashion.
GET api/v3/Account/Contract/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,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "name": "My Contract",
                "accountId": 10,
                "accountName": "Sample Text Data",
                "accountContractStatusTypeId": 5,
                "accountContractStatusTypeName": "Sample Text Data",
                "start": "2021-04-26T15:25:27.587Z",
                "frequency": 12,
                "frequencyTypeId": 22,
                "frequencyTypeName": "Sample Text Data",
                "accountContractRenewalTypeId": 16,
                "accountContractRenewalTypeName": "Sample Text Data",
                "renewalAccountContractId": 14,
                "renewalAccountContractName": "Sample Text Data",
                "contractTerminationId": 24,
                "contractTerminationName": "Sample Text Data",
                "terminationAccountContractStatusTypeId": 9,
                "terminationAccountContractStatusTypeName": "Sample Text Data",
                "renewalAccountContractStatusTypeId": 0,
                "renewalAccountContractStatusTypeName": "Sample Text Data",
                "earlyTermination": "2021-04-26T15:25:27.587Z",
                "earlyTerminationComment": "Sample Text Data",
                "termTypeId": 0,
                "termTypeName": "Sample Text Data",
                "extendedStart": "2021-04-26T15:25:27.587Z",
                "version": 0
            }
        ]
    }
}
GETapi/v3/Account/Contract/Paged/Detail
Retrieve all of the AccountContract 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 AccountContract objects in a paged fashion with all object details.
GET api/v3/Account/Contract/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,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "name": "My Contract",
                "accountId": 8,
                "accountName": "Sample Text Data",
                "accountContractStatusTypeId": 14,
                "accountContractStatusTypeName": "Sample Text Data",
                "start": "2021-04-26T15:25:27.587Z",
                "frequency": 12,
                "frequencyTypeId": 9,
                "frequencyTypeName": "Sample Text Data",
                "accountContractRenewalTypeId": 2,
                "accountContractRenewalTypeName": "Sample Text Data",
                "renewalAccountContractId": 11,
                "renewalAccountContractName": "Sample Text Data",
                "contractTerminationId": 12,
                "contractTerminationName": "Sample Text Data",
                "terminationAccountContractStatusTypeId": 18,
                "terminationAccountContractStatusTypeName": "Sample Text Data",
                "renewalAccountContractStatusTypeId": 10,
                "renewalAccountContractStatusTypeName": "Sample Text Data",
                "earlyTermination": "2021-04-26T15:25:27.587Z",
                "earlyTerminationComment": "Sample Text Data",
                "termTypeId": 21,
                "termTypeName": "Sample Text Data",
                "extendedStart": "2021-04-26T15:25:27.587Z",
                "version": 20,
                "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/v3/Account/Contract/{id}
Retrieve an instance of the AccountContract object by its ID.
{id}Unique identifier for the AccountContract object.
Retrieve an instance of the AccountContract object by its ID.
GET api/v3/Account/Contract/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 21,
        "ownerName": "Sample Text Data",
        "name": "My Contract",
        "accountId": 2,
        "accountName": "Sample Text Data",
        "accountContractStatusTypeId": 22,
        "accountContractStatusTypeName": "Sample Text Data",
        "start": "2021-04-26T15:25:27.587Z",
        "frequency": 16,
        "frequencyTypeId": 26,
        "frequencyTypeName": "Sample Text Data",
        "accountContractRenewalTypeId": 1,
        "accountContractRenewalTypeName": "Sample Text Data",
        "renewalAccountContractId": 9,
        "renewalAccountContractName": "Sample Text Data",
        "contractTerminationId": 6,
        "contractTerminationName": "Sample Text Data",
        "terminationAccountContractStatusTypeId": 0,
        "terminationAccountContractStatusTypeName": "Sample Text Data",
        "renewalAccountContractStatusTypeId": 22,
        "renewalAccountContractStatusTypeName": "Sample Text Data",
        "earlyTermination": "2021-04-26T15:25:27.587Z",
        "earlyTerminationComment": "Sample Text Data",
        "termTypeId": 3,
        "termTypeName": "Sample Text Data",
        "extendedStart": "2021-04-26T15:25:27.587Z",
        "version": 11
    }
}
GETapi/v3/Account/Contract/{id}/Detail
Retrieve deep detail of the AccountContract 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 AccountContract object.
Retrieve deep detail of the AccountContract object by its ID.
GET api/v3/Account/Contract/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 27,
        "ownerName": "Sample Text Data",
        "name": "My Contract",
        "accountId": 22,
        "accountName": "Sample Text Data",
        "accountContractStatusTypeId": 17,
        "accountContractStatusTypeName": "Sample Text Data",
        "start": "2021-04-26T15:25:27.587Z",
        "frequency": 4,
        "frequencyTypeId": 26,
        "frequencyTypeName": "Sample Text Data",
        "accountContractRenewalTypeId": 1,
        "accountContractRenewalTypeName": "Sample Text Data",
        "renewalAccountContractId": 24,
        "renewalAccountContractName": "Sample Text Data",
        "contractTerminationId": 8,
        "contractTerminationName": "Sample Text Data",
        "terminationAccountContractStatusTypeId": 14,
        "terminationAccountContractStatusTypeName": "Sample Text Data",
        "renewalAccountContractStatusTypeId": 10,
        "renewalAccountContractStatusTypeName": "Sample Text Data",
        "earlyTermination": "2021-04-26T15:25:27.587Z",
        "earlyTerminationComment": "Sample Text Data",
        "termTypeId": 17,
        "termTypeName": "Sample Text Data",
        "extendedStart": "2021-04-26T15:25:27.587Z",
        "version": 14,
        "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/v3/Account/Contract/{id}
Update or Add the AccountContract 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 AccountContract object.
Update or Add the AccountContract object and optionally make changes to any child objects.
PATCH api/v3/Account/Contract/{id}

{
    "details": {},
    "accountContracts": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "My Contract",
                "accountId": 14,
                "accountContractStatusTypeId": 4,
                "start": "2021-04-26T15:25:27.587Z",
                "frequency": 21,
                "frequencyTypeId": 7,
                "accountContractRenewalTypeId": 1,
                "renewalAccountContractId": 10,
                "contractTerminationId": 10,
                "terminationAccountContractStatusTypeId": 9,
                "renewalAccountContractStatusTypeId": 27,
                "earlyTermination": "2021-04-26T15:25:27.587Z",
                "earlyTerminationComment": "Sample Text Data",
                "termTypeId": 7,
                "version": 21
            }
        ]
    }
}
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": "accountContract",
                "instance": {
                    "identity": 1,
                    "ownerId": 12,
                    "ownerName": "Sample Text Data",
                    "name": "My Contract",
                    "accountId": 27,
                    "accountName": "Sample Text Data",
                    "accountContractStatusTypeId": 26,
                    "accountContractStatusTypeName": "Sample Text Data",
                    "start": "2021-04-26T15:25:27.587Z",
                    "frequency": 16,
                    "frequencyTypeId": 21,
                    "frequencyTypeName": "Sample Text Data",
                    "accountContractRenewalTypeId": 5,
                    "accountContractRenewalTypeName": "Sample Text Data",
                    "renewalAccountContractId": 17,
                    "renewalAccountContractName": "Sample Text Data",
                    "contractTerminationId": 18,
                    "contractTerminationName": "Sample Text Data",
                    "terminationAccountContractStatusTypeId": 12,
                    "terminationAccountContractStatusTypeName": "Sample Text Data",
                    "renewalAccountContractStatusTypeId": 8,
                    "renewalAccountContractStatusTypeName": "Sample Text Data",
                    "earlyTermination": "2021-04-26T15:25:27.587Z",
                    "earlyTerminationComment": "Sample Text Data",
                    "termTypeId": 16,
                    "termTypeName": "Sample Text Data",
                    "extendedStart": "2021-04-26T15:25:27.587Z",
                    "version": 21
                }
            }
        ]
    }
}
POSTapi/v3/Account/Contract/
Create a new instance of the AccountContract object.
Create a new instance of the AccountContract object.
POST api/v3/Account/Contract/

{
    "name": "My Contract",
    "accountId": 18,
    "accountContractStatusTypeId": 0,
    "start": "2021-04-26T15:25:27.587Z",
    "frequency": 11,
    "frequencyTypeId": 3,
    "accountContractRenewalTypeId": 27,
    "renewalAccountContractId": 14,
    "contractTerminationId": 26,
    "terminationAccountContractStatusTypeId": 16,
    "renewalAccountContractStatusTypeId": 21,
    "earlyTermination": "2021-04-26T15:25:27.587Z",
    "earlyTerminationComment": "Sample Text Data",
    "termTypeId": 22,
    "version": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 18,
                "ownerName": "Sample Text Data",
                "name": "My Contract",
                "accountId": 0,
                "accountName": "Sample Text Data",
                "accountContractStatusTypeId": 6,
                "accountContractStatusTypeName": "Sample Text Data",
                "start": "2021-04-26T15:25:27.587Z",
                "frequency": 10,
                "frequencyTypeId": 12,
                "frequencyTypeName": "Sample Text Data",
                "accountContractRenewalTypeId": 26,
                "accountContractRenewalTypeName": "Sample Text Data",
                "renewalAccountContractId": 14,
                "renewalAccountContractName": "Sample Text Data",
                "contractTerminationId": 9,
                "contractTerminationName": "Sample Text Data",
                "terminationAccountContractStatusTypeId": 13,
                "terminationAccountContractStatusTypeName": "Sample Text Data",
                "renewalAccountContractStatusTypeId": 24,
                "renewalAccountContractStatusTypeName": "Sample Text Data",
                "earlyTermination": "2021-04-26T15:25:27.587Z",
                "earlyTerminationComment": "Sample Text Data",
                "termTypeId": 20,
                "termTypeName": "Sample Text Data",
                "extendedStart": "2021-04-26T15:25:27.587Z",
                "version": 14
            }
        ]
    }
}
PUTapi/v3/Account/Contract/{id}
Update an existing instance of the AccountContract object.
Update an existing instance of the AccountContract object.
PUT api/v3/Account/Contract/{id}

{
    "identity": 1,
    "name": "My Contract",
    "accountId": 25,
    "accountContractStatusTypeId": 20,
    "start": "2021-04-26T15:25:27.587Z",
    "frequency": 4,
    "frequencyTypeId": 22,
    "accountContractRenewalTypeId": 6,
    "renewalAccountContractId": 23,
    "contractTerminationId": 27,
    "terminationAccountContractStatusTypeId": 25,
    "renewalAccountContractStatusTypeId": 5,
    "earlyTermination": "2021-04-26T15:25:27.587Z",
    "earlyTerminationComment": "Sample Text Data",
    "termTypeId": 9,
    "version": 25
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "name": "My Contract",
                "accountId": 0,
                "accountName": "Sample Text Data",
                "accountContractStatusTypeId": 16,
                "accountContractStatusTypeName": "Sample Text Data",
                "start": "2021-04-26T15:25:27.587Z",
                "frequency": 14,
                "frequencyTypeId": 9,
                "frequencyTypeName": "Sample Text Data",
                "accountContractRenewalTypeId": 18,
                "accountContractRenewalTypeName": "Sample Text Data",
                "renewalAccountContractId": 14,
                "renewalAccountContractName": "Sample Text Data",
                "contractTerminationId": 18,
                "contractTerminationName": "Sample Text Data",
                "terminationAccountContractStatusTypeId": 9,
                "terminationAccountContractStatusTypeName": "Sample Text Data",
                "renewalAccountContractStatusTypeId": 22,
                "renewalAccountContractStatusTypeName": "Sample Text Data",
                "earlyTermination": "2021-04-26T15:25:27.587Z",
                "earlyTerminationComment": "Sample Text Data",
                "termTypeId": 12,
                "termTypeName": "Sample Text Data",
                "extendedStart": "2021-04-26T15:25:27.587Z",
                "version": 4
            }
        ]
    }
}