Otter · Schema

FinancialTransaction

FinancialTransaction schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
orderIdentifiers	object
id	string	External financial transaction identifier.
pending	boolean	Whether the transaction can be updated in the future.
currencyCode	string	The 3-letter currency code (ISO 4217) to use for all monetary values in this order.
createdAt	string	The date (in UTC) when the financial transaction was created.
customerId	string	Customer identifier.
notes	string	General notes about the financial transaction.
type	string	Financial transaction operation type.
payout	object
orderItems	array	Detailed financial per order item.
issues	array	List of issues that might have happened with the order.
data	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "FinancialTransaction",
  "description": "FinancialTransaction schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-financial-transaction-schema.json",
  "type": "object",
  "properties": {
    "orderIdentifiers": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-identifier-finance-schema.json"
    },
    "id": {
      "type": "string",
      "description": "External financial transaction identifier.",
      "example": "store_123"
    },
    "pending": {
      "type": "boolean",
      "description": "Whether the transaction can be updated in the future.",
      "example": true
    },
    "currencyCode": {
      "maxLength": 3,
      "minLength": 3,
      "type": "string",
      "description": "The 3-letter currency code (ISO 4217) to use for all monetary values in this order.",
      "example": "EUR"
    },
    "createdAt": {
      "type": "string",
      "description": "The date (in UTC) when the financial transaction was created.",
      "format": "date-time",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "customerId": {
      "type": "string",
      "nullable": true,
      "description": "Customer identifier.",
      "example": "store_123"
    },
    "notes": {
      "type": "string",
      "nullable": true,
      "description": "General notes about the financial transaction.",
      "example": "string"
    },
    "type": {
      "type": "string",
      "description": "Financial transaction operation type.",
      "enum": [
        "PAYMENT",
        "ADJUSTMENT",
        "CANCELLATION",
        "MISC"
      ],
      "example": "PAYMENT"
    },
    "payout": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payout-info-schema.json"
    },
    "orderItems": {
      "type": "array",
      "nullable": true,
      "description": "Detailed financial per order item.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-item-information-schema.json"
      }
    },
    "issues": {
      "type": "array",
      "nullable": true,
      "description": "List of issues that might have happened with the order.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-issue-schema.json"
      }
    },
    "data": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-financial-data-schema.json"
    }
  },
  "required": [
    "id",
    "orderIdentifiers",
    "pending",
    "currencyCode",
    "createdAt",
    "type",
    "data"
  ]
}