TAG LINE

SMALL TITLE

Version 9 APIs

APIs based on the latest platform version 10.7

Version 8 APIs

APIs based on platform version 10.6

Version 7 APIs

APIs based on platform version 10.5

Account

(API Version v8)

The Account object represents a customer account in the system. It holds essential information about the details of the account such as when it is billed.

What can you do with Account?

DELETE Account/{id}
Delete an instance of the Account object.
DELETE Account/{id}/Contact
Delete a Contact object from the Account.
DELETE Account/{id}/Contact/{contactId}
Delete a Contact/{contactId} object from the Account.
DELETE Account/{id}/Note
Delete a Note object from the Account.
DELETE Account/{id}/Note/{noteId}
Delete a Note/{noteId} object from the Account.
GET Account/
Retrieve all of the Account objects.
GET Account/Paged
Retrieve all of the Account objects in a paged fashion.
GET Account/Paged/Detail
Retrieve all of the Account objects in a paged fashion with all object details.
GET Account/{id}
Retrieve an instance of the Account object by its ID.
GET Account/{id}/Contact
Retrieve all of the Contact objects for the specified Account.
GET Account/{id}/Contact/Paged
Retrieve all of the Contact objects for a specified Account in a paged fashion.
GET Account/{id}/Contact/{contactId}
Retrieve a specified Contact object by its ID for a specified Account.
GET Account/{id}/Contact/{contactId}/Detail
Retrieve deep detail of the Account object by its ID.
GET Account/{id}/Detail
Retrieve deep detail of the Account object by its ID.
GET Account/{id}/Note
Retrieve all of the Note objects for the specified Account.
GET Account/{id}/Note/Paged
Retrieve all of the Note objects for a specified Account in a paged fashion.
GET Account/{id}/Note/{noteId}
Retrieve a specified Note object by its ID for a specified Account.
GET Account/{id}/TaxAddress
Retrieve the Tax Address details for a specified Account ID.
GET Account/{id}/TaxAddress/AvailableFor
Retrieve the Tax Address details for a specified Account ID.
PATCH Account/{id}
Update or Add the Account object and optionally make changes to any child objects.
POST Account/
Create a new instance of the Account object.
POST Account/{id}/Contact
Create a new instance of a Contact object that belongs to the Account.
POST Account/{id}/Note
Create a new instance of a Note object that belongs to the Account.
POST Account/{id}/Patch
This method is only created as work around in order to provide PATCH capability for Salesforce that can only submit POST calls. Typically an internal API with limited use.
PUT Account/{id}
Update an existing instance of the Account object.
PUT Account/{id}/Contact
Update an existing instance of a Contact object that belongs to the Account.
PUT Account/{id}/Note
Update an existing instance of a Note object that belongs to the Account.

Properties

Property Details

identity READ-ONLY	"identity": 1 Type: Number This is the unique numeric identifier for the Account
currencyId	"currencyId": 5 Type: Number Unique identifier for the associated Currency object.
currencyName	"currencyName": "Sample Name" Type: String The name of the object associated with the currencyId property.
ownerId READ-ONLY	"ownerId": 1 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 Account" Type: String This is the name given to the account.
created READ-ONLY	"created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
accountStatusTypeId	"accountStatusTypeId": 27 Type: Number Unique identifier for the associated AccountStatusType object.
accountStatusTypeName	"accountStatusTypeName": "Sample Name" Type: String The name of the object associated with the accountStatusTypeId property.
billGroupId	"billGroupId": 9 Type: Number Unique identifier for the associated BillGroup object.
billGroupName	"billGroupName": "Sample Name" Type: String The name of the object associated with the billGroupId property.
actingOwnerId READ-ONLY	"actingOwnerId": 15 Type: Number Unique identifier for the associated Owner object.
actingOwnerName READ-ONLY	"actingOwnerName": "Sample Name" Type: String The name of the object associated with the actingOwnerId property.
updated READ-ONLY	"updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.
effectiveCancel	"effectiveCancel": "2021-04-26T15:25:27.587Z" Type: Date This is the date for when the account is to be cancelled. Date and time values are specified in the ISO 8601 format.
invoiceDeliveryId	"invoiceDeliveryId": 9 Type: Number Unique identifier for the associated InvoiceDelivery object.
invoiceDeliveryName	"invoiceDeliveryName": "Sample Name" Type: String The name of the object associated with the invoiceDeliveryId property.
accountsReceivableTermsId	"accountsReceivableTermsId": 16 Type: Number Unique identifier for the associated AccountsReceivableTerms object.
accountsReceivableTermsName	"accountsReceivableTermsName": "Sample Name" Type: String The name of the object associated with the accountsReceivableTermsId property.
accountTypeId	"accountTypeId": 17 Type: Number Unique identifier for the associated AccountType object.
accountTypeName	"accountTypeName": "Sample Name" Type: String The name of the object associated with the accountTypeId property.
billDay	"billDay": 1 Type: Number The day of the month that this account's subscriptions and one time charges are billed.
accountTaxCategoryId	"accountTaxCategoryId": 12 Type: Number Unique identifier for the associated AccountTaxCategory object.
accountTaxCategoryName	"accountTaxCategoryName": "Sample Name" Type: String The name of the object associated with the accountTaxCategoryId property.
taxCodeId	"taxCodeId": 21 Type: Number Unique identifier for the associated TaxCode object.
taxCodeName	"taxCodeName": "Sample Name" Type: String The name of the object associated with the taxCodeId property.
invoicerAccountId	"invoicerAccountId": My Invoicer Account Type: Number This is the account that will receive the invoice for subscriptions and one-time charges. Unique identifier for the associated Account object.
invoicerAccountName	"invoicerAccountName": "Sample Name" Type: String The name of the object associated with the invoicerAccountId property.
usageInvoicerAccountId	"usageInvoicerAccountId": My Usage Invoicer Account Type: Number This is the account that will receive the invoice for usage charges. Unique identifier for the associated Account object.
usageInvoicerAccountName	"usageInvoicerAccountName": "Sample Name" Type: String The name of the object associated with the usageInvoicerAccountId property.
taxSettingAccountId	"taxSettingAccountId": My Usage Invoicer Account Type: Number This is the account that is used for tax calculation purposes. Unique identifier for the associated Account object.
taxSettingAccountName	"taxSettingAccountName": "Sample Name" Type: String The name of the object associated with the taxSettingAccountId property.
usageBillDay	"usageBillDay": 1 Type: Number The day of the month that this account's metered usage is billed.
isReadOnlyBillDay	"isReadOnlyBillDay": true Type: Boolean If this account's bill day is inherited from an another invoicer account.
isReadOnlyUsageBillDay	"isReadOnlyUsageBillDay": false Type: Boolean If this account's usage bill day is inherited from an another invoicer account.
displayName	"displayName": "My Account Display Name" Type: String Optional display name associated with the account
createdByUserId	"createdByUserId": 10 Type: Number Unique identifier for the associated User object.
createdByUserName	"createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property.
pendingBillDay	"pendingBillDay": 15 Type: Number Details an upcoming change to the existing billDay i.e. the day of the month that this account's subscriptions and one time charges will be billed.
pendingUsageBillDay	"pendingUsageBillDay": 15 Type: Number Details an upcoming change to the existing usageBillDay i.e. the day of the month that this account's metered usage is billed.
lifeline	"lifeline": false Type: Boolean Indicates if an account is a Lifeline customer or not.
externalAccountIdentifier	"externalAccountIdentifier": "ExternalID-2001" Type: String An optional account ID from an alternative external system.
vATNumber	"vATNumber": "VAT499001" Type: String The Value Added Tax (VAT) number associated with the account.
eInvoiceEndpointId	"eInvoiceEndpointId": "01394200362" Type: String The eInvoice Endpoint ID required if using eInvoice system.
eInvoiceSchemeId	"eInvoiceSchemeId": "9935" Type: String The eInvoice Scheme ID required if using eInvoice system.
zeroInclusiveTaxWhenExempt	"zeroInclusiveTaxWhenExempt": false Type: Boolean Flag to zeroise any included usage taxes if account is tax exempt.
defaultPaymentGatewayId	"defaultPaymentGatewayId": 25 Type: Number Unique identifier for the associated PaymentGateway object.
defaultPaymentGatewayName	"defaultPaymentGatewayName": "Sample Name" Type: String The name of the object associated with the defaultPaymentGatewayId property.
id	"id": 24 Type: Number

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. Below you will find the child objects that can be updated as part of PATCH operations for the Account object.

