Get a report V1

Get a report based on the id provided.

GET/v1/reports/{id}

Authorization

authorization<token>

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

In: header

Path Parameters

idstring

Report id path parameter

Formatuuid

Response Body

curl -X GET "https://api.pragma-project.dev/v1/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08"

curl -X GET "https://api.pragma-project.dev/v1/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "9f3ffd49-7148-469d-ae3e-b34f84e16d33",
  "createdAt": {},
  "updatedAt": {},
  "locationId": "671bd3b3-c942-4989-95ba-76776a6b6cb7",
  "startedAt": {},
  "finalizedAt": {},
  "deviceName": "TestBox",
  "deviceIdentifier": null,
  "reportNumber": 1,
  "guestsNumber": 146,
  "totalSales": 1000,
  "reportHeaderInfo": {
    "headerAddress": "1 rue de la peace man",
    "headerCity": "Paris",
    "headerCountry": "France",
    "headerName": "TestBox",
    "headerPhone": "0123456789",
    "headerNaf": "1234Z",
    "headerSiret": "12345678912345",
    "headerText": "TestBox",
    "headerTva": "FR123456789",
    "headerUrl": "https://testbox.com",
    "headerZip": "75001"
  },
  "reportProducts": [
    {
      "productName": "Porto rouge",
      "productSales": 1000,
      "category": "Aperitifs",
      "subCategory": "Aperitifs",
      "productQuantity": 2,
      "productCatalogId": "57584b5e-fdf4-49a8-b551-bb9a10ec258a"
    }
  ],
  "reportClerksShift": [
    {
      "name": "Boss",
      "id": "6a4b7edf-bfdf-4bb2-9b00-a48e55580aa7",
      "clockInDate": "2024-03-13T14:25:00Z",
      "clockOutDate": "2024-03-13T15:10:00Z"
    }
  ],
  "clerkName": null,
  "clerkId": null,
  "reportDiscounts": [
    {
      "discountName": "Sad Hour",
      "discountValue": 420,
      "discountCatalogId": "57584b5e-fdf4-49a8-b551-bb9a10ec258a"
    }
  ],
  "reportTaxes": [
    {
      "taxName": "TVA 20",
      "taxRate": 2000,
      "taxAmount": 167,
      "taxableAmount": 833
    }
  ],
  "reportPayments": [
    {
      "paymentName": "Credit Card",
      "paymentAmount": 1000
    }
  ],
  "initialCashBalance": 3000,
  "finalCashBalance": 11000,
  "reportEntries": [
    {
      "entryName": "cash fund",
      "entryAmount": 200,
      "entryType": "cash"
    },
    {
      "entryName": "buy pain",
      "entryAmount": -200,
      "entryType": "cash"
    },
    {
      "entryName": "Bank deposit",
      "entryAmount": -2000,
      "entryType": ""
    },
    {
      "entryName": "jean charles",
      "entryAmount": 10000,
      "entryType": "credit card"
    }
  ],
  "orders": [
    "5a1b5429-91b2-4c9f-928c-7c2ec929e10d",
    "a32adb2b-45c3-46f5-b5e5-cfc94c703019",
    "ea154f47-a346-4b3e-99c8-b9d1d342dc02"
  ]
}