{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/medianfi-com/json-schema/medianfi-com-quick-books-document-candidates-schema.json",
  "title": "QuickBooksDocumentCandidates",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/medianfi-com-accountant-documents-api-openapi.yml#/components/schemas/QuickBooksDocumentCandidates",
  "type": "object",
  "required": [
    "documentId",
    "state",
    "reason",
    "snapshot",
    "candidates",
    "truncated"
  ],
  "properties": {
    "documentId": {
      "type": "string",
      "format": "uuid"
    },
    "state": {
      "type": "string",
      "enum": [
        "ready",
        "disabled",
        "unavailable",
        "missing_fields",
        "none"
      ]
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "not_configured",
        "no_connection",
        "ambiguous_connection",
        "sync_in_progress",
        "no_completed_snapshot",
        "snapshot_failed",
        "unassigned_document",
        "missing_vendor_or_date",
        "candidate_limit",
        null
      ]
    },
    "snapshot": {
      "type": [
        "object",
        "null"
      ],
      "required": [
        "runId",
        "completedAt"
      ],
      "properties": {
        "runId": {
          "type": "string",
          "format": "uuid"
        },
        "completedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "truncated": {
      "type": "boolean"
    },
    "candidates": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "type": "object",
        "required": [
          "objectType",
          "providerId",
          "documentNumber",
          "vendorName",
          "txnDate",
          "amountMinorUnits",
          "currency",
          "minorUnitExponent",
          "grade",
          "signals"
        ],
        "properties": {
          "objectType": {
            "type": "string",
            "enum": [
              "Bill",
              "Purchase",
              "VendorCredit"
            ]
          },
          "providerId": {
            "type": "string"
          },
          "documentNumber": {
            "type": [
              "string",
              "null"
            ]
          },
          "vendorName": {
            "type": "string"
          },
          "txnDate": {
            "type": "string",
            "format": "date"
          },
          "amountMinorUnits": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^-?[0-9]+$"
          },
          "currency": {
            "type": [
              "string",
              "null"
            ]
          },
          "minorUnitExponent": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 9
          },
          "grade": {
            "type": "string",
            "enum": [
              "exact",
              "probable"
            ]
          },
          "signals": {
            "type": "object",
            "required": [
              "number",
              "vendor",
              "date",
              "amount"
            ],
            "properties": {
              "number": {
                "type": "boolean"
              },
              "vendor": {
                "type": "boolean"
              },
              "date": {
                "type": "boolean"
              },
              "amount": {
                "type": [
                  "boolean",
                  "null"
                ]
              }
            }
          }
        }
      }
    }
  }
}