Standard PATCH objects:

accountParent - create, update, delete
usageRatePlan - update, delete
accountTaxExemptLevel - attach, detach

DataFlow PATCH objects:

account - create, update, delete
accountParent - create, update, delete
usageRatePlan - update, delete
accountTaxExemptLevel - attach, detach

End Points

DELETE	Account/{id}
Delete an instance of the Account object. Upon successful delete, this API will return a record of all of the related 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 Account object.
Delete an instance of the Account object. DELETE Account/{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": "account" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

DELETE	Account/{id}/Contact
Delete a Contact object from the Account. Upon successful delete, this API will return a record of all of the related 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 Account object.
{contactId}	Unique identifier for the Contact object sent down in the body of the request in JSON format. { "details": { "items": [ { "identity": 1 } ] } }
Delete a Contact object from the Account. DELETE Account/{id}/Contact 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": "account" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

DELETE	Account/{id}/Contact/{contactId}
Delete a Contact/{contactId} object from the Account. Upon successful delete, this API will return a record of all of the related 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 Account object.
{contact/{contactid}Id}	Unique identifier for the Contact/{contactId} object sent down in the body of the request in JSON format. { "details": { "items": [ { "identity": 1 } ] } }
Delete a Contact/{contactId} object from the Account. DELETE Account/{id}/Contact/{contactId} 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": "account" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

DELETE	Account/{id}/Note
Delete a Note object from the Account. Upon successful delete, this API will return a record of all of the related 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 Account object.
{noteId}	Unique identifier for the Note object sent down in the body of the request in JSON format. { "details": { "items": [ { "identity": 1 } ] } }
Delete a Note object from the Account. DELETE Account/{id}/Note 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": "account" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

DELETE	Account/{id}/Note/{noteId}
Delete a Note/{noteId} object from the Account. Upon successful delete, this API will return a record of all of the related 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 Account object.
{note/{noteid}Id}	Unique identifier for the Note/{noteId} object sent down in the body of the request in JSON format. { "details": { "items": [ { "identity": 1 } ] } }
Delete a Note/{noteId} object from the Account. DELETE Account/{id}/Note/{noteId} 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": "account" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the Account objects.

GET Account/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "currencyId": 5,
            "currencyName": "Sample Text Data",
            "ownerId": 17,
            "ownerName": "Sample Text Data",
            "name": "My Account",
            "created": "2021-04-26T15:25:27.587Z",
            "accountStatusTypeId": 2,
            "accountStatusTypeName": "Sample Text Data",
            "billGroupId": 16,
            "billGroupName": "Sample Text Data",
            "actingOwnerId": 4,
            "actingOwnerName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z",
            "effectiveCancel": "2021-04-26T15:25:27.587Z",
            "invoiceDeliveryId": 5,
            "invoiceDeliveryName": "Sample Text Data",
            "accountsReceivableTermsId": 22,
            "accountsReceivableTermsName": "Sample Text Data",
            "accountTypeId": 0,
            "accountTypeName": "Sample Text Data",
            "billDay": 1,
            "accountTaxCategoryId": 26,
            "accountTaxCategoryName": "Sample Text Data",
            "taxCodeId": 15,
            "taxCodeName": "Sample Text Data",
            "invoicerAccountId": "My Invoicer Account",
            "invoicerAccountName": "Sample Text Data",
            "usageInvoicerAccountId": "My Usage Invoicer Account",
            "usageInvoicerAccountName": "Sample Text Data",
            "taxSettingAccountId": "My Usage Invoicer Account",
            "taxSettingAccountName": "Sample Text Data",
            "usageBillDay": 1,
            "isReadOnlyBillDay": true,
            "isReadOnlyUsageBillDay": false,
            "displayName": "My Account Display Name",
            "createdByUserId": 8,
            "createdByUserName": "Sample Text Data",
            "pendingBillDay": "15",
            "pendingUsageBillDay": "15",
            "lifeline": false,
            "externalAccountIdentifier": "ExternalID-2001",
            "vATNumber": "VAT499001",
            "eInvoiceEndpointId": "01394200362",
            "eInvoiceSchemeId": "9935",
            "zeroInclusiveTaxWhenExempt": false,
            "defaultPaymentGatewayId": 15,
            "defaultPaymentGatewayName": "Sample Text Data",
            "id": 24
        }
    ]
}

