Financials | Financial Account

The Financial Account represents accounts of type petty cash and bank account.

Overview

api/{tenantKey}/{orgKey}/financialCore/financialAccounts

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

All Operations

This service includes the following operations:

GET:
POST:
- POST FinancialAccounts
- POST Financial Account
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiFinancialAccountEntityDimensionDetailsResource
ApiFinancialAccountResource
FinancialAccountDimensionResource
FinancialAccountResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

FinancialAccountType

GET Operations

GET FinancialAccounts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialAccounts

GET /financialCore/financialAccounts

GET FinancialAccounts (paged)

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

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialAccounts?page={page}&pageSize={pageSize}

GET /financialCore/financialAccounts?page={page}&pageSize={pageSize}

GET FinancialAccount 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 FinancialAccountResource.

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/financialAccounts/{id}

GET /financialCore/financialAccounts/{id}

GET FinancialAccount by key

Returns the entity record that matches the specified key.

The following elements are required:

financialAccountKey

(string) The financial account's key.

Response:

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

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/financialAccounts/{financialAccountKey}

GET /financialCore/financialAccounts/{financialAccountKey}

GET Print FinancialAccount by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialAccounts/{id}/print?template={template}

GET /financialCore/financialAccounts/{id}/print?template={template}

GET Print FinancialAccount by key

Prints the specified entity record.

The following elements are required:

financialAccountKey

(string) The financial account's key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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/financialAccounts/{financialAccountKey}/print

GET /financialCore/financialAccounts/{financialAccountKey}/print

GET Original Print FinancialAccountOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialAccounts/{id}/printOriginal?template={template}

GET /financialCore/financialAccounts/{id}/printOriginal?template={template}

GET Original Print FinancialAccount by key

Prints the specified entity record.

The following elements are required:

financialAccountKey

(string) The financial account's key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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/financialAccounts/{financialAccountKey}/printOriginal

GET /financialCore/financialAccounts/{financialAccountKey}/printOriginal

POST Operations

POST FinancialAccounts

Creates a new entity record.

The following elements are required:

financialAccountResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiFinancialAccountResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialAccounts

POST /financialCore/financialAccounts

POST Financial Account

Inserts a new 'Financial Account Dimension' in the 'Financial Account'.

The following elements are required:

financialAccountKey	(string) The financial account's key.
value	(ApiFinancialAccountEntityDimensionDetailsResource) The ApiFinancialAccountEntityDimensionDetailsResource instance. See ApiFinancialAccountEntityDimensionDetailsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialAccounts/{financialAccountKey}/entityDimensionDetails

POST /financialCore/financialAccounts/{financialAccountKey}/entityDimensionDetails

PUT Operations

PUT Set AccountNumber FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/accountNumber

PUT /financialCore/financialAccounts/{financialAccountKey}/accountNumber

PUT Set Branch FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/branch

PUT /financialCore/financialAccounts/{financialAccountKey}/branch

PUT Set ChartOfAccount FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/chartOfAccount

PUT /financialCore/financialAccounts/{financialAccountKey}/chartOfAccount

PUT Set Company FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/company

PUT /financialCore/financialAccounts/{financialAccountKey}/company

PUT Set Country FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/country

PUT /financialCore/financialAccounts/{financialAccountKey}/country

PUT Set CreditorEntityReference FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/creditorEntityReference

PUT /financialCore/financialAccounts/{financialAccountKey}/creditorEntityReference

PUT Set Description FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/description

PUT /financialCore/financialAccounts/{financialAccountKey}/description

PUT Set DimensionValue FinancialAccountDimension

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

The following elements are required:

