Counters
Get all counters
Returns all counters of an enterprise associated with the connector integration. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/counters/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| 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. |
| optional, max length 3 months | Interval in which Counter was updated. | |
| string Counter type | optional | Type of the counter. If not specified, the operation returns all types. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Counter | required | All types of counters. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Counter
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the counter. |
| string | required | Name of the counter. |
| string | required | Creation date and time of the counter in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the counter in UTC timezone in ISO 8601 format. |
| boolean | required | Whether the counter is used by default. |
| number | required | Current value the counter. |
| string | required | Format the counter is displayed in. |
| string Counter type | optional | Type of the counter. |
Counter type discriminator
Counter
- Any type of counterAvailabilityBlockCounter
BillCounter
BillPreviewCounter
FiscalCounter
ProformaCounter
RegistrationCardCounter
ServiceOrderCounter
...
Last updated