TAG LINE
SMALL TITLE
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.
identity READ-ONLY | "identity": 2 Type: Number This is the unique numeric identifier for the Account |
currencyId | "currencyId": 14 Type: Number Unique identifier for the associated Currency object. |
currencyCode | "currencyCode": "USD" Type: String Abbreviated currency code associated to the currencyId. |
currencyName | "currencyName": "Sample Name" Type: String The name of the object associated with the currencyId property. |
ownerId READ-ONLY | "ownerId": 19 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": 2 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": 8 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": 3 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. |
lastUpdate | "lastUpdate": "2021-04-26T15:25:27.587Z" Type: Date 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": 4 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": 6 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": 4 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": 23 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": 22 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": "Hello World" Type: String |
createdByUserId | "createdByUserId": 5 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. |
id | "id": 20 Type: Number |
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:
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 Account object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v2/Account/{id} |
| Delete an instance of the Account 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 Account object. |
Delete an instance of the Account object. DELETE api/v2/Account/{id}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 | api/v2/Account/{id}/Contact |
| Delete a Contact object from the Account. 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 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 api/v2/Account/{id}/ContactHTTP/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 | api/v2/Account/{id}/Note |
| Delete a Note object from the Account. 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 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 api/v2/Account/{id}/NoteHTTP/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"
}
]
}
} | |
| GET | api/v2/Account/ |
| Retrieve all of the Account objects. | |
Retrieve all of the Account objects. GET api/v2/Account/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"currencyId": 23,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 17,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 14,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 26,
"billGroupName": "Sample Text Data",
"actingOwnerId": 21,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 22,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 27,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 6,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 26,
"accountTaxCategoryName": "Sample Text Data",
"taxCodeId": 14,
"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": "Sample Text Data",
"createdByUserId": 7,
"createdByUserName": "Sample Text Data",
"id": 26
}
]
} | |
| GET | api/v2/Account/Paged |
| 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 api/v2/Account/Paged 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": 1,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 14,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 9,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 16,
"billGroupName": "Sample Text Data",
"actingOwnerId": 9,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 13,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 19,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 11,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 17,
"accountTaxCategoryName": "Sample Text Data",
"taxCodeId": 10,
"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": "Sample Text Data",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"id": 13
}
]
}
} | |
| GET | api/v2/Account/Paged/Detail |
| 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 api/v2/Account/Paged/Detail 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,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 18,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 9,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 8,
"billGroupName": "Sample Text Data",
"actingOwnerId": 22,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 17,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 26,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 8,
"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": "Sample Text Data",
"createdByUserId": 10,
"createdByUserName": "Sample Text Data",
"id": 8,
"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
}
]
}
}
}
]
}
} | |
| GET | api/v2/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 api/v2/Account/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"currencyId": 21,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 5,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 4,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 25,
"billGroupName": "Sample Text Data",
"actingOwnerId": 8,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 23,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 12,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 21,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 1,
"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": "Sample Text Data",
"createdByUserId": 1,
"createdByUserName": "Sample Text Data",
"id": 21
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/ContactHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"details": {
"totalCount": 1,
"items": [
{
"identity": 1,
"contactTypeId": 5,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"name": "Sample Text Data",
"isUsedForTax": true
}
]
}
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/Contact/PagedHTTP/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": 18,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"name": "Sample Text Data",
"isUsedForTax": true
}
]
}
}
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/Contact/{contactId}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"details": {
"totalCount": 1,
"items": [
{
"identity": 1,
"contactTypeId": 16,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"name": "Sample Text Data",
"isUsedForTax": true
}
]
}
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"currencyId": 15,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 23,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 17,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 0,
"billGroupName": "Sample Text Data",
"actingOwnerId": 6,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 2,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 16,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 23,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 14,
"accountTaxCategoryName": "Sample Text Data",
"taxCodeId": 16,
"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": "Sample Text Data",
"createdByUserId": 11,
"createdByUserName": "Sample Text Data",
"id": 22,
"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
}
]
}
}
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/NoteHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"details": {
"totalCount": 1,
"items": [
{
"identity": 1,
"subject": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 3,
"noteTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 21,
"updatedByUserName": "Sample Text Data",
"showOnOverview": true,
"isImportant": true
}
]
}
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/Note/PagedHTTP/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": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 6,
"noteTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 14,
"updatedByUserName": "Sample Text Data",
"showOnOverview": true,
"isImportant": true
}
]
}
}
}
} | |
| GET | api/v2/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 api/v2/Account/{id}/Note/{noteId}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"details": {
"totalCount": 1,
"items": [
{
"identity": 1,
"subject": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 13,
"noteTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 21,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 26,
"updatedByUserName": "Sample Text Data",
"showOnOverview": true,
"isImportant": true
}
]
}
}
} | |
| PATCH | api/v2/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 api/v2/Account/{id}
{
"details": {},
"accounts": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"currencyId": 0,
"name": "My Account",
"accountStatusTypeId": 14,
"billGroupId": 9,
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 2,
"accountsReceivableTermsId": 15,
"accountTypeId": 3,
"billDay": 1,
"accountTaxCategoryId": 22,
"taxCodeId": 23,
"invoicerAccountId": "My Invoicer Account",
"usageInvoicerAccountId": "My Usage Invoicer Account",
"taxSettingAccountId": "My Usage Invoicer Account",
"usageBillDay": 1,
"isReadOnlyBillDay": true,
"isReadOnlyUsageBillDay": false,
"displayName": "Sample Text Data",
"createdByUserId": 20,
"id": 26
}
]
}
}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": 26,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 3,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 18,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 0,
"billGroupName": "Sample Text Data",
"actingOwnerId": 17,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 19,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 3,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 8,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 25,
"accountTaxCategoryName": "Sample Text Data",
"taxCodeId": 10,
"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": "Sample Text Data",
"createdByUserId": 7,
"createdByUserName": "Sample Text Data",
"id": 20
}
}
]
}
} | |
| POST | api/v2/Account/ |
| Create a new instance of the Account object. | |
Create a new instance of the Account object. POST api/v2/Account/
{
"currencyId": 7,
"name": "My Account",
"accountStatusTypeId": 22,
"billGroupId": 3,
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 20,
"accountsReceivableTermsId": 21,
"accountTypeId": 20,
"billDay": 1,
"accountTaxCategoryId": 18,
"taxCodeId": 0,
"invoicerAccountId": "My Invoicer Account",
"usageInvoicerAccountId": "My Usage Invoicer Account",
"taxSettingAccountId": "My Usage Invoicer Account",
"usageBillDay": 1,
"isReadOnlyBillDay": true,
"isReadOnlyUsageBillDay": false,
"displayName": "Sample Text Data",
"createdByUserId": 13,
"id": 12
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"currencyId": 8,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 16,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 15,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 7,
"billGroupName": "Sample Text Data",
"actingOwnerId": 11,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 25,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 3,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 2,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 1,
"accountTaxCategoryName": "Sample Text Data",
"taxCodeId": 21,
"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": "Sample Text Data",
"createdByUserId": 16,
"createdByUserName": "Sample Text Data",
"id": 25
}
]
}
} | |
| POST | api/v2/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 api/v2/Account/{id}/Contact
{
"contactTypeId": 27,
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"isUsedForTax": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"contactTypeId": 21,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"name": "Sample Text Data",
"isUsedForTax": true
}
]
}
} | |
| POST | api/v2/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 api/v2/Account/{id}/Note
{
"subject": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 23,
"createdByUserId": 16,
"updatedByUserId": 9,
"showOnOverview": true,
"isImportant": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"subject": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 14,
"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": 8,
"updatedByUserName": "Sample Text Data",
"showOnOverview": true,
"isImportant": true
}
]
}
} | |
| POST | api/v2/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. |
| PUT | api/v2/Account/{id} |
| Update an existing instance of the Account object. | |
Update an existing instance of the Account object. PUT api/v2/Account/{id}
{
"identity": 1,
"currencyId": 0,
"name": "My Account",
"accountStatusTypeId": 1,
"billGroupId": 11,
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 21,
"accountsReceivableTermsId": 2,
"accountTypeId": 24,
"billDay": 1,
"accountTaxCategoryId": 0,
"taxCodeId": 26,
"invoicerAccountId": "My Invoicer Account",
"usageInvoicerAccountId": "My Usage Invoicer Account",
"taxSettingAccountId": "My Usage Invoicer Account",
"usageBillDay": 1,
"isReadOnlyBillDay": true,
"isReadOnlyUsageBillDay": false,
"displayName": "Sample Text Data",
"createdByUserId": 9,
"id": 12
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"currencyId": 6,
"currencyCode": "USD",
"currencyName": "Sample Text Data",
"ownerId": 13,
"ownerName": "Sample Text Data",
"name": "My Account",
"created": "2021-04-26T15:25:27.587Z",
"accountStatusTypeId": 27,
"accountStatusTypeName": "Sample Text Data",
"billGroupId": 3,
"billGroupName": "Sample Text Data",
"actingOwnerId": 16,
"actingOwnerName": "Sample Text Data",
"lastUpdate": "2021-04-26T15:25:27.587Z",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryId": 13,
"invoiceDeliveryName": "Sample Text Data",
"accountsReceivableTermsId": 11,
"accountsReceivableTermsName": "Sample Text Data",
"accountTypeId": 10,
"accountTypeName": "Sample Text Data",
"billDay": 1,
"accountTaxCategoryId": 20,
"accountTaxCategoryName": "Sample Text Data",
"taxCodeId": 2,
"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": "Sample Text Data",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"id": 2
}
]
}
} | |
| PUT | api/v2/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 api/v2/Account/{id}/Contact
{
"identity": 1,
"contactTypeId": 26,
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"isUsedForTax": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"contactTypeId": 8,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"name": "Sample Text Data",
"isUsedForTax": true
}
]
}
} | |
| PUT | api/v2/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 api/v2/Account/{id}/Note
{
"identity": 1,
"subject": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 16,
"createdByUserId": 5,
"updatedByUserId": 16,
"showOnOverview": true,
"isImportant": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"subject": "Sample Text Data",
"text": "Sample Text Data",
"noteTypeId": 8,
"noteTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 5,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 19,
"updatedByUserName": "Sample Text Data",
"showOnOverview": true,
"isImportant": true
}
]
}
} | |