SpotOn · JSON Structure

Restaurant Pos Export Paid In Out Structure

A cash paid in or paid out record at a location.

Type: object Properties: 12
RestaurantPoint of SalePaymentsOnline OrderingReservationsReporting

PaidInOut is a JSON Structure definition published by SpotOn, describing 12 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id locationId deleted voided paymentOptionId amount employeeId employeeName createdAt kind reason notes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/spoton/refs/heads/main/json-structure/restaurant-pos-export-paid-in-out-structure.json",
  "name": "PaidInOut",
  "description": "A cash paid in or paid out record at a location.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique paid in/out identifier."
    },
    "locationId": {
      "type": "string",
      "description": "Associated location identifier."
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the record is marked as deleted."
    },
    "voided": {
      "type": "boolean",
      "description": "Whether the record is voided."
    },
    "paymentOptionId": {
      "type": "string",
      "description": "Associated payment option identifier."
    },
    "amount": {
      "type": "string",
      "description": "Amount in US dollars, as a decimal string."
    },
    "employeeId": {
      "type": "string",
      "description": "Identifier of the employee who recorded the entry."
    },
    "employeeName": {
      "type": "string",
      "description": "Full name of the employee who recorded the entry."
    },
    "createdAt": {
      "type": "datetime",
      "description": "RFC 3339 creation timestamp."
    },
    "kind": {
      "type": "string",
      "description": "Whether cash was paid in or paid out.",
      "enum": [
        "IN",
        "OUT"
      ]
    },
    "reason": {
      "type": "string",
      "description": "Predefined reason for the entry."
    },
    "notes": {
      "type": "string",
      "description": "Operator notes."
    }
  }
}