---
title: "Balance:Year"
method: GET
path: "/v2/balance/year"
tags: ["Balance"]
---

# Balance:Year

`GET /v2/balance/year`

This API gives an end of year overview

## Query parameters

- `merchant` object
  - `eq` string — Get results that equal the given value
- `turnoverGroup` object
  - `in` string — Filter by turnover group codes (comma-separated, must exist and have authorization)
- `year` object
  - `eq` integer — Filter by exact year match (current year or within past 3 years)
- `month` object
  - `eq` string — Filter by exact month match (01-12)
- `day` object
  - `eq` integer — Filter by exact day match (01-31)

## Response `200`

OK

- BalanceYearOutput — This API gives an end of year overview
  - `merchant` BalanceYearOutputMerchant
    - `code` string — The merchant id of your company starting with M.
    - `name` string — The name of the merchant.
    - `status` 'ACTIVE' | 'INACTIVE' — The status of the merchant.
    - `contractPackage` string — The contract package of the merchant.
  - `turnoverGroups` BalanceYearOutputTurnoverGroup[]
    - `code` string — The CT-code for a turn over group.
    - `name` string — New Turnover Group for Great Cookies Inc.
  - `paymentMethodGroups` BalanceYearOutputPaymentMethodGroup[] — Collection of payment method groups with their statistics
    - `tag` string — The tag identifier for the payment method group.
    - `name` string — The name of the payment method group.
    - `sequence` integer — The sequence order of the payment method group
    - `paymentMethodBrands` BalanceYearOutputPaymentMethodGroupPaymentMethodBrand[] — Collection of payment method brands within this group
      - `id` integer — The identifier for the payment method brand
      - `name` string — The name of the payment method brand
      - `sequence` integer — The sequence order of the payment method brand
      - `paymentMethods` BalanceYearOutputPaymentMethodGroupPaymentMethodBrandPaymentMethod[] — Collection of payment methods within this brand
        - `id` integer — The ID of the payment option e.g. iDEAL is 10
        - `name` string — The name of the payment method
        - `direction` string — The direction of the payment. (DEBIT or CREDIT)
        - `collecting` boolean — Whether the payment method is collecting payments
        - `paymentType` string — The type of payment (e.g., sale, refund)
        - `amount` AmountOutput — A monetary amount with its value in cents and currency in ISO-4217 format.
          - `value` integer — The amount value in cents
          - `currency` string — The currency in ISO-4217 format
        - `costs` BalanceCostsOutput
          - `value` integer — The cost value in cents.
          - `currency` string — The currency in ISO-4217 format.
          - `vatPercentage` integer — The VAT percentage.
        - `releaseDate` string, date-time — The date and time at which the funds will be released in ISO-8601 (ATOM) notation
        - `turnoverDate` string, date-time — The turnover date (transaction date)
        - `transactions` integer — The number of transactions
        - `uniquePayers` integer — The number of unique payers

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/versions/2bc260c7bdfc/schema)