The getPayPeriodDetails API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations.
What it does:
Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount
Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available
Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes
Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations
Supports pagination of payrollLineItems using limit and offset
Notes:
includeTransactions can be used to view the company debit and employee credits on each payPeriod
includeTransactions defaults to false when not included in the request
limit and offset are optional; omit both to retrieve all payroll line items
Company debit and credit transactions for the pay period. Present at the response root only when includeTransactions is true.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rollfi","colors":{"primary":"#FF4217","light":"#FAFAFA","dark":"#0E0E0E"},"logo":{"light":"https://mintcdn.com/rollfi/0plDFeEVanwNirPi/logo/rollfi-logo.png?fit=max\u0026auto=format\u0026n=0plDFeEVanwNirPi\u0026q=85\u0026s=9564367ecd94a7809971163c7483ebba","dark":"https://mintcdn.com/rollfi/0plDFeEVanwNirPi/logo/rollfi-logo.png?fit=max\u0026auto=format\u0026n=0plDFeEVanwNirPi\u0026q=85\u0026s=9564367ecd94a7809971163c7483ebba"},"favicon":"https://mintcdn.com/rollfi/3cmcmZSTLqMTkR5Y/favicon.png?fit=max\u0026auto=format\u0026n=3cmcmZSTLqMTkR5Y\u0026q=85\u0026s=59ceef17edf39bfa875cf1c7c3f6d7d3","api":{"mdx":{"auth":{"method":"basic","name":"client_id:api_key"},"server":["https://sandbox.rollfi.xyz"]}},"navbar":{"links":[{"href":"https://cal.com/team/rollfi/embedded-payroll","label":"Contact Us"}],"primary":{"type":"button","label":"Sign in","href":"https://app.rollfi.xyz/app/Rollfi-Registration/Login"}},"footer":{"socials":{"twitter":"https://twitter.com/rollfi_xyz","linkedin":"https://www.linkedin.com/company/rollfi"}},"icons":{"library":"lucide"},"styling":{"latex":true},"navigation":{"global":{"tabs":[{"tab":"Embedded Payroll","href":"https://www.rollfi.xyz"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rollfi","hasAudioNarration":false,"actualSubdomain":"rollfi","customDomains":["developer.rollfi.xyz"],"gitSource":{"type":"github","owner":"rollfipayroll","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfd1f6369ee86f9f90cf6f","collectionId":"de0b6885-7a3b-4ba2-8d98-9b077dc12566","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfd1f6369ee86f9f90cf6f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfd1f6369ee86f9f90cf6f","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":354},{"language":"default","tag":"Reports","count":55},{"language":"default","tag":"Admin Portal","count":43},{"language":"default","tag":"Payroll","count":25},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Overview","count":16},{"language":"default","tag":"Webhooks","count":13},{"language":"default","tag":"Company Onboarding","count":11},{"language":"default","tag":"User Portal","count":10},{"language":"default","tag":"User Onboarding","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/reports/getPayPeriodDetails","slug":"/api-reference/reports/getPayPeriodDetails","pageMetadata":{"openapi":"get /reports/getPayPeriodDetails","title":"getPayPeriodDetails","description":"The `getPayPeriodDetails` API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations.\n\n### What it does:\n- Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount\n- Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available\n- Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes\n- Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations\n- Supports pagination of payrollLineItems using limit and offset\n\n### Notes:\n- includeTransactions can be used to view the company debit and employee credits on each payPeriod\n- includeTransactions defaults to false when not included in the request\n- limit and offset are optional; omit both to retrieve all payroll line items\n","href":"/api-reference/reports/getPayPeriodDetails"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"getPayPeriodDetails\"\n }), \" API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"What it does:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Supports pagination of payrollLineItems using limit and offset\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Notes:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"includeTransactions can be used to view the company debit and employee credits on each payPeriod\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"includeTransactions defaults to false when not included in the request\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"limit and offset are optional; omit both to retrieve all payroll line items\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /reports/getPayPeriodDetails","title":"getPayPeriodDetails","description":"The `getPayPeriodDetails` API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations.\n\n### What it does:\n- Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount\n- Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available\n- Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes\n- Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations\n- Supports pagination of payrollLineItems using limit and offset\n\n### Notes:\n- includeTransactions can be used to view the company debit and employee credits on each payPeriod\n- includeTransactions defaults to false when not included in the request\n- limit and offset are optional; omit both to retrieve all payroll line items\n","href":"/api-reference/reports/getPayPeriodDetails"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"getPayPeriodDetails","deprecated":false,"description":"The `getPayPeriodDetails` API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations.\n\n### What it does:\n- Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount\n- Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available\n- Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes\n- Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations\n- Supports pagination of payrollLineItems using limit and offset\n\n### Notes:\n- includeTransactions can be used to view the company debit and employee credits on each payPeriod\n- includeTransactions defaults to false when not included in the request\n- limit and offset are optional; omit both to retrieve all payroll line items\n","tags":[],"parameters":[],"requestBody":"8ffa2ca5-1f44-4fc9-b261-3d3c48e9063d","responses":{"200":"227097a9-506a-490f-96d8-525da5cf1ba2"},"security":[],"method":"get","type":"path","servers":[],"path":"/reports/getPayPeriodDetails","baseUrlOptions":["https://sandbox.rollfi.xyz"],"title":"getPayPeriodDetails","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","examples":["getPayPeriodDetails"],"title":"getPayPeriodDetails","enum":["getPayPeriodDetails"],"isRequired":true,"uniqueKey":"method","typeLabel":"enum\u003cstring>"},"payPeriodId":{"type":"string","format":"uuid","description":"ID of the pay period to retrieve.","isRequired":true,"uniqueKey":"payPeriodId","typeLabel":"string\u003cuuid>"},"companyId":{"type":"string","format":"uuid","description":"Optional company ID. Resolved from payPeriodId when omitted.","uniqueKey":"companyId","typeLabel":"string\u003cuuid>"},"includeTransactions":{"type":"boolean","default":false,"description":"Include company debit and employee credit transaction details. Transaction fields are omitted when false.","uniqueKey":"includeTransactions","typeLabel":"boolean"},"limit":{"type":"integer","minimum":0,"description":"Maximum number of payroll line items to return. Use a positive value for a bounded page; omit for no page-size limit.","uniqueKey":"limit","typeLabel":"integer"},"offset":{"type":"integer","minimum":0,"default":0,"description":"Number of payroll line items to skip. Supplying limit or offset adds root-level pagination metadata.","uniqueKey":"offset","typeLabel":"integer"}},"required":["method","payPeriodId"],"uniqueKey":"","typeLabel":"object"},"example":{"method":"getPayPeriodDetails","payPeriodId":"7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53","includeTransactions":false,"limit":50,"offset":0},"examples":{"Example":{"title":"Example","value":{"method":"getPayPeriodDetails","payPeriodId":"7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53","includeTransactions":false,"limit":50,"offset":0}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"227097a9-506a-490f-96d8-525da5cf1ba2":{"description":"Pay period details. Pagination and transaction fields are included only when requested.","content":{"application/json":{"schema":{"type":"object","properties":{"payPeriod":{"type":"array","items":{"type":"object","properties":{"payPeriodId":{"type":"string","format":"uuid","uniqueKey":"payPeriod.items.[INDEX].payPeriodId","typeLabel":"string\u003cuuid>"},"payScheduleId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"payPeriod.items.[INDEX].payScheduleId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"payPeriod.items.[INDEX].payScheduleId.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payScheduleId","typeLabel":"string\u003cuuid> | null"},"companyId":{"type":"string","format":"uuid","uniqueKey":"payPeriod.items.[INDEX].companyId","typeLabel":"string\u003cuuid>"},"payPeriod":{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payPeriod","typeLabel":"string"},"deadLineToRunPayroll":{"oneOf":[{"type":"string","uniqueKey":"payPeriod.items.[INDEX].deadLineToRunPayroll.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].deadLineToRunPayroll.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].deadLineToRunPayroll","typeLabel":"string | null"},"PayPeriodStatus":{"oneOf":[{"type":"string","uniqueKey":"payPeriod.items.[INDEX].PayPeriodStatus.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].PayPeriodStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].PayPeriodStatus","typeLabel":"string | null"},"total":{"oneOf":[{"type":"number","uniqueKey":"payPeriod.items.[INDEX].total.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].total.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].total","typeLabel":"number | null"},"debitAmount":{"oneOf":[{"type":"number","description":"Calculated debit amount for the pay period, when available.","uniqueKey":"payPeriod.items.[INDEX].debitAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Calculated debit amount for the pay period, when available.","uniqueKey":"payPeriod.items.[INDEX].debitAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].debitAmount","typeLabel":"number | null"},"employeeTaxSum":{"oneOf":[{"type":"number","uniqueKey":"payPeriod.items.[INDEX].employeeTaxSum.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].employeeTaxSum.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].employeeTaxSum","typeLabel":"number | null"},"employerTaxSum":{"oneOf":[{"type":"number","uniqueKey":"payPeriod.items.[INDEX].employerTaxSum.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].employerTaxSum.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].employerTaxSum","typeLabel":"number | null"},"isProcessed":{"oneOf":[{"type":"boolean","uniqueKey":"payPeriod.items.[INDEX].isProcessed.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].isProcessed.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].isProcessed","typeLabel":"boolean | null"},"payDate":{"oneOf":[{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payDate.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].payDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payDate","typeLabel":"string | null"},"payEndDate":{"oneOf":[{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payEndDate.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].payEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payEndDate","typeLabel":"string | null"},"payBeginDate":{"oneOf":[{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payBeginDate.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].payBeginDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payBeginDate","typeLabel":"string | null"},"workerType":{"oneOf":[{"type":"object","properties":{"workerType":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].workerType.oneOf.0.workerType","typeLabel":"string"}},"required":["workerType"],"uniqueKey":"payPeriod.items.[INDEX].workerType.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"workerType":{"type":"string"}},"required":["workerType"],"uniqueKey":"payPeriod.items.[INDEX].workerType.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].workerType","typeLabel":"object | null"},"payPeriodType":{"oneOf":[{"type":"object","properties":{"payPeriodType":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payPeriodType.oneOf.0.payPeriodType","typeLabel":"string"}},"required":["payPeriodType"],"uniqueKey":"payPeriod.items.[INDEX].payPeriodType.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"payPeriodType":{"type":"string"}},"required":["payPeriodType"],"uniqueKey":"payPeriod.items.[INDEX].payPeriodType.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payPeriodType","typeLabel":"object | null"},"payrollLineItems":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"userName":{"type":"string","description":"Employee name, or company name for a business contractor.","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].userName","typeLabel":"string"},"baseTotal":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].baseTotal.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].baseTotal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].baseTotal","typeLabel":"number | null"},"numberOfLeaveDays":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].numberOfLeaveDays.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].numberOfLeaveDays.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].numberOfLeaveDays","typeLabel":"number | null"},"lop":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].lop.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].lop.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].lop","typeLabel":"number | null"},"retroAmount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].retroAmount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].retroAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].retroAmount","typeLabel":"number | null"},"grossTotal":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].grossTotal.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].grossTotal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].grossTotal","typeLabel":"number | null"},"netTotal":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].netTotal.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].netTotal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].netTotal","typeLabel":"number | null"},"payHours":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payHours.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payHours.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payHours","typeLabel":"number | null"},"differentialPay":{"type":"boolean","description":"Whether the latest active wage record has differential pay enabled.","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].differentialPay","typeLabel":"boolean"},"isMiscellaneousStateTaxApplicable":{"type":"boolean","description":"Whether the employee has an active miscellaneous state tax configuration.","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].isMiscellaneousStateTaxApplicable","typeLabel":"boolean"},"employeeTaxDetails":{"type":"array","items":{"type":"object","properties":{"taxName":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTaxDetails.items.[INDEX].taxName","typeLabel":"string"},"taxAmount":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTaxDetails.items.[INDEX].taxAmount","typeLabel":"number"},"taxAmountYtd":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTaxDetails.items.[INDEX].taxAmountYtd","typeLabel":"number"},"isEmployerTax":{"type":"boolean","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTaxDetails.items.[INDEX].isEmployerTax","typeLabel":"boolean"}},"required":["taxName","taxAmount","taxAmountYtd","isEmployerTax"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTaxDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTaxDetails","typeLabel":"object[]"},"employerTaxDetails":{"type":"array","items":{"type":"object","properties":{"taxName":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employerTaxDetails.items.[INDEX].taxName","typeLabel":"string"},"taxAmount":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employerTaxDetails.items.[INDEX].taxAmount","typeLabel":"number"},"taxAmountYtd":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employerTaxDetails.items.[INDEX].taxAmountYtd","typeLabel":"number"},"isEmployerTax":{"type":"boolean","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employerTaxDetails.items.[INDEX].isEmployerTax","typeLabel":"boolean"}},"required":["taxName","taxAmount","taxAmountYtd","isEmployerTax"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employerTaxDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employerTaxDetails","typeLabel":"object[]"},"taxAdjustments":{"type":"array","items":{"type":"object","properties":{"taxName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX].taxName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX].taxName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX].taxName","typeLabel":"string | null"},"taxAmount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX].taxAmount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX].taxAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX].taxAmount","typeLabel":"number | null"}},"required":["taxName","taxAmount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].taxAdjustments","typeLabel":"object[]"},"payRate":{"oneOf":[{"type":"number","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payRate.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payRate","typeLabel":"number | null"},"standardWorkingHours":{"oneOf":[{"type":"number","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].standardWorkingHours.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].standardWorkingHours.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].standardWorkingHours","typeLabel":"number | null"},"employeeWages":{"type":"array","description":"Latest active employee wage record, when available. Differential-pay identifiers are excluded.","items":{"type":"object","properties":{"wageRate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageRate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageRate","typeLabel":"number | null"},"wageBasis":{"oneOf":[{"type":"object","properties":{"wageBasis":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageBasis.oneOf.0.wageBasis","typeLabel":"string"}},"required":["wageBasis"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageBasis.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"wageBasis":{"type":"string"}},"required":["wageBasis"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageBasis.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX].wageBasis","typeLabel":"object | null"}},"required":["wageRate","wageBasis"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeWages","typeLabel":"object[]"},"paymentMethod":{"type":"string","description":"Payment method label, included when available.","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].paymentMethod","typeLabel":"string"},"employeeTax":{"oneOf":[{"type":"object","properties":{"employeeTax":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTax.oneOf.0.employeeTax.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTax.oneOf.0.employeeTax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTax.oneOf.0.employeeTax","typeLabel":"number | null"}},"required":["employeeTax"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTax.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"employeeTax":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["employeeTax"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTax.oneOf.1","typeLabel":"null"}],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeeTax","typeLabel":"object | null"},"employeePayrollTransactions":{"type":"array","description":"Included only when includeTransactions is true.","items":{"type":"object","properties":{"transactionName":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeePayrollTransactions.items.[INDEX].transactionName","typeLabel":"string"},"transferAmount":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeePayrollTransactions.items.[INDEX].transferAmount","typeLabel":"number"},"status":{"type":"string","enum":["failed","pending","returned","complete","cancelled"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeePayrollTransactions.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["transactionName","transferAmount","status"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeePayrollTransactions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].employeePayrollTransactions","typeLabel":"object[]"},"miscellaneousStateTaxes":{"type":"array","items":{"type":"object","properties":{"stateCode":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX].stateCode","typeLabel":"string"},"taxName":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX].taxName","typeLabel":"string"},"taxDetails":{"type":"array","items":{"type":"object","description":"Tax-specific form fields use camelCase names and string values, alongside noOfHours.","properties":{"noOfHours":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX].taxDetails.items.[INDEX].noOfHours","typeLabel":"number"}},"additionalProperties":{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX].taxDetails.items.[INDEX].additionalProperties","typeLabel":"string"},"required":["noOfHours"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX].taxDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX].taxDetails","typeLabel":"object[]"}},"required":["stateCode","taxName","taxDetails"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].miscellaneousStateTaxes","typeLabel":"object[]"},"overTimes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX].type","typeLabel":"string"},"amount":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX].amount","typeLabel":"number"},"numberOfHours":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX].numberOfHours","typeLabel":"number"},"multiplier":{"oneOf":[{"type":"number","description":"Overtime multiplier, or an empty string when unavailable.","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX].multiplier.oneOf.0","typeLabel":"number"},{"type":"string","description":"Overtime multiplier, or an empty string when unavailable.","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX].multiplier.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX].multiplier","typeLabel":"number | string"}},"required":["type","amount","numberOfHours","multiplier"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].overTimes","typeLabel":"object[]"},"additionalCompensations":{"type":"array","items":{"type":"object","properties":{"payrollLineItemAdditionalCompensationVertexCompensationIdentifier":{"oneOf":[{"type":"object","properties":{"compensationDescription":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].payrollLineItemAdditionalCompensationVertexCompensationIdentifier.oneOf.0.compensationDescription","typeLabel":"string"}},"required":["compensationDescription"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].payrollLineItemAdditionalCompensationVertexCompensationIdentifier.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"compensationDescription":{"type":"string"}},"required":["compensationDescription"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].payrollLineItemAdditionalCompensationVertexCompensationIdentifier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].payrollLineItemAdditionalCompensationVertexCompensationIdentifier","typeLabel":"object | null"},"amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX].amount","typeLabel":"number | null"}},"required":["payrollLineItemAdditionalCompensationVertexCompensationIdentifier","amount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].additionalCompensations","typeLabel":"object[]"},"deductions":{"type":"array","items":{"type":"object","properties":{"vertexDeductionIdentifier":{"oneOf":[{"type":"object","properties":{"deductionDescription":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].vertexDeductionIdentifier.oneOf.0.deductionDescription","typeLabel":"string"}},"required":["deductionDescription"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].vertexDeductionIdentifier.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"deductionDescription":{"type":"string"}},"required":["deductionDescription"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].vertexDeductionIdentifier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].vertexDeductionIdentifier","typeLabel":"object | null"},"amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX].amount","typeLabel":"number | null"}},"required":["vertexDeductionIdentifier","amount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].deductions","typeLabel":"object[]"},"reimbursements":{"type":"array","items":{"type":"object","properties":{"reimbursementType":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX].reimbursementType.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX].reimbursementType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX].reimbursementType","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX].amount","typeLabel":"number | null"}},"required":["reimbursementType","amount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].reimbursements","typeLabel":"object[]"},"garnishments":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].garnishments.items.[INDEX].amount","typeLabel":"number"},"garnishmentType":{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].garnishments.items.[INDEX].garnishmentType","typeLabel":"string"},"garnishmentAgency":{"type":"string","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].garnishments.items.[INDEX].garnishmentAgency","typeLabel":"string"}},"required":["amount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].garnishments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].garnishments","typeLabel":"object[]"},"timeOffs":{"type":"array","items":{"type":"object","properties":{"leaveType":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].timeOffs.items.[INDEX].leaveType","typeLabel":"string"},"hours":{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].timeOffs.items.[INDEX].hours","typeLabel":"number"},"policyType":{"type":"string","description":"Paid-time-off policy label, when available.","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].timeOffs.items.[INDEX].policyType","typeLabel":"string"},"amount":{"type":"number","description":"Amount for an unpaid-time-off entry, when applicable.","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].timeOffs.items.[INDEX].amount","typeLabel":"number"}},"required":["leaveType","hours"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].timeOffs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].timeOffs","typeLabel":"object[]"},"payDetails":{"type":"array","items":{"type":"object","properties":{"payPercentage":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].payPercentage.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].payPercentage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].payPercentage","typeLabel":"number | null"},"amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].amount","typeLabel":"number | null"},"employeePayAccount":{"oneOf":[{"type":"object","properties":{"accountName":{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].employeePayAccount.oneOf.0.accountName","typeLabel":"string"}},"required":["accountName"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].employeePayAccount.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"accountName":{"type":"string"}},"required":["accountName"],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].employeePayAccount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].employeePayAccount","typeLabel":"object | null"},"paymentMethod":{"type":"string","description":"Payment method label, included when available.","uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX].paymentMethod","typeLabel":"string"}},"required":["payPercentage","amount","employeePayAccount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].payDetails","typeLabel":"object[]"},"basePay":{"type":"array","description":"Active imported base-pay entries. Omitted when none exist.","items":{"type":"object","properties":{"payCode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payCode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payCode","typeLabel":"string | null"},"payHours":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payHours.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payHours.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payHours","typeLabel":"number | null"},"payRate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payRate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].payRate","typeLabel":"number | null"},"multiplier":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].multiplier.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].multiplier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].multiplier","typeLabel":"number | null"},"amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX].amount","typeLabel":"number | null"}},"required":["payCode","payHours","payRate","multiplier","amount"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX].basePay","typeLabel":"object[]"}},"required":["userId","userName","baseTotal","numberOfLeaveDays","lop","retroAmount","grossTotal","netTotal","payHours","differentialPay","isMiscellaneousStateTaxApplicable","taxAdjustments","employeeTaxDetails","employerTaxDetails"],"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payPeriod.items.[INDEX].payrollLineItems","typeLabel":"object[]"}},"uniqueKey":"payPeriod.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payPeriod","typeLabel":"object[]"},"pagination":{"type":"object","description":"Present when limit or offset is supplied. total counts payroll line items for the pay period, not just the returned page.","properties":{"offset":{"type":"integer","isRequired":true,"uniqueKey":"pagination.offset","typeLabel":"integer"},"limit":{"type":"integer","description":"Requested limit, or 0 when omitted.","isRequired":true,"uniqueKey":"pagination.limit","typeLabel":"integer"},"total":{"type":"integer","isRequired":true,"uniqueKey":"pagination.total","typeLabel":"integer"}},"required":["offset","limit","total"],"uniqueKey":"pagination","typeLabel":"object"},"companyPayrollTransactions":{"type":"array","description":"Company debit and credit transactions for the pay period. Present at the response root only when includeTransactions is true.","items":{"type":"object","properties":{"transactionName":{"type":"string","isRequired":true,"uniqueKey":"companyPayrollTransactions.items.[INDEX].transactionName","typeLabel":"string"},"transferAmount":{"type":"number","isRequired":true,"uniqueKey":"companyPayrollTransactions.items.[INDEX].transferAmount","typeLabel":"number"},"status":{"type":"string","enum":["failed","pending","returned","complete","cancelled"],"isRequired":true,"uniqueKey":"companyPayrollTransactions.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["transferAmount","status","transactionName"],"uniqueKey":"companyPayrollTransactions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"companyPayrollTransactions","typeLabel":"object[]"}},"required":["payPeriod"],"uniqueKey":"","typeLabel":"object"},"examples":{"1":{"title":"1","value":{"pagination":{"offset":0,"limit":50,"total":1},"payPeriod":[{"payPeriodId":"7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53","payScheduleId":"56925A03-645D-4AC8-BBDF-6960A1DFF394","companyId":"3986B7F2-AC6E-4694-A2B1-970167A98216","payPeriod":"09/01/2026 - 09/15/2026","deadLineToRunPayroll":"2026-09-14","PayPeriodStatus":"processed","total":2025,"debitAmount":2140,"employeeTaxSum":250,"employerTaxSum":115,"isProcessed":true,"payDate":"2026-09-18","payEndDate":"2026-09-15","payBeginDate":"2026-09-01","workerType":{"workerType":"W2"},"payPeriodType":{"payPeriodType":"Regular"},"payrollLineItems":[{"userId":"4DF5A79A-3735-4588-95A6-B80D15CB5A5E","userName":"Alex Morgan","baseTotal":2000,"numberOfLeaveDays":0,"lop":0,"retroAmount":0,"grossTotal":2025,"netTotal":1775,"payHours":80,"payRate":25,"standardWorkingHours":8,"differentialPay":true,"isMiscellaneousStateTaxApplicable":false,"employeeWages":[{"wageRate":25,"wageBasis":{"wageBasis":"Hourly"}}],"paymentMethod":"Direct Deposit","employeeTax":{"employeeTax":250},"employeeTaxDetails":[{"taxName":"Federal Withholding Tax","taxAmount":250,"taxAmountYtd":2250,"isEmployerTax":false}],"employerTaxDetails":[{"taxName":"Social Security","taxAmount":115,"taxAmountYtd":1035,"isEmployerTax":true}],"taxAdjustments":[{"taxName":"Federal Withholding Tax","taxAmount":10.5}],"miscellaneousStateTaxes":[],"overTimes":[],"additionalCompensations":[],"deductions":[],"reimbursements":[],"garnishments":[],"timeOffs":[],"payDetails":[{"payPercentage":100,"amount":1775,"employeePayAccount":{"accountName":"Primary Checking"},"paymentMethod":"Direct Deposit"}],"basePay":[{"payCode":"REG","payHours":80,"payRate":25,"multiplier":1,"amount":2000},{"payCode":"SHIFT","payHours":2.5,"payRate":10,"multiplier":1,"amount":25}]}]}]}},"2":{"title":"2","value":{"payPeriod":[{"payPeriodId":"7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53","payScheduleId":"56925A03-645D-4AC8-BBDF-6960A1DFF394","companyId":"3986B7F2-AC6E-4694-A2B1-970167A98216","payPeriod":"09/01/2026 - 09/15/2026","deadLineToRunPayroll":"2026-09-14","PayPeriodStatus":"processed","total":2025,"debitAmount":2140,"employeeTaxSum":250,"employerTaxSum":115,"isProcessed":true,"payDate":"2026-09-18","payEndDate":"2026-09-15","payBeginDate":"2026-09-01","workerType":{"workerType":"W2"},"payPeriodType":{"payPeriodType":"Regular"},"payrollLineItems":[{"userId":"4DF5A79A-3735-4588-95A6-B80D15CB5A5E","userName":"Alex Morgan","baseTotal":2000,"numberOfLeaveDays":0,"lop":0,"retroAmount":0,"grossTotal":2025,"netTotal":1775,"payHours":80,"payRate":25,"standardWorkingHours":8,"differentialPay":false,"isMiscellaneousStateTaxApplicable":false,"employeeWages":[],"employeeTax":{"employeeTax":250},"employeePayrollTransactions":[{"transactionName":"AchCredit","transferAmount":1775,"status":"complete"}],"employeeTaxDetails":[{"taxName":"Federal Withholding Tax","taxAmount":250,"taxAmountYtd":2250,"isEmployerTax":false}],"employerTaxDetails":[{"taxName":"Social Security","taxAmount":115,"taxAmountYtd":1035,"isEmployerTax":true}],"taxAdjustments":[],"miscellaneousStateTaxes":[],"overTimes":[],"additionalCompensations":[{"payrollLineItemAdditionalCompensationVertexCompensationIdentifier":{"compensationDescription":"Bonus"},"amount":25}],"deductions":[],"reimbursements":[],"garnishments":[],"timeOffs":[],"payDetails":[{"payPercentage":100,"amount":1775,"employeePayAccount":null}]}]}],"companyPayrollTransactions":[{"transactionName":"AchDebit","transferAmount":2140,"status":"complete"}]}}},"exampleType":"examples"}},"headers":{},"exampleType":"examples"}},"security":{"cd1c40a7-bd38-4917-b084-8cc61e562703":{"Authorization":{"type":"http","scheme":"basic","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`."}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`."},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"Rollfi_v2.openapi.json"},"subdomain":"rollfi","siteName":"Rollfi","title":"getPayPeriodDetails - Rollfi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T15:16:45.840Z","originalFileLocation":"api-reference/reports/getPayPeriodDetails.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The getPayPeriodDetails API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations. ### What it does: - Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount - Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available - Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes - Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations - Supports pagination of payrollLineItems using limit and offset ### Notes: - includeTransactions can be used to view the company debit and employee credits on each payPeriod - includeTransactions defaults to false when not included in the request - limit and offset are optional; omit both to retrieve all payroll line items\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rollfi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"getPayPeriodDetails - Rollfi\">\u003cmeta data-mint-head property=\"og:description\" content=\"The getPayPeriodDetails API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations. ### What it does: - Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount - Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available - Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes - Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations - Supports pagination of payrollLineItems using limit and offset ### Notes: - includeTransactions can be used to view the company debit and employee credits on each payPeriod - includeTransactions defaults to false when not included in the request - limit and offset are optional; omit both to retrieve all payroll line items\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rollfi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rollfi.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=getPayPeriodDetails\u0026amp;description=The+%60getPayPeriodDetails%60+API+retrieves+detailed+payroll+information+for+a+specific+pay+period+using+a+payPeriodId.+Use+it+to+review+payroll+totals%2C+employee+ea\u0026amp;theme=b6b82f0d9dde7dd38e7329b6\u0026amp;signature=b82f5546c76cd2e842c8aabdd51b62942c35c7ac6b33d0d5271a95d0d6a3e85e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"getPayPeriodDetails - Rollfi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The getPayPeriodDetails API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations. ### What it does: - Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount - Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available - Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes - Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations - Supports pagination of payrollLineItems using limit and offset ### Notes: - includeTransactions can be used to view the company debit and employee credits on each payPeriod - includeTransactions defaults to false when not included in the request - limit and offset are optional; omit both to retrieve all payroll line items\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rollfi.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=getPayPeriodDetails\u0026amp;description=The+%60getPayPeriodDetails%60+API+retrieves+detailed+payroll+information+for+a+specific+pay+period+using+a+payPeriodId.+Use+it+to+review+payroll+totals%2C+employee+ea\u0026amp;theme=b6b82f0d9dde7dd38e7329b6\u0026amp;signature=b82f5546c76cd2e842c8aabdd51b62942c35c7ac6b33d0d5271a95d0d6a3e85e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rollfi/RELF3aF393RgDF3q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rollfi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4217\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/reports/getPayPeriodDetails.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.rollfi.xyz/#organization\",\"name\":\"Rollfi\",\"url\":\"https://developer.rollfi.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rollfi/0plDFeEVanwNirPi/logo/rollfi-logo.png?fit=max\u0026auto=format\u0026n=0plDFeEVanwNirPi\u0026q=85\u0026s=9564367ecd94a7809971163c7483ebba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.rollfi.xyz#website\",\"name\":\"Rollfi\",\"url\":\"https://developer.rollfi.xyz\",\"publisher\":{\"@id\":\"https://developer.rollfi.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails#webpage\",\"url\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails\",\"name\":\"getPayPeriodDetails\",\"description\":\"The getPayPeriodDetails API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations. ### What it does: - Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount - Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available - Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes - Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations - Supports pagination of payrollLineItems using limit and offset ### Notes: - includeTransactions can be used to view the company debit and employee credits on each payPeriod - includeTransactions defaults to false when not included in the request - limit and offset are optional; omit both to retrieve all payroll line items\",\"dateModified\":\"2026-10-09T15:16:45.840Z\",\"isPartOf\":{\"@id\":\"https://developer.rollfi.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.rollfi.xyz/api-reference/companyonboarding/createBusiness\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Reports\",\"item\":\"https://developer.rollfi.xyz/api-reference/reports/PaidTimeOff/getTimeOffPolicyTypes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"getPayPeriodDetails\",\"item\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails#apireference\",\"headline\":\"getPayPeriodDetails\",\"name\":\"getPayPeriodDetails\",\"description\":\"The getPayPeriodDetails API retrieves detailed payroll information for a specific pay period using a payPeriodId. Use it to review payroll totals, employee earnings, taxes, deductions, reimbursements, garnishments, and payment allocations. ### What it does: - Returns pay period dates, status, companyId, payScheduleId, totals, and debitAmount - Provides employee gross and net pay, wage information, differential-pay eligibility, and imported base-pay entries when available - Returns employee and employer tax details, tax adjustments, and grouped miscellaneous state taxes - Includes overtime, additional compensation, deductions, reimbursements, formatted time off, garnishments, and payment allocations - Supports pagination of payrollLineItems using limit and offset ### Notes: - includeTransactions can be used to view the company debit and employee credits on each payPeriod - includeTransactions defaults to false when not included in the request - limit and offset are optional; omit both to retrieve all payroll line items\",\"url\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails\",\"mainEntityOfPage\":{\"@id\":\"https://developer.rollfi.xyz/api-reference/reports/getPayPeriodDetails#webpage\"},\"dateModified\":\"2026-10-09T15:16:45.840Z\",\"publisher\":{\"@id\":\"https://developer.rollfi.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.rollfi.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rollfi\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rollfi","nav":{"global":{"tabs":[{"tab":"Embedded Payroll","href":"https://www.rollfi.xyz"}]},"anchors":[{"anchor":"Documentation","icon":"lightbulb","color":{"light":"#FF4217","dark":"#FF4217"},"pages":[{"title":"Documentation","href":"/docs/PayrollAPIDocumentation"}]},{"anchor":"API Reference","icon":"terminal","groups":[{"group":"API Reference","pages":[{"group":"Company Onboarding","pages":[{"openapi":"post /companyOnboarding/createBusiness","title":"createBusiness","href":"/api-reference/companyonboarding/createBusiness"},{"openapi":"post /companyOnboarding/companyRegistration","title":"companyRegistration","href":"/api-reference/companyonboarding/companyRegistration"},{"openapi":"put /companyOnboarding/updateAdminUser","title":"updateAdminUser","href":"/api-reference/companyonboarding/updateAdminUser"},{"openapi":"post /companyOnboarding/addCompanyLocation","title":"addCompanyLocation","href":"/api-reference/companyonboarding/addcompanylocation"},{"openapi":"post /companyOnboarding/addKybInformation","title":"addKybInformation","href":"/api-reference/companyonboarding/addkybinformation"},{"openapi":"post /companyOnboarding/initiateCompanyKyb","title":"initiateCompanyKyb","href":"/api-reference/companyonboarding/initiateCompanyKyb"},{"openapi":"post /companyOnboarding/addBusinessUser","title":"addBusinessUser","href":"/api-reference/companyonboarding/addbusinessuser"},{"openapi":"post /companyOnboarding/addBookKeeper","title":"addBookKeeper","href":"/api-reference/companyonboarding/addBookKeeper"},{"openapi":"put /companyOnboarding/updateKybInformation","title":"updateKybInformation","href":"/api-reference/companyonboarding/updateKybInformation"},{"openapi":"delete /companyOnboarding/deleteBusinessUser","title":"deleteBusinessUser","href":"/api-reference/companyonboarding/deleteBusinessUser"},{"openapi":"put /companyOnboarding/updateCompany","title":"updateCompany","href":"/api-reference/companyonboarding/updateCompany"}]},{"group":"User Onboarding","pages":[{"openapi":"post /userOnboarding/addKycInformation","title":"addKycInformation","href":"/api-reference/useronboarding/addKycInformation"},{"openapi":"post /userOnboarding/addW4Information","title":"addW4Information","href":"/api-reference/useronboarding/addW4Information"},{"openapi":"put /userOnboarding/acceptTermsAndCondition","title":"acceptTermsAndCondition","href":"/api-reference/useronboarding/acceptTermsAndCondition"},{"openapi":"post /userOnboarding/initiateUserKyc","title":"initiateUserKyc","href":"/api-reference/useronboarding/initiateUserKyc"},{"openapi":"put /userOnboarding/updateKycInformation","title":"updateKycInformation","href":"/api-reference/useronboarding/updateKycInformation"},{"openapi":"post /userOnboarding/addStateW4Information","title":"addStateW4Information","href":"/api-reference/useronboarding/addStateW4Information"},{"openapi":"put /userOnboarding/updateStateW4Information","title":"updateStateW4Information","href":"/api-reference/useronboarding/updateStateW4Information"},{"openapi":"put /userOnboarding/updateW4Information","title":"updateW4Information","href":"/api-reference/useronboarding/updateW4Information"}]},{"group":"Admin Portal","pages":[{"openapi":"post /adminPortal/addUser","title":"addUser","href":"/api-reference/adminportal/addUser"},{"openapi":"post /adminPortal/addUsers","title":"addUsers","href":"/api-reference/adminportal/addUsers"},{"openapi":"put /adminPortal/updateUser","title":"updateUser","href":"/api-reference/adminportal/updateUser"},{"openapi":"delete /adminPortal/deleteUser","title":"deleteUser","href":"/api-reference/adminportal/deleteUser"},{"openapi":"post /adminPortal/addFormerUser","title":"addFormerUser","href":"/api-reference/adminportal/addFormerUser"},{"openapi":"post /adminPortal/addUserWage","title":"addUserWage","href":"/api-reference/adminportal/addUserWage"},{"openapi":"put /adminPortal/updateUserWage","title":"updateUserWage","href":"/api-reference/adminportal/updateUserWage"},{"openapi":"post /adminPortal/activateUser","title":"activateUser","href":"/api-reference/adminportal/activateUser"},{"openapi":"post /adminPortal/deactivateUser","title":"deactivateUser","href":"/api-reference/adminportal/deactivateUser"},{"openapi":"post /adminPortal/addCompanyBankAccount","title":"addCompanyBankAccount","href":"/api-reference/adminportal/addCompanyBankAccount"},{"openapi":"put /adminPortal/deactivateCompanyBankAccount","title":"deactivateCompanyBankAccount","href":"/api-reference/adminportal/deactivateCompanyBankAccount"},{"openapi":"post /adminPortal/verifyMicroDeposits","title":"verifyMicroDeposits","href":"/api-reference/adminportal/verifyMicroDeposits"},{"openapi":"post /adminPortal/addBusinessContractor","title":"addBusinessContractor","href":"/api-reference/adminportal/addBusinessContractor"},{"openapi":"post /adminPortal/addStateRegistrationInfo","title":"addStateRegistrationInfo","href":"/api-reference/adminportal/addStateRegistrationInfo"},{"openapi":"put /adminPortal/updateStateRegistrationInfo","title":"updateStateRegistrationInfo","href":"/api-reference/adminportal/updateStateRegistrationInfo"},{"openapi":"post /adminPortal/addTimeOffPolicy","title":"addTimeOffPolicy","href":"/api-reference/adminportal/addTimeOffPolicy"},{"openapi":"post /adminPortal/addTimeOffPolicyAssignment","title":"addTimeOffPolicyAssignment","href":"/api-reference/adminportal/addTimeOffPolicyAssignment"},{"openapi":"put /adminPortal/updateTimeOffPolicyAssignment","title":null,"href":"/api-reference/adminportal/updateTimeOffPolicyAssignment"},{"openapi":"post /adminPortal/approveTimeOffRequest","title":"approveTimeOffRequest","href":"/api-reference/adminportal/approveTimeOffRequest"},{"openapi":"post /adminPortal/addTimeTrackingPolicy","title":"addTimeTrackingPolicy","href":"/api-reference/adminportal/addTimeTrackingPolicy"},{"openapi":"put /adminPortal/updateTimeTrackingPolicy","title":"updateTimeTrackingPolicy","href":"/api-reference/adminportal/updateTimeTrackingPolicy"},{"openapi":"delete /adminPortal/deleteTimeTrackingPolicy","title":"deleteTimeTrackingPolicy","href":"/api-reference/adminportal/deleteTimeTrackingPolicy"},{"openapi":"post /adminPortal/addTimeTrackingPolicyAssignments","title":"addTimeTrackingPolicyAssignments","href":"/api-reference/adminportal/addTimeTrackingPolicyAssignments"},{"openapi":"post /adminPortal/removeTimeTrackingPolicyAssignments","title":"removeTimeTrackingPolicyAssignments","href":"/api-reference/adminportal/removeTimeTrackingPolicyAssignments"},{"openapi":"post /adminPortal/upsertTimeEntry","title":"upsertTimeEntry","href":"/api-reference/adminportal/upsertTimeEntry"},{"openapi":"delete /adminPortal/deleteTimeEntry","title":"deleteTimeEntry","href":"/api-reference/adminportal/deleteTimeEntry"},{"openapi":"put /adminPortal/updateTimeCardApprovals","title":"updateTimeCardApprovals","href":"/api-reference/adminportal/updateTimeCardApprovals"},{"openapi":"post /adminPortal/syncTimeCardsToPayroll","title":"syncTimeCardsToPayroll","href":"/api-reference/adminportal/syncTimeCardsToPayroll"},{"openapi":"put /adminPortal/updateBusinessUserAsEmployee","title":"updateBusinessUserAsEmployee","href":"/api-reference/adminportal/updateBusinessUserAsEmployee"},{"openapi":"put /adminPortal/updateEmployeeAsBusinessUser","title":"updateEmployeeAsBusinessUser","href":"/api-reference/adminportal/updateEmployeeAsBusinessUser"},{"openapi":"put /adminPortal/updateBusinessUser","title":"updateBusinessUser","href":"/api-reference/adminportal/updateBusinessUser"},{"openapi":"put /adminPortal/updateCompanyLocation","title":"updateCompanyLocation","href":"/api-reference/adminportal/updateCompanyLocation"},{"openapi":"delete /adminPortal/deleteStateRegistrationInfo","title":"deleteStateRegistrationInfo","href":"/api-reference/adminportal/deleteStateRegistrationInfo"},{"openapi":"post /adminPortal/addEmployeeMiscellaneousStateTax","title":"addEmployeeMiscellaneousStateTax","href":"/api-reference/adminportal/addEmployeeMiscellaneousStateTax"},{"openapi":"put /adminPortal/terminateUser","title":"terminateUser","href":"/api-reference/adminportal/terminateUser"},{"openapi":"post /adminPortal/uploadDocument","title":"uploadDocument","href":"/api-reference/adminportal/uploadDocument"},{"openapi":"get /adminPortal/downloadDocument","title":"downloadDocument","href":"/api-reference/adminportal/downloadDocument"},{"openapi":"post /adminPortal/addRecurringPayItem","title":"addRecurringPayItem","href":"/api-reference/adminportal/addRecurringPayItem"},{"openapi":"put /adminPortal/updateRecurringPayItem","title":"updateRecurringPayItem","href":"/api-reference/adminportal/updateRecurringPayItem"},{"openapi":"delete /adminPortal/deleteRecurringPayItem","title":"deleteRecurringPayItem","href":"/api-reference/adminportal/deleteRecurringPayItem"},{"openapi":"post /adminPortal/addGarnishments","title":"addGarnishments","href":"/api-reference/adminportal/addGarnishments"},{"openapi":"put /adminPortal/updateGarnishment","title":"updateGarnishment","href":"/api-reference/adminportal/updateGarnishment"},{"openapi":"post /adminPortal/removeGarnishment","title":"removeGarnishment","href":"/api-reference/adminportal/removeGarnishment"}]},{"group":"User Portal","pages":[{"openapi":"post /userPortal/addUserBankAccount","title":"addUserBankAccount","href":"/api-reference/userportal/addUserBankAccount"},{"openapi":"put /userPortal/updateUserPayPercentage","title":"updateUserPayPercentage","href":"/api-reference/userportal/updateUserPayPercentage"},{"openapi":"put /userPortal/updateKycInformation","title":"updateKycInformation","href":"/api-reference/userportal/updateKycInformation"},{"openapi":"post /userPortal/addTimeOffRequest","title":"addTimeOffRequest","href":"/api-reference/userportal/addTimeOffRequest"},{"openapi":"post /userPortal/cancelTimeOffRequest","title":"cancelTimeOffRequest","href":"/api-reference/userportal/cancelTimeOffRequest"},{"openapi":"delete /userPortal/deleteTimeOffRequest","title":"deleteTimeOffRequest","href":"/api-reference/userportal/deleteTimeOffRequest"},{"openapi":"post /userPortal/clockIn","title":"clockIn","href":"/api-reference/userportal/clockIn"},{"openapi":"put /userPortal/clockOut","title":"clockOut","href":"/api-reference/userportal/clockOut"},{"openapi":"post /userPortal/startBreak","title":"startBreak","href":"/api-reference/userportal/startBreak"},{"openapi":"put /userPortal/endBreak","title":"endBreak","href":"/api-reference/userportal/endBreak"}]},{"group":"Payroll","pages":[{"openapi":"post /payroll/addPaySchedule","title":"addPaySchedule","href":"/api-reference/payroll/addPaySchedule"},{"openapi":"put /payroll/updatePaySchedule","title":"updatePaySchedule","href":"/api-reference/payroll/updatePaySchedule"},{"openapi":"post /payroll/deactivatePaySchedule","title":"deactivatePaySchedule","href":"/api-reference/payroll/deactivatePaySchedule"},{"openapi":"post /payroll/importRegularDifferentialPayrollData","title":"importRegularDifferentialPayrollData","href":"/api-reference/payroll/importRegularDifferentialPayrollData"},{"openapi":"post /payroll/importRegularPayrollData","title":"importRegularPayrollData","href":"/api-reference/payroll/importRegularPayrollData"},{"openapi":"post /payroll/addSupplementalPayPeriod","title":"addSupplementalPayPeriod","href":"/api-reference/payroll/addSupplementalPayPeriod"},{"openapi":"post /payroll/initiatePayroll","title":"initiatePayroll","href":"/api-reference/payroll/initiatePayroll"},{"openapi":"post /payroll/removeDeductions","title":"removeDeductions","href":"/api-reference/payroll/removeDeductions"},{"openapi":"post /payroll/removeAdditionalCompensations","title":"removeAdditionalCompensations","href":"/api-reference/payroll/removeAdditionalCompensations"},{"openapi":"post /payroll/removeReimbursements","title":"removeReimbursements","href":"/api-reference/payroll/removeReimbursements"},{"openapi":"post /payroll/removeUsersFromSupplementalPayPeriod","title":"removeUsersFromSupplementalPayPeriod","href":"/api-reference/payroll/removeUsersFromSupplementalPayPeriod"},{"openapi":"post /payroll/addUsersToSupplementalPayPeriod","title":"addUsersToSupplementalPayPeriod","href":"/api-reference/payroll/addUsersToSupplementalPayPeriod"},{"openapi":"put /payroll/editUsersOfSupplementalPayPeriod","title":"editUsersOfSupplementalPayPeriod","href":"/api-reference/payroll/editUsersOfSupplementalPayPeriod"},{"openapi":"post /payroll/addUsersToRegularPayPeriod","title":"addUsersToRegularPayPeriod","href":"/api-reference/payroll/addUsersToRegularPayPeriod"},{"openapi":"post /payroll/removeUsersFromRegularPayPeriod","title":"removeUsersFromRegularPayPeriod","href":"/api-reference/payroll/removeUsersFromRegularPayPeriod"},{"openapi":"post /payroll/removeOvertime","title":"removeOvertime","href":"/api-reference/payroll/removeOvertime"},{"openapi":"post /payroll/skipPayPeriod","title":"skipPayPeriod","href":"/api-reference/payroll/skipPayPeriod"},{"openapi":"post /payroll/addSupplementalPayPeriodWithLineItems","title":"addSupplementalPayPeriodWithLineItems","href":"/api-reference/payroll/addSupplementalPayPeriodWithLineItems"},{"openapi":"post /payroll/cancelPayrollSubmission","title":"cancelPayrollSubmission","href":"/api-reference/payroll/cancelPayrollSubmission"},{"openapi":"post /payroll/importPayrollHistory","title":"importPayrollHistory","href":"/api-reference/payroll/importPayrollHistory"},{"openapi":"post /payroll/addPayrollTaxExemption","title":"addPayrollTaxExemption","href":"/api-reference/payroll/addPayrollTaxExemption"},{"openapi":"put /payroll/updatePayrollTaxExemption","title":"updatePayrollTaxExemption","href":"/api-reference/payroll/updatePayrollTaxExemption"},{"openapi":"post /payroll/addPayrollLineItemTaxAdjustments","title":"addPayrollLineItemTaxAdjustments","href":"/api-reference/payroll/addPayrollLineItemTaxAdjustments"},{"openapi":"put /payroll/updatePayrollLineItemTaxAdjustment","title":"updatePayrollLineItemTaxAdjustment","href":"/api-reference/payroll/updatePayrollLineItemTaxAdjustment"},{"openapi":"post /payroll/removePayrollLineItemTaxAdjustment","title":"removePayrollLineItemTaxAdjustment","href":"/api-reference/payroll/removePayrollLineItemTaxAdjustment"}]},{"group":"Benefits","pages":[{"openapi":"post /benefits/addEmployeeBenefits","title":"addEmployeeBenefits","href":"/api-reference/benefits/addEmployeeBenefits"},{"openapi":"put /benefits/updateEmployeeBenefits","title":"updateEmployeeBenefits","href":"/api-reference/benefits/updateEmployeeBenefits"},{"openapi":"post /benefits/addCompanyEmployeeBenefits","title":"addCompanyEmployeeBenefits","href":"/api-reference/benefits/addCompanyEmployeeBenefits"},{"openapi":"post /benefits/removeCompanyBenefits","title":"removeCompanyBenefits","href":"/api-reference/benefits/removeCompanyBenefits"},{"openapi":"post /benefits/removeEmployeeBenefits","title":"removeEmployeeBenefits","href":"/api-reference/benefits/removeEmployeeBenefits"},{"openapi":"post /benefits/addCompanyBenefits","title":"addCompanyBenefits","href":"/api-reference/benefits/addCompanyBenefits"},{"openapi":"get /benefits/getBenefitValidEffectiveMonths","title":"getBenefitValidEffectiveMonths","href":"/api-reference/benefits/getBenefitValidEffectiveMonths"}]},{"group":"Reports","pages":[{"group":"PTO","pages":[{"openapi":"get /reports/getTimeOffPolicyTypes","title":"getTimeOffPolicyTypes","href":"/api-reference/reports/PaidTimeOff/getTimeOffPolicyTypes"},{"openapi":"get /reports/getTimeOffPolicyAssignments","title":"getTimeOffPolicyAssignments","href":"/api-reference/reports/PaidTimeOff/getTimeOffPolicyAssignments"},{"openapi":"get /reports/getTimeOffRequest","title":"getTimeOffRequest","href":"/api-reference/reports/PaidTimeOff/getTimeOffRequest"}]},{"group":"Time Tracking","pages":[{"openapi":"get /reports/getEmployeeTimeTrackingStatus","title":"getEmployeeTimeTrackingStatus","href":"/api-reference/reports/TimeTracking/getEmployeeTimeTrackingStatus"},{"openapi":"get /reports/getTimeTrackingPolicy","title":"getTimeTrackingPolicy","href":"/api-reference/reports/TimeTracking/getTimeTrackingPolicy"},{"openapi":"get /reports/getPayPeriodTimeCards","title":"getPayPeriodTimeCards","href":"/api-reference/reports/TimeTracking/getPayPeriodTimeCards"},{"openapi":"get /reports/getEmployeePayPeriodTimeCard","title":"getEmployeePayPeriodTimeCard","href":"/api-reference/reports/TimeTracking/getEmployeePayPeriodTimeCard"}]},{"group":"Garnishments","pages":[{"openapi":"get /reports/getGarnishmentTypes","title":"getGarnishmentTypes","href":"/api-reference/reports/Garnishments/getGarnishmentTypes"},{"openapi":"get /reports/getGarnishmentAgencies","title":"getGarnishmentAgencies","href":"/api-reference/reports/Garnishments/getGarnishmentAgencies"},{"openapi":"get /reports/getGarnishmentFormFields","title":"getGarnishmentFormFields","href":"/api-reference/reports/Garnishments/getGarnishmentFormFields"}]},{"openapi":"get /reports/getActiveUsers","title":"getActiveUsers","href":"/api-reference/reports/getActiveUsers"},{"openapi":"get /reports/getAdditionalCompensationDescription","title":"getAdditionalCompensationDescription","href":"/api-reference/reports/getAdditionalCompensationDescription"},{"openapi":"get /reports/getBusinessUsers","title":"getBusinessUsers","href":"/api-reference/reports/getBusinessUsers"},{"openapi":"get /reports/getBusinessUserDetails","title":"getBusinessUserDetails","href":"/api-reference/reports/getBusinessUserDetails"},{"openapi":"get /reports/getCompanies","title":"getCompanies","href":"/api-reference/reports/getCompanies"},{"openapi":"get /reports/getCompanyInfo","title":"getCompanyInfo","href":"/api-reference/reports/getCompanyInfo"},{"openapi":"get /reports/getCompanyTask","title":"getCompanyTask","href":"/api-reference/reports/getCompanyTask"},{"openapi":"get /reports/getCompanyLocationInfo","title":"getCompanyLocationInfo","href":"/api-reference/reports/getCompanyLocationInfo"},{"openapi":"get /reports/getDeactivatedUsers","title":"getDeactivatedUsers","href":"/api-reference/reports/getDeactivatedUsers"},{"openapi":"get /reports/getDeductionDescription","title":"getDeductionDescription","href":"/api-reference/reports/getDeductionDescription"},{"openapi":"get /reports/getIndividualPayrollHistory","title":"getIndividualPayrollHistory","href":"/api-reference/reports/getIndividualPayrollHistory"},{"openapi":"get /reports/getOverTimeTypes","title":"getOverTimeTypes","href":"/api-reference/reports/getOverTimeTypes"},{"openapi":"get /reports/getProcessedPayperiodsDetails","title":"getProcessedPayperiodsDetails","href":"/api-reference/reports/getProcessedPayperiodsDetails"},{"openapi":"get /reports/getPaidEmployeesCountBasedOnDateRange","title":"getPaidEmployeesCountBasedOnDateRange","description":"\nThe `getPaidEmployeesCountBasedOnDateRange` API returns the total count of employees who received payment within a specified date range.\n\n### What it does:\n\n- Returns the number of employees paid during a specific time period\n","href":"/api-reference/reports/getPaidEmployeesCountBasedOnDateRange"},{"openapi":"get /reports/getPayPeriodDetails","title":"getPayPeriodDetails","href":"/api-reference/reports/getPayPeriodDetails"},{"openapi":"get /reports/getPayPeriod","title":"getPayPeriod","description":"\nThe `getPayPeriod` API retrieves pay period information for a company based on worker type.\n\n### What it does:\n\n- Returns pay period details including dates, deadlines, and payroll amounts\n\n### Notes:\n\n- Requires `companyId` and `workerType` (W2 or 1099) parameters\n- Used before initiating payroll processing with `initiatePayroll`","href":"/api-reference/reports/getPayPeriod"},{"openapi":"get /reports/getAllPayPeriods","title":"getAllPayPeriods","href":"/api-reference/reports/getAllPayPeriods"},{"openapi":"get /reports/getPayrollHistoryBasedOnPayPeriod","title":"getPayrollHistoryBasedOnPayPeriod","href":"/api-reference/reports/getPayrollHistoryBasedOnPayPeriod"},{"openapi":"get /reports/getPayrollHistoryBasedOnDateRange","title":"getPayrollHistoryBasedOnDateRange","href":"/api-reference/reports/getPayrollHistoryBasedOnDateRange"},{"openapi":"get /reports/getPayRun","title":"getPayRun","href":"/api-reference/reports/getPayRun"},{"openapi":"get /reports/getPaySchedule","title":"getPaySchedule","href":"/api-reference/reports/getPaySchedule"},{"openapi":"get /reports/getMonthlyAndSemiMonthlyPayScheduleDates","title":"getMonthlyAndSemiMonthlyPayScheduleDates","href":"/api-reference/reports/getMonthlyAndSemiMonthlyPayScheduleDates"},{"openapi":"get /reports/getPayStub","title":"getPayStub","href":"/api-reference/reports/getPayStub"},{"openapi":"get /reports/getPayBeginDates","title":"getPayBeginDates","href":"/api-reference/reports/getPayBeginDates"},{"openapi":"get /reports/getStateRegistrationFields","title":"getStateRegistrationFields","href":"/api-reference/reports/getStateRegistrationFields"},{"openapi":"get /reports/getStateW4FormFields","title":"getStateW4FormFields","href":"/api-reference/reports/getStateW4FormFields"},{"openapi":"get /reports/getTerminatedUsers","title":"getTerminatedUsers","href":"/api-reference/reports/getTerminatedUsers"},{"openapi":"get /reports/getTransactionBasedOnReference","title":"getTransactionBasedOnReference","href":"/api-reference/reports/getTransactionBasedOnReference"},{"openapi":"get /reports/getTransactions","title":"getTransactions","href":"/api-reference/reports/getTransactions"},{"openapi":"get /reports/getTransactionsBasedOnName","title":"getTransactionsBasedOnName","href":"/api-reference/reports/getTransactionsBasedOnName"},{"openapi":"get /reports/getUserTask","title":"getUserTask","href":"/api-reference/reports/getUserTask"},{"openapi":"get /reports/getCompanyBenefits","title":"getCompanyBenefits","href":"/api-reference/reports/getCompanyBenefits"},{"openapi":"get /reports/getUsersByCompanyName","title":"getUsersByCompanyName","href":"/api-reference/reports/getUsersByCompanyName"},{"openapi":"get /reports/getUnProcessedPayPeriod","title":"getUnProcessedPayPeriod","href":"/api-reference/reports/getUnProcessedPayPeriod"},{"openapi":"get /reports/getUsers","title":"getUsers","href":"/api-reference/reports/getUsers"},{"openapi":"get /reports/getUser","title":"getUser","href":"/api-reference/reports/getUser"},{"openapi":"get /reports/getEmployeeMiscellaneousStateTaxforPayroll","title":"getEmployeeMiscellaneousStateTaxforPayroll","href":"/api-reference/reports/getEmployeeMiscellaneousStateTaxforPayroll"},{"openapi":"get /reports/getEmployeeMiscellaneousStateTaxFormFields","title":"getEmployeeMiscellaneousStateTaxFormFields","href":"/api-reference/reports/getEmployeeMiscellaneousStateTaxFormFields"},{"openapi":"get /reports/getTaxNameForExemption","title":"getTaxNameForExemption","href":"/api-reference/reports/getTaxNameForExemption"},{"openapi":"get /reports/getCompanyTaxExemptions","title":"getCompanyTaxExemptions","href":"/api-reference/reports/getCompanyTaxExemptions"},{"openapi":"get /reports/getEmployeeTaxExemptions","title":"getEmployeeTaxExemptions","href":"/api-reference/reports/getEmployeeTaxExemptions"},{"openapi":"get /reports/getAllowedTaxAdjustmentsList","title":"getAllowedTaxAdjustmentsList","href":"/api-reference/reports/getAllowedTaxAdjustmentsList"},{"openapi":"get /reports/getUploadedDocuments","title":"getUploadedDocuments","href":"/api-reference/reports/getUploadedDocuments"},{"openapi":"get /reports/getPayrollJournalReport","title":"getPayrollJournalReport","href":"/api-reference/reports/getPayrollJournalReport"},{"openapi":"get /reports/getCashRequirementsReport","title":"getCashRequirementsReport","href":"/api-reference/reports/getCashRequirementsReport"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks/getWebhookPublicKey","title":"getWebhookPublicKey","href":"/api-reference/webhooks/getWebhookPublicKey"},{"group":"Company","pages":[{"title":"Company Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/Company/overview"},{"title":"Company KYB Status","openapi":"webhook companyKybStatus","href":"/api-reference/webhooks/Company/companyKybStatus"}]},{"group":"Employee","pages":[{"title":"Employee Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/Employee/overview"},{"title":"Employee Status","openapi":"webhook employeeStatus","href":"/api-reference/webhooks/Employee/employeeStatus"},{"title":"Employee KYC Status","openapi":"webhook employeeKycStatus","href":"/api-reference/webhooks/Employee/employeeKycStatus"}]},{"group":"Bank Account","pages":[{"title":"Bank Account Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/BankAccount/overview"},{"title":"Company Bank Account Status","openapi":"webhook companyBankAccountStatus","href":"/api-reference/webhooks/BankAccount/companyBankAccountStatus"},{"title":"Employee Bank Account Status","openapi":"webhook employeeBankAccountStatus","href":"/api-reference/webhooks/BankAccount/employeeBankAccountStatus"}]},{"group":"Pay Period","pages":[{"title":"Pay Period Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/PayPeriod/overview"},{"title":"Pay Period Status","openapi":"webhook payPeriodStatus","href":"/api-reference/webhooks/PayPeriod/payPeriodStatus"}]},{"group":"Pay Schedule","pages":[{"title":"Pay Schedule Webhooks Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/PaySchedule/overview"},{"title":"Pay Schedule Status","openapi":"webhook payScheduleIsActive","href":"/api-reference/webhooks/PaySchedule/payScheduleStatus"}]}]},{"group":"Sandbox","pages":[{"openapi":"POST /sandbox/refreshCompanyKybStatus","title":"refreshCompanyKybStatus","href":"/api-reference/sandbox/refreshCompanyKybStatus"},{"openapi":"POST /sandbox/refreshUserKycStatus","title":"refreshUserKycStatus","href":"/api-reference/sandbox/refreshUserKycStatus"},{"openapi":"POST /sandbox/refreshCompanyBankAccountStatus","title":"refreshCompanyBankAccountStatus","href":"/api-reference/sandbox/refreshCompanyBankAccountStatus"},{"openapi":"POST /sandbox/refreshUserBankAccountStatus","title":"refreshUserBankAccountStatus","href":"/api-reference/sandbox/refreshUserBankAccountStatus"},{"openapi":"POST /sandbox/addFundsToLedger","title":"addFundsToLedger","href":"/api-reference/sandbox/addFundsToLedger"}]}]}]},{"anchor":"Terminology","icon":"book-open-text","color":{"light":"#FF4217","dark":"#FF4217"},"pages":[{"title":"Terminology","href":"/terminology"}]},{"anchor":"Releases","icon":"notebook-pen","color":{"light":"#FF4217","dark":"#FF4217"},"pages":[{"title":"Releases","href":"/releases/release-notes/Sept-2026"}]}]},"basePath":"","title":"getPayPeriodDetails - Rollfi","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}