Account

What can you do with Account?


Properties

Property Details
id
"id": 579
Type: Number
This is the unique numeric identifier for the Account
currencyId
"currencyId": 102
Type: Number
Unique identifier for the associated Currency object.
ownerId
"ownerId": 603
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": 834
Type: Number
Unique identifier for the associated AccountStatusType object.
billGroupId
"billGroupId": 675
Type: Number
Unique identifier for the associated BillGroup object.
actingOwnerId
"actingOwnerId": 645
Type: Number
Unique identifier for the associated Owner object.
createdBy
"createdBy": 635
Type: Number
lastStatusChanged
"lastStatusChanged": "2005-04-11T14:56:24"
Type: Date
lastUpdate
"lastUpdate": "2005-04-11T14:56:24"
Type: Date
effectiveCancel
"effectiveCancel": "2005-04-11T14:56:24"
Type: Date
invoiceConfigurationId
"invoiceConfigurationId": 169
Type: Number
Unique identifier for the associated InvoiceConfiguration object.
accountsReceivableTermsId
"accountsReceivableTermsId": 490
Type: Number
Unique identifier for the associated AccountsReceivableTerms object.
accountTypeId
"accountTypeId": 2
Type: Number
Unique identifier for the associated AccountType object.
autoPayTypeId
"autoPayTypeId": 475
Type: Number
Unique identifier for the associated AutoPayType object.
isAutoPayEnabled
"isAutoPayEnabled": true
Type: Boolean
autoPayDay
"autoPayDay": 442
Type: Number
billDay
"billDay": 946
Type: Number
isTaxExempt
"isTaxExempt": true
Type: Boolean
accountTaxCategoryId
"accountTaxCategoryId": 531
Type: Number
Unique identifier for the associated AccountTaxCategory object.
taxCodeId
"taxCodeId": 693
Type: Number
Unique identifier for the associated TaxCode object.
invoicerAccountId
"invoicerAccountId": 609
Type: Number
Unique identifier for the associated Account object.
usageInvoicerAccountId
"usageInvoicerAccountId": 427
Type: Number
Unique identifier for the associated Account object.
taxSettingAccountId
"taxSettingAccountId": 122
Type: Number
Unique identifier for the associated Account object.
usageBillDay
"usageBillDay": 26
Type: Number
isReadOnlyBillDay
"isReadOnlyBillDay": true
Type: Boolean
isReadOnlyUsageBillDay
"isReadOnlyUsageBillDay": true
Type: Boolean
displayName
"displayName": "Hello World"
Type: String


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
  • createdBy
  • lastStatusChanged
  • lastUpdate
  • effectiveCancel
  • invoiceConfigurationId
  • accountsReceivableTermsId
  • accountTypeId
  • autoPayTypeId
  • isAutoPayEnabled
  • autoPayDay
  • billDay
  • isTaxExempt
  • accountTaxCategoryId
  • taxCodeId
  • invoicerAccountId
  • usageInvoicerAccountId
  • taxSettingAccountId
  • usageBillDay
  • isReadOnlyBillDay
  • isReadOnlyUsageBillDay
  • displayName

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