Delaget API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This api is based on REST principles. To gain access you will need a API Key, please contact Delaget support to have a API key created for you. All requests to the Delaget API must be via HTTPS.

Usage Scenarios:

Retrieving daily transactional data for an organization:

1. For the organization make a call to /organizations.
2. Inspect the response: organization.locations for a list of locations.
3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/retail_transactions

Retrieving daily financial data for an organization:

1. For the organization make a call to /organizations.
2. Inspect the response: organization.locations for a list of locations.
3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/summary

Retrieving daily time punch data for an organization:

1. For the organization make a call to /organizations.
2. Inspect the response: organization.locations for a list of locations.
3. For each location in the list call /organizations/{organization_code}/locations/{location_id}/time_cards

Notes:

• All times are in the local timezone of the location, unless otherwise noted.

Base URLs:

• https://api.delaget.com/api/v1

Email: Support

Authentication

• API Key (ApiKeyAuth)
  • Parameter Name: apiKey, in: header.

Organization

List organizations the caller has access to

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

curl --request GET \
  --url https://api.delaget.com/api/v1/organizations \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'

HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);

import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations

Parameters

Example responses

200 Response

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Response Schema

Status Code 200

Retrieves an organization's details

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

curl --request GET \
  --url https://api.delaget.com/api/v1/organizations/string \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'

HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);

import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}

Retrieves details about one organization.

Parameters

Example responses

200 Response

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0,
  "code": "YCI",
  "name": "Your restaurants incorporated",
  "locations": [
    {
      "location_id": 1234,
      "location_number": 12345,
      "organization_location_identifier": "012345 - Rice Street",
      "name": "Lake Street",
      "open_date": "2017-02-01",
      "close_date": "2018-02-01",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "workers": [
        {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      ]
    }
  ]
}

Responses

Response Schema

Enumerated Values

Retrieves list of workers by location for an organization

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/workers");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

curl --request GET \
  --url https://api.delaget.com/api/v1/organizations/string/workers \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'

HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/workers")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/workers");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);

import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/workers", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/workers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/workers

Retrieves details about one organization's workers.

Parameters

Example responses

Results matching the input parameters, response envelope contains a list of worker objects.

{
  "data": [
    {
      "location_id": 217381,
      "location_number": "901398",
      "organization_location_identifier": "901398",
      "name": "MAIN STREET",
      "open_date": "1980-01-01",
      "address": {
        "street": "1672 MAIN ST.",
        "city": "ST. PAUL",
        "state": "MN",
        "zip": "99999"
      },
      "workers": [
        {
          "id": 955774,
          "first_name": "JOHN",
          "last_name": "CAKE",
          "hire_date": "2004-06-01",
          "term_date": "2004-06-01"
        },
        {
          "id": 955775,
          "first_name": "JANE",
          "last_name": "JACKSON",
          "middle_initial": "R",
          "hire_date": "2003-04-01",
          "birth_date": "1985-01-14",
          "term_code": "VT16",
          "term_date": "2006-05-18",
          "gender": "Male",
          "address": {
            "street": "115 BIRK AVE W # 13",
            "city": "ST PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "5427"
          }
        },
        {
          "id": 955776,
          "first_name": "KATHY",
          "last_name": "JAMES",
          "middle_initial": "E",
          "hire_date": "2005-12-13",
          "term_date": "2006-02-21"
        },
        {
          "id": 955777,
          "first_name": "RAY",
          "last_name": "OLIVE",
          "hire_date": "2002-07-24",
          "birth_date": "1989-04-28",
          "term_date": "2002-09-14",
          "gender": "Male",
          "address": {
            "street": "652 GRAND ST # 1",
            "city": "ST.PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "0000"
          }
        },
        {
          "id": 955778,
          "first_name": "JANET",
          "last_name": "THOME",
          "hire_date": "2013-04-19",
          "birth_date": "1994-05-11",
          "term_code": "VT11",
          "term_date": "2015-02-23",
          "gender": "Male",
          "address": {
            "street": "180 SNELLING AVE W # 999",
            "city": "ST PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "0000"
          }
        },
        {
          "id": 955779,
          "first_name": "LISA",
          "last_name": "BOYD",
          "hire_date": "2001-12-25",
          "term_date": "2003-12-23"
        },
        {
          "id": 955780,
          "first_name": "DEAN",
          "last_name": "MAPLE",
          "middle_initial": "A",
          "hire_date": "2002-06-22",
          "birth_date": "1984-09-18",
          "term_code": "VT24",
          "term_date": "2009-01-04",
          "gender": "Male",
          "address": {
            "street": "1999 MARK AVE # A",
            "city": "ST PAUL",
            "state": "MN",
            "zip": "99999",
            "zip_plus_four": "0000"
          }
        }
      ]
    },
    {
      "location_id": 217391,
      "location_number": "902396",
      "organization_location_identifier": "902396",
      "name": "MOUNT CARMEL",
      "open_date": "1980-01-01",
      "address": {
        "street": "999 HIGHWAY 125",
        "city": "MOUNT CARMEL",
        "state": "MN",
        "zip": "99999"
      },
      "workers": [
        {
          "id": 955510,
          "first_name": "KATHY",
          "last_name": "STEPHENS",
          "middle_initial": "A",
          "hire_date": "2013-12-10",
          "term_code": "Borrow",
          "term_date": "2014-05-13"
        },
        {
          "id": 955520,
          "first_name": "CHRIS",
          "last_name": "RIGHT",
          "hire_date": "2011-11-29",
          "term_date": "2011-11-29"
        },
        {
          "id": 955592,
          "first_name": "JACKSON",
          "last_name": "CRAIG",
          "middle_initial": "R",
          "hire_date": "2013-12-10",
          "term_code": "Borrow",
          "term_date": "2014-02-18"
        }
      ]
    }
  ],
  "data_type": "location[]",
  "available_requests": 199
}

