Connector API
Search…
Counters

Get all counters

Returns all counters of an enterprise associated with the connector integration.

Request

[PlatformAddress]/api/connector/v1/counters/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0"
5
}
Copied!
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.

Response

1
{
2
"BillCounters": [
3
{
4
"Id": "b7e4b68a-026e-41f3-ad2f-35325aa5dcbf",
5
"Name": "Normal",
6
"IsDefault": false,
7
"Value": 67,
8
"Format": "NORMAL{0:0000}"
9
},
10
{
11
"Id": "403842df-635f-4b6e-8de5-42129201235e",
12
"Name": "Events",
13
"IsDefault": true,
14
"Value": 1575,
15
"Format": "E2018{0:0000}"
16
}
17
],
18
"ProformaCounters": [
19
{
20
"Id": "3362d7d5-a52f-4077-b2b4-4ec2476e6e19",
21
"Name": "Default",
22
"IsDefault": true,
23
"Value": 171,
24
"Format": ""
25
}
26
],
27
"BillPreviewCounters": [
28
{
29
"Id": "1162d7d5-a52f-4077-b2b4-4ec2476e6e19",
30
"Name": "Default",
31
"IsDefault": true,
32
"Value": 911,
33
"Format": ""
34
}
35
],
36
"ServiceOrderCounters": [
37
{
38
"Id": "a9fd7868-1ed0-4e96-8dd9-580708c200ea",
39
"Name": "Default",
40
"IsDefault": true,
41
"Value": 25797,
42
"Format": null
43
}
44
],
45
"RegistrationCardCounters": []
46
}
Copied!
Property
Type
Contract
Description
BillCounters
array of Counter
required
The counters used to count closed Bills.
ProformaCounters
array of Counter
required
The counters used to count Pro Forma invoices for Bills.
BillPreviewCounters
array of Counter
required
The counters used to count bill previews for Bills.
ServiceOrderCounters
array of Counter
required
The counters used to count service orders (for example a Reservation).
RegistrationCardCounters
array of Counter
required
The counters used to count registration cards.

Counter

Property
Type
Contract
Description
Id
string
required
Unique identifier of the counter.
Name
string
required
Name of the counter.
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.