Account

Accounts are used by your company for recording transactions, checking the debit, credit and running balances of accounts, viewing registers and reconciling accounts. Account object allows you to perform the following operations:

Retrieve a specific account or a list of accounts
Create an account
Update an account
Delete an account

cURL
NODE.JS
PHP
C#
PYTHON
JAVA

Name	Description	Format	Attributes
code	Represents the name of your account along with the ID	string	Filterable, Sortable MaxLength = 50
name	Name of an account	string	MaxLength = 65
type	Determines the type of account, e.g., credit card, bank, etc.	AccountType Enumerated type: Click to see possible values and their descriptions.	Filterable, Sortable
createdById	Identifier of the user who created this object	uuid	Filterable
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields in the account	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
description	Description of your account	string	MaxLength = 255
displayAccount	Represents the display account as per Global Settings	string
id	Object identifier	uuid	Filterable
isActive	If true, account is active	boolean	Filterable
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
lastUpdatedById	Identifier of the user who last updated this object	uuid	Filterable
level	Determines the hierarchy level of an account	int32
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectState Enumerated type: Click to see possible values and their descriptions.
openingBalance	Opening balance of an account	double
openingBalanceAsOf	Represents the opening balance of your account on a specific date in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
parentAccount	Name of the parent account to which an account belongs	string
parentAccountId	Identifier of the parent account to which an account belongs	uuid
rootAccountId	Identifier of the root or top-level account	uuid
routingNumber	Routing number of the account	string
runningBalance	Represents all reconciled as well as unreconciled transactions	double
taxLine	Tax line number, used in preparing a tax return. It is needed only if you prepare your company's tax return using an accounting software that integrates with CORE.	string	MaxLength = 100
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Account List

Use this method to retrieve a list of accounts. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.

Request URL

base_url/account

/account

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Account

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
fields	Query	Specifies the model properties you want in the response body	string
where	Query	Specifies only those records that match an expression in the query	string
orderBy	Query	Specifies the order of records	string
page	Query	Specifies the page number and number of records on each page	string
expand	Query	Specifies the nested model properties you want in the response body	string

Response Body

Name	Description	Format
code	Represents the name of your account along with the ID	string
name	Name of an account	string
type	Determines the type of account, e.g., credit card, bank, etc.	AccountTypeEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields in the account	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
description	Description of your account	string
displayAccount	Represents the display account as per Global Settings	string
id	Object identifier	uuid
isActive	If true, account is active	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
level	Determines the hierarchy level of an account	int32
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
openingBalance	Opening balance of an account	double
openingBalanceAsOf	Represents the opening balance of your account on a specific date in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
parentAccount	Name of the parent account to which an account belongs	string
parentAccountId	Identifier of the parent account to which an account belongs	uuid
rootAccountId	Identifier of the root or top-level account	uuid
routingNumber	Routing number of the account	string
runningBalance	Represents all reconciled as well as unreconciled transactions	double
taxLine	Tax line number, used in preparing a tax return. It is needed only if you prepare your company's tax return using an accounting software that integrates with CORE.	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

