Jasmin Developers - Web API Reference

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:

All Resources

This service uses the following resources:

GET Operations

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

Response status codes:

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

Resource URL:

GET /financialCore/financialAccountEntries/odata

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

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}

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:

POST /financialCore/financialAccountEntries

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/account

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/amount

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/cashFlowItem

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/currency

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/documentDate

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/exchangeRate

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/financialAccount

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/isActive

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/note

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 /financialCore/financialAccountEntries/{companyKey}/{entryKey}/remarks

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:

PUT /financialCore/financialAccountEntries/{companyKey}/{entryKey}/taxRate

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

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:

DELETE /financialCore/financialAccountEntries/{companyKey}/{entryKey}

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 (MoneyResource) Amount.
See MoneyResource .
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 (MoneyResource) Amount.
See MoneyResource .
isBankAccount (bool) Is Bank Account.
pettyCashAllowsForeignCurrency (bool) Petty Cash Allows Foreign Currency.
generateAccountPending (bool) Pending payment/receivable.
accountedAmount (MoneyResource) Accounted Amount.
See MoneyResource .
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.


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.