Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Account

Creates a Account resource.

Creates a Account resource.

post/accounts

Request body

idstring

unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

codestring nullable

customer defined code for the account e.g. "400" e.g. "SALES"

taxTypestring nullable

a tax code used for the account e.g. "TAX001"

bankAccountNumberstring nullable

a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826"

bankAccountTypestring nullable

indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL"

currencyCodestring nullable

the currency code e.g. "USD"

fullyQualifiedNamestring nullable

full canonical name for the account e.g. Short term cash

namestring nullable required

short name for the account e.g. "Sandra's Bank Account"

classificationstring nullable

The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense.

accountSubTypestring nullable

application based classification of the account e.g. "BANK"

currentBalanceWithSubAccountsstring nullable

represents the total value of the account including any sub accounts in cents

createdstring date-time nullable

when the account was created

modifiedstring date-time nullable

when any user modifiable attributes of the object were last changed

accountTypestring nullable

the type or class of the account e.g. "ASSET"

currentBalancestring nullable

the value of the account excluding any sub accounts in cents

activeboolean nullable

whether or not the account is active and should be included in calculations

subAccountboolean nullable

whether this account is actually a subaccount of another account

descriptionstring nullable

a user definable long form description of the account e.g. "This is the main company account for income and expenses"

srcIdstring nullable

the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

parentAccountIdstring nullable

if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK"

deletedboolean nullable

whether or not the account is active

Example request

{
  "id": "quickbooks-726",
  "integration": "quickbooks",
  "code": "400",
  "taxType": "TAX001",
  "bankAccountNumber": "823772-2828773-09826",
  "bankAccountType": "CREDITCARD",
  "currencyCode": "USD",
  "fullyQualifiedName": "Short Term Cash",
  "name": "Sandra's Bank Account",
  "classification": "Asset",
  "accountSubType": "BANK",
  "currentBalanceWithSubAccounts": "387687",
  "created": "2021-06-24 22:35:07",
  "modified": "2021-06-24 22:35:07",
  "accountType": "ASSET",
  "currentBalance": "29872",
  "active": true,
  "description": "This is the main company account for income and expenses",
  "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK"
}

Response

Account resource created

idstring

unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

codestring nullable

customer defined code for the account e.g. "400" e.g. "SALES"

taxTypestring nullable

a tax code used for the account e.g. "TAX001"

bankAccountNumberstring nullable

a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826"

bankAccountTypestring nullable

indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL"

currencyCodestring nullable

the currency code e.g. "USD"

fullyQualifiedNamestring nullable

full canonical name for the account e.g. Short term cash

namestring nullable required

short name for the account e.g. "Sandra's Bank Account"

classificationstring nullable

The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense.

accountSubTypestring nullable

application based classification of the account e.g. "BANK"

currentBalanceWithSubAccountsstring nullable

represents the total value of the account including any sub accounts in cents

createdstring date-time nullable

when the account was created

modifiedstring date-time nullable

when any user modifiable attributes of the object were last changed

accountTypestring nullable

the type or class of the account e.g. "ASSET"

currentBalancestring nullable

the value of the account excluding any sub accounts in cents

activeboolean nullable

whether or not the account is active and should be included in calculations

subAccountboolean nullable

whether this account is actually a subaccount of another account

descriptionstring nullable

a user definable long form description of the account e.g. "This is the main company account for income and expenses"

srcIdstring nullable

the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

parentAccountIdstring nullable

if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK"

deletedboolean nullable

whether or not the account is active

Example response

{
  "id": "quickbooks-726",
  "integration": "quickbooks",
  "code": "400",
  "taxType": "TAX001",
  "bankAccountNumber": "823772-2828773-09826",
  "bankAccountType": "CREDITCARD",
  "currencyCode": "USD",
  "fullyQualifiedName": "Short Term Cash",
  "name": "Sandra's Bank Account",
  "classification": "Asset",
  "accountSubType": "BANK",
  "currentBalanceWithSubAccounts": "387687",
  "created": "2021-06-24 22:35:07",
  "modified": "2021-06-24 22:35:07",
  "accountType": "ASSET",
  "currentBalance": "29872",
  "active": true,
  "description": "This is the main company account for income and expenses",
  "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK"
}