Skip to content

ledgerBalances_getAll

POST
/api/connector/v1/ledgerBalances/getAll

Returns opening & closing balances of all specified ledgers for each day in the specified interval.

LedgerBalanceParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
Date
required

Date interval over which the ledger balances are created.

object
Start
required
string format: date
>= 1 characters
End
required
string format: date
>= 1 characters
LedgerTypes
required

Accounting ledger types to which ledger balances belong.

Array<string>
>= 1 items unique items
Allowed values: Revenue Tax Payment Deposit Guest City NonRevenue

OK

LedgerBalanceResult
object
LedgerBalances
required

The list of filtered ledger balances.

Array<object>
nullable
LedgerBalance

Ledger balance

object
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
Date
required

Day for which ledger balance applies in ISO 8601 format.

string format: date
>= 1 characters
LedgerType
required
Accounting ledger type

Type of accounting ledger.

Revenue

Tax

Payment

Deposit

Guest

City

NonRevenue

string
Allowed values: Revenue Tax Payment Deposit Guest City NonRevenue
OpeningBalance
required
Amount

Ledger opening balance at the start of the day.

object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
ClosingBalance
required
Amount

Ledger closing balance at the end of the day.

object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
Cursor

Unique identifier of the last and hence oldest ledger balance returned. This can be used in Limitation in a subsequent request to fetch the next batch of ledger balances.

string format: uuid
nullable

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable