Planday Developer
Getting startedGuidesAPI
Visit our website
Getting started
Guides
Employee management integrationsPoint of Sale (POS) integrationsTime clock integrationsPayroll integrationsTime and Cost integrationsErrorsPlanday structure
API

Point of Sale (POS) integrations

One of the main integration use cases is to send total daily revenue into Planday, which enable managers to compare the labour cost with the revenue. In Planday we automatically calculate the payroll percentage (labour cost vs. revenue) based on these numbers, and this can be compared to a defined budget, which has to be set in Planday.

Revenue is linked to a revenue unit in Planday. Revenue units are managed by the clients inside Planday and each unit is linked to a department. You can have multiple revenue units per department, reflecting where the revenue is generated. Learn more about revenue and revenue units here https://help.planday.com/s/article/Setting-up-and-managing-Revenue?language=en_US. A typical example of how revenue units are used and structured can be described with the example below.

Example

Business X has two restaurants and in each restaurant they generate revenue in the bar and in the restaurant. This could look like following:

Business X has one Planday portal

Department A (Restaurant 1)

  • Revenue unit 1A (Restaurant 1 - Bar)
  • Revenue unit 2A (Restaurant 1 - Restaurant)

Department B (Restaurant 2)

  • Revenue unit 1B (Restaurant 2 - Bar)
  • Revenue unit 2B (Restaurant 2 - Restaurant)
  • You can use our Get Revenue unit endpoints to get the ID for all revenue units.

Mapping and adding revenue

Typically will need to enable the client to make a mapping between the revenue units in Planday and your system. The revenue unit is usually mapped to some kind of a "sales area", but it depends on the system.

When you know the mapping you can use the POST /revenue/v{version}/revenueunits endpoint to set the revenue in Planday. Here you have to specify the value, the revenue unit ID, date and optionally a comment.

Regarding the comment field, we recommend to add information like timestamp for the last update and "who" updated the revenue. Please see this example: Revenue imported from [name of source e.g. POS system] in Restaurant at 15/03/2020 23:00:21 (UTC)

Exclude tax from the revenue data

You need to consider whether the revenue should be including or excluding tax, or make a toggle so the client can decide themselves. You may also consider if there are any other sales data that should be excluded e.g. service charges, gift cards, charity fees.

Frequency

It is up to you to decide how often you will update the revenue. You need to be aware that we only store one value for daily revenue, so for days back in time you can only set one value, whereas you can update the current date value several times a day, so the client can monitor it. This could for example be every 5 min.