Retrieve all of the Account 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 Account objects in a paged fashion.

GET Account/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,
                "currencyId": 4,
                "currencyName": "Sample Text Data",
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "name": "My Account",
                "created": "2021-04-26T15:25:27.587Z",
                "accountStatusTypeId": 7,
                "accountStatusTypeName": "Sample Text Data",
                "billGroupId": 26,
                "billGroupName": "Sample Text Data",
                "actingOwnerId": 3,
                "actingOwnerName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "invoiceDeliveryId": 9,
                "invoiceDeliveryName": "Sample Text Data",
                "accountsReceivableTermsId": 25,
                "accountsReceivableTermsName": "Sample Text Data",
                "accountTypeId": 7,
                "accountTypeName": "Sample Text Data",
                "billDay": 1,
                "accountTaxCategoryId": 16,
                "accountTaxCategoryName": "Sample Text Data",
                "taxCodeId": 8,
                "taxCodeName": "Sample Text Data",
                "invoicerAccountId": "My Invoicer Account",
                "invoicerAccountName": "Sample Text Data",
                "usageInvoicerAccountId": "My Usage Invoicer Account",
                "usageInvoicerAccountName": "Sample Text Data",
                "taxSettingAccountId": "My Usage Invoicer Account",
                "taxSettingAccountName": "Sample Text Data",
                "usageBillDay": 1,
                "isReadOnlyBillDay": true,
                "isReadOnlyUsageBillDay": false,
                "displayName": "My Account Display Name",
                "createdByUserId": 12,
                "createdByUserName": "Sample Text Data",
                "pendingBillDay": "15",
                "pendingUsageBillDay": "15",
                "lifeline": false,
                "externalAccountIdentifier": "ExternalID-2001",
                "vATNumber": "VAT499001",
                "eInvoiceEndpointId": "01394200362",
                "eInvoiceSchemeId": "9935",
                "zeroInclusiveTaxWhenExempt": false,
                "defaultPaymentGatewayId": 14,
                "defaultPaymentGatewayName": "Sample Text Data",
                "id": 6
            }
        ]
    }
}

Retrieve all of the Account 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 Account objects in a paged fashion with all object details.

GET Account/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,
                "currencyId": 16,
                "currencyName": "Sample Text Data",
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "My Account",
                "created": "2021-04-26T15:25:27.587Z",
                "accountStatusTypeId": 8,
                "accountStatusTypeName": "Sample Text Data",
                "billGroupId": 21,
                "billGroupName": "Sample Text Data",
                "actingOwnerId": 12,
                "actingOwnerName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "invoiceDeliveryId": 22,
                "invoiceDeliveryName": "Sample Text Data",
                "accountsReceivableTermsId": 22,
                "accountsReceivableTermsName": "Sample Text Data",
                "accountTypeId": 20,
                "accountTypeName": "Sample Text Data",
                "billDay": 1,
                "accountTaxCategoryId": 24,
                "accountTaxCategoryName": "Sample Text Data",
                "taxCodeId": 6,
                "taxCodeName": "Sample Text Data",
                "invoicerAccountId": "My Invoicer Account",
                "invoicerAccountName": "Sample Text Data",
                "usageInvoicerAccountId": "My Usage Invoicer Account",
                "usageInvoicerAccountName": "Sample Text Data",
                "taxSettingAccountId": "My Usage Invoicer Account",
                "taxSettingAccountName": "Sample Text Data",
                "usageBillDay": 1,
                "isReadOnlyBillDay": true,
                "isReadOnlyUsageBillDay": false,
                "displayName": "My Account Display Name",
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data",
                "pendingBillDay": "15",
                "pendingUsageBillDay": "15",
                "lifeline": false,
                "externalAccountIdentifier": "ExternalID-2001",
                "vATNumber": "VAT499001",
                "eInvoiceEndpointId": "01394200362",
                "eInvoiceSchemeId": "9935",
                "zeroInclusiveTaxWhenExempt": false,
                "defaultPaymentGatewayId": 20,
                "defaultPaymentGatewayName": "Sample Text Data",
                "id": 9,
                "details": {
                    "parent": {
                        "identity": 73,
                        "accountId": 83,
                        "accountName": "Sample Text Data",
                        "parentAccountId": 11,
                        "parentAccountName": "Sample Text Data",
                        "topAccountId": 30,
                        "topAccountName": "Sample Text Data",
                        "updated": "2021-04-26T15:25:27.587Z"
                    },
                    "contacts": [
                        {
                            "identity": 12,
                            "contactTypeId": 41,
                            "contactTypeName": "Sample Text Data",
                            "title": "Sample Text Data",
                            "firstName": "Sample Text Data",
                            "lastName": "Sample Text Data",
                            "isUsedForTax": true,
                            "updated": "2021-04-26T15:25:27.587Z",
                            "name": "Sample Text Data",
                            "details": {
                                "contactPoints": [
                                    {
                                        "identity": 31,
                                        "contactPointTypeId": 47,
                                        "contactPointTypeName": "Sample Text Data",
                                        "value": "Sample Text Data",
                                        "contactId": 59,
                                        "updated": "2021-04-26T15:25:27.587Z"
                                    }
                                ],
                                "address": {
                                    "identity": 81,
                                    "address1": "Sample Text Data",
                                    "address2": "Sample Text Data",
                                    "stateId": 53,
                                    "stateName": "Sample Text Data",
                                    "countryId": 20,
                                    "countryName": "Sample Text Data",
                                    "zipCode": "Sample Text Data",
                                    "latitude": 3.22,
                                    "longitude": 78.73,
                                    "cityName": "Sample Text Data",
                                    "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z",
                                    "isIncorporated": true,
                                    "updated": "2021-04-26T15:25:27.587Z",
                                    "stateCode": "Sample Text Data",
                                    "countryCode": "Sample Text Data"
                                }
                            }
                        }
                    ],
                    "currentRatePlan": {
                        "identity": 43,
                        "name": "Sample Text Data",
                        "displayName": "Sample Text Data",
                        "start": "2021-04-26T15:25:27.587Z"
                    },
                    "currentPricePlan": {
                        "identity": 90,
                        "name": "Sample Text Data",
                        "accountId": 16,
                        "accountName": "Sample Text Data",
                        "description": "Sample Text Data",
                        "start": "2021-04-26T15:25:27.587Z",
                        "end": "2021-04-26T15:25:27.587Z",
                        "lastUsedForBilling": "2021-04-26T15:25:27.587Z",
                        "includeChildAccounts": true
                    },
                    "accountSummary": {
                        "identity": 1,
                        "accountId": 48,
                        "accountName": "Sample Text Data",
                        "balance": 24.59,
                        "balanceDue": 45.76
                    },
                    "priceBookRegions": [
                        {
                            "identity": 6,
                            "name": "Sample Text Data",
                            "description": "Sample Text Data",
                            "isActive": true,
                            "created": "2021-04-26T15:25:27.587Z"
                        }
                    ],
                    "accountTaxExemptions": [
                        {
                            "identity": 83,
                            "accountId": 39,
                            "accountName": "Sample Text Data",
                            "description": "Sample Text Data",
                            "isFederalTaxLevel": true,
                            "isStateTaxLevel": true,
                            "isCountyTaxLevel": true,
                            "isLocalTaxLevel": true,
                            "taxTypeId": 16,
                            "taxTypeName": "Sample Text Data",
                            "updated": "2021-04-26T15:25:27.587Z",
                            "stateId": 0,
                            "stateName": "Sample Text Data",
                            "stateCode": "Sample Text Data",
                            "countryId": 94,
                            "countryName": "Sample Text Data",
                            "countryCode": "Sample Text Data",
                            "zipCode": "Sample Text Data",
                            "city": "Sample Text Data"
                        }
                    ],
                    "taxAddresses": [
                        {
                            "identity": 39,
                            "name": "Sample Text Data",
                            "isShared": true,
                            "accountId": 95,
                            "accountName": "Sample Text Data",
                            "addressId": 54,
                            "created": "2021-04-26T15:25:27.587Z",
                            "updated": "2021-04-26T15:25:27.587Z",
                            "saveTaxAddressOnInvoicer": true,
                            "address1": "Sample Text Data",
                            "address2": "Sample Text Data",
                            "stateId": 30,
                            "stateName": "Sample Text Data",
                            "stateCode": "Sample Text Data",
                            "countryId": 85,
                            "countryName": "Sample Text Data",
                            "countryCode": "Sample Text Data",
                            "zipCode": "Sample Text Data",
                            "cityName": "Sample Text Data",
                            "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z",
                            "isIncorporated": true
                        }
                    ]
                }
            }
        ]
    }
}

GET	Account/{id}
Retrieve an instance of the Account object by its ID.
{id}	Unique identifier for the Account object.
Retrieve an instance of the Account object by its ID. GET Account/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "currencyId": 10, "currencyName": "Sample Text Data", "ownerId": 5, "ownerName": "Sample Text Data", "name": "My Account", "created": "2021-04-26T15:25:27.587Z", "accountStatusTypeId": 8, "accountStatusTypeName": "Sample Text Data", "billGroupId": 17, "billGroupName": "Sample Text Data", "actingOwnerId": 9, "actingOwnerName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 18, "invoiceDeliveryName": "Sample Text Data", "accountsReceivableTermsId": 17, "accountsReceivableTermsName": "Sample Text Data", "accountTypeId": 11, "accountTypeName": "Sample Text Data", "billDay": 1, "accountTaxCategoryId": 0, "accountTaxCategoryName": "Sample Text Data", "taxCodeId": 26, "taxCodeName": "Sample Text Data", "invoicerAccountId": "My Invoicer Account", "invoicerAccountName": "Sample Text Data", "usageInvoicerAccountId": "My Usage Invoicer Account", "usageInvoicerAccountName": "Sample Text Data", "taxSettingAccountId": "My Usage Invoicer Account", "taxSettingAccountName": "Sample Text Data", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 11, "createdByUserName": "Sample Text Data", "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 14, "defaultPaymentGatewayName": "Sample Text Data", "id": 2 } }

GET	Account/{id}/Contact
Retrieve all of the Contact objects for the specified Account.
{id}	Unique identifier for the Account object.
Retrieve all of the Contact objects for the specified Account. GET Account/{id}/Contact View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "details": { "totalCount": 1, "items": [ { "identity": 1, "contactTypeId": 8, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } ] } } }

GET	Account/{id}/Contact/Paged
Retrieve all of the Contact objects for a specified Account 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.
{id}	Unique identifier for the Account object.
Retrieve all of the Contact objects for a specified Account in a paged fashion. GET Account/{id}/Contact/Paged View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "details": { "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "contactTypeId": 16, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } ] } } } }

GET	Account/{id}/Contact/{contactId}
Retrieve a specified Contact object by its ID for a specified Account.
{id}	Unique identifier for the Account object.
{contactId}	Unique identifier for the Contact object.
Retrieve a specified Contact object by its ID for a specified Account. GET Account/{id}/Contact/{contactId} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "details": { "totalCount": 1, "items": [ { "identity": 1, "contactTypeId": 6, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } ] } } }

