ROSE Developers - Web API Reference

Financials | Dimension Balance

The Dimension Balance represents all general ledger account and dimension accumulated transaction and this service manage the common operations of this entity.(RESERVED FOR INTERNAL USE.).

Overview


URL api/{tenantKey}/{orgKey}/financialCore/dimensionBalances
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Dimension Balances With Segments

This operation gets the Balances with dimensions. (RESERVED FOR INTERNAL USE.).

The following elements are required:

companyKey (string) The Company Key.
financialYear (int) The Financial Year.
ledgerKey (string) The Ledger Key.
fromPeriod (int) The inicial period.
toPeriod (int) The final period.

Response:

When successful, the response body contains a list of resources of type 'DimensionBalanceWithSegments'. See DimensionBalanceWithSegments.

Response status codes:

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

Resource URL:

GET /financialCore/dimensionBalances/getDimensionBalancesWithSegments/{companyKey}

GET Get Dimension Balance Pivot Config

This operation gets the Dimension Balances Configurations. (RESERVED FOR INTERNAL USE.).

The following elements are required:

companyKey (string) The Company Key.

Response:

When successful, the response body contains a list of resources of type 'PivotConfiguration'. See PivotConfiguration.

Response status codes:

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

Resource URL:

GET /financialCore/dimensionBalances/getDimensionBalancePivotConfig/{companyKey}

Resources


DimensionBalanceWithSegments

The following elements are optional:

chartOfAccount (string) Chart Of Account.
company (string) Company.
dimensionSet (string) Dimension Set.
period (int) Period.
financialYear (string) Financial Year.
gLAccount (string) GL Account.
ledger (string) Ledger.
totalAmountCreditReporting (decimal) Total Amount Credit Reporting.
totalAmountDebitReporting (decimal) Total Amount Debit Reporting.
chartOfAccountDescription (string) Chart Of Account Description.
companyDescription (string) Company Description.
gLAccountDescription (string) GL Account Description.
ledgerDescription (string) Ledger Description.


PivotConfiguration

The following elements are optional:

caption (string) The Caption.
dataField (string) The data field.
area (string) The area.
dataType (string) The data type.
summaryType (string) The summary type.