Skip to main content

Document revision history

2024-10-22

  • Updated interfaces and documentation for release 2024.5.
  • Added instructions how to create a developer partner account in the testing sandbox.

2024-04-25

  • Updated interfaces and documentation for release 2024.4, including external journals.

2024-02-15

  • Updated interfaces for release 2024.2.

2024-01-22

  • Added The 30,000 Foot View section.
  • Documented the Customers and Resources resources.
  • Updated interfaces for release 2024.1.

2023-06-09

  • Updated interfaces for release 2023.3.
  • Documented the new Java and PHP SDKs.
  • Documented the new OAuth 2.0 Authorization Code Flow.

2022-12-01

  • Updated interfaces for release 2022.2, including labels.
  • Documented usage of the new REPORT request method.

2022-02-18

  • Updated interfaces for release 2022.1.
  • Documented cron expressions.
  • Documented order reference format and uniqueness requirements.
  • This document now targets web rather than paper.

2020-03-30

  • Added WebhookAction authentication documentation.
  • Added TakeOutStatus documentation.
  • Fixed/completed the ButtonMapItem documentation.
  • Added the owner property to interface Order. Updated comments regarding items, order-reference and client-reference.
  • Documented the special permission handling for access tokens owned by service users.

2020-03-04

  • Added the Binary Properties and Direct Property Access section.
  • Documented Server-Sent Events/Event Stream.
  • Added Product Modifiers section.
  • Documented the button map resource.
  • Moved section Peripherals to its correct location.

2020-02-28

  • Added Stored_ prefix to REST resource response types.
  • Documented Take-Out configuration and gratuity handling.
  • Added missing documentation for entertainment bills and Host2T terminals.
  • Documented interface for card terminal reconciliations.