Financials | Financial Account Entry

Service to manage entities of type 'FinancialAccountEntry'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET FinancialAccountEntries
  • GET FinancialAccountEntries (paged)
  • GET FinancialAccountEntry by identifier
  • GET FinancialAccountEntry by key
  • GET Print FinancialAccountEntry by identifier
  • GET Print FinancialAccountEntry by key
  • GET Original Print FinancialAccountEntryOriginal by identifier
  • GET Original Print FinancialAccountEntry by key
• POST:
  • POST FinancialAccountEntries
• PUT:
  • PUT Set IsActive FinancialAccountEntry
  • PUT Set DocumentDate FinancialAccountEntry
  • PUT Set ExchangeRate FinancialAccountEntry
  • PUT Set Currency FinancialAccountEntry
  • PUT Set FinancialAccount FinancialAccountEntry
  • PUT Set CashFlowItem FinancialAccountEntry
  • PUT Set Amount FinancialAccountEntry
  • PUT Set Note FinancialAccountEntry
  • PUT Set Remarks FinancialAccountEntry
  • PUT Set Account FinancialAccountEntry
  • PUT Set TaxRate FinancialAccountEntry
• DELETE:
  • DELETE FinancialAccountEntry by identifier
  • DELETE FinancialAccountEntry by key

All Resources

This service uses the following resources:

• ApiFinancialAccountEntryResource
• FinancialAccountEntryResource

GET Operations

GET FinancialAccountEntries

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET FinancialAccountEntries (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 FinancialAccountEntryResource.

Response status codes:

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

Resource URL:

GET FinancialAccountEntry 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 FinancialAccountEntryResource.

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:

GET FinancialAccountEntry by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
entryKey	(int) Entry.

Response:

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

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:

GET Print FinancialAccountEntry 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:

GET Print FinancialAccountEntry by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
entryKey	(int) Entry.

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:

GET Original Print FinancialAccountEntryOriginal 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:

GET Original Print FinancialAccountEntry by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
entryKey	(int) Entry.

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:

POST Operations

POST FinancialAccountEntries

Creates a new entity record.

The following elements are required:

financialAccountEntryResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set Account FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set Amount FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set CashFlowItem FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set Currency FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set DocumentDate FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set ExchangeRate FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set FinancialAccount FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set IsActive FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set Note FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set Remarks FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

PUT Set TaxRate FinancialAccountEntry

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

The following elements are required:

entryKey	(int) Entry.
companyKey	(string) The company 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:

DELETE Operations

DELETE FinancialAccountEntry 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:

DELETE FinancialAccountEntry by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
entryKey	(int) Entry.

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:

Resources

ApiFinancialAccountEntryResource

The following elements are required:

entryKey	(int) Entry.
documentDate	(DateTime) Value Date.
company	(string) Company.
exchangeRate	(decimal) Exchange Rate.
currency	(string) Currency.
financialAccount	(string) Financial Account.
cashFlowItem	(string) Cash Flow.
amount	(decimal) Amount.
taxRate	(decimal) Tax Rate.

The following elements are optional:

note	(string) Reference.
remarks	(string) Remarks.
account	(string) Account.

FinancialAccountEntryResource

The following elements are required:

entryKey	(int) Entry.
postingDate	(DateTime) Posting Date.
documentDate	(DateTime) Value Date.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
exchangeRate	(decimal) Exchange Rate.
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
financialAccount	(string) Financial Account. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
cashFlowItem	(string) Cash Flow. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
amount	(decimal) Amount.
isBankAccount	(bool) Is Bank Account.
pettyCashAllowsForeignCurrency	(bool) Petty Cash Allows Foreign Currency.
generateAccountPending	(bool) Pending payment/receivable.
accountedAmount	(decimal) Accounted Amount.
taxRate	(decimal) Tax Rate.

The following elements are optional:

exchangeRateDate	(DateTime) Exchange Rate Date.
note	(string) Reference.
remarks	(string) Remarks.
account	(string) Account. (fk) Allowed value: the natural key of a record of type Account. These records are accessibly through the Accounts service.
paymentMethod	(string) Payment Method. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
party	(string) Party. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.