Logo PopinaPopina API

Create a new till from POS

Create a new till coming from the POS.

POST/v2/tills/

Authorization

authorization<token>

To get an API key, please contact us. We'll be happy to help you.

In: header

Query Parameters

locationId?string

Location id query parameter

Formatuuid

Request Body

idstring

Till unique identifier of the client

Formatuuid
notestring|null
establishmentNamestring

Till ticket name

siretCodestring

Till ticket company's SIRET code

countrystring

Till ticket country

citystring

Till ticket city

zipCodestring

Till ticket zip code (e.g.: "33270")

address1string

Till ticket address 1

address2string|null
phoneNumberstring|null
websitestring|null
tvaCodestring

Till ticket VAT code

nafCodestring

Till ticket NAF code

customHeaderstring|null
customFooterstring|null
logoUrlstring|null
companyNamestring

Till ticket company name

deviceNamestring

Till device name

deviceIdentifierstring
isTrainingboolean

Training till (school mode)

startedAtstring

Till start date

Formatdate-time
finalizedAtstring

Till end date

Formatdate-time
reportNumberinteger

Till fiscal number

Range0 <= value
localestring

Till's locale

clerkNamestring

Employee's name who closed the till

clerkIdstring

Employee's name who closed the till

Formatuuid
initialCashBalanceinteger|null
finalCashBalanceinteger|null
financialMovementList

Till financial movements

declaredPaymentList

Till total payments

clerkShiftList

Till clerks shift list

orderList

Response Body

application/json

curl -X POST "https://api.pragma-project.dev/v2/tills/" \  -H "Content-Type: application/json" \  -d '{    "id": "B8DC389A-2F38-4C22-8E24-7B03F727FF76",    "deviceName": "François\'s MacBook Pro",    "deviceIdentifier": "d85074d5-0b77-4214-aef7-0c37b0a560b7",    "startedAt": "2024-02-06T09:43:09+01:00",    "finalizedAt": "2024-02-06T09:43:23+01:00",    "note": "Démonstration \n   ",    "reportNumber": 1,    "establishmentName": "Jalia Démo",    "address1": "3 rue Théodore Blanc",    "address2": "Appt 2",    "customHeader": "Démonstration \n   ",    "siretCode": "35075312500235",    "phoneNumber": "05 56 43 26 37",    "zipCode": "33520",    "city": "Bruges",    "country": "France",    "website": "www.jdc.fr",    "nafCode": "5610A",    "tvaCode": "FR89350753125",    "orderList": [      {        "id": "D3B5125E-F206-458A-8F18-F1332B774FBA",        "tillId": "B8DC389A-2F38-4C22-8E24-7B03F727FF76",        "roomId": "be993bcb-c1db-4ef6-af70-070b4ef8a148",        "revisionHash": "b8dc389a-2f38-4c22-8e24-7b03f727ff76",        "deviceIdentifier": "d85074d5-0b77-4214-aef7-0c37b0a560b7",        "openedAt": "2024-02-06T09:43:09+01:00",        "modifiedAt": "2024-02-06T09:43:09+01:00",        "closedAt": "2024-02-06T09:43:23+01:00",        "paidAt": "2024-02-06T09:43:23+01:00",        "canceledAt": null,        "transferredAt": null,        "firstBillPrintDate": "2024-02-06T09:43:23+01:00",        "postPaymentPrintDate": null,        "total": 1550,        "totalTax": 100,        "totalDiscount": 0,        "totalWithoutTax": 1450,        "leftToPay": 0,        "guestsCount": 2,        "billPrintCount": 1,        "proofsOfPaymentCount": 1,        "postPaymentPrintCount": 0,        "roomName": "Salle",        "roomType": "room",        "roomPricing": "normal",        "tableId": "c6622e74-9b71-4160-b877-221eac7a2eb3",        "tableName": "Table 7",        "tablePosX": 1,        "tablePosY": 1,        "tableShape": "square",        "beeperNumber": -1,        "deviceName": "SKT 1",        "comment": null,        "preparationActivated": false,        "isMerged": false,        "manuallyClosed": false,        "isPaid": true,        "isPrepaid": false,        "isCanceled": false,        "canceledReason": null,        "fiscalNumber": 69420,        "signature": "MEUCIQDDHTjTEuYvo1bMkpGtsA+QCBPFBdCfO530LzrYaqTwZwIgD7k7ZKDVLKbPSqk0wZtubTRmuCFaI7Q2MkPZ9Zr1j6g=",        "operatorId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",        "operatorName": "Gérant",        "firebaseCustomerName": null,        "firebaseCustomerRefKey": null,        "firebaseReservationRefKey": null,        "bookingId": null,        "customerId": null,        "isTraining": false,        "isTransferred": false,        "transferredTo": null,        "externalServiceId": null,        "extOctorateReservationId": null,        "extQoodosCheckInId": null,        "extQoodosUserId": null,        "extQoodosUserName": null,        "pickupHour": null,        "groupedTableInfo": [],        "channel": "unknown",        "serviceType": "unknown",        "customerInfo": null,        "deliveryAddress": null,        "deliveryComment": null,        "deliveryCustomerInfo": null,        "source": "unknown",        "externalLocationId": null,        "externalOrderId": null,        "productRowList": [          {            "id": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",            "parentProductRowId": null,            "comboParentId": null,            "productId": "3480cde6-1722-4a18-bfb5-6b0145f50a0b",            "categoryId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",            "taxId": "a5d6c5d2-1c68-446b-badd-30b6d38e43c8",            "priceId": "07512bce-9737-4158-bb6b-749e285b9faf",            "operatorId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",            "pricingId": "3a410007-93a8-4742-882f-3efbc30c0cf0",            "deviceIdentifier": "d85074d5-0b77-4214-aef7-0c37b0a560b7",            "recordedAt": "2024-02-06T09:43:09+01:00",            "modifiedAt": "2024-02-06T09:43:09+01:00",            "reclaimedAt": null,            "transmittedAt": null,            "orderedAt": "2024-02-06T09:43:09+01:00",            "taxName": "TVA 10%",            "taxRate": 10,            "taxAmount": 100,            "taxableAmount": 1500,            "subCategoryId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",            "subCategoryName": "Boissons",            "categoryCatalogColor": "colorBlue",            "categoryName": "Boissons",            "unitPriceRow": 1500,            "unitPriceRowWithModifier": 1500,            "totalRowWithModifier": 1500,            "totalDiscount": 0,            "totalRow": 1500,            "quantity": 1,            "weight": null,            "pricingName": "Prix normal",            "pricingType": "normal",            "deviceName": "SKT 1",            "operatorName": "Gérant",            "name": "Coca-Cola",            "canceledReason": null,            "transferredTo": null,            "isTransferred": false,            "comment": null,            "isMerged": false,            "isCustomPrice": false,            "validated": true,            "isCanceled": false,            "currencyCode": "EUR",            "menuStepName": null,            "menuStepIndex": null,            "sku": null,            "isLoss": false,            "lossReason": null,            "modifierRowList": [],            "discountRowList": []          }        ],        "menuRowList": [          {            "id": "3f6aab07-1ae5-4b78-8d70-368ca0cd46be",            "recordedAt": "2024-02-06T09:43:09+01:00",            "modifiedAt": "2024-02-06T09:43:09+01:00",            "unitPriceRow": 1450,            "totalRow": 1450,            "currencyCode": "EUR",            "amountToAdd": 0,            "amountToSubtract": 0,            "pricingId": "3a410007-93a8-4742-882f-3efbc30c0cf0",            "menuId": "3480cde6-1722-4a18-bfb5-6b0145f50a0b",            "pricingName": "Prix normal",            "pricingType": "normal",            "name": "Menu Coca-Cola",            "parentMenuRowId": null,            "productRowList": [              {                "id": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",                "parentProductRowId": null,                "comboParentId": null,                "productId": "3480cde6-1722-4a18-bfb5-6b0145f50a0b",                "categoryId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",                "taxId": "a5d6c5d2-1c68-446b-badd-30b6d38e43c8",                "priceId": "07512bce-9737-4158-bb6b-749e285b9faf",                "operatorId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",                "pricingId": "3a410007-93a8-4742-882f-3efbc30c0cf0",                "deviceIdentifier": "d85074d5-0b77-4214-aef7-0c37b0a560b7",                "recordedAt": "2024-02-06T09:43:09+01:00",                "modifiedAt": "2024-02-06T09:43:09+01:00",                "reclaimedAt": null,                "transmittedAt": null,                "orderedAt": "2024-02-06T09:43:09+01:00",                "taxName": "TVA 10%",                "taxRate": 10,                "taxAmount": 100,                "taxableAmount": 1500,                "subCategoryId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",                "subCategoryName": "Boissons",                "categoryCatalogColor": "colorBlue",                "categoryName": "Boissons",                "unitPriceRow": 1500,                "unitPriceRowWithModifier": 1600,                "totalRowWithModifier": 1450,                "totalDiscount": 150,                "totalRow": 1500,                "quantity": 1,                "weight": null,                "pricingName": "Prix normal",                "pricingType": "normal",                "deviceName": "SKT 1",                "operatorName": "Gérant",                "name": "Coca-Cola",                "canceledReason": null,                "transferredTo": null,                "isTransferred": false,                "comment": null,                "isMerged": false,                "isCustomPrice": false,                "validated": true,                "isCanceled": false,                "currencyCode": "EUR",                "menuStepName": "COCA-COLA",                "menuStepIndex": 1,                "sku": null,                "isLoss": false,                "lossReason": null,                "modifierRowList": [                  {                    "modifierId": "910273dc-974c-40cb-9b9f-a8d46b152503",                    "modifiedAt": "2024-02-06T09:43:09+01:00",                    "recordedAt": "2024-02-06T09:43:09+01:00",                    "modifierGroupId": "cd5834a3-8777-45e0-b12f-0eeb5f477fca",                    "modifierGroupName": "Coca Modifier",                    "amount": 100,                    "name": "Supplément choléstérol",                    "modifierGroupIndex": 1,                    "modifierIndex": 0                  }                ],                "discountRowList": [                  {                    "id": "71009f4d-45b5-4db8-b53c-cb0e0a6f54bf",                    "name": "Réduction 10%",                    "amount": 150,                    "discountGroupId": "cd5834a3-8777-45e0-b12f-0eeb5f477fca",                    "discountId": "cd5834a3-8777-45e0-b12f-0eeb5f477fca",                    "modifiedAt": "2024-02-06T09:43:09+01:00",                    "recordedAt": "2024-02-06T09:43:09+01:00",                    "splitAllowed": false,                    "status": "validated",                    "couponCode": null,                    "rewardId": null,                    "extQoodosCheckInId": null                  }                ]              }            ]          }        ],        "paymentRowList": [          {            "id": "9215d649-27c9-4b25-9031-e2dcd34e2302",            "recordedAt": "2024-02-06T09:43:09+01:00",            "modifiedAt": "2024-02-06T09:43:09+01:00",            "amount": 2950,            "changeAmount": 0,            "changePaymentMode": null,            "currencyCode": "EUR",            "name": "Carte de crédit",            "paymentMode": "card",            "paymentType": "payment",            "paymentId": "6b5f0075-1c30-4852-a05c-f5c92fbad5b2",            "tipAmount": 0,            "status": "validated",            "totalProofOfPaymentAmount": 1,            "lastProofOfPaymentAmount": 1,            "buyerCardReceipt": null,            "changePaymentId": null,            "changePaymentName": null,            "externalServiceId": null,            "firebaseCustomerRefKey": null,            "operatorId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",            "operatorName": "Gérant",            "sellerCardReceipt": null,            "paymentProtocol": "payxpert"          }        ]      }    ],    "clerkShiftList": [      {        "name": "Gérant",        "id": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",        "clockInDate": "2024-02-06T09:43:09+01:00",        "clockOutDate": "2024-02-06T09:43:23+01:00"      }    ],    "clerkName": "Gérant",    "clerkId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",    "declaredPaymentList": [      {        "paymentMode": "card",        "paymentAmount": 1550,        "quantity": 1,        "paymentId": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",        "paymentName": "Carte de crédit"      }    ],    "financialMovementList": [],    "initialCashBalance": 0,    "finalCashBalance": 0,    "customFooter": "Démonstration \n   ",    "logoUrl": "https://www.jdc.fr/logo.png",    "companyName": "Jalia Démo",    "isTraining": false,    "locale": "fr_FR"  }'
{
  "tillId": "19818646-df1d-4c99-b178-4fe04bb8d522"
}

Create a new till POST

Previous Page

Fetch a location tills status GET

Next Page