Liability List Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-liability-list-response-schema.json",
  "title": "Liability List Response",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-liabilities-api-openapi.yml#/components/schemas/LiabilityListResponse",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/CommonResponse"
    },
    {
      "properties": {
        "data": {
          "$ref": "#/$defs/LiabilityListData"
        }
      }
    }
  ],
  "$defs": {
    "CommonResponse": {
      "title": "CommonResponse",
      "type": "object",
      "required": [
        "code",
        "requestId"
      ],
      "properties": {
        "code": {
          "$ref": "#/$defs/ObjectMetadataRefCode"
        },
        "message": {
          "$ref": "#/$defs/ObjectMetadataRefMessage"
        },
        "requestId": {
          "$ref": "#/$defs/ObjectMetadataRefRequestID"
        }
      },
      "description": ""
    },
    "Liability": {
      "title": "Liability",
      "type": "object",
      "description": "The liabilities of the user from an employment data provider.",
      "x-internal": false,
      "x-tags": [
        "Liabilities"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/LiabilityPayload"
        },
        {
          "properties": {
            "metadata": {
              "$ref": "#/$defs/ObjectReferenceMetadata"
            }
          }
        }
      ],
      "required": [
        "id",
        "type",
        "startDate",
        "loanAmount",
        "currency",
        "amortizationFrequency",
        "metadata"
      ]
    },
    "LiabilityListData": {
      "type": "object",
      "properties": {
        "nextCursor": {
          "$ref": "#/$defs/ObjectNextCursor"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Liability"
          }
        }
      }
    },
    "LiabilityPayload": {
      "type": "object",
      "required": [
        "id",
        "type",
        "startDate",
        "loanAmount",
        "currency",
        "amortizationFrequency"
      ],
      "properties": {
        "id": {
          "$ref": "#/$defs/RefObjectID"
        },
        "type": {
          "type": "string",
          "description": "the loan type"
        },
        "referenceId": {
          "type": "string",
          "description": "the loan referenceId"
        },
        "startDate": {
          "type": "string",
          "format": "date",
          "description": "the loan start date"
        },
        "endDate": {
          "type": "string",
          "format": "date",
          "description": "the loan end date"
        },
        "firstAmortizationDate": {
          "type": "string",
          "format": "date",
          "description": "the loan first amortization date"
        },
        "amortizationFrequency": {
          "$ref": "#/$defs/RefPayPeriod"
        },
        "currency": {
          "$ref": "#/$defs/RefCurrency"
        },
        "loanAmount": {
          "type": "number",
          "description": "loan amount"
        },
        "amortizationAmount": {
          "type": "number",
          "description": "loan amortization amount"
        },
        "outstandingBalance": {
          "type": "number",
          "description": "loan outstanding balance"
        },
        "nextPaymentAmount": {
          "type": "number",
          "description": "loan next payment amount"
        },
        "overduePaymentAmount": {
          "type": "number",
          "description": "loan total overdue amount"
        }
      }
    },
    "ObjectMetadataRefCode": {
      "type": "string",
      "title": "ObjectMetadataRefCode",
      "description": "Request status code",
      "enum": [
        "OK",
        "CREATED",
        "INVALID_CREDENTIALS",
        "INVALID_PARAMETERS",
        "INVALID_TOKEN",
        "UNAUTHORIZED_ACCESS",
        "MISSING_RESOURCE",
        "REQUEST_LIMIT_EXCEEDED",
        "SERVER_ERROR",
        "UNSUPPORTED_METHOD",
        "SERVER_UNAVAILABLE",
        "TIME_LIMIT_EXCEEDED"
      ],
      "x-internal": false
    },
    "ObjectMetadataRefMessage": {
      "type": "string",
      "title": "ObjectMetadataRefMessage",
      "description": "Message response to the request",
      "x-internal": false
    },
    "ObjectMetadataRefRequestID": {
      "type": "string",
      "title": "ObjectMetadataRefRequestID",
      "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.",
      "x-internal": false
    },
    "ObjectNextCursor": {
      "title": "ObjectNextCursor",
      "type": "string",
      "description": "The next cursor value that can be used in the following query.",
      "x-internal": false
    },
    "ObjectReferenceMetadata": {
      "title": "Reference Metadata",
      "type": "object",
      "description": "Metadata related to account-specific data",
      "properties": {
        "itemCreatedAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "createdAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "accountId": {
          "type": "string",
          "deprecated": true,
          "description": "The accountId of this object"
        },
        "sourceId": {
          "type": "string",
          "description": "The ACCOUNT or ARCHIVE ID associated with this object"
        },
        "sourceType": {
          "$ref": "#/$defs/RefSourceType"
        },
        "userId": {
          "type": "string",
          "description": "The user ID associated with this object"
        },
        "providerId": {
          "type": "string",
          "description": "The provider ID associated with this object"
        }
      },
      "required": [
        "createdAt",
        "itemCreatedAt",
        "sourceId",
        "sourceType",
        "userId",
        "providerId"
      ]
    },
    "RefCurrency": {
      "type": "string",
      "title": "Currency ISO Codes",
      "description": "Currency in 3 character alpha ISO 4217",
      "enum": [
        "AFN",
        "DZD",
        "ARS",
        "AMD",
        "AWG",
        "AUD",
        "AZN",
        "BSD",
        "BHD",
        "THB",
        "PAB",
        "BBD",
        "BYN",
        "BZD",
        "BMD",
        "VES",
        "BOB",
        "BRL",
        "BND",
        "BGN",
        "BIF",
        "CAD",
        "CVE",
        "KYD",
        "GHS",
        "XOF",
        "XAF",
        "XPF",
        "CLP",
        "COP",
        "KMF",
        "CDF",
        "BAM",
        "NIO",
        "CRC",
        "HRK",
        "CZK",
        "GMD",
        "DKK",
        "MKD",
        "DJF",
        "STD",
        "DOP",
        "VND",
        "XCD",
        "EGP",
        "SVC",
        "ETB",
        "EUR",
        "FKP",
        "FJD",
        "HUF",
        "GIP",
        "HTG",
        "PYG",
        "GNF",
        "GYD",
        "HKD",
        "UAH",
        "ISK",
        "INR",
        "IRR",
        "IQD",
        "JMD",
        "JOD",
        "KES",
        "PGK",
        "LAK",
        "EEK",
        "KWD",
        "MWK",
        "AOA",
        "MMK",
        "GEL",
        "LVL",
        "LBP",
        "ALL",
        "HNL",
        "SLL",
        "LRD",
        "LYD",
        "SZL",
        "LTL",
        "LSL",
        "MGA",
        "MYR",
        "TMT",
        "MUR",
        "MZN",
        "MXN",
        "MDL",
        "MAD",
        "NGN",
        "ERN",
        "NAD",
        "NPR",
        "ANG",
        "ILS",
        "RON",
        "TWD",
        "NZD",
        "BTN",
        "KPW",
        "NOK",
        "PEN",
        "MRO",
        "TOP",
        "PKR",
        "MOP",
        "UYU",
        "PHP",
        "GBP",
        "BWP",
        "QAR",
        "GTQ",
        "ZAR",
        "OMR",
        "KHR",
        "MVR",
        "IDR",
        "RUB",
        "RWF",
        "SHP",
        "SAR",
        "RSD",
        "SCR",
        "SGD",
        "SBD",
        "KGS",
        "SOS",
        "TJS",
        "LKR",
        "SDG",
        "SRD",
        "SEK",
        "CHF",
        "SYP",
        "BDT",
        "WST",
        "TZS",
        "KZT",
        "TTD",
        "MNT",
        "TND",
        "TRY",
        "AED",
        "UGX",
        "CLF",
        "USD",
        "UZS",
        "VUV",
        "KRW",
        "YER",
        "JPY",
        "CNY",
        "ZMW",
        "ZWL",
        "PLN"
      ]
    },
    "RefDateTime": {
      "type": "string",
      "title": "Date and Time string",
      "format": "date-time",
      "description": "Date and time"
    },
    "RefObjectID": {
      "type": "string",
      "title": "Object ID",
      "description": "Unique ID of this object"
    },
    "RefPayPeriod": {
      "type": [
        "string",
        "null"
      ],
      "title": "Pay Period",
      "description": "Pay period",
      "enum": [
        "Hourly",
        "Daily",
        "Weekly",
        "Semimonthly",
        "Monthly",
        "Bimonthly",
        "Quarterly",
        "Annually",
        "Variable",
        "Unspecified",
        null
      ]
    },
    "RefSourceType": {
      "type": [
        "string",
        "null"
      ],
      "title": "Ref-Source-Type",
      "enum": [
        "ACCOUNT",
        "UPLOAD",
        "ARCHIVE",
        "SOCIAL_SECURITY"
      ],
      "description": "Source Type"
    }
  }
}