Get a report by id V2
Get a report based on the id provided.
GET
/v2/reports/{id}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
Format
uuidQuery Parameters
locationId?string
Location id query parameter
Format
uuidResponse Body
application/json
curl -X GET "https://api.pragma-project.dev/v2/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"tillId": "19818646-df1d-4c99-b178-4fe04bb8d522",
"startedAt": "2019-08-24T14:15:22Z",
"finalizedAt": "2019-08-24T14:15:22Z",
"deviceName": "string",
"deviceIdentifier": "string",
"reportNumber": -9007199254740991,
"guestsNumber": 0,
"totalSales": -9007199254740991,
"clerkName": "string",
"clerkId": "e4c300eb-72bd-4c32-893b-3e60750f0575",
"initialCashBalance": -9007199254740991,
"finalCashBalance": -9007199254740991,
"orderCount": 0,
"establishmentName": "string",
"siretCode": "string",
"customHeader": "string",
"customFooter": "string",
"companyName": "string",
"phoneNumber": "string",
"website": "string",
"locale": "ff_Adlm_GN",
"address1": "string",
"address2": "string",
"logoUrl": "string",
"zipCode": "string",
"tvaCode": "string",
"country": "string",
"nafCode": "string",
"city": "string",
"note": "string",
"reportRecordedPayments": [
{
"quantity": 1,
"totalAmount": -9007199254740991,
"changeAmount": -9007199254740991,
"tipsAmount": -9007199254740991,
"name": "string",
"paymentMode": "cash",
"paymentType": "payment"
}
],
"reportCancellations": [
{
"quantity": 1,
"amount": -9007199254740991,
"afterFinalization": true,
"name": "string",
"productList": [
{
"name": "string",
"quantity": -9007199254740991,
"amount": -9007199254740991
}
]
}
],
"reportTransferred": [
{
"amount": 0,
"quantity": 1,
"name": "string"
}
],
"reportModifiers": [
{
"quantity": 1,
"groupName": "string",
"amount": -9007199254740991,
"name": "string"
}
],
"reportEntries": [
{
"entryCatalogId": "699f6eae-8d0c-4a41-bd0d-c7a0b71cc2be",
"entryAmount": 0,
"deviceIdentifier": "string",
"recordedAt": "2019-08-24T14:15:22Z",
"entryName": "string",
"operatorName": "string",
"operatorId": "string",
"currencyCode": "string",
"entryType": "string",
"paymentMode": "cash",
"deviceName": "string",
"paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
"paymentName": "string",
"customerId": "string",
"customerName": "string"
}
],
"reportDiscounts": [
{
"discountName": "string",
"discountValue": 0,
"discountCatalogId": "4be36738-13fb-4cd2-8b4e-bfc3bc082b03",
"quantity": 1,
"vatAmount": -9007199254740991,
"gifted": true,
"taxRepartition": [
{
"quantity": 1,
"discountValue": -9007199254740991,
"taxableAmount": -9007199254740991,
"taxAmount": -9007199254740991,
"taxName": "string",
"taxRate": 0
}
],
"productList": [
{
"name": "string",
"quantity": -9007199254740991,
"VATAmount": -9007199254740991,
"discountValue": -9007199254740991
}
]
}
],
"reportProducts": [
{
"productCatalogId": "4269f01b-f9e3-4367-a846-5d3c63fd34bc",
"productQuantity": 1,
"productSales": 0,
"excludingTax": 0,
"inMenu": true,
"subCategory": "string",
"productName": "string",
"category": "string",
"sku": "string",
"pricingList": [
{
"pricing": "string",
"quantity": 0,
"sales": 0,
"excludingTax": 0
}
],
"modifierList": [
{
"modifierName": "string",
"modifierGroupName": "string",
"quantity": 0,
"amount": -9007199254740991
}
]
}
],
"reportClerksShift": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clockInDate": "2019-08-24T14:15:22Z",
"clockOutDate": "2019-08-24T14:15:22Z",
"name": "string",
"orderCount": 0,
"guestCount": 0,
"totalDiscount": 0,
"quantityDiscounted": 0,
"cancellations": [
{
"name": "string",
"quantity": 1,
"amount": -9007199254740991,
"afterFinalization": true
}
],
"paymentsOwner": [
{
"name": "string",
"quantity": 1,
"amount": -9007199254740991,
"amountWithGuests": -9007199254740991,
"tipsAmount": -9007199254740991,
"changeAmount": -9007199254740991,
"paymentType": "payment",
"paymentMode": "cash"
}
],
"paymentsOperator": [
{
"name": "string",
"quantity": 1,
"amount": -9007199254740991,
"amountWithGuests": -9007199254740991,
"tipsAmount": -9007199254740991,
"changeAmount": -9007199254740991,
"paymentType": "payment",
"paymentMode": "cash"
}
],
"losses": [
{
"name": "string",
"quantity": 1,
"amount": -9007199254740991,
"afterFinalization": true
}
]
}
],
"reportPayments": [
{
"paymentName": "string",
"paymentAmount": 0,
"paymentMode": "cash",
"paymentCatalogId": "d76033a6-a1eb-48c3-a3d8-dcba231570ff"
}
],
"reportRooms": [
{
"orderCount": 1,
"guestCount": 0,
"totalExcludingTax": -9007199254740991,
"totalWithGuest": -9007199254740991,
"total": -9007199254740991,
"type": "string",
"name": "string"
}
],
"reportMenus": [
{
"name": "string",
"coursesDescription": [
"string"
],
"quantity": 1,
"totalExcludingTax": -9007199254740991,
"totalSales": -9007199254740991,
"steps": [
{
"stepName": "string",
"quantity": 1,
"products": [
{
"productCatalogId": "4269f01b-f9e3-4367-a846-5d3c63fd34bc",
"productQuantity": 1,
"productSales": 0,
"excludingTax": 0,
"inMenu": true,
"subCategory": "string",
"productName": "string",
"category": "string",
"sku": "string",
"pricingList": [
{
"pricing": "string",
"quantity": 0,
"sales": 0,
"excludingTax": 0
}
],
"modifierList": [
{
"modifierName": "string",
"modifierGroupName": "string",
"quantity": 0,
"amount": -9007199254740991
}
]
}
]
}
]
}
],
"reportTaxes": [
{
"taxName": "string",
"taxRate": -9007199254740991,
"taxAmount": -9007199254740991,
"taxableAmount": -9007199254740991,
"taxCatalogId": "060cdf9d-7227-42e9-a215-7befdb05bf6d"
}
],
"reportLosses": [
{
"reason": "string",
"amount": -9007199254740991,
"quantity": 0,
"productList": [
{
"name": "string",
"amount": -9007199254740991,
"quantity": 0
}
]
}
],
"reportVersion": 1,
"orders": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"roomName": "string",
"openedAt": null,
"closedAt": null,
"tableName": "string",
"operatorName": "string",
"total": 0,
"isPaid": true,
"isCanceled": true,
"isTransferred": true,
"tableId": "073fbfcb-cd05-4203-be18-a1ce6f8e4d2d"
}
]
}