v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Point of Sale

Objectives

Get objectives

Return the total amount and the tax amount for a specific period

get/consumers/{consumer_id}/pos/objectives

consumer_idstring uuid required

pageinteger

Page number

sizeinteger

Page size

date_fromstring date required

Start date (inclusive) of the period to get payments from

date_tostring date required

End date (inclusive) of the period to get payments from

location_idstring nullable

Unique identifier of the location. If none passed, objectives from all locations will be returned unless the location was selected by the end-user

Successful Response

totalinteger required

pageinteger required

sizeinteger required

{
  "items": [
    {
      "total": 10,
      "tax_amount": 1,
      "date": "2025-01-01"
    }
  ]
}