Pinwheel · Schema

Account

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
customer_id	string	Banking platforms webhooks only: the customer ID associated with the platform's customer.
tags	object	The tags associated with the link token that triggered the job.
reseller_customer_id	string	The reseller customer ID associated with the job. Used exclusively for reseller customers.
created_at	string	ISO 8601 timestamp of created time.
link_token_id	string	UUID of the link token used to create the account.
platform_id	string	UUID of the platform associated with this account.
connected	boolean	If true, you can retrieve new data for the account using On Demand Updates or automatically via Monitoring.
monitoring_status	object	Monitoring status describes the the automated ability of Pinwheel to retrieve new account information.
end_user_id	string	User ID provided by you, to associate Pinwheel users with your user model. Required if `account_id` is not provided. This ID will be returned in all webhook events and all account-affiliated API respo
id	string	Unique identifier for the object.
data_updated_at	object	When data last changed for this payroll account.
data_refreshed_at	object	ISO 8601 timestamp of when data was last refreshed for this payroll account.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "customer_id": {
      "type": "string",
      "title": "customer_id",
      "description": "Banking platforms webhooks only: the customer ID associated with the platform's customer."
    },
    "tags": {
      "type": "object",
      "title": "tags",
      "description": "The tags associated with the link token that triggered the job."
    },
    "reseller_customer_id": {
      "type": "string",
      "title": "reseller_customer_id",
      "description": "The reseller customer ID associated with the job. Used exclusively for reseller customers."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "created_at",
      "description": "ISO 8601 timestamp of created time."
    },
    "link_token_id": {
      "type": "string",
      "format": "uuid",
      "title": "link_token_id",
      "description": "UUID of the link token used to create the account."
    },
    "platform_id": {
      "type": "string",
      "format": "uuid",
      "title": "platform_id",
      "description": "UUID of the platform associated with this account."
    },
    "connected": {
      "type": "boolean",
      "title": "connected",
      "description": "If true, you can retrieve new data for the account using On Demand Updates or automatically via Monitoring."
    },
    "monitoring_status": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "active",
            "degraded",
            "user_action_required",
            "customer_disabled",
            "unavailable"
          ]
        }
      ],
      "description": "Monitoring status describes the the automated ability of Pinwheel to retrieve new account information."
    },
    "end_user_id": {
      "type": "string",
      "title": "end_user_id",
      "description": "User ID provided by you, to associate Pinwheel users with your user model. Required if `account_id` is not provided. This ID will be returned in all webhook events and all account-affiliated API responses. Leading and trailing whitespace will be stripped. Do not include PII in this identifier."
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "id",
      "description": "Unique identifier for the object."
    },
    "data_updated_at": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PayrollAccountDataUpdated"
        }
      ],
      "title": "data_updated_at",
      "description": "When data last changed for this payroll account."
    },
    "data_refreshed_at": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PayrollAccountDataRefreshed"
        }
      ],
      "title": "data_refreshed_at",
      "description": "ISO 8601 timestamp of when data was last refreshed for this payroll account."
    }
  },
  "type": "object",
  "required": [
    "created_at",
    "platform_id",
    "connected",
    "monitoring_status",
    "id",
    "data_updated_at",
    "data_refreshed_at"
  ],
  "title": "Account",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/PayrollAccountObjResponse.json"
}