Responses

Response Schema

Status Code 200

Location

Retrieves a labor data on a business day

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

curl --request GET \
  --url 'https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04' \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'

HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);

import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/locations/0/time_cards?date=2022-02-04")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/locations/{location_id}/time_cards

By passing in the appropriate options you can retrieve time punches for a location on a given day.

Parameters

Example responses

Results matching the input parameters, response envelope contains an array with time_card objects.

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Response Schema

Status Code 200

Retrieves location summary information on a business day

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

curl --request GET \
  --url 'https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04' \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'

HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);

import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/locations/0/summary?date=2022-02-04", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/locations/0/summary?date=2022-02-04")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/locations/{location_id}/summary

By passing in the appropriate options you can retrieve summary information (including ledger account summary data) for a location on a given day.

Parameters

Example responses

Results matching the input parameters, response envelope contains an array with summary objects.

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Response Schema

Status Code 200

Retrieves a list of orders for a business day

Code samples

var client = new RestClient("https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04");
var request = new RestRequest(Method.GET);
request.AddHeader("apikey", "API_KEY");
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);

curl --request GET \
  --url 'https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04' \
  --header 'accept: application/json' \
  --header 'apikey: API_KEY'

HttpResponse response = Unirest.get("https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04")
  .header("accept", "application/json")
  .header("apikey", "API_KEY")
  .asString();

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("apikey", "API_KEY");

xhr.send(data);

import http.client

conn = http.client.HTTPSConnection("api.delaget.com")

headers = {
    'accept': "application/json",
    'apikey': "API_KEY"
    }

conn.request("GET", "/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.delaget.com/api/v1/organizations/string/locations/string/retail_transactions?date=2022-02-04")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["apikey"] = 'API_KEY'

response = http.request(request)
puts response.read_body

GET /organizations/{organization_code}/locations/{location_id}/retail_transactions

By passing in the appropriate options you can retrieve orders for a location on a given day.

Parameters

Example responses

Results matching the input parameters, response envelope contains an array with retail_transaction objects.

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Responses

Response Schema

Status Code 200

Schemas

response_envelope

{
  "data": {},
  "paging": {
    "cursor": {
      "after": "string"
    },
    "next": "string"
  },
  "available_requests": 0
}

Properties

paging

{
  "cursor": {
    "after": "string"
  },
  "next": "string"
}

Properties

cursors

{
  "after": "string"
}

Properties

organization