GET	Account/{id}/Contact/{contactId}/Detail
Retrieve deep detail of the Account 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 Account object.
Retrieve deep detail of the Account object by its ID. GET Account/{id}/Contact/{contactId}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "currencyId": 8, "currencyName": "Sample Text Data", "ownerId": 16, "ownerName": "Sample Text Data", "name": "My Account", "created": "2021-04-26T15:25:27.587Z", "accountStatusTypeId": 10, "accountStatusTypeName": "Sample Text Data", "billGroupId": 22, "billGroupName": "Sample Text Data", "actingOwnerId": 26, "actingOwnerName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 11, "invoiceDeliveryName": "Sample Text Data", "accountsReceivableTermsId": 5, "accountsReceivableTermsName": "Sample Text Data", "accountTypeId": 19, "accountTypeName": "Sample Text Data", "billDay": 1, "accountTaxCategoryId": 5, "accountTaxCategoryName": "Sample Text Data", "taxCodeId": 19, "taxCodeName": "Sample Text Data", "invoicerAccountId": "My Invoicer Account", "invoicerAccountName": "Sample Text Data", "usageInvoicerAccountId": "My Usage Invoicer Account", "usageInvoicerAccountName": "Sample Text Data", "taxSettingAccountId": "My Usage Invoicer Account", "taxSettingAccountName": "Sample Text Data", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 17, "createdByUserName": "Sample Text Data", "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 4, "defaultPaymentGatewayName": "Sample Text Data", "id": 18, "details": { "parent": { "identity": 73, "accountId": 83, "accountName": "Sample Text Data", "parentAccountId": 11, "parentAccountName": "Sample Text Data", "topAccountId": 30, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" }, "contacts": [ { "identity": 12, "contactTypeId": 41, "contactTypeName": "Sample Text Data", "title": "Sample Text Data", "firstName": "Sample Text Data", "lastName": "Sample Text Data", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z", "name": "Sample Text Data", "details": { "contactPoints": [ { "identity": 31, "contactPointTypeId": 47, "contactPointTypeName": "Sample Text Data", "value": "Sample Text Data", "contactId": 59, "updated": "2021-04-26T15:25:27.587Z" } ], "address": { "identity": 81, "address1": "Sample Text Data", "address2": "Sample Text Data", "stateId": 53, "stateName": "Sample Text Data", "countryId": 20, "countryName": "Sample Text Data", "zipCode": "Sample Text Data", "latitude": 3.22, "longitude": 78.73, "cityName": "Sample Text Data", "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z", "isIncorporated": true, "updated": "2021-04-26T15:25:27.587Z", "stateCode": "Sample Text Data", "countryCode": "Sample Text Data" } } } ], "currentRatePlan": { "identity": 43, "name": "Sample Text Data", "displayName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z" }, "currentPricePlan": { "identity": 90, "name": "Sample Text Data", "accountId": 16, "accountName": "Sample Text Data", "description": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z", "end": "2021-04-26T15:25:27.587Z", "lastUsedForBilling": "2021-04-26T15:25:27.587Z", "includeChildAccounts": true }, "accountSummary": { "identity": 1, "accountId": 48, "accountName": "Sample Text Data", "balance": 24.59, "balanceDue": 45.76 }, "priceBookRegions": [ { "identity": 6, "name": "Sample Text Data", "description": "Sample Text Data", "isActive": true, "created": "2021-04-26T15:25:27.587Z" } ], "accountTaxExemptions": [ { "identity": 83, "accountId": 39, "accountName": "Sample Text Data", "description": "Sample Text Data", "isFederalTaxLevel": true, "isStateTaxLevel": true, "isCountyTaxLevel": true, "isLocalTaxLevel": true, "taxTypeId": 16, "taxTypeName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "stateId": 0, "stateName": "Sample Text Data", "stateCode": "Sample Text Data", "countryId": 94, "countryName": "Sample Text Data", "countryCode": "Sample Text Data", "zipCode": "Sample Text Data", "city": "Sample Text Data" } ], "taxAddresses": [ { "identity": 39, "name": "Sample Text Data", "isShared": true, "accountId": 95, "accountName": "Sample Text Data", "addressId": 54, "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "saveTaxAddressOnInvoicer": true, "address1": "Sample Text Data", "address2": "Sample Text Data", "stateId": 30, "stateName": "Sample Text Data", "stateCode": "Sample Text Data", "countryId": 85, "countryName": "Sample Text Data", "countryCode": "Sample Text Data", "zipCode": "Sample Text Data", "cityName": "Sample Text Data", "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z", "isIncorporated": true } ] } } }

GET	Account/{id}/Detail
Retrieve deep detail of the Account 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 Account object.
Retrieve deep detail of the Account object by its ID. GET Account/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "currencyId": 2, "currencyName": "Sample Text Data", "ownerId": 17, "ownerName": "Sample Text Data", "name": "My Account", "created": "2021-04-26T15:25:27.587Z", "accountStatusTypeId": 21, "accountStatusTypeName": "Sample Text Data", "billGroupId": 19, "billGroupName": "Sample Text Data", "actingOwnerId": 16, "actingOwnerName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 20, "invoiceDeliveryName": "Sample Text Data", "accountsReceivableTermsId": 22, "accountsReceivableTermsName": "Sample Text Data", "accountTypeId": 22, "accountTypeName": "Sample Text Data", "billDay": 1, "accountTaxCategoryId": 27, "accountTaxCategoryName": "Sample Text Data", "taxCodeId": 23, "taxCodeName": "Sample Text Data", "invoicerAccountId": "My Invoicer Account", "invoicerAccountName": "Sample Text Data", "usageInvoicerAccountId": "My Usage Invoicer Account", "usageInvoicerAccountName": "Sample Text Data", "taxSettingAccountId": "My Usage Invoicer Account", "taxSettingAccountName": "Sample Text Data", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 5, "createdByUserName": "Sample Text Data", "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 0, "defaultPaymentGatewayName": "Sample Text Data", "id": 24, "details": { "parent": { "identity": 73, "accountId": 83, "accountName": "Sample Text Data", "parentAccountId": 11, "parentAccountName": "Sample Text Data", "topAccountId": 30, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" }, "contacts": [ { "identity": 12, "contactTypeId": 41, "contactTypeName": "Sample Text Data", "title": "Sample Text Data", "firstName": "Sample Text Data", "lastName": "Sample Text Data", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z", "name": "Sample Text Data", "details": { "contactPoints": [ { "identity": 31, "contactPointTypeId": 47, "contactPointTypeName": "Sample Text Data", "value": "Sample Text Data", "contactId": 59, "updated": "2021-04-26T15:25:27.587Z" } ], "address": { "identity": 81, "address1": "Sample Text Data", "address2": "Sample Text Data", "stateId": 53, "stateName": "Sample Text Data", "countryId": 20, "countryName": "Sample Text Data", "zipCode": "Sample Text Data", "latitude": 3.22, "longitude": 78.73, "cityName": "Sample Text Data", "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z", "isIncorporated": true, "updated": "2021-04-26T15:25:27.587Z", "stateCode": "Sample Text Data", "countryCode": "Sample Text Data" } } } ], "currentRatePlan": { "identity": 43, "name": "Sample Text Data", "displayName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z" }, "currentPricePlan": { "identity": 90, "name": "Sample Text Data", "accountId": 16, "accountName": "Sample Text Data", "description": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z", "end": "2021-04-26T15:25:27.587Z", "lastUsedForBilling": "2021-04-26T15:25:27.587Z", "includeChildAccounts": true }, "accountSummary": { "identity": 1, "accountId": 48, "accountName": "Sample Text Data", "balance": 24.59, "balanceDue": 45.76 }, "priceBookRegions": [ { "identity": 6, "name": "Sample Text Data", "description": "Sample Text Data", "isActive": true, "created": "2021-04-26T15:25:27.587Z" } ], "accountTaxExemptions": [ { "identity": 83, "accountId": 39, "accountName": "Sample Text Data", "description": "Sample Text Data", "isFederalTaxLevel": true, "isStateTaxLevel": true, "isCountyTaxLevel": true, "isLocalTaxLevel": true, "taxTypeId": 16, "taxTypeName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "stateId": 0, "stateName": "Sample Text Data", "stateCode": "Sample Text Data", "countryId": 94, "countryName": "Sample Text Data", "countryCode": "Sample Text Data", "zipCode": "Sample Text Data", "city": "Sample Text Data" } ], "taxAddresses": [ { "identity": 39, "name": "Sample Text Data", "isShared": true, "accountId": 95, "accountName": "Sample Text Data", "addressId": 54, "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "saveTaxAddressOnInvoicer": true, "address1": "Sample Text Data", "address2": "Sample Text Data", "stateId": 30, "stateName": "Sample Text Data", "stateCode": "Sample Text Data", "countryId": 85, "countryName": "Sample Text Data", "countryCode": "Sample Text Data", "zipCode": "Sample Text Data", "cityName": "Sample Text Data", "taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z", "isIncorporated": true } ] } } }

GET	Account/{id}/Note
Retrieve all of the Note objects for the specified Account.
{id}	Unique identifier for the Account object.
Retrieve all of the Note objects for the specified Account. GET Account/{id}/Note View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "details": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 18, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 9, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 23, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } } }

