Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all counters
  • Request
  • Response

Was this helpful?

  1. API Operations

Counters

PreviousConfigurationNextCountries

Last updated 4 months ago

Was this helpful?

Get all counters

Returns all counters of an enterprise associated with the connector integration. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/counters/getAll

{
    "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

UpdatedUtc

optional, max length 3 months

Type

optional

Type of the counter. If not specified, the operation returns all types.

Limitation

required

Limitation on the quantity of data returned.

Response

{
     "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

required

All types of counters.

BillCounters

required

ProformaCounters

required

BillPreviewCounters

required

ServiceOrderCounters

required

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

RegistrationCardCounters

required

The counters used to count registration cards. Deprecated!

Counter

Property
Type
Contract
Description

Id

string

required

Unique identifier of the counter.

Name

string

required

Name 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.

IsDefault

boolean

required

Whether the counter is used by default.

Value

number

required

Current value the counter.

Format

string

required

Format the counter is displayed in.

Type

optional

Type of the counter.

Counter type discriminator

  • Counter - Any type of counter

  • AvailabilityBlockCounter

  • BillCounter

  • BillPreviewCounter

  • FiscalCounter

  • ProformaCounter

  • RegistrationCardCounter

  • CorrectionBillCounter

  • ServiceOrderCounter

  • PaymentConfirmationBillCounter

  • CreditNoteBillCounter

  • ...

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

Interval in which was updated.

string

array of

array of

The counters used to count closed . Deprecated!

array of

The counters used to count Pro Forma invoices for . Deprecated!

array of

The counters used to count bill previews for . Deprecated!

array of

array of

string

Pagination
Portfolio Access Tokens
Counter
Counter type
Counter
Counter
Counter
Counter
Counter
Counter
Counter type
Limitation
Time interval
Enterprises
Bills
Bills
Bills