{
  "code": "YCI",
  "name": "Your restaurants incorporated",
  "locations": [
    {
      "location_id": 1234,
      "location_number": 12345,
      "organization_location_identifier": "012345 - Rice Street",
      "name": "Lake Street",
      "open_date": "2017-02-01",
      "close_date": "2018-02-01",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "workers": [
        {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      ]
    }
  ]
}

Properties

money

{
  "amount": "5.35",
  "currency_code": "USD"
}

Properties

location

{
  "location_id": 1234,
  "location_number": 12345,
  "organization_location_identifier": "012345 - Rice Street",
  "name": "Lake Street",
  "open_date": "2017-02-01",
  "close_date": "2018-02-01",
  "address": {
    "street": "100 Main Street",
    "suite": "400 east",
    "city": "Anytown",
    "county": "County",
    "state": "MN",
    "zip": "01234",
    "zip_plus_four": "1234"
  },
  "workers": [
    {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    }
  ]
}

Properties

location_summary

{
  "paid_in_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "paid_out_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "net_sales": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "gross_sales": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "ledger_account_summaries": [
    {
      "account_number": "string",
      "account_name": "string",
      "amount": 0,
      "types": [
        {
          "type": "Allowances",
          "factor": -1
        }
      ]
    }
  ]
}

Properties

ledger_account_summary

{
  "account_number": "string",
  "account_name": "string",
  "amount": 0,
  "types": [
    {
      "type": "Allowances",
      "factor": -1
    }
  ]
}

A financial account for a location on a given day. Note that multiple accounts may have the same type. For example two accounts may be related to net sales.

Properties

account_type

{
  "type": "Allowances",
  "factor": -1
}

Describes the type of financal account.

Properties

Enumerated Values

time_card

{
  "id": 0,
  "business_day": "2017-02-01",
  "clocked_in": "2019-01-01T17:30:28",
  "clocked_out": "2019-01-01T20:30:00",
  "job_code": {
    "code": "string",
    "description": "string"
  },
  "pay_rate": {
    "rate": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "effective_date": "2017-02-01",
    "expiration_date": "2018-02-01"
  },
  "regular_hours": "9.00",
  "overtime_hours": "9.00",
  "doubletime_hours": "1",
  "charged_tips": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "sales": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "tips": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "worker": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  }
}

Properties

job_code

{
  "code": "string",
  "description": "string"
}

Properties

pay_rate

{
  "rate": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "effective_date": "2017-02-01",
  "expiration_date": "2018-02-01"
}

Properties

worker

{
  "id": "1234wsa",
  "first_name": "John",
  "last_name": "Doe",
  "middle_initial": "M",
  "phone": "4088675309",
  "alternative_phone": "string",
  "email": "user@example.com",
  "hire_date": "2017-02-01",
  "birth_date": "2000-02-01",
  "term_code": "string",
  "term_date": "2017-02-01",
  "gender": "Female",
  "address": {
    "street": "100 Main Street",
    "suite": "400 east",
    "city": "Anytown",
    "county": "County",
    "state": "MN",
    "zip": "01234",
    "zip_plus_four": "1234"
  },
  "client_worker_identification": {
    "company_code": "string",
    "identifier": "string"
  }
}

Properties

Enumerated Values

retail_transactions