GET	Account/{id}/Note/Paged
Retrieve all of the Note objects for a specified Account 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.
{id}	Unique identifier for the Account object.
Retrieve all of the Note objects for a specified Account in a paged fashion. GET Account/{id}/Note/Paged View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "details": { "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 1, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 0, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 0, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } } } }

GET	Account/{id}/Note/{noteId}
Retrieve a specified Note object by its ID for a specified Account.
{id}	Unique identifier for the Account object.
{noteId}	Unique identifier for the Note object.
Retrieve a specified Note object by its ID for a specified Account. GET Account/{id}/Note/{noteId} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "details": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 3, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 4, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 14, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } } }

GET	Account/{id}/TaxAddress
Retrieve the Tax Address details for a specified Account ID.
{id}	Unique identifier for the Account object.
Retrieve the Tax Address details for a specified Account ID. GET Account/{id}/TaxAddress View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "currencyId": 15, "currencyName": "Sample Text Data", "ownerId": 21, "ownerName": "Sample Text Data", "name": "My Account", "created": "2021-04-26T15:25:27.587Z", "accountStatusTypeId": 1, "accountStatusTypeName": "Sample Text Data", "billGroupId": 16, "billGroupName": "Sample Text Data", "actingOwnerId": 5, "actingOwnerName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 12, "invoiceDeliveryName": "Sample Text Data", "accountsReceivableTermsId": 12, "accountsReceivableTermsName": "Sample Text Data", "accountTypeId": 23, "accountTypeName": "Sample Text Data", "billDay": 1, "accountTaxCategoryId": 9, "accountTaxCategoryName": "Sample Text Data", "taxCodeId": 6, "taxCodeName": "Sample Text Data", "invoicerAccountId": "My Invoicer Account", "invoicerAccountName": "Sample Text Data", "usageInvoicerAccountId": "My Usage Invoicer Account", "usageInvoicerAccountName": "Sample Text Data", "taxSettingAccountId": "My Usage Invoicer Account", "taxSettingAccountName": "Sample Text Data", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 27, "createdByUserName": "Sample Text Data", "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 19, "defaultPaymentGatewayName": "Sample Text Data", "id": 27 } }

GET	Account/{id}/TaxAddress/AvailableFor
Retrieve the Tax Address details for a specified Account ID.
{id}	Unique identifier for the Account object.
Retrieve the Tax Address details for a specified Account ID. GET Account/{id}/TaxAddress/AvailableFor View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "currencyId": 13, "currencyName": "Sample Text Data", "ownerId": 8, "ownerName": "Sample Text Data", "name": "My Account", "created": "2021-04-26T15:25:27.587Z", "accountStatusTypeId": 0, "accountStatusTypeName": "Sample Text Data", "billGroupId": 15, "billGroupName": "Sample Text Data", "actingOwnerId": 26, "actingOwnerName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 16, "invoiceDeliveryName": "Sample Text Data", "accountsReceivableTermsId": 4, "accountsReceivableTermsName": "Sample Text Data", "accountTypeId": 19, "accountTypeName": "Sample Text Data", "billDay": 1, "accountTaxCategoryId": 9, "accountTaxCategoryName": "Sample Text Data", "taxCodeId": 20, "taxCodeName": "Sample Text Data", "invoicerAccountId": "My Invoicer Account", "invoicerAccountName": "Sample Text Data", "usageInvoicerAccountId": "My Usage Invoicer Account", "usageInvoicerAccountName": "Sample Text Data", "taxSettingAccountId": "My Usage Invoicer Account", "taxSettingAccountName": "Sample Text Data", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 23, "createdByUserName": "Sample Text Data", "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 0, "defaultPaymentGatewayName": "Sample Text Data", "id": 4 } }

