Pinwheel · Schema

Employer

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
id	string	UUID of the employer.
name	string	Name of employer, e.g., Apple, Disney, Walmart.
last_updated	string	ISO 8601 timestamp of the last update to this object.
logo_url	string	The URL of the employer logo.
supported_jobs	array	Array of supported jobs.
fractional_amount_supported	boolean	Whether or not the platform accepts decimal values for `direct_deposit_switch`.
amount_supported	boolean	Whether a direct deposit job supports specific amount.
min_amount	number	Minimum amount, if any, platform accepts for `direct_deposit_switch`.
max_amount	number	Maximum amount, if any, platform accepts for `direct_deposit_switch`.
min_percentage	integer	Minimum percentage allowed for `direct_deposit_switch`.
max_percentage	integer	Maximum percentage allowed for `direct_deposit_switch`.
percentage_supported	boolean	Whether a direct deposit job supports percentage switching.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "id",
      "description": "UUID of the employer."
    },
    "name": {
      "type": "string",
      "title": "name",
      "description": "Name of employer, e.g., Apple, Disney, Walmart."
    },
    "last_updated": {
      "type": "string",
      "format": "date-time",
      "title": "last_updated",
      "description": "ISO 8601 timestamp of the last update to this object."
    },
    "logo_url": {
      "type": "string",
      "maxLength": 65536,
      "minLength": 1,
      "format": "uri",
      "title": "logo_url",
      "description": "The URL of the employer logo."
    },
    "supported_jobs": {
      "items": {
        "type": "string",
        "enum": [
          "direct_deposit_allocations",
          "bill_cancellation",
          "direct_deposit_switch",
          "paycheck_viewer",
          "paystubs",
          "bill_switch",
          "identity",
          "direct_deposit_payment",
          "income",
          "employment",
          "tax_forms",
          "shifts"
        ]
      },
      "type": "array",
      "description": "Array of supported jobs."
    },
    "fractional_amount_supported": {
      "type": "boolean",
      "title": "fractional_amount_supported",
      "description": "Whether or not the platform accepts decimal values for `direct_deposit_switch`."
    },
    "amount_supported": {
      "type": "boolean",
      "title": "amount_supported",
      "description": "Whether a direct deposit job supports specific amount."
    },
    "min_amount": {
      "type": "number",
      "title": "min_amount",
      "description": "Minimum amount, if any, platform accepts for `direct_deposit_switch`."
    },
    "max_amount": {
      "type": "number",
      "title": "max_amount",
      "description": "Maximum amount, if any, platform accepts for `direct_deposit_switch`."
    },
    "min_percentage": {
      "type": "integer",
      "exclusiveMaximum": true,
      "title": "min_percentage",
      "description": "Minimum percentage allowed for `direct_deposit_switch`.",
      "maximum": 100.0,
      "minimum": true,
      "exclusiveMinimum": true
    },
    "max_percentage": {
      "type": "integer",
      "exclusiveMaximum": true,
      "title": "max_percentage",
      "description": "Maximum percentage allowed for `direct_deposit_switch`.",
      "maximum": 100.0,
      "minimum": true,
      "exclusiveMinimum": true
    },
    "percentage_supported": {
      "type": "boolean",
      "title": "percentage_supported",
      "description": "Whether a direct deposit job supports percentage switching."
    }
  },
  "type": "object",
  "required": [
    "id",
    "name",
    "last_updated",
    "supported_jobs",
    "fractional_amount_supported",
    "amount_supported",
    "min_percentage",
    "max_percentage",
    "percentage_supported"
  ],
  "title": "Employer",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/EmployerObjResponse.json"
}