Skip to content

Latest commit

 

History

History
80 lines (69 loc) · 3.3 KB

cashiers.md

File metadata and controls

80 lines (69 loc) · 3.3 KB

Cashiers

Get all cashiers

Returns all cashiers. Note this operation uses Pagination and supports Portfolio Access Tokens.

Request

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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "Ids": [
    "9a36e3fa-2299-474b-a8a2-5ea4da317abc"
  ],
  "UpdatedUtc": {
    "StartUtc": "2023-10-01T00:00:00Z",
    "EndUtc": "2023-10-31T00:00:00Z"
  },
  "ActivityStates": [
    "Active"
  ],
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "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.
Ids array of string optional, max 1000 items Unique identifiers of the requested Cashier.
UpdatedUtc Time interval optional, max length 3 months Interval in which Cashier was updated.
ActivityStates array of Activity state optional Whether to return only active, only deleted or both records.
Limitation Limitation required Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "Cashiers": [
    {
      "Id": "9a36e3fa-2299-474b-a8a2-5ea4da317abc",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "IsActive": true,
      "Name": "Main Cashier",
      "CreatedUtc": "2023-10-01T11:48:57Z",
      "UpdatedUtc": "2023-10-28T11:48:57Z"
    }
  ],
  "Cursor": "0b9560fb-055d-47d3-a6d4-e579c44ca558"
}
Property Type Contract Description
Cashiers array of Cashier required Cashiers in the enterprise.
Cursor string optional Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Cashier

Property Type Contract Description
Id string required Unique identifier of the cashier.
EnterpriseId string required Unique identifier of the Enterprise.
IsActive boolean required Whether the cashier is still active.
Name string required Name of the cashier.
CreatedUtc string required Creation date and time of the Cashier in UTC timezone in ISO 8601 format.
UpdatedUtc string required Last update date and time of the Cashier in UTC timezone in ISO 8601 format.