Allocation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Allocation",
  "title": "Allocation",
  "type": "object",
  "x-apideck-schema-id": "Allocation",
  "x-apideck-weights": {
    "id": "medium",
    "type": "medium",
    "code": "medium",
    "amount": "medium",
    "allocation_id": "medium"
  },
  "x-apideck-strict-any-of": [
    {
      "required": [
        "id"
      ]
    },
    {
      "required": [
        "code"
      ]
    }
  ],
  "properties": {
    "id": {
      "type": "string",
      "title": "Linked entity ID",
      "description": "Unique identifier of entity this payment should be attributed to.",
      "example": "123456"
    },
    "type": {
      "type": "string",
      "title": "Allocation type",
      "description": "Type of entity this payment should be attributed to.",
      "x-apideck-enum-id": "allocations.type",
      "enum": [
        "invoice",
        "order",
        "expense",
        "credit_memo",
        "over_payment",
        "pre_payment",
        "journal_entry",
        "other",
        "bill"
      ]
    },
    "code": {
      "type": "string",
      "example": "N091",
      "readOnly": true
    },
    "amount": {
      "type": "number",
      "title": "Amount",
      "description": "Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.",
      "example": 49.99,
      "nullable": true
    },
    "allocation_id": {
      "type": "string",
      "title": "Allocation ID",
      "description": "Unique identifier of the allocation",
      "example": "123456"
    }
  }
}