Otter · JSON Structure

Public Api Invoice Payout Info Structure

InvoicePayoutInfo schema from Public API (Otter Public API).

Type: object Properties: 4 Required: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

InvoicePayoutInfo is a JSON Structure definition published by Otter, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id date summary total

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/otter/refs/heads/main/json-structure/public-api-invoice-payout-info-structure.json",
  "name": "InvoicePayoutInfo",
  "description": "InvoicePayoutInfo schema from Public API (Otter Public API).",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Payout identifier.",
      "example": "store_123"
    },
    "date": {
      "type": "date",
      "description": "The payout date.",
      "example": "2021-10-01"
    },
    "summary": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-financial-data-schema.json"
    },
    "total": {
      "type": "double",
      "nullable": true,
      "description": "Total payout value. Should only be used if summary is not provided.",
      "example": 19.07
    }
  },
  "required": [
    "id",
    "date"
  ]
}