[
  {
    "id": "1234abc",
    "identifier": "string",
    "business_day": "2017-02-01",
    "check_number": "1234abc",
    "register_number": "1234abc",
    "status": "Finished",
    "is_split_transfer": false,
    "order_entry_employee": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    },
    "cashier": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    },
    "total_amount": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "tax_amount": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "discount_amount": {
      "amount": "5.35",
      "currency_code": "USD"
    },
    "open_time": "2019-01-01T20:30:00",
    "closed_time": "2019-01-01T20:30:00",
    "channel": {
      "name": "Delivery Service Front Counter",
      "description": "string",
      "group": "DeliveryService"
    },
    "destination": {
      "destination_name": "drive thru",
      "destination_description": "string",
      "destination_group": "drive_thru"
    },
    "tender": [
      {
        "type": "Cash, Coupon, Check, CreditDebit, CustomerAccount, GiftCard, GiftCertificate, Loyalty, Mobile, OnlinePayment, Voucher, Other",
        "subtender_type": "Amex, DinersClub, DiscoverCard, GoogleWallet, MasterCard, PayPal, Visa, ApplePay",
        "amount": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "change": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "amount_applied_to_bill": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "gift_card_number": "string",
        "account_number_last_four": "string",
        "tip_amount": {
          "amount": "5.35",
          "currency_code": "USD"
        }
      }
    ],
    "line_items": [
      {
        "id": 0,
        "price_modifiers": [
          {
            "key": "string",
            "group_type": "GeneralDiscount",
            "amount": {
              "amount": "5.35",
              "currency_code": "USD"
            },
            "quantity": 0,
            "approval": {
              "approver": {
                "id": "1234wsa",
                "first_name": "John",
                "last_name": "Doe",
                "middle_initial": "M",
                "phone": "4088675309",
                "alternative_phone": "string",
                "email": "user@example.com",
                "hire_date": "2017-02-01",
                "birth_date": "2000-02-01",
                "term_code": "string",
                "term_date": "2017-02-01",
                "gender": "Female",
                "address": {
                  "street": "100 Main Street",
                  "suite": "400 east",
                  "city": "Anytown",
                  "county": "County",
                  "state": "MN",
                  "zip": "01234",
                  "zip_plus_four": "1234"
                },
                "client_worker_identification": {
                  "company_code": "string",
                  "identifier": "string"
                }
              }
            },
            "entered_by": {
              "id": "1234wsa",
              "first_name": "John",
              "last_name": "Doe",
              "middle_initial": "M",
              "phone": "4088675309",
              "alternative_phone": "string",
              "email": "user@example.com",
              "hire_date": "2017-02-01",
              "birth_date": "2000-02-01",
              "term_code": "string",
              "term_date": "2017-02-01",
              "gender": "Female",
              "address": {
                "street": "100 Main Street",
                "suite": "400 east",
                "city": "Anytown",
                "county": "County",
                "state": "MN",
                "zip": "01234",
                "zip_plus_four": "1234"
              },
              "client_worker_identification": {
                "company_code": "string",
                "identifier": "string"
              }
            },
            "description": "string"
          }
        ],
        "type": "Sale",
        "split_transfer": {
          "type": "Split",
          "direction": "From",
          "transaction_id": "string"
        },
        "item": {
          "key": "string",
          "type": "Stock",
          "name": "string",
          "product_type_id": "string",
          "product_type_name": "string",
          "is_part_of": 0,
          "action_code": "Add",
          "is_deferred_sale": true
        },
        "quantity": 0,
        "actual_price": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "regular_price": {
          "amount": "5.35",
          "currency_code": "USD"
        },
        "applied_time": "2019-01-01T20:30:00",
        "is_void": true,
        "void_approval": {
          "approver": {
            "id": "1234wsa",
            "first_name": "John",
            "last_name": "Doe",
            "middle_initial": "M",
            "phone": "4088675309",
            "alternative_phone": "string",
            "email": "user@example.com",
            "hire_date": "2017-02-01",
            "birth_date": "2000-02-01",
            "term_code": "string",
            "term_date": "2017-02-01",
            "gender": "Female",
            "address": {
              "street": "100 Main Street",
              "suite": "400 east",
              "city": "Anytown",
              "county": "County",
              "state": "MN",
              "zip": "01234",
              "zip_plus_four": "1234"
            },
            "client_worker_identification": {
              "company_code": "string",
              "identifier": "string"
            }
          }
        },
        "is_cancel": true,
        "is_delete": true,
        "reason": "string"
      }
    ]
  }
]

Properties

address

{
  "street": "100 Main Street",
  "suite": "400 east",
  "city": "Anytown",
  "county": "County",
  "state": "MN",
  "zip": "01234",
  "zip_plus_four": "1234"
}

Properties

retail_transaction

{
  "id": "1234abc",
  "identifier": "string",
  "business_day": "2017-02-01",
  "check_number": "1234abc",
  "register_number": "1234abc",
  "status": "Finished",
  "is_split_transfer": false,
  "order_entry_employee": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  },
  "cashier": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  },
  "total_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "tax_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "discount_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "open_time": "2019-01-01T20:30:00",
  "closed_time": "2019-01-01T20:30:00",
  "channel": {
    "name": "Delivery Service Front Counter",
    "description": "string",
    "group": "DeliveryService"
  },
  "destination": {
    "destination_name": "drive thru",
    "destination_description": "string",
    "destination_group": "drive_thru"
  },
  "tender": [
    {
      "type": "Cash, Coupon, Check, CreditDebit, CustomerAccount, GiftCard, GiftCertificate, Loyalty, Mobile, OnlinePayment, Voucher, Other",
      "subtender_type": "Amex, DinersClub, DiscoverCard, GoogleWallet, MasterCard, PayPal, Visa, ApplePay",
      "amount": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "change": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "amount_applied_to_bill": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "gift_card_number": "string",
      "account_number_last_four": "string",
      "tip_amount": {
        "amount": "5.35",
        "currency_code": "USD"
      }
    }
  ],
  "line_items": [
    {
      "id": 0,
      "price_modifiers": [
        {
          "key": "string",
          "group_type": "GeneralDiscount",
          "amount": {
            "amount": "5.35",
            "currency_code": "USD"
          },
          "quantity": 0,
          "approval": {
            "approver": {
              "id": "1234wsa",
              "first_name": "John",
              "last_name": "Doe",
              "middle_initial": "M",
              "phone": "4088675309",
              "alternative_phone": "string",
              "email": "user@example.com",
              "hire_date": "2017-02-01",
              "birth_date": "2000-02-01",
              "term_code": "string",
              "term_date": "2017-02-01",
              "gender": "Female",
              "address": {
                "street": "100 Main Street",
                "suite": "400 east",
                "city": "Anytown",
                "county": "County",
                "state": "MN",
                "zip": "01234",
                "zip_plus_four": "1234"
              },
              "client_worker_identification": {
                "company_code": "string",
                "identifier": "string"
              }
            }
          },
          "entered_by": {
            "id": "1234wsa",
            "first_name": "John",
            "last_name": "Doe",
            "middle_initial": "M",
            "phone": "4088675309",
            "alternative_phone": "string",
            "email": "user@example.com",
            "hire_date": "2017-02-01",
            "birth_date": "2000-02-01",
            "term_code": "string",
            "term_date": "2017-02-01",
            "gender": "Female",
            "address": {
              "street": "100 Main Street",
              "suite": "400 east",
              "city": "Anytown",
              "county": "County",
              "state": "MN",
              "zip": "01234",
              "zip_plus_four": "1234"
            },
            "client_worker_identification": {
              "company_code": "string",
              "identifier": "string"
            }
          },
          "description": "string"
        }
      ],
      "type": "Sale",
      "split_transfer": {
        "type": "Split",
        "direction": "From",
        "transaction_id": "string"
      },
      "item": {
        "key": "string",
        "type": "Stock",
        "name": "string",
        "product_type_id": "string",
        "product_type_name": "string",
        "is_part_of": 0,
        "action_code": "Add",
        "is_deferred_sale": true
      },
      "quantity": 0,
      "actual_price": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "regular_price": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "applied_time": "2019-01-01T20:30:00",
      "is_void": true,
      "void_approval": {
        "approver": {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      },
      "is_cancel": true,
      "is_delete": true,
      "reason": "string"
    }
  ]
}

*Field notes:

• total_amount: Sum of retail_transaction_item.quantity * retail_transaction_item.actual_price and tax_amount
• discount_amount: Sum of transaction discounts and transaction item discounts *

Properties

Enumerated Values

retail_transaction_item

{
  "id": 0,
  "price_modifiers": [
    {
      "key": "string",
      "group_type": "GeneralDiscount",
      "amount": {
        "amount": "5.35",
        "currency_code": "USD"
      },
      "quantity": 0,
      "approval": {
        "approver": {
          "id": "1234wsa",
          "first_name": "John",
          "last_name": "Doe",
          "middle_initial": "M",
          "phone": "4088675309",
          "alternative_phone": "string",
          "email": "user@example.com",
          "hire_date": "2017-02-01",
          "birth_date": "2000-02-01",
          "term_code": "string",
          "term_date": "2017-02-01",
          "gender": "Female",
          "address": {
            "street": "100 Main Street",
            "suite": "400 east",
            "city": "Anytown",
            "county": "County",
            "state": "MN",
            "zip": "01234",
            "zip_plus_four": "1234"
          },
          "client_worker_identification": {
            "company_code": "string",
            "identifier": "string"
          }
        }
      },
      "entered_by": {
        "id": "1234wsa",
        "first_name": "John",
        "last_name": "Doe",
        "middle_initial": "M",
        "phone": "4088675309",
        "alternative_phone": "string",
        "email": "user@example.com",
        "hire_date": "2017-02-01",
        "birth_date": "2000-02-01",
        "term_code": "string",
        "term_date": "2017-02-01",
        "gender": "Female",
        "address": {
          "street": "100 Main Street",
          "suite": "400 east",
          "city": "Anytown",
          "county": "County",
          "state": "MN",
          "zip": "01234",
          "zip_plus_four": "1234"
        },
        "client_worker_identification": {
          "company_code": "string",
          "identifier": "string"
        }
      },
      "description": "string"
    }
  ],
  "type": "Sale",
  "split_transfer": {
    "type": "Split",
    "direction": "From",
    "transaction_id": "string"
  },
  "item": {
    "key": "string",
    "type": "Stock",
    "name": "string",
    "product_type_id": "string",
    "product_type_name": "string",
    "is_part_of": 0,
    "action_code": "Add",
    "is_deferred_sale": true
  },
  "quantity": 0,
  "actual_price": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "regular_price": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "applied_time": "2019-01-01T20:30:00",
  "is_void": true,
  "void_approval": {
    "approver": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    }
  },
  "is_cancel": true,
  "is_delete": true,
  "reason": "string"
}