PATCH	Account/{id}
Update or Add the Account 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 Account object.
Update or Add the Account object and optionally make changes to any child objects. PATCH Account/{id} { "details": {}, "accounts": { "items": [ { "patchType": "create", "patchClientId": 1, "currencyId": 8, "name": "My Account", "accountStatusTypeId": 15, "billGroupId": 9, "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 22, "accountsReceivableTermsId": 20, "accountTypeId": 26, "billDay": 1, "accountTaxCategoryId": 3, "taxCodeId": 27, "invoicerAccountId": "My Invoicer Account", "usageInvoicerAccountId": "My Usage Invoicer Account", "taxSettingAccountId": "My Usage Invoicer Account", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 6, "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 11, "id": 10 } ] } } 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": "account", "instance": { "identity": 1, "currencyId": 21, "currencyName": "Sample Text Data", "ownerId": 4, "ownerName": "Sample Text Data", "name": "My Account", "created": "2021-04-26T15:25:27.587Z", "accountStatusTypeId": 17, "accountStatusTypeName": "Sample Text Data", "billGroupId": 5, "billGroupName": "Sample Text Data", "actingOwnerId": 25, "actingOwnerName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "effectiveCancel": "2021-04-26T15:25:27.587Z", "invoiceDeliveryId": 24, "invoiceDeliveryName": "Sample Text Data", "accountsReceivableTermsId": 26, "accountsReceivableTermsName": "Sample Text Data", "accountTypeId": 13, "accountTypeName": "Sample Text Data", "billDay": 1, "accountTaxCategoryId": 4, "accountTaxCategoryName": "Sample Text Data", "taxCodeId": 7, "taxCodeName": "Sample Text Data", "invoicerAccountId": "My Invoicer Account", "invoicerAccountName": "Sample Text Data", "usageInvoicerAccountId": "My Usage Invoicer Account", "usageInvoicerAccountName": "Sample Text Data", "taxSettingAccountId": "My Usage Invoicer Account", "taxSettingAccountName": "Sample Text Data", "usageBillDay": 1, "isReadOnlyBillDay": true, "isReadOnlyUsageBillDay": false, "displayName": "My Account Display Name", "createdByUserId": 21, "createdByUserName": "Sample Text Data", "pendingBillDay": "15", "pendingUsageBillDay": "15", "lifeline": false, "externalAccountIdentifier": "ExternalID-2001", "vATNumber": "VAT499001", "eInvoiceEndpointId": "01394200362", "eInvoiceSchemeId": "9935", "zeroInclusiveTaxWhenExempt": false, "defaultPaymentGatewayId": 4, "defaultPaymentGatewayName": "Sample Text Data", "id": 19 } } ] } }

Create a new instance of the Account object.

POST Account/

{
    "currencyId": 24,
    "name": "My Account",
    "accountStatusTypeId": 20,
    "billGroupId": 25,
    "updated": "2021-04-26T15:25:27.587Z",
    "effectiveCancel": "2021-04-26T15:25:27.587Z",
    "invoiceDeliveryId": 4,
    "accountsReceivableTermsId": 0,
    "accountTypeId": 27,
    "billDay": 1,
    "accountTaxCategoryId": 17,
    "taxCodeId": 11,
    "invoicerAccountId": "My Invoicer Account",
    "usageInvoicerAccountId": "My Usage Invoicer Account",
    "taxSettingAccountId": "My Usage Invoicer Account",
    "usageBillDay": 1,
    "isReadOnlyBillDay": true,
    "isReadOnlyUsageBillDay": false,
    "displayName": "My Account Display Name",
    "createdByUserId": 25,
    "pendingBillDay": "15",
    "pendingUsageBillDay": "15",
    "lifeline": false,
    "externalAccountIdentifier": "ExternalID-2001",
    "vATNumber": "VAT499001",
    "eInvoiceEndpointId": "01394200362",
    "eInvoiceSchemeId": "9935",
    "zeroInclusiveTaxWhenExempt": false,
    "defaultPaymentGatewayId": 25,
    "id": 17
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "currencyId": 20,
                "currencyName": "Sample Text Data",
                "ownerId": 1,
                "ownerName": "Sample Text Data",
                "name": "My Account",
                "created": "2021-04-26T15:25:27.587Z",
                "accountStatusTypeId": 20,
                "accountStatusTypeName": "Sample Text Data",
                "billGroupId": 14,
                "billGroupName": "Sample Text Data",
                "actingOwnerId": 20,
                "actingOwnerName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "invoiceDeliveryId": 22,
                "invoiceDeliveryName": "Sample Text Data",
                "accountsReceivableTermsId": 23,
                "accountsReceivableTermsName": "Sample Text Data",
                "accountTypeId": 12,
                "accountTypeName": "Sample Text Data",
                "billDay": 1,
                "accountTaxCategoryId": 19,
                "accountTaxCategoryName": "Sample Text Data",
                "taxCodeId": 5,
                "taxCodeName": "Sample Text Data",
                "invoicerAccountId": "My Invoicer Account",
                "invoicerAccountName": "Sample Text Data",
                "usageInvoicerAccountId": "My Usage Invoicer Account",
                "usageInvoicerAccountName": "Sample Text Data",
                "taxSettingAccountId": "My Usage Invoicer Account",
                "taxSettingAccountName": "Sample Text Data",
                "usageBillDay": 1,
                "isReadOnlyBillDay": true,
                "isReadOnlyUsageBillDay": false,
                "displayName": "My Account Display Name",
                "createdByUserId": 5,
                "createdByUserName": "Sample Text Data",
                "pendingBillDay": "15",
                "pendingUsageBillDay": "15",
                "lifeline": false,
                "externalAccountIdentifier": "ExternalID-2001",
                "vATNumber": "VAT499001",
                "eInvoiceEndpointId": "01394200362",
                "eInvoiceSchemeId": "9935",
                "zeroInclusiveTaxWhenExempt": false,
                "defaultPaymentGatewayId": 27,
                "defaultPaymentGatewayName": "Sample Text Data",
                "id": 7
            }
        ]
    }
}

