Report

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argyle/refs/heads/main/json-schema/report.json",
  "title": "Report",
  "type": "object",
  "example": {
    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
    "generated_at": "2023-03-09T16:22:06.081Z",
    "created_at": "2023-03-09T16:22:06.081Z",
    "type": "voie",
    "status": "generated",
    "file_url": "www.argyle.com/storagename/pdf",
    "json_url": "www.argyle.com/storagename/json",
    "last_synced_at": "2023-03-09T14:08:25.069Z",
    "accounts": [
      {
        "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
        "item": "item_123456789",
        "last_synced_at": "2023-03-09T14:08:25.069105Z"
      },
      {
        "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
        "item": "item_000000001",
        "last_synced_at": "2023-03-01T05:10:59.558295Z"
      }
    ],
    "metadata": {},
    "external_id": "July_Connection"
  },
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the report object.\n\nAlso the \"**Reference #**\" on the report PDF.\n"
    },
    "user": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the user associated with the report."
    },
    "reference_id": {
      "type": "string",
      "format": "uuid",
      "description": "Report PDF identifier.",
      "deprecated": true
    },
    "generated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the report was requested.",
      "deprecated": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the report was requested."
    },
    "type": {
      "type": "string",
      "enum": [
        "voe",
        "voie",
        "voe-mortgage",
        "voie-mortgage"
      ],
      "description": "The type of report.\n\n- `voie` - Verification of Income and Employment\n- `voe` - Verification of Employment\n- `voie-mortgage` - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n- `voe-mortgage` - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n"
    },
    "status": {
      "type": "string",
      "enum": [
        "waiting_for_sync",
        "generating",
        "generated",
        "failed"
      ],
      "description": "Progress of report generation.\n\n- `waiting_for_sync`: Data from the connected payroll account is still being retrieved.\n- `generating`: The report is being generated.\n- `generated`: The report is ready to download.\n- `failed`: A system error occurred, preventing report generation.\n"
    },
    "file_url": {
      "type": "string",
      "description": "Download link to the report PDF.\n\nThis static URL redirects to a download page that requires [Argyle authentication headers](/api-guide/overview#authentication). See the dropdown below for more information.\n\nImplementation requirements for client-side applications:\n"
    },
    "json_url": {
      "type": "string",
      "description": "Download link to the report in JSON.\n\nThis static URL redirects to a download page that requires [Argyle authentication headers](/api-guide/overview#authentication). See the dropdown below for more information.\n"
    },
    "last_synced_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.\n\nUsed to populate the \"Data as of\" date on the report PDF.\n"
    },
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the account."
          },
          "item": {
            "type": "string",
            "description": "ID of the Item in Link through which the account was connected."
          },
          "last_synced_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the account was last scanned for new data before the report was generated."
          }
        }
      },
      "description": "The accounts used to generate the report."
    },
    "metadata": {
      "type": "object",
      "description": "Any metadata for internal use added when generating the report."
    },
    "external_id": {
      "type": "string",
      "description": "The [external_id](/api-reference/users#object-external_id) of the user, otherwise `null`."
    }
  }
}