A line item in a transaction, if the price modifier item is populated the price modifier, with no other data it is at the general retail_transaction level.

Properties

Enumerated Values

split_transfer_item

{
  "type": "Split",
  "direction": "From",
  "transaction_id": "string"
}

Provides information about a split or transferred item.

Properties

Enumerated Values

sales_item

{
  "key": "string",
  "type": "Stock",
  "name": "string",
  "product_type_id": "string",
  "product_type_name": "string",
  "is_part_of": 0,
  "action_code": "Add",
  "is_deferred_sale": true
}

Details about a item sold as part of a transaction

Properties

Enumerated Values

price_modifier_item

{
  "key": "string",
  "group_type": "GeneralDiscount",
  "amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "quantity": 0,
  "approval": {
    "approver": {
      "id": "1234wsa",
      "first_name": "John",
      "last_name": "Doe",
      "middle_initial": "M",
      "phone": "4088675309",
      "alternative_phone": "string",
      "email": "user@example.com",
      "hire_date": "2017-02-01",
      "birth_date": "2000-02-01",
      "term_code": "string",
      "term_date": "2017-02-01",
      "gender": "Female",
      "address": {
        "street": "100 Main Street",
        "suite": "400 east",
        "city": "Anytown",
        "county": "County",
        "state": "MN",
        "zip": "01234",
        "zip_plus_four": "1234"
      },
      "client_worker_identification": {
        "company_code": "string",
        "identifier": "string"
      }
    }
  },
  "entered_by": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  },
  "description": "string"
}

Properties

Enumerated Values

line_item_approval

{
  "approver": {
    "id": "1234wsa",
    "first_name": "John",
    "last_name": "Doe",
    "middle_initial": "M",
    "phone": "4088675309",
    "alternative_phone": "string",
    "email": "user@example.com",
    "hire_date": "2017-02-01",
    "birth_date": "2000-02-01",
    "term_code": "string",
    "term_date": "2017-02-01",
    "gender": "Female",
    "address": {
      "street": "100 Main Street",
      "suite": "400 east",
      "city": "Anytown",
      "county": "County",
      "state": "MN",
      "zip": "01234",
      "zip_plus_four": "1234"
    },
    "client_worker_identification": {
      "company_code": "string",
      "identifier": "string"
    }
  }
}

Properties

tender

{
  "type": "Cash, Coupon, Check, CreditDebit, CustomerAccount, GiftCard, GiftCertificate, Loyalty, Mobile, OnlinePayment, Voucher, Other",
  "subtender_type": "Amex, DinersClub, DiscoverCard, GoogleWallet, MasterCard, PayPal, Visa, ApplePay",
  "amount": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "change": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "amount_applied_to_bill": {
    "amount": "5.35",
    "currency_code": "USD"
  },
  "gift_card_number": "string",
  "account_number_last_four": "string",
  "tip_amount": {
    "amount": "5.35",
    "currency_code": "USD"
  }
}

*Field notes:

• amount: The actual amount of currency presented (tax and tips included) *

Properties

coupon

{
  "key": "string",
  "name": "string",
  "description": "string",
  "quanity": 0
}

Properties

channel

{
  "name": "Delivery Service Front Counter",
  "description": "string",
  "group": "DeliveryService"
}

Properties

destination

{
  "destination_name": "drive thru",
  "destination_description": "string",
  "destination_group": "drive_thru"
}

Properties

client_worker_identification

{
  "company_code": "string",
  "identifier": "string"
}

client_worker_identification

Properties