financialAccountKey	(string) The financial account's key.
lineId	(string) The detail identifier.
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/financialAccounts/{financialAccountKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT /financialCore/financialAccounts/{financialAccountKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT Set FinancialAccountKey FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/financialAccountKey

PUT /financialCore/financialAccounts/{financialAccountKey}/financialAccountKey

PUT Set FinancialAccountType FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial account's key.
value	(enum FinancialAccountType) The request body should contain the new value for the attribute. See FinancialAccountType.

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/financialAccounts/{financialAccountKey}/financialAccountType

PUT /financialCore/financialAccounts/{financialAccountKey}/financialAccountType

PUT Set FinancialInstitution FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/financialInstitution

PUT /financialCore/financialAccounts/{financialAccountKey}/financialInstitution

PUT Set GLAccount FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/gLAccount

PUT /financialCore/financialAccounts/{financialAccountKey}/gLAccount

PUT Set IBAN FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/iBAN

PUT /financialCore/financialAccounts/{financialAccountKey}/iBAN

PUT Set IsActive FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/isActive

PUT /financialCore/financialAccounts/{financialAccountKey}/isActive

PUT Set PartyCode FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/partyCode

PUT /financialCore/financialAccounts/{financialAccountKey}/partyCode

PUT Set Responsible FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/responsible

PUT /financialCore/financialAccounts/{financialAccountKey}/responsible

PUT Set SWIFT FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial 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/financialAccounts/{financialAccountKey}/sWIFT

PUT /financialCore/financialAccounts/{financialAccountKey}/sWIFT

PUT Set ValidFrom FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial account's key.
value	(DateTime) 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/financialAccounts/{financialAccountKey}/validFrom

PUT /financialCore/financialAccounts/{financialAccountKey}/validFrom

PUT Set ValidTo FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial account's key.
value	(DateTime) 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/financialAccounts/{financialAccountKey}/validTo

PUT /financialCore/financialAccounts/{financialAccountKey}/validTo

PUT Set Custom Attribute FinancialAccount

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

financialAccountKey	(string) The financial account's key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/financialAccounts/{financialAccountKey}/{customAttributeName}

PUT /financialCore/financialAccounts/{financialAccountKey}/{customAttributeName}

DELETE Operations

DELETE Financial Account Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

financialAccountKey	(string) The financial account's key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/financialAccounts/{financialAccountKey}/entityDimensionDetails/{lineId}

DELETE /financialCore/financialAccounts/{financialAccountKey}/entityDimensionDetails/{lineId}

DELETE FinancialAccount 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/financialAccounts/{id}

DELETE /financialCore/financialAccounts/{id}

DELETE FinancialAccount by key

Deletes the entity record that matches the specified key.

The following elements are required:

financialAccountKey

(string) The financial 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/financialAccounts/{financialAccountKey}

DELETE /financialCore/financialAccounts/{financialAccountKey}

Resources

ApiFinancialAccountEntityDimensionDetailsResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

ApiFinancialAccountResource

The following elements are required:

financialAccountKey	(string) The financial account's key.
company	(string) The financial account's associated company.
gLAccount	(string) The GL account of the financial account. Must be from subledger financial accoutns.
chartOfAccount	(string) The chart of accounts of the company.
financialAccountType	(enum FinancialAccountType) The type of account: petty cash or bank account. See FinancialAccountType.

The following elements are optional:

description	(string) The financial account's description.
accountNumber	(string) The account's number.
iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
branch	(string) The branch's name.
validFrom	(DateTime) The start date for validity period.
validTo	(DateTime) The end date for validity period.
country	(string) The country where the account's institution is based.
entityDimensionDetails	(List of ApiFinancialAccountEntityDimensionDetailsResource) The dimensions of the financial account. See ApiFinancialAccountEntityDimensionDetailsResource.
responsible	(string) The responsible for the account.
creditorEntityReference	(string) Reference used for direct debit payment or for bank charges.
financialInstitution	(string) The associated financial institution.
partyCode	(string) Party Code.

FinancialAccountDimensionResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

FinancialAccountResource

The following elements are required:

financialAccountKey	(string) The financial account's key.
company	(string) The financial account's associated company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
gLAccount	(string) The GL account of the financial account. Must be from subledger financial accoutns. (fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
chartOfAccount	(string) The chart of accounts of the company. (fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
financialAccountType	(enum FinancialAccountType) The type of account: petty cash or bank account. See FinancialAccountType.

The following elements are optional:

description	(string) The financial account's description.
accountNumber	(string) The account's number.
iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
branch	(string) The branch's name.
validFrom	(DateTime) The start date for validity period.
validTo	(DateTime) The end date for validity period.
country	(string) The country where the account's institution is based. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
entityDimensionDetails	(List of FinancialAccountDimensionResource) The dimensions of the financial account. See FinancialAccountDimensionResource.
responsible	(string) The responsible for the account.
creditorEntityReference	(string) Reference used for direct debit payment or for bank charges.
financialInstitution	(string) The associated financial institution. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
partyCode	(string) Party Code.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

FinancialAccountType

1	PettyCash
2	BankAccount