Skip to content
Mews Open API

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 and supports Portfolio Access Tokens.

Request Body

Section titled “Request Body ”
CounterFilterParameters
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
CounterIds

Unique identifiers of the counters. If not specified, the operation returns all counters.

Array<string>
nullable >= 1 items <= 1000 items
Type
Any of:
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
UpdatedUtc
TimeFilterInterval

Interval in which Counter was updated.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
Example
{
  "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
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

CounterResult
object
Counters
required

All types of counters.

Array<object>
Counter
object
Id
required

Unique identifier of the counter.

string format: uuid
EnterpriseId
required

Unique identifier of the enterprise to which the counter belongs.

string format: uuid
Name
required

Name of the counter.

string
>= 1 characters
IsDefault
required

Whether the counter is used by default.

boolean
Value
required

Current value of the counter.

integer format: int64
Format
required

Display format of the counter.

string
>= 1 characters
Type
required
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
CreatedUtc
required

Creation date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
BillCounters
required

The counters used to count closed Bills.

Array<object>
Counter
object
Id
required

Unique identifier of the counter.

string format: uuid
EnterpriseId
required

Unique identifier of the enterprise to which the counter belongs.

string format: uuid
Name
required

Name of the counter.

string
>= 1 characters
IsDefault
required

Whether the counter is used by default.

boolean
Value
required

Current value of the counter.

integer format: int64
Format
required

Display format of the counter.

string
>= 1 characters
Type
required
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
CreatedUtc
required

Creation date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
ProformaCounters
required

The counters used to count Pro Forma invoices for Bills.

Array<object>
Counter
object
Id
required

Unique identifier of the counter.

string format: uuid
EnterpriseId
required

Unique identifier of the enterprise to which the counter belongs.

string format: uuid
Name
required

Name of the counter.

string
>= 1 characters
IsDefault
required

Whether the counter is used by default.

boolean
Value
required

Current value of the counter.

integer format: int64
Format
required

Display format of the counter.

string
>= 1 characters
Type
required
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
CreatedUtc
required

Creation date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
BillPreviewCounters
required

The counters used to count bill previews for Bills.

Array<object>
Counter
object
Id
required

Unique identifier of the counter.

string format: uuid
EnterpriseId
required

Unique identifier of the enterprise to which the counter belongs.

string format: uuid
Name
required

Name of the counter.

string
>= 1 characters
IsDefault
required

Whether the counter is used by default.

boolean
Value
required

Current value of the counter.

integer format: int64
Format
required

Display format of the counter.

string
>= 1 characters
Type
required
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
CreatedUtc
required

Creation date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
ServiceOrderCounters
required

The counters used to count service orders (for example reservations).

Array<object>
Counter
object
Id
required

Unique identifier of the counter.

string format: uuid
EnterpriseId
required

Unique identifier of the enterprise to which the counter belongs.

string format: uuid
Name
required

Name of the counter.

string
>= 1 characters
IsDefault
required

Whether the counter is used by default.

boolean
Value
required

Current value of the counter.

integer format: int64
Format
required

Display format of the counter.

string
>= 1 characters
Type
required
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
CreatedUtc
required

Creation date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
RegistrationCardCounters
required

The counters used to count registration cards.

Array<object>
Counter
object
Id
required

Unique identifier of the counter.

string format: uuid
EnterpriseId
required

Unique identifier of the enterprise to which the counter belongs.

string format: uuid
Name
required

Name of the counter.

string
>= 1 characters
IsDefault
required

Whether the counter is used by default.

boolean
Value
required

Current value of the counter.

integer format: int64
Format
required

Display format of the counter.

string
>= 1 characters
Type
required
Counter type discriminator

Type of the counter.

string
Allowed values: Counter AccountingCounter AvailabilityBlockCounter BillCounter BillPreviewCounter FiscalCounter ProformaCounter RegistrationCardCounter ServiceOrderCounter CorrectionBillCounter PaymentConfirmationBillCounter CreditNoteBillCounter
CreatedUtc
required

Creation date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the counter in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Cursor

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.

string format: uuid
nullable
Example
{
  "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"
    }
  ]
}

204

Section titled “204 ”

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

400

Section titled “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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

401

Section titled “401 ”

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

403

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

408

Section titled “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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

429

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

500

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable