invoices

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-invoices-schema.json",
  "title": "invoices",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oyster-hr-invoices-api-openapi.yml#/components/schemas/invoices",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "referenceCode": {
        "type": "string"
      },
      "type": {
        "type": "string",
        "enum": [
          "DEPOSIT",
          "PREFUNDING",
          "SETTLEMENT",
          "MANUAL",
          "CONTRACTORS_FEE",
          "MONTHLY_PAYMENT",
          "AD_HOC_PAYMENT",
          "EXPENSE_REIMBURSEMENT",
          "GLOBAL_PAYROLL",
          "SCALE",
          "SALARY_INSIGHTS",
          "TRUE_UPS",
          "OYSTER_FEES",
          "MANUAL_PREFUNDING",
          "MANUAL_SETTLEMENT",
          "MANUAL_OYSTER_FEES",
          "MANUAL_INVOICE_BY_OYSTER"
        ]
      },
      "status": {
        "type": "string",
        "enum": [
          "VOIDED",
          "WAITING_APPROVAL",
          "READY_FOR_REVIEW",
          "APPROVED",
          "AUTO_APPROVED",
          "DISPUTED"
        ]
      },
      "payrollMonth": {
        "type": [
          "string",
          "null"
        ]
      },
      "payrollYear": {
        "type": [
          "string",
          "null"
        ]
      },
      "issueDate": {
        "type": [
          "string",
          "null"
        ],
        "format": "date"
      },
      "dueDate": {
        "type": [
          "string",
          "null"
        ],
        "format": "date"
      },
      "amount": {
        "$ref": "#/$defs/amount"
      },
      "charge": {
        "$ref": "#/$defs/chargeCollectionItem"
      },
      "payout": {
        "$ref": "#/$defs/payoutCollectionItem"
      }
    },
    "required": [
      "id",
      "referenceCode",
      "type",
      "status",
      "payrollMonth",
      "payrollYear",
      "issueDate",
      "dueDate",
      "amount",
      "charge",
      "payout"
    ]
  },
  "$defs": {
    "amount": {
      "type": "object",
      "properties": {
        "decimal": {
          "type": "string",
          "pattern": "^\\d+([.]\\d+)?$"
        },
        "currencyCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 3
        }
      },
      "required": [
        "decimal",
        "currencyCode"
      ]
    },
    "chargeCollectionItem": {
      "type": [
        "object",
        "null"
      ],
      "required": [
        "id",
        "status",
        "amount",
        "amountDue"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "NO_PAYMENT",
            "PENDING",
            "WAITING_FOR_WIRE_TRANSFER",
            "OVERDUE",
            "DIRECT_DEBIT_IN_PROGRESS",
            "DIRECT_DEBIT_FAILED",
            "CHARGED_BACK",
            "PAID",
            "PARTIALLY_PAID",
            "VOIDED"
          ]
        },
        "amount": {
          "$ref": "#/$defs/amount"
        },
        "amountDue": {
          "$ref": "#/$defs/amount"
        }
      }
    },
    "payoutCollectionItem": {
      "type": [
        "object",
        "null"
      ],
      "required": [
        "id",
        "status",
        "amount"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "NOT_INITIATED",
            "INITIATED",
            "IN_PROGRESS",
            "PAID",
            "RETURNED",
            "NO_PAYMENT",
            "SENT"
          ]
        },
        "amount": {
          "$ref": "#/$defs/amount"
        }
      }
    }
  }
}