Financials | Financial Account

Service to manage entities of type 'FinancialAccount'.

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
PUT:
DELETE:
- DELETE FinancialAccount by identifier
- DELETE FinancialAccount by key

All Resources

This service uses the following resources:

ApiFinancialAccountResource
FinancialAccountResource
MoneyResource

All Enumerations

This service uses the following enumerations:

FinancialAccountType

GET Operations

GET FinancialAccounts (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 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/odata

GET /financialCore/financialAccounts/odata

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}

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.

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

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 AllowForeignCurrency FinancialAccount

Updates the value of attribute 'AllowForeignCurrency' 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.

Resource URL:

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

PUT /financialCore/financialAccounts/{financialAccountKey}/allowForeignCurrency

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 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 Currency FinancialAccount

Updates the value of attribute 'Currency' 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}/currency

PUT /financialCore/financialAccounts/{financialAccountKey}/currency

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 ExchangeRate FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial account's key.
value	(decimal) 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}/exchangeRate

PUT /financialCore/financialAccounts/{financialAccountKey}/exchangeRate

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 HasOpeningBalance FinancialAccount

Updates the value of attribute 'HasOpeningBalance' 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.

Resource URL:

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

PUT /financialCore/financialAccounts/{financialAccountKey}/hasOpeningBalance

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 OpeningAmount FinancialAccount

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

The following elements are required:

financialAccountKey	(string) The financial account's key.
value	(decimal) 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}/openingAmount

PUT /financialCore/financialAccounts/{financialAccountKey}/openingAmount

PUT Set OpeningDate FinancialAccount

Updates the value of attribute 'OpeningDate' 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}/openingDate

PUT /financialCore/financialAccounts/{financialAccountKey}/openingDate

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

DELETE Operations

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

ApiFinancialAccountResource

The following elements are required:

company	(string) The financial account's associated company.
financialAccountKey	(string) The financial account's key.
financialAccountType	(enum FinancialAccountType) The type of account: petty cash or bank account. See FinancialAccountType.
allowForeignCurrency	(bool) Indicates if the financial account (if petty cash) allow foreign currency.
openingAmount	(MoneyResource) Opening Amount. See MoneyResource .
exchangeRate	(decimal) Exchange Rate.
hasOpeningBalance	(bool) Has Opening Balance?.

The following elements are optional:

description	(string) The financial account's description.
accountNumber	(string) The account's number.
iBAN	(string) The financial 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.
financialInstitution	(string) The associated financial institution.
currency	(string) The currency which the financial accounts operates.
country	(string) The country where the financial account is based.
responsible	(string) The responsible for the financial account (if petty cash).
creditorEntityReference	(string) Creditor Entity Reference.
openingDate	(DateTime) Opening Date.

FinancialAccountResource

The following elements are required:

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.
financialAccountKey	(string) The financial account's key.
reconciliationTolerance	(decimal) The reconciliation tolerance, by default 2.
financialAccountType	(enum FinancialAccountType) The type of account: petty cash or bank account. See FinancialAccountType.
allowForeignCurrency	(bool) Indicates if the financial account (if petty cash) allow foreign currency.
openingAmount	(MoneyResource) Opening Amount. See MoneyResource .
exchangeRate	(decimal) Exchange Rate.
hasOpeningBalance	(bool) Has Opening Balance?.

The following elements are optional:

description	(string) The financial account's description.
accountNumber	(string) The account's number.
iBAN	(string) The financial 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.
partyTaxSchema	(string) The party's tax schema. (fk) Allowed value: the natural key of a record of type PartyTaxSchema. These records are accessibly through the PartyTaxSchemas service.
financialInstitution	(string) The associated financial institution. (fk) Allowed value: the natural key of a record of type FinancialInstitution. These records are accessibly through the FinancialInstitutions service.
currency	(string) The currency which the financial accounts operates. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
partyWithholdingTaxSchema	(string) The party's withholding tax schema. (fk) Allowed value: the natural key of a record of type PartyWithholdingTaxSchema. These records are accessibly through the PartyWithholdingTaxSchemas service.
country	(string) The country where the financial account is based. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
responsible	(string) The responsible for the financial account (if petty cash).
creditorEntityReference	(string) Creditor Entity Reference.
openingDate	(DateTime) Opening Date.
exchangeRateDate	(DateTime) Exchange Rate Date.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

Enumerations

FinancialAccountType

1	PettyCash
2	BankAccount