TAG LINE
SMALL TITLE

Account

(API Version v3)


What can you do with Account?


Properties

Property Details
id
"id": 15
Type: Number
This is the unique numeric identifier for the Account
currencyId
"currencyId": 5
Type: Number
Unique identifier for the associated Currency object.
ownerId
"ownerId": 11
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
created
"created": "2005-04-11T14:56:24"
Type: Date
accountStatusTypeId
"accountStatusTypeId": 8
Type: Number
Unique identifier for the associated AccountStatusType object.
billGroupId
"billGroupId": 4
Type: Number
Unique identifier for the associated BillGroup object.
actingOwnerId
"actingOwnerId": 1
Type: Number
Unique identifier for the associated Owner object.
lastUpdate
"lastUpdate": "2005-04-11T14:56:24"
Type: Date
effectiveCancel
"effectiveCancel": "2005-04-11T14:56:24"
Type: Date
invoiceDeliveryId
"invoiceDeliveryId": 9
Type: Number
Unique identifier for the associated InvoiceDelivery object.
accountsReceivableTermsId
"accountsReceivableTermsId": 18
Type: Number
Unique identifier for the associated AccountsReceivableTerms object.
accountTypeId
"accountTypeId": 5
Type: Number
Unique identifier for the associated AccountType object.
billDay
"billDay": 22
Type: Number
accountTaxCategoryId
"accountTaxCategoryId": 10
Type: Number
Unique identifier for the associated AccountTaxCategory object.
taxCodeId
"taxCodeId": 11
Type: Number
Unique identifier for the associated TaxCode object.
invoicerAccountId
"invoicerAccountId": 14
Type: Number
Unique identifier for the associated Account object.
usageInvoicerAccountId
"usageInvoicerAccountId": 11
Type: Number
Unique identifier for the associated Account object.
taxSettingAccountId
"taxSettingAccountId": 2
Type: Number
Unique identifier for the associated Account object.
usageBillDay
"usageBillDay": 27
Type: Number
isReadOnlyBillDay
"isReadOnlyBillDay": true
Type: Boolean
isReadOnlyUsageBillDay
"isReadOnlyUsageBillDay": true
Type: Boolean
displayName
"displayName": "Hello World"
Type: String
createdByUserId
"createdByUserId": 27
Type: Number
Unique identifier for the associated User object.
id
"id": 10
Type: Number


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • currencyId
  • name
  • created
  • accountStatusTypeId
  • billGroupId
  • actingOwnerId
  • lastUpdate
  • effectiveCancel
  • invoiceDeliveryId
  • accountsReceivableTermsId
  • accountTypeId
  • billDay
  • accountTaxCategoryId
  • taxCodeId
  • invoicerAccountId
  • usageInvoicerAccountId
  • taxSettingAccountId
  • usageBillDay
  • isReadOnlyBillDay
  • isReadOnlyUsageBillDay
  • displayName
  • createdByUserId
  • currencyCode

Patch Types

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

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

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/Account/{id:int}
Delete an instance of the Account object.
DELETEapi/v3/Account/{id:int}/Note
Delete a Note object from the Account.
{id:int}Unique identifier for the Account object.
GETapi/v3/Account
Retrieve all of the Account objects.
GETapi/v3/Account/Paged
Retreive all of the Account objects in a paged fashion.
GETapi/v3/Account/Paged/Detail
Retreive all of the Account objects in a paged fashion with all object details.
GETapi/v3/Account/{id:int}
Retrieve an instance of the Account object by it's ID.
{id:int}Unique identifier for the Account object.
GETapi/v3/Account/{id:int}/Detail
Retreive all of the Detail objects for the specified Account.
{id:int}Unique identifier for the Account object.
GETapi/v3/Account/{id:int}/Note
Retreive all of the Note objects for the specified Account.
{id:int}Unique identifier for the Account object.
GETapi/v3/Account/{id:int}/Note/Paged
Retreive all of the Note objects for a specified Account.
{id:int}Unique identifier for the Account object.
GETapi/v3/Account/{id:int}/Note/{noteId:int}
Retrieve a specified Note object by it's ID for a specified Account.
{id:int}Unique identifier for the Account object.
PATCHapi/v3/Account/{id:int}
Update the Account object and optionally make changes to any child objects.
POSTapi/v3/Account
Create a new instance of the Account object.
POSTapi/v3/Account/{id:int}/Note
Create a new instance of a Note object that belongs to the Account.
{id:int}Unique identifier for the Account object.
POSTapi/v3/Account/{id:int}/Patch
Create a new instance of a Patch object that belongs to the Account.
{id:int}Unique identifier for the Account object.
PUTapi/v3/Account/{id:int}
Update an existing instance of the Account object.
PUTapi/v3/Account/{id:int}/Note
Update an existing instance of a Note object that belongs to the Account.
{id:int}Unique identifier for the Account object.