Skip to main content

End of Day Notifications

Integrated Back Office and Reporting/Analytics partners can benefit from an automated notification that a given business date has been closed on the point of sale (POS) terminal, which can enable management oversight of reconciliation tasks to be completed in a timely manner. This type of webhook notification is vital to alert third-party systems that they are free to start closing periods and perform aggregate calculations using transactional data like orders, drawers, and deposits.

The End of Day (EOD) Notifications documentation includes the following sections:

Example Site EOD Notification Object

The code below shows an example of the Site EOD Notification Object that is published to the webhook URL:

{
  "entityName": "EOD",
  "data": {
    "company_id": "6141aadfb290560007bd29a7",
    "new_business_date": "2021-09-30T00:00:00.000Z",
    "notification_datetime": "2021-09-30T20:26:03.183Z",
    "previous_business_date": "2021-08-23T00:00:00.000Z",
    "site_id": "6141aded80fc9800075b4034",
    "store_number": "175"
  }
}

For more information, see Data Models General Structure - Site EOD.

Example Terminal EOD Notification Object

The code below shows an example of the Terminal EOD Notification Object that is published to the webhook URL:

{
  "entityName": "TerminalEOD",
  "data": {
    "company_id": "6141aadfb290560007bd29a7",
    "site_id": "6141aded80fc9800075b4034",
    "store_number": "175",
    "store_business_date": "2021-09-30T00:00:00.000Z",
    "notification_datetime": "2021-09-30T20:26:03.183Z",
    "terminals": [
      {
        "terminal_id": "5a5901f0fcacfe00019a7fda",
        "terminal_name": "Reg1(Cashier)1",
        "terminal_number": "2",
        "old_business_date": "2021-08-23T00:00:00.000Z",
        "new_business_date": "2021-09-30T00:00:00.000Z"
      }
    ]
  }
}

For more information, see Data Models General Structure - Terminal EOD.

Transport Specifics

End of Day (EOD) notifications are sent with a delay of 15 minutes in order to finish data synchronization from terminals so that all entities could be sent to the target address successfully before the EOD notification.

Warning

Some terminals can be offline so their EOD notifications and data will be synchronized after the terminal is back online.

Note

A site EOD notification with a new business date is sent when at least one terminal from this site switched its business date to a date greater than the site’s previous one.

Data Models

Data Models General Structure - Site EOD

The table below defines the attributes that the Data Stream service sends as part of the Site End of Day (EOD) Notification Object:

Field Name

Type

Description

company_id

string

The unique identifier (UID) of the message's source company

site_id

string

The UID of the message's source site

store_number

string

The readable identifier of the site. It may contain both letters and numbers.

previous_business_date

string

The previous business date that is being closed currently.

It is sent in the ISO8601 Format (YYYY-MM-DDThh:mm:ss[.SSS]Z).

new_business_date

string

The new business date that is opened.

It is sent in the ISO8601 Format (YYYY-MM-DDThh:mm:ss[.SSS]Z).

notification_datetime

string

The UTC timestamp when the notification was sent from the point of sale (POS) system

Data Models General Structure - Terminal EOD

The table below defines the attributes that the Data Stream service sends as part of the Terminal End of Day (EOD) Notification Object:

Field Name

Type

Description

company_id

string

The unique identifier (UID) of the message's source company

site_id

string

The UID of the message's source site

store_number

string

The readable identifier of the site. It may contain both letters and numbers.

store_business_date

string

The store’s business date at the moment when the terminal’s EOD notification was received.

It is sent in the ISO8601 Format (YYYY-MM-DDThh:mm:ss[.SSS]Z).

notification_datetime

string

The UTC timestamp when the notification was sent from the point of sale (POS) system

terminals

terminals Array

A list of terminals that switched their business date to a new value.

Warning

Each terminal sends its own EOD notification, so this array contains information about one terminal only at a time.

terminals Array

Field Name

Type

Description

terminal_id

string

The unique identifier (UID) of the terminal that changed its business date within the current site

terminal_name

string

The readable name of the terminal that changed its business date within the current site. This name is configured in Data Management.

terminal_number

string

The readable identifier of the terminal that changed its business date within the current site. This identifier is configured in Data Management.

old_business_date

string

The previous business date that is being closed currently.

It is sent in the ISO8601 Format (YYYY-MM-DDThh:mm:ss[.SSS]Z).

new_business_date

string

The terminal's new business date.

It is sent in the ISO8601 Format (YYYY-MM-DDThh:mm:ss[.SSS]Z).

Sample terminals Array Body

"terminals": [
  {
    "terminal_id": "5e1626a6cbdbfa001fff6b21",
    "terminal_name": "Reg 2 (Cashier)",
    "terminal_number": "2",
    "old_business_date": "2022-02-11T00:00:00.000Z",
    "new_business_date": "2022-02-12T00:00:00.000Z"
  }
]
See also: