---
title: "Get all counters"
method: POST
path: "/api/connector/v1/counters/getAll"
tags: ["Counters"]
---

# Get all counters

`POST /api/connector/v1/counters/getAll`

Returns all counters of an enterprise associated with the connector integration.
Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).

## Request body

- CounterFilterParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `Limitation` Limitation, required — Limitation on the quantity of data returned.
    - `Count` integer, required
    - `Cursor` string, uuid, nullable
  - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
  - `CounterIds` string[], nullable — Unique identifiers of the counters. If not specified, the operation returns all counters.
  - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter' — Type of the counter.
  - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable

## Response `200`

OK

- CounterResult
  - `Counters` Counter[], required — All types of counters.
    - `Id` string, uuid, required — Unique identifier of the counter.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise to which the counter belongs.
    - `Name` string, required — Name of the counter.
    - `IsDefault` boolean, required — Whether the counter is used by default.
    - `Value` integer, required — Current value of the counter.
    - `Format` string, required — Display format of the counter.
    - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter', required — Type of the counter.
    - `CreatedUtc` string, date-time, required — Creation date and time of the counter in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the counter in UTC timezone in ISO 8601 format.
  - `BillCounters` Counter[], required — The counters used to count closed `Bills`.
    - `Id` string, uuid, required — Unique identifier of the counter.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise to which the counter belongs.
    - `Name` string, required — Name of the counter.
    - `IsDefault` boolean, required — Whether the counter is used by default.
    - `Value` integer, required — Current value of the counter.
    - `Format` string, required — Display format of the counter.
    - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter', required — Type of the counter.
    - `CreatedUtc` string, date-time, required — Creation date and time of the counter in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the counter in UTC timezone in ISO 8601 format.
  - `ProformaCounters` Counter[], required — The counters used to count Pro Forma invoices for `Bills`.
    - `Id` string, uuid, required — Unique identifier of the counter.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise to which the counter belongs.
    - `Name` string, required — Name of the counter.
    - `IsDefault` boolean, required — Whether the counter is used by default.
    - `Value` integer, required — Current value of the counter.
    - `Format` string, required — Display format of the counter.
    - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter', required — Type of the counter.
    - `CreatedUtc` string, date-time, required — Creation date and time of the counter in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the counter in UTC timezone in ISO 8601 format.
  - `BillPreviewCounters` Counter[], required — The counters used to count bill previews for `Bills`.
    - `Id` string, uuid, required — Unique identifier of the counter.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise to which the counter belongs.
    - `Name` string, required — Name of the counter.
    - `IsDefault` boolean, required — Whether the counter is used by default.
    - `Value` integer, required — Current value of the counter.
    - `Format` string, required — Display format of the counter.
    - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter', required — Type of the counter.
    - `CreatedUtc` string, date-time, required — Creation date and time of the counter in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the counter in UTC timezone in ISO 8601 format.
  - `ServiceOrderCounters` Counter[], required — The counters used to count service orders (for example reservations).
    - `Id` string, uuid, required — Unique identifier of the counter.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise to which the counter belongs.
    - `Name` string, required — Name of the counter.
    - `IsDefault` boolean, required — Whether the counter is used by default.
    - `Value` integer, required — Current value of the counter.
    - `Format` string, required — Display format of the counter.
    - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter', required — Type of the counter.
    - `CreatedUtc` string, date-time, required — Creation date and time of the counter in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the counter in UTC timezone in ISO 8601 format.
  - `RegistrationCardCounters` Counter[], required — The counters used to count registration cards.
    - `Id` string, uuid, required — Unique identifier of the counter.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise to which the counter belongs.
    - `Name` string, required — Name of the counter.
    - `IsDefault` boolean, required — Whether the counter is used by default.
    - `Value` integer, required — Current value of the counter.
    - `Format` string, required — Display format of the counter.
    - `Type` 'Counter' | 'AccountingCounter' | 'AvailabilityBlockCounter' | 'BillCounter' | 'BillPreviewCounter' | 'FiscalCounter' | 'ProformaCounter' | 'RegistrationCardCounter' | 'ServiceOrderCounter' | 'CorrectionBillCounter' | 'PaymentConfirmationBillCounter' | 'CreditNoteBillCounter' | 'PaymentSplitBillCounter', required — Type of the counter.
    - `CreatedUtc` string, date-time, required — Creation date and time of the counter in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the counter in UTC timezone in ISO 8601 format.
  - `Cursor` string, uuid, nullable — Unique identifier of the last returned counter in `Counters`. This can be used in Limitation in a subsequent request to fetch the next batch of counters.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — 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).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — 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.
- `408` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — 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](https://github.com/MewsSystems/gitbook-connector-api).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/4bf95cbc375f/schema)
