Account / Contract

What can you do with AccountContract?


Properties

Property Details
id
"id": 890
Type: Number
This is the unique numeric identifier for the AccountContract
ownerId
"ownerId": 422
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
accountId
"accountId": 541
Type: Number
Unique identifier for the associated Account object.
accountContractStatusTypeId
"accountContractStatusTypeId": 400
Type: Number
Unique identifier for the associated AccountContractStatusType object.
start
"start": "2005-04-11T14:56:24"
Type: Date
frequency
"frequency": 576
Type: Number
frequencyTypeId
"frequencyTypeId": 827
Type: Number
Unique identifier for the associated FrequencyType object.
accountContractRenewalTypeId
"accountContractRenewalTypeId": 227
Type: Number
Unique identifier for the associated AccountContractRenewalType object.
renewalAccountContractId
"renewalAccountContractId": 844
Type: Number
Unique identifier for the associated AccountContract object.
contractTerminationId
"contractTerminationId": 229
Type: Number
Unique identifier for the associated ContractTermination object.
terminationAccountContractStatusTypeId
"terminationAccountContractStatusTypeId": 614
Type: Number
Unique identifier for the associated AccountContractStatusType object.
renewalAccountContractStatusTypeId
"renewalAccountContractStatusTypeId": 509
Type: Number
Unique identifier for the associated AccountContractStatusType object.
earlyTermination
"earlyTermination": "2005-04-11T14:56:24"
Type: Date
earlyTerminationComment
"earlyTerminationComment": "Hello World"
Type: String
termTypeId
"termTypeId": 766
Type: Number
Unique identifier for the associated TermType object.
extendedStart
"extendedStart": "2005-04-11T14:56:24"
Type: Date


Update Request Filters

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
  • extendedStart

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/v1/Account/Contract/{id:int}
Delete an instance of the AccountContract object.
GETapi/v1/Account/Contract
Retrieve all of the AccountContract objects.
GETapi/v1/Account/Contract/Metadata
Retrieve all of the meta data details of the AccountContract object.
GETapi/v1/Account/Contract/Metadata/{option}
Retrieve all the meta data details of the AccountContract object based on provided options.
{option}Metadata options for the AccountContract object.
GETapi/v1/Account/Contract/Paged
Retreive all of the AccountContract objects in a paged fashion.
GETapi/v1/Account/Contract/Paged/Detail
Retreive all of the AccountContract objects in a paged fashion with all object details.
GETapi/v1/Account/Contract/{id:int}
Retrieve an instance of the AccountContract object by it's ID.
{id:int}Unique identifier for the AccountContract object.
GETapi/v1/Account/Contract/{id:int}/Detail
Retreive all of the Detail objects for the specified AccountContract.
{id:int}Unique identifier for the AccountContract object.
PATCHapi/v1/Account/Contract/{id:int}
Update the AccountContract object and optionally make changes to any child objects.
POSTapi/v1/Account/Contract
Create a new instance of the AccountContract object.
PUTapi/v1/Account/Contract/{id:int}
Update an existing instance of the AccountContract object.