Financials | Account

Service to manage entities of type 'Account'.

Overview

api/{tenantKey}/{orgKey}/financialCore/accounts

URL	api/{tenantKey}/{orgKey}/financialCore/accounts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Accounts
PUT:
DELETE:
- DELETE Account by identifier
- DELETE Account by key

All Resources

This service uses the following resources:

AccountResource
ApiAccountResource

GET Operations

GET Accounts (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See AccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/odata

GET /financialCore/accounts/odata

GET Account by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See AccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{id}

GET /financialCore/accounts/{id}

GET Account by key

Returns the entity record that matches the specified key.

The following elements are required:

accountKey

(string) The account's key.

Response:

When successful, the response body contains the entity record. See AccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}

GET /financialCore/accounts/{accountKey}

POST Operations

POST Accounts

Creates a new entity record.

The following elements are required:

accountResource

(ApiAccountResource) The request body should contain the entity record that should be created.
See ApiAccountResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiAccountResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts

POST /financialCore/accounts

PUT Operations

PUT Set AccountKey Account

Updates the value of attribute 'AccountKey' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/accountKey

PUT /financialCore/accounts/{accountKey}/accountKey

PUT Set AccountType Account

Updates the value of attribute 'AccountType' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/accountType

PUT /financialCore/accounts/{accountKey}/accountType

PUT Set CostAccount Account

Updates the value of attribute 'CostAccount' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/costAccount

PUT /financialCore/accounts/{accountKey}/costAccount

PUT Set DefaultItemTaxSchema Account

Updates the value of attribute 'DefaultItemTaxSchema' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/defaultItemTaxSchema

PUT /financialCore/accounts/{accountKey}/defaultItemTaxSchema

PUT Set Description Account

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/description

PUT /financialCore/accounts/{accountKey}/description

PUT Set IsActive Account

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/isActive

PUT /financialCore/accounts/{accountKey}/isActive

PUT Set Remarks Account

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

accountKey	(string) The account's key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}/remarks

PUT /financialCore/accounts/{accountKey}/remarks

DELETE Operations

DELETE Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{id}

DELETE /financialCore/accounts/{id}

DELETE Account by key

Deletes the entity record that matches the specified key.

The following elements are required:

accountKey

(string) The account's key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/accounts/{accountKey}

DELETE /financialCore/accounts/{accountKey}

Resources

AccountResource

The following elements are required:

accountKey	(string) The account's key.
description	(string) Description.
accountType	(string) Account Type. (fk) Allowed value: the natural key of a record of type AccountType.
isAccountTypeDefault	(bool) Defines if the account where to insert posting when the account type is defined as 'DirectPosting'. Internally determined.
isLocked	(bool) Is Locked.

The following elements are optional:

remarks	(string) Remarks.
costAccount	(string) The Cost Account. (fk) Allowed value: the natural key of a record of type Account. These records are accessibly through the Accounts service.
isSalesProfitAccount	(bool) Defines if the account references the account type defined at the accounting setup as the 'Sales Revenue Account Type'. Internally determined.
defaultItemTaxSchema	(string) Default VAT Type. (fk) Allowed value: the natural key of a record of type ItemTaxSchema. These records are accessibly through the ItemTaxSchemas service.
lockReason	(string) Lock Reason. (fk) Allowed value: the natural key of a record of type EntityLockReason. These records are accessibly through the EntityLockReasons service.

ApiAccountResource

The following elements are required:

accountKey	(string) The account's key.
description	(string) Description.
accountType	(string) Account Type.

The following elements are optional:

remarks	(string) Remarks.
costAccount	(string) The Cost Account.
defaultItemTaxSchema	(string) Default VAT Type.