POST	Account/{id}/Contact
Create a new instance of a Contact object that belongs to the Account.
{id}	Unique identifier for the Account object.
Create a new instance of a Contact object that belongs to the Account. POST Account/{id}/Contact { "contactTypeId": 8, "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "contactTypeId": 5, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } ] } }

POST	Account/{id}/Note
Create a new instance of a Note object that belongs to the Account.
{id}	Unique identifier for the Account object.
Create a new instance of a Note object that belongs to the Account. POST Account/{id}/Note { "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 12, "createdByUserId": 7, "updatedByUserId": 23, "showOnOverview": true, "isImportant": true } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 18, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 14, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 10, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } }

POST	Account/{id}/Patch
This method is only created as work around in order to provide PATCH capability for Salesforce that can only submit POST calls. Typically an internal API with limited use.
{id}	Unique identifier for the Account object.

Update an existing instance of the Account object.

PUT Account/{id}

{
    "identity": 1,
    "currencyId": 16,
    "name": "My Account",
    "accountStatusTypeId": 6,
    "billGroupId": 21,
    "updated": "2021-04-26T15:25:27.587Z",
    "effectiveCancel": "2021-04-26T15:25:27.587Z",
    "invoiceDeliveryId": 24,
    "accountsReceivableTermsId": 2,
    "accountTypeId": 15,
    "billDay": 1,
    "accountTaxCategoryId": 17,
    "taxCodeId": 21,
    "invoicerAccountId": "My Invoicer Account",
    "usageInvoicerAccountId": "My Usage Invoicer Account",
    "taxSettingAccountId": "My Usage Invoicer Account",
    "usageBillDay": 1,
    "isReadOnlyBillDay": true,
    "isReadOnlyUsageBillDay": false,
    "displayName": "My Account Display Name",
    "createdByUserId": 17,
    "pendingBillDay": "15",
    "pendingUsageBillDay": "15",
    "lifeline": false,
    "externalAccountIdentifier": "ExternalID-2001",
    "vATNumber": "VAT499001",
    "eInvoiceEndpointId": "01394200362",
    "eInvoiceSchemeId": "9935",
    "zeroInclusiveTaxWhenExempt": false,
    "defaultPaymentGatewayId": 10,
    "id": 12
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "currencyId": 26,
                "currencyName": "Sample Text Data",
                "ownerId": 18,
                "ownerName": "Sample Text Data",
                "name": "My Account",
                "created": "2021-04-26T15:25:27.587Z",
                "accountStatusTypeId": 20,
                "accountStatusTypeName": "Sample Text Data",
                "billGroupId": 3,
                "billGroupName": "Sample Text Data",
                "actingOwnerId": 12,
                "actingOwnerName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "invoiceDeliveryId": 16,
                "invoiceDeliveryName": "Sample Text Data",
                "accountsReceivableTermsId": 4,
                "accountsReceivableTermsName": "Sample Text Data",
                "accountTypeId": 12,
                "accountTypeName": "Sample Text Data",
                "billDay": 1,
                "accountTaxCategoryId": 20,
                "accountTaxCategoryName": "Sample Text Data",
                "taxCodeId": 25,
                "taxCodeName": "Sample Text Data",
                "invoicerAccountId": "My Invoicer Account",
                "invoicerAccountName": "Sample Text Data",
                "usageInvoicerAccountId": "My Usage Invoicer Account",
                "usageInvoicerAccountName": "Sample Text Data",
                "taxSettingAccountId": "My Usage Invoicer Account",
                "taxSettingAccountName": "Sample Text Data",
                "usageBillDay": 1,
                "isReadOnlyBillDay": true,
                "isReadOnlyUsageBillDay": false,
                "displayName": "My Account Display Name",
                "createdByUserId": 1,
                "createdByUserName": "Sample Text Data",
                "pendingBillDay": "15",
                "pendingUsageBillDay": "15",
                "lifeline": false,
                "externalAccountIdentifier": "ExternalID-2001",
                "vATNumber": "VAT499001",
                "eInvoiceEndpointId": "01394200362",
                "eInvoiceSchemeId": "9935",
                "zeroInclusiveTaxWhenExempt": false,
                "defaultPaymentGatewayId": 24,
                "defaultPaymentGatewayName": "Sample Text Data",
                "id": 4
            }
        ]
    }
}

PUT	Account/{id}/Contact
Update an existing instance of a Contact object that belongs to the Account.
{id}	Unique identifier for the Account object.
Update an existing instance of a Contact object that belongs to the Account. PUT Account/{id}/Contact { "identity": 1, "contactTypeId": 0, "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "contactTypeId": 10, "contactTypeName": "Sample Text Data", "title": "Mr.", "firstName": "John", "lastName": "Doe", "isUsedForTax": true, "updated": "2021-04-26T15:25:27.587Z" } ] } }

PUT	Account/{id}/Note
Update an existing instance of a Note object that belongs to the Account.
{id}	Unique identifier for the Account object.
Update an existing instance of a Note object that belongs to the Account. PUT Account/{id}/Note { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 8, "createdByUserId": 13, "updatedByUserId": 26, "showOnOverview": true, "isImportant": true } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "subject": "Delivery Instuctions", "text": "Drop off at rear door.", "noteTypeId": 24, "noteTypeName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 0, "createdByUserName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z", "updatedByUserId": 22, "updatedByUserName": "Sample Text Data", "showOnOverview": true, "isImportant": true } ] } }