> For the complete documentation index, see [llms.txt](https://docs.mews.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mews.com/connector-api/operations/counters.md). # Counters ## Get all counters Returns all counters of an enterprise associated with the connector integration. Note this operation uses [Pagination](/connector-api/guidelines/pagination.md) and supports [Portfolio Access Tokens](/connector-api/concepts/multi-property.md). ### Request `[PlatformAddress]/api/connector/v1/counters/getAll` ```javascript { "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "UpdatedUtc": { "StartUtc": "2023-10-01T00:00:00Z", "EndUtc": "2023-10-31T00:00:00Z" }, "Type": "Counter", "Limitation": { "Count": 10 } } ``` | Property | Type | Contract | Description | | --------------- | -------------------------------------------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | `EnterpriseIds` | array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. | | `CounterIds` | array of string | optional, max 1000 items | Unique identifiers of the counters. If not specified, the operation returns all counters. | | `Type` | [Counter type discriminator](#counter-type-discriminator) | optional | Type of the counter. If not specified, the operation returns all types. | | `UpdatedUtc` | [Time interval](/connector-api/operations/_objects.md#time-interval) | optional, max length 3 months | Interval in which `Counter` was updated. | | `Limitation` | [Limitation](/connector-api/guidelines/pagination.md#limitation) | required | Limitation on the quantity of data returned and optional Cursor for the starting point of data. | ### Response ```javascript { "Counters": [ { "Id": "b7e4b68a-026e-41f3-ad2f-35325aa5dcbf", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "Normal", "CreatedUtc": "2023-10-01T11:48:57Z", "UpdatedUtc": "2023-10-28T11:48:57Z", "IsDefault": false, "Value": 67, "Format": "NORMAL{0:0000}", "Type": "BillCounter" }, { "Id": "403842df-635f-4b6e-8de5-42129201235e", "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc", "Name": "Events", "IsDefault": true, "CreatedUtc": "2023-10-01T11:48:57Z", "UpdatedUtc": "2023-10-28T11:48:57Z", "Value": 1575, "Format": "E2018{0:0000}", "Type": "BillCounter" }, { "Id": "3362d7d5-a52f-4077-b2b4-4ec2476e6e19", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "Default", "CreatedUtc": "2023-10-01T11:48:57Z", "UpdatedUtc": "2023-10-28T11:48:57Z", "IsDefault": true, "Value": 171, "Format": "", "Type": "ProformaCounter" }, { "Id": "1162d7d5-a52f-4077-b2b4-4ec2476e6e19", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "Default", "CreatedUtc": "2023-10-01T11:48:57Z", "UpdatedUtc": "2023-10-28T11:48:57Z", "IsDefault": true, "Value": 911, "Format": "", "Type": "BillPreviewCounter" }, { "Id": "a9fd7868-1ed0-4e96-8dd9-580708c200ea", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "Default", "CreatedUtc": "2023-10-01T11:48:57Z", "UpdatedUtc": "2023-10-28T11:48:57Z", "IsDefault": true, "Value": 25797, "Format": null, "Type": "ServiceOrderCounter" } ] } ``` | Property | Type | Contract | Description | | ------------------------------ | ------------------------------------ | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Counters` | array of [Counter](#counter) | required | All types of counters. | | `Cursor` | string | optional | 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. | | ~~`BillCounters`~~ | ~~array of~~ [~~Counter~~](#counter) | ~~required~~ | ~~The counters used to count closed `Bills`.~~ **Deprecated!** Use `Counters` instead. | | ~~`ProformaCounters`~~ | ~~array of~~ [~~Counter~~](#counter) | ~~required~~ | ~~The counters used to count Pro Forma invoices for `Bills`.~~ **Deprecated!** Use `Counters` instead. | | ~~`BillPreviewCounters`~~ | ~~array of~~ [~~Counter~~](#counter) | ~~required~~ | ~~The counters used to count bill previews for `Bills`.~~ **Deprecated!** Use `Counters` instead. | | ~~`ServiceOrderCounters`~~ | ~~array of~~ [~~Counter~~](#counter) | ~~required~~ | ~~The counters used to count service orders (for example reservations).~~ **Deprecated!** Use `Counters` instead. | | ~~`RegistrationCardCounters`~~ | ~~array of~~ [~~Counter~~](#counter) | ~~required~~ | ~~The counters used to count registration cards.~~ **Deprecated!** Use `Counters` instead. | #### Counter | Property | Type | Contract | Description | | -------------- | --------------------------------------------------------- | -------- | ---------------------------------------------------------------------------- | | `Id` | string | required | Unique identifier of the counter. | | `EnterpriseId` | string | 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 type discriminator](#counter-type-discriminator) | required | Type of the counter. | | `CreatedUtc` | string | required | Creation date and time of the counter in UTC timezone in ISO 8601 format. | | `UpdatedUtc` | string | required | Last update date and time of the counter in UTC timezone in ISO 8601 format. | #### Counter type discriminator * `Counter` - Any type of counter. * `AccountingCounter` * `AvailabilityBlockCounter` * `BillCounter` * `BillPreviewCounter` * `FiscalCounter` * `ProformaCounter` * `RegistrationCardCounter` * `ServiceOrderCounter` * `CorrectionBillCounter` * `PaymentConfirmationBillCounter` * `CreditNoteBillCounter` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.mews.com/connector-api/operations/counters.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.