{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/rutter/json-schema/rutter-hris-employee-payroll-run-response-with-connection-schema.json",
  "title": "HrisEmployeePayrollRunResponseWithConnection",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rutter-hris-api-openapi.yml#/components/schemas/HrisEmployeePayrollRunResponseWithConnection",
  "type": "object",
  "properties": {
    "employee_payroll_run": {
      "$ref": "#/$defs/HrisEmployeePayrollRun"
    },
    "connection": {
      "$ref": "#/$defs/Connection"
    }
  },
  "required": [
    "employee_payroll_run",
    "connection"
  ],
  "$defs": {
    "Connection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The UUID of the connection. Generated by Rutter."
        },
        "orgId": {
          "type": "string",
          "format": "uuid",
          "description": "Your organization id."
        },
        "platform": {
          "$ref": "#/$defs/Platform"
        }
      },
      "required": [
        "id",
        "orgId",
        "platform"
      ]
    },
    "HrisEmployeePayrollRun": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The Rutter generated unique ID of the HRIS employee payroll run.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "platform_id": {
          "type": "string",
          "description": "The platform specific ID of the HRIS employee payroll run.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "employee_id": {
          "type": "string",
          "format": "uuid",
          "description": "The Rutter ID of the [HRIS employee payroll run](/rest/version/hris-employees) linked to the employee.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "paycheck_txn_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The platform paycheck transaction identifier.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "payroll_run_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The platform or provider payroll run identifier.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "check_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the paycheck was issued.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "gross_pay": {
          "type": [
            "number",
            "null"
          ],
          "description": "The employee's gross pay.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "net_pay": {
          "type": [
            "number",
            "null"
          ],
          "description": "The employee's net pay.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "total_hours": {
          "type": [
            "number",
            "null"
          ],
          "description": "The total hours paid."
        },
        "employer_contributions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "number",
                "description": "The amount for the payroll item.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The platform payroll item name.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The normalized type of the payroll item.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              }
            },
            "required": [
              "amount",
              "name",
              "type"
            ],
            "additionalProperties": false
          },
          "description": "Contributions paid by the employer.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "earnings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "number",
                "description": "The amount for the payroll item.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "hours": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The hours for the earning."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The platform payroll item name.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The normalized earning type.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              }
            },
            "required": [
              "amount",
              "hours",
              "name",
              "type"
            ],
            "additionalProperties": false
          },
          "description": "Earnings included in the paycheck.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "employee_deductions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "number",
                "description": "The amount for the payroll item."
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The platform payroll item name."
              },
              "pre_tax": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether the deduction is taken before tax."
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The normalized type of the payroll item."
              }
            },
            "required": [
              "amount",
              "name",
              "pre_tax",
              "type"
            ],
            "additionalProperties": false
          },
          "description": "Deductions taken from the employee's pay."
        },
        "taxes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "number",
                "description": "The amount for the payroll item.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "employer": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether the tax is paid by the employer.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The platform payroll item name.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The normalized type of the payroll item.",
                "x-rutter-platforms": {
                  "QUICKBOOKS_DESKTOP": {}
                }
              }
            },
            "required": [
              "amount",
              "employer",
              "name",
              "type"
            ],
            "additionalProperties": false
          },
          "description": "Taxes withheld or paid by the employer.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS employee payroll run was created.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS employee payroll run was last updated.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "last_synced_at": {
          "type": "string",
          "description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the HRIS employee payroll run was last synced by Rutter.",
          "x-rutter-platforms": {
            "QUICKBOOKS_DESKTOP": {}
          }
        },
        "platform_data": {
          "type": "object",
          "additionalProperties": {},
          "description": "The raw platform data corresponding to the Rutter object."
        }
      },
      "required": [
        "id",
        "platform_id",
        "employee_id",
        "paycheck_txn_id",
        "payroll_run_id",
        "check_date",
        "gross_pay",
        "net_pay",
        "total_hours",
        "employer_contributions",
        "earnings",
        "employee_deductions",
        "taxes",
        "created_at",
        "updated_at",
        "last_synced_at"
      ]
    },
    "Platform": {
      "type": "string",
      "enum": [
        "AMAZON",
        "EBAY",
        "ETSY",
        "FNAC",
        "WALMART",
        "SHOPEE",
        "LAZADA",
        "MERCADOLIBRE",
        "ALIBABA",
        "WAYFAIR",
        "SHEIN",
        "NOON",
        "SHOPLINE",
        "PRESTASHOP",
        "SHOPIFY",
        "MAGENTO",
        "WOO_COMMERCE",
        "SQUARESPACE",
        "WIX",
        "SHOPER",
        "SHOPLAZZA",
        "BIG_COMMERCE",
        "SALLA",
        "ZID",
        "TIKTOKSHOP",
        "COMMERCELAYER",
        "WEBFLOW",
        "GUMROAD",
        "ECWID",
        "PAYPAL",
        "SQUARE",
        "STRIPE",
        "CLOVER",
        "MOLLIE",
        "PAYNL",
        "AUTHORIZENET",
        "RECHARGE",
        "CHARGIFY",
        "CHARGEBEE",
        "RECURLY",
        "KASHFLOW",
        "SAGE_INTACCT",
        "SAGE_INTACCT_V2",
        "DYNAMICS365",
        "DYNAMICS365FO",
        "ZOHOBOOKS",
        "EXACTONLINE",
        "FREEAGENT",
        "QUICKBOOKS",
        "QUICKBOOKS_DESKTOP",
        "FRESHBOOKS",
        "XERO",
        "SAGE_BUSINESS_CLOUD",
        "SAGE_50",
        "VISTA",
        "NETSUITE",
        "WAVE",
        "DUALENTRY",
        "CAMPFIRE",
        "RILLET",
        "SOFTLEDGER",
        "VISMA",
        "SPIRIS",
        "LEXWARE",
        "MONEYBIRD",
        "SAGE200CLOUD",
        "MX",
        "PLAID",
        "TELLER",
        "RAMP",
        "ODOO",
        "ACUMATICA",
        "FULFIL",
        "TALLY",
        "SAPBUSINESSONE",
        "SAPS4HANA",
        "WORKDAY",
        "ANFIX",
        "ORACLEFUSION",
        "HOLDED",
        "MYOBBUSINESS",
        "FORTNOX",
        "GOOGLE",
        "FACEBOOK",
        "TIKTOK",
        "INTUIT_BANK_FEEDS",
        "PLAID_BANK_FEEDS",
        "SAGE",
        "SAGE_BANK_FEEDS",
        "YODLEE_BANK_FEEDS",
        "QUICKBOOKS_HRIS",
        "BAMBOO_HR",
        "GUSTO",
        "DEEL",
        "RIPPLING"
      ],
      "description": "The underlying platform."
    }
  }
}