ROSE Developers - Web API Reference

Financials | Account Determination

The Ffinancial Account Determination represents a general ledger accounts configuration for a chart of account.

Overview


URL api/{tenantKey}/{orgKey}/financialCore/financialAccountDeterminations
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 FinancialAccountDeterminations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/financialAccountDeterminations

GET FinancialAccountDeterminations (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 FinancialAccountDeterminationResource.

Response status codes:

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

Resource URL:

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

GET FinancialAccountDetermination 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 FinancialAccountDeterminationResource.

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

GET FinancialAccountDetermination by key

Returns the entity record that matches the specified key.

The following elements are required:

chartOfAccount (string) The chart of accounts.

Response:

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

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/financialAccountDeterminations/{chartOfAccount}

GET Print FinancialAccountDetermination 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 /financialCore/financialAccountDeterminations/{id}/print?template={template}

GET Print FinancialAccountDetermination by key

Prints the specified entity record.

The following elements are required:

chartOfAccount (string) The chart of accounts.

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 /financialCore/financialAccountDeterminations/{chartOfAccount}/print

GET Original Print FinancialAccountDeterminationOriginal 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 /financialCore/financialAccountDeterminations/{id}/printOriginal?template={template}

GET Original Print FinancialAccountDetermination by key

Prints the specified entity record.

The following elements are required:

chartOfAccount (string) The chart of accounts.

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 /financialCore/financialAccountDeterminations/{chartOfAccount}/printOriginal

POST Operations

POST FinancialAccountDeterminations

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /financialCore/financialAccountDeterminations

PUT Operations

PUT Set AssetAquisitionClearingAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/assetAquisitionClearingAccount

PUT Set AssetSaleClearingAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/assetSaleClearingAccount

PUT Set DiscountGivenAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/discountGivenAccount

PUT Set DiscountReceivedAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/discountReceivedAccount

PUT Set ExchRateGainAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/exchRateGainAccount

PUT Set ExchRateLossAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/exchRateLossAccount

PUT Set IsActive FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/isActive

PUT Set RetainedEarningsAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/retainedEarningsAccount

PUT Set RoundingGainAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/roundingGainAccount

PUT Set RoundingLossAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/roundingLossAccount

PUT Set YTDNetIncomeAccount FinancialAccountDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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/financialAccountDeterminations/{chartOfAccount}/yTDNetIncomeAccount

DELETE Operations

DELETE FinancialAccountDetermination 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/financialAccountDeterminations/{id}

DELETE FinancialAccountDetermination by key

Deletes the entity record that matches the specified key.

The following elements are required:

chartOfAccount (string) The chart of accounts.

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/financialAccountDeterminations/{chartOfAccount}

Resources


ApiFinancialAccountDeterminationResource

The following elements are required:

chartOfAccount (string) The chart of accounts.
roundingGainAccount (string) The account to be used when occurs a gain in rounding from the settlement process.
roundingLossAccount (string) The account to be used when occurs a loss in rounding from the settlement process.
discountGivenAccount (string) The account to be used when the user gives a discount to a customer in the settlement process.
discountReceivedAccount (string) The account to be used when the user receives a discount from a vendor in the settlement process.
exchRateGainAccount (string) The account to be used when occurs a gain in exchange rates differences from the settlement process.
exchRateLossAccount (string) The account to be used when occurs a loss in exchange rates differences from the settlement process.
yTDNetIncomeAccount (string) The year to date net income account.
retainedEarningsAccount (string) The retained earnings account to be used in the year end process.

The following elements are optional:

assetAquisitionClearingAccount (string) Asset Aquisition Clearing Account.
assetSaleClearingAccount (string) Asset Sale Clearing Account.


FinancialAccountDeterminationResource

The following elements are required:

chartOfAccount (string) The chart of accounts.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
roundingGainAccount (string) The account to be used when occurs a gain in rounding from the settlement process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
roundingLossAccount (string) The account to be used when occurs a loss in rounding from the settlement process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
discountGivenAccount (string) The account to be used when the user gives a discount to a customer in the settlement process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
discountReceivedAccount (string) The account to be used when the user receives a discount from a vendor in the settlement process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
exchRateGainAccount (string) The account to be used when occurs a gain in exchange rates differences from the settlement process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
exchRateLossAccount (string) The account to be used when occurs a loss in exchange rates differences from the settlement process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
yTDNetIncomeAccount (string) The year to date net income account.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
retainedEarningsAccount (string) The retained earnings account to be used in the year end process.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.

The following elements are optional:

assetAquisitionClearingAccount (string) Asset Aquisition Clearing Account.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
assetSaleClearingAccount (string) Asset Sale Clearing Account.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.