Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Financial

Get Receipt by External Reference

Returns a single receipt matching the external reference supplied in the request. See externalReferences for examples.

get/f/finance/{businessLocationId}/saleByExternalReference

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

Query parameters

externalReferenceIdstring required
Example:TASK:OO-{businessLocationId}-{unique-reference-code}

The external reference of the receipt. See externalReferences.

Response

Receipt returned

accountReferencestring

Unique reference code for the account.

accountFiscIdstring

The account identifier

receiptIdstring

The unique identifier for the receipt associated with this account.

timeofOpeningstring

The account creation timestamp.

timeofCloseAndPaidstring

The account close timestamp.

cancelledboolean
externalFiscalNumberstring
tableNumberstring

The table number.

tableNamestring

The name of the table.

accountProfileCodestring

The account profile associated with the account.

ownerNamestring

The name of the user associated with the account.

ownerIdnumber

The unique identifier for the user associated with the account.

type'SALE' | 'VOID' | 'RECALL' | 'REFUND' | 'SPLIT' | 'UPDATE' | 'TRANSFER' | 'FLOAT' | 'TRANSITORY' | 'CROSS_BL' | 'CANCEL'

The sale type.

externalReferencesstring[]
nbCoversnumber

The number of covers.

dineInboolean

Whether the order is dine-in.

deviceIdnumber

The unique identifier for the device where the account was created.

deviceNamestring

The name of the device where the account was created.

voidReason'Broken' | 'Cooking' | 'Other' | 'Taste' | 'Unhappy Client' | 'User Mistake' | 'Waited too long'

The void reason, if applicable.

Example response

{
  "accountReference": "57X0j3hzTZ2oo9sdVWiUog==",
  "accountFiscId": "A65315.17",
  "receiptId": "R65315.13",
  "source": {
    "initialAccountId": "A65315.13",
    "previousAccountId": "A65315.15"
  },
  "salesLines": [
    {
      "id": "S65315.33",
      "parentLineId": "S65315.32",
      "totalNetAmountWithTax": "11.00",
      "totalNetAmountWithoutTax": "8.33",
      "menuListPrice": "10.00",
      "unitCostPrice": "5.00",
      "serviceCharge": "1.00",
      "serviceChargeType": "APPORTIONED",
      "serviceChargeRate": "10.00",
      "discountAmount": "0.00",
      "taxCode": "VAT20",
      "taxAmount": "1.6667",
      "taxRatePercentage": "20.00",
      "taxLines": [
        {
          "taxId": "41910290874374",
          "taxCode": "VAT20",
          "taxRate": "1.2",
          "taxAmount": "1.666667",
          "taxIncluded": true
        }
      ],
      "discountType": "DISCOUNT",
      "discountCode": "10PCT",
      "discountName": "10% Discount",
      "accountDiscountAmount": "1.00",
      "accountDiscountType": "DISCOUNT",
      "accountDiscountCode": "Staff 20%",
      "accountDiscountName": "Staff Discount",
      "totalDiscountAmount": "1.00",
      "sku": "52",
      "name": "Burger",
      "nameOverride": "Burger Double Cheese",
      "statisticGroup": "Food",
      "quantity": "1",
      "accountingGroup": {
        "accountingGroupId": 141948669132845,
        "name": "Food",
        "statisticGroup": "Food",
        "code": "123"
      },
      "currency": "GBP",
      "revenueCenter": "Fixed POS",
      "revenueCenterId": 141948669132822,
      "categories": [
        {
          "category": "default",
          "value": "Food"
        }
      ],
      "timeofSale": "2023-07-27T19:58:22.474Z",
      "staffId": 14670,
      "staffName": "Manager",
      "deviceId": 75125,
      "deviceName": "iPad9",
      "voidReason": "Unhappy Client",
      "accountProfileCode": "AAP"
    }
  ],
  "payments": [
    {
      "code": "CASH",
      "description": "Cash",
      "paymentMethodId": 141948669132824,
      "netAmountWithTax": "11.00",
      "currency": "GBP",
      "tip": "0.00",
      "consumer": {
        "id": "ec021fb0-4c12-425e-b30f-320ab720448b",
        "customerId": 120913,
        "title": "Mr",
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumber1": "555-555-5555",
        "phoneNumber2": "555-555-5556",
        "companyName": "Company Name",
        "addressLine1": "123 Street st.",
        "addressLine2": "Unit 123",
        "zipCode": "12345",
        "city": "Some City",
        "state": "Some State",
        "email": "customer@email.com",
        "taxIdentifier": "123456789",
        "fiscalCode": "123456789",
        "destinationCode": "123456789"
      },
      "type": "NORMAL",
      "deviceId": "72676",
      "deviceName": "ipad9",
      "staffId": 180480,
      "staffName": "Manager",
      "authorization": "001",
      "externalReference": "1000",
      "revenueCenter": "Fixed POS",
      "revenueCenterId": 141948669132822,
      "fiscId": "T72691.8",
      "uuid": "bc7i2X_CTkeg8qlec66wmg==",
      "fiscDate": "2023-02-14T20:04:08.665Z",
      "surcharge": "0.00"
    }
  ],
  "timeofOpening": "2023-02-14T19:58:48.224Z",
  "timeofCloseAndPaid": "2023-02-14T20:04:08.734Z",
  "tableNumber": "1",
  "tableName": "Dining Room, Table 1",
  "accountProfileCode": "AAP",
  "ownerName": "Manager",
  "ownerId": 14670,
  "type": "SALE",
  "externalReferences": [
    "\"TASK:OO-{businessLocationId}-{unique-reference-code}\", \"TASK:OO-{businessLocationId}-(another-unique-reference-code)\""
  ],
  "nbCovers": 2,
  "dineIn": true,
  "deviceId": 75125,
  "deviceName": "ipad9",
  "voidReason": "Unhappy Client"
}