[
  {
    "code": "6011",
    "name": "Account",
    "type": null,
    "createdById": "f5cdd89e-e3b8-4664-a3db-02959801f6f7",
    "createdOn": "2024-09-05T05:41:56Z",
    "customFields": [
      {
        "definitionId": "0d3f5852-72ac-451a-8923-2c5dd4355faf",
        "createdById": "33222fbf-73eb-457f-8356-85795fe3f2bc",
        "createdOn": "2024-09-05T05:41:57Z",
        "description": "CustomFieldData Description",
        "id": "f08c89ac-8520-4dcc-bbf4-ff0e37a295d9",
        "label": "label",
        "lastUpdated": "2024-09-05T05:41:57Z",
        "lastUpdatedById": "67b290d3-2b24-47bb-8941-d659ed148cdd",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "description": "Account Description",
    "displayAccount": "displayAccount",
    "id": "7863af84-86c9-4615-87bf-8c7588829caf",
    "isActive": true,
    "lastUpdated": "2024-09-05T05:41:57Z",
    "lastUpdatedById": "cf70a280-6c53-4f69-9e07-63cc0f2af4c4",
    "level": 0,
    "objectState": null,
    "openingBalance": 1,
    "openingBalanceAsOf": "2024-09-05T05:41:57Z",
    "parentAccount": "parentAccount",
    "parentAccountId": "a295e608-52fa-4c8a-b88d-562f1ab4d3fa",
    "rootAccountId": "ec2b6896-8d6e-4373-8adc-d0ddef3a6c68",
    "routingNumber": "routingNumber",
    "runningBalance": 1,
    "taxLine": "taxLine",
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Retrieve an Account

Use this method to retrieve a specific account. Pass id as the parameter.

Request URL

base_url/account/{id}

/account/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Account

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Account identifier	string

Response Body

Name	Description	Format
code	Represents the name of your account along with the ID	string
name	Name of an account	string
type	Determines the type of account, e.g., credit card, bank, etc.	AccountTypeEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields in the account	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
description	Description of your account	string
displayAccount	Represents the display account as per Global Settings	string
id	Object identifier	uuid
isActive	If true, account is active	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
level	Determines the hierarchy level of an account	int32
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
openingBalance	Opening balance of an account	double
openingBalanceAsOf	Represents the opening balance of your account on a specific date in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
parentAccount	Name of the parent account to which an account belongs	string
parentAccountId	Identifier of the parent account to which an account belongs	uuid
rootAccountId	Identifier of the root or top-level account	uuid
routingNumber	Routing number of the account	string
runningBalance	Represents all reconciled as well as unreconciled transactions	double
taxLine	Tax line number, used in preparing a tax return. It is needed only if you prepare your company's tax return using an accounting software that integrates with CORE.	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

{
  "code": "6011",
  "name": "Account",
  "type": null,
  "createdById": "cd137547-481e-4462-9c34-cd453edb5827",
  "createdOn": "2024-09-05T05:41:57Z",
  "customFields": [
    {
      "definitionId": "ec5835b0-a322-4f7e-8e48-b8754efbe739",
      "createdById": "a2075949-75dc-4b2b-af9d-d0f2c544926b",
      "createdOn": "2024-09-05T05:41:57Z",
      "description": "CustomFieldData Description",
      "id": "7f10eeff-4d9c-415b-9109-3a98ba3f6753",
      "label": "label",
      "lastUpdated": "2024-09-05T05:41:57Z",
      "lastUpdatedById": "ec774f95-0142-43d3-9993-6ced76d850a9",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "description": "Account Description",
  "displayAccount": "displayAccount",
  "id": "5cdcbfe9-5837-4542-af65-11f6d6f5dc3d",
  "isActive": true,
  "lastUpdated": "2024-09-05T05:41:57Z",
  "lastUpdatedById": "5458de4e-aee2-463c-80a2-804cd75ca0f4",
  "level": 0,
  "objectState": null,
  "openingBalance": 1,
  "openingBalanceAsOf": "2024-09-05T05:41:57Z",
  "parentAccount": "parentAccount",
  "parentAccountId": "558158bf-7ffc-44e0-90a7-74a572a9b5ae",
  "rootAccountId": "7dcf5f1a-9988-4fe9-9f52-5466e0622548",
  "routingNumber": "routingNumber",
  "runningBalance": 1,
  "taxLine": "taxLine",
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create an Account

Use this method to save an account. Pass account as the parameter.

Request URL

base_url/account

/account

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Account

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Account object	Account

Response Body

Name	Description	Format
code	Represents the name of your account along with the ID	string
name	Name of an account	string
type	Determines the type of account, e.g., credit card, bank, etc.	AccountTypeEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields in the account	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
description	Description of your account	string
displayAccount	Represents the display account as per Global Settings	string
id	Object identifier	uuid
isActive	If true, account is active	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
level	Determines the hierarchy level of an account	int32
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
openingBalance	Opening balance of an account	double
openingBalanceAsOf	Represents the opening balance of your account on a specific date in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
parentAccount	Name of the parent account to which an account belongs	string
parentAccountId	Identifier of the parent account to which an account belongs	uuid
rootAccountId	Identifier of the root or top-level account	uuid
routingNumber	Routing number of the account	string
runningBalance	Represents all reconciled as well as unreconciled transactions	double
taxLine	Tax line number, used in preparing a tax return. It is needed only if you prepare your company's tax return using an accounting software that integrates with CORE.	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

{
  "code": "6011",
  "name": "Account",
  "type": null,
  "createdById": "ba3c6af8-9b4f-49a4-b0a1-93c232746aab",
  "createdOn": "2024-09-05T05:41:57Z",
  "customFields": [
    {
      "definitionId": "4fc216ae-4baf-40bd-8dee-07b958ce72d2",
      "createdById": "24221831-5209-4c18-b7d7-31a393d5ab1e",
      "createdOn": "2024-09-05T05:41:57Z",
      "description": "CustomFieldData Description",
      "id": "a95eba24-927b-49bb-b61b-53ce9325b38d",
      "label": "label",
      "lastUpdated": "2024-09-05T05:41:57Z",
      "lastUpdatedById": "8ff9b1c3-2b54-47a5-83a1-2466a939db62",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "description": "Account Description",
  "displayAccount": "displayAccount",
  "id": "10671069-4a18-4c5a-9fb6-dcb77eb2b954",
  "isActive": true,
  "lastUpdated": "2024-09-05T05:41:57Z",
  "lastUpdatedById": "41547a20-b839-49de-b274-b5de0709e74a",
  "level": 0,
  "objectState": null,
  "openingBalance": 1,
  "openingBalanceAsOf": "2024-09-05T05:41:57Z",
  "parentAccount": "parentAccount",
  "parentAccountId": "29a6f0be-a51d-4884-b808-54f6cfdcb08a",
  "rootAccountId": "5a2c1424-3b22-411e-8547-15508906626f",
  "routingNumber": "routingNumber",
  "runningBalance": 1,
  "taxLine": "taxLine",
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create an Account List

Use this method to save multiple accounts. Pass model as the parameter.

Request URL

base_url/account/batch

/account/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Account

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Account object	AccountBatchRequest

Response Body

Name	Description	Format
batchSize	Represents the number of entities in a batch	int64
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
progress	Represents the total number of entities processed	int64
status	Represents the status of a job e.g., ready, running, completed, or terminated	string
token	Represents the token for update operations	int32
type	Represents the type of a job e.g., create, update, or delete	string
version	Implements concurrency on this object	byte

Example Response

{
  "batchSize": 0,
  "createdById": "979f5933-d56b-423c-bb81-3a977ad9a464",
  "createdOn": "2024-09-05T05:41:57Z",
  "id": "d9552244-5b2a-4717-9666-f5daae98a7b2",
  "lastUpdated": "2024-09-05T05:41:57Z",
  "lastUpdatedById": "1cd18547-6175-4050-bb8b-b84f4f31d88e",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Update an Account

Use this method to update an account. Pass id and account as the parameters.

Request URL

base_url/account/{id}

/account/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Account

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Account identifier	string
body	Body	Account object	Account

Response Body

Name	Description	Format
code	Represents the name of your account along with the ID	string
name	Name of an account	string
type	Determines the type of account, e.g., credit card, bank, etc.	AccountTypeEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields in the account	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
description	Description of your account	string
displayAccount	Represents the display account as per Global Settings	string
id	Object identifier	uuid
isActive	If true, account is active	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
level	Determines the hierarchy level of an account	int32
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
openingBalance	Opening balance of an account	double
openingBalanceAsOf	Represents the opening balance of your account on a specific date in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
parentAccount	Name of the parent account to which an account belongs	string
parentAccountId	Identifier of the parent account to which an account belongs	uuid
rootAccountId	Identifier of the root or top-level account	uuid
routingNumber	Routing number of the account	string
runningBalance	Represents all reconciled as well as unreconciled transactions	double
taxLine	Tax line number, used in preparing a tax return. It is needed only if you prepare your company's tax return using an accounting software that integrates with CORE.	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

{
  "code": "6011",
  "name": "Account",
  "type": null,
  "createdById": "bc33161b-cbf4-4f45-883a-73729f067910",
  "createdOn": "2024-09-05T05:41:57Z",
  "customFields": [
    {
      "definitionId": "79f219b5-3004-46ac-a74d-397ea8cc1c96",
      "createdById": "9706c59c-ffa4-4a7a-a093-70e5dc69ab90",
      "createdOn": "2024-09-05T05:41:57Z",
      "description": "CustomFieldData Description",
      "id": "ebebcd27-e333-401d-b573-97ac7ed8776f",
      "label": "label",
      "lastUpdated": "2024-09-05T05:41:57Z",
      "lastUpdatedById": "b02e9aba-ca28-4156-b68c-eeb0805d9515",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "description": "Account Description",
  "displayAccount": "displayAccount",
  "id": "e68f5134-b876-49f1-a013-0d23befb0b33",
  "isActive": true,
  "lastUpdated": "2024-09-05T05:41:57Z",
  "lastUpdatedById": "a1bc67ba-2e01-4f9a-a7a0-73e2ff7082a1",
  "level": 0,
  "objectState": null,
  "openingBalance": 1,
  "openingBalanceAsOf": "2024-09-05T05:41:57Z",
  "parentAccount": "parentAccount",
  "parentAccountId": "6405936c-8a0e-4d23-a4db-77356d1d1780",
  "rootAccountId": "8e6299b6-0e43-4ba7-becb-52f181d065e0",
  "routingNumber": "routingNumber",
  "runningBalance": 1,
  "taxLine": "taxLine",
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Delete an Account

Use this method to delete an account. Pass id as the parameter.

Request URL

base_url/account/{id}

/account/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Account identifier	string

Patch an Account

Use this method to perform partial modifications to an account. Pass id and patch document as parameters.

Request URL

base_url/account/{id}

/account/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Account

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Account identifier	string
body	Body	A document containing an array of objects with each object representing a single operation to be performed	AccountPatchDocument

Response Body

Name	Description	Format

Account

The Account Object

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body