> ## Documentation Index > Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt > Use this file to discover all available pages before exploring further. # Get > Fetch a payroll's details ## OpenAPI ````yaml /openapi/workforce-management.yaml get /v1/payrolls/{payrollId} openapi: 3.0.0 info: description: APIs for interacting with Cadana Payroll Platform version: 1.0.0 title: Business Workforce Management termsOfService: https://cadanapay.com/terms-and-conditions contact: email: api@cadanapay.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.cadanapay.com description: Prod Server - url: https://dev-api.cadanapay.com description: Dev Server security: - Authorization: [] tags: - name: Custom Auth description: APIs for interacting with Custom Authentication - name: Persons description: APIs for interacting with the HR module - name: Milestones description: APIs for milestone-based contractor pay - name: Instant Pay description: APIs for interacting with Instant Pay functionality - name: Users description: APIs for interacting with employee/contractor Cadana accounts - name: Files description: APIs for interacting with file uploads - name: Payrolls description: APIs for interacting with Payroll - name: Platform description: Platform APIs for interacting with businesses - name: Businesses description: APIs for interacting with Business - name: Contracts description: APIs for interacting with contracts - name: Sandbox description: APIs for relevant sandbox simulations - name: Invoices description: APIs for interacting with invoices - name: Reimbursements description: APIs for interacting with reimbursements - name: Entities description: >- APIs for managing legal sub-entities (subsidiaries, branches) under a parent business paths: /v1/payrolls/{payrollId}: get: tags: - Payrolls summary: Get description: Fetch a payroll's details operationId: getPayroll parameters: - $ref: '#/components/parameters/payrollId' - $ref: '#/components/parameters/XMultiTenantKey' responses: '200': $ref: '#/components/responses/GetPayrollResponse' '400': $ref: '#/components/responses/BadRequestError' security: - Authorization: [] components: parameters: payrollId: name: payrollId in: path description: The unique identifier for the payroll required: true schema: type: string format: uuid XMultiTenantKey: name: X-MultiTenantKey in: header required: false schema: type: string description: >- Required when using a Platform API token. The tenant key identifying which business to operate on. responses: GetPayrollResponse: description: > Payroll details. Employee payrolls include tax, pension, statutory deduction, and employer contribution aggregates plus per-entry allowance, deduction, and employer-contribution line items. Contractor payrolls omit those fields entirely and return only the salary-based shape. content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/payrollSummary' - type: object properties: entries: type: array items: $ref: '#/components/schemas/payrollEntry' examples: employeePayroll: summary: Employee payroll with tax, pension, and per-entry breakdown value: payrollId: 7c4f1d36-2b9a-4bca-91e7-2b1f1e6e7c11 workerType: EMPLOYEE type: REGULAR status: Pending Submission payrollDate: '2021-06-26' debit: amount: 31947900 currency: PHP gross: amount: 31947900 currency: PHP net: amount: 31947900 currency: PHP tax: amount: 0 currency: PHP pension: amount: 0 currency: PHP statutoryDeductions: amount: 0 currency: PHP employerContributions: amount: 0 currency: PHP payPeriod: fromDate: '2021-06-01' toDate: '2021-06-30' entries: - personId: 04a8977d-5d99-4b28-8de4-8161401ca3fa salary: amount: 75000 currency: PHP bonus: amount: 10000 currency: PHP gross: amount: 85000 currency: PHP net: amount: 75704 currency: PHP allowances: - name: Transport isTaxable: true amount: amount: 5000 currency: PHP - name: Housing isTaxable: true amount: amount: 10000 currency: PHP deductions: - name: SSS isStatutory: true amount: amount: 4125 currency: PHP - name: Bonus Tax isStatutory: false amount: amount: 500 currency: PHP - name: Withholding Tax isStatutory: true amount: amount: 4671 currency: PHP employerContributions: - name: SSS isStatutory: false amount: amount: 9750 currency: PHP contractorPayroll: summary: Contractor payroll (no tax/pension fields) value: payrollId: 9f1c8a6e-8e3d-4f9a-9d52-0e8b7a2b3c44 workerType: CONTRACTOR type: REGULAR status: Pending Submission payrollDate: '2021-06-26' debit: amount: 100000 currency: USD gross: amount: 100000 currency: USD net: amount: 100000 currency: USD payPeriod: fromDate: '2021-06-01' toDate: '2021-06-30' entries: - personId: 11111111-2222-3333-4444-555555555555 salary: amount: 100000 currency: USD gross: amount: 100000 currency: USD net: amount: 100000 currency: USD BadRequestError: description: Bad input provided by client content: application/json: schema: $ref: '#/components/schemas/BadRequestError' schemas: payrollSummary: type: object properties: payrollId: type: string description: created payroll id format: uuid workerType: type: string description: worker type example: EMPLOYEE enum: - EMPLOYEE - CONTRACTOR status: allOf: - $ref: '#/components/schemas/payrollStatus' description: >- Current payroll status. Values are title-cased (e.g. `Pending Submission`, `Scheduled`, `Completed`). numPeople: type: integer description: number of people in payroll run example: 50 type: type: string description: payroll type example: ONE-OFF enum: - ONE-OFF - REGULAR payrollDate: type: string description: payroll date format: date debit: allOf: - $ref: '#/components/schemas/amount' description: >- Total amount deducted from the business balance for this payroll. For direct employment this is net pay plus fees; for EOR workers (`compInfo.employmentModel: "eor"`) it is gross pay plus employer contributions, so statutory amounts are collected. gross: allOf: - $ref: '#/components/schemas/amount' description: Total gross pay across all entries, before deductions. net: allOf: - $ref: '#/components/schemas/amount' description: Total net (take-home) pay across all entries. tax: allOf: - $ref: '#/components/schemas/amount' description: >- Total income tax withheld across all entries. Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. pension: allOf: - $ref: '#/components/schemas/amount' description: >- Combined employee and employer retirement contributions across all entries; the employee and employer portions are also included in `statutoryDeductions` and `employerContributions` respectively. Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. statutoryDeductions: allOf: - $ref: '#/components/schemas/amount' description: >- Total of all employee-side statutory deductions, including income tax and social security, across all entries. Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. employerContributions: allOf: - $ref: '#/components/schemas/amount' description: >- Total employer contributions across all entries (e.g., employer-side social security). Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. payPeriod: allOf: - $ref: '#/components/schemas/payPeriod' description: The pay period this payroll covers. payrollEntry: required: - salary - personId type: object properties: entryId: allOf: - $ref: '#/components/schemas/uuid' description: >- Stable per-entry identifier. Disambiguates entries when the same `personId` appears more than once in the same payroll (e.g., separate base-salary and bonus entries). Returned on read; not accepted on save. personId: $ref: '#/components/schemas/uuid' transactionIds: type: array description: >- Disbursement transaction IDs produced when this entry was paid out. Populated once the payroll status reaches `processing`; omitted before disbursements are triggered. A single entry can have multiple transactions when the payment is split across payment methods. items: $ref: '#/components/schemas/uuid' salary: $ref: '#/components/schemas/amount' bonus: $ref: '#/components/schemas/amount' gross: allOf: - $ref: '#/components/schemas/amount' description: >- Entry-level gross compensation. Omitted if the entry has not yet been calculated. net: allOf: - $ref: '#/components/schemas/amount' description: >- Entry-level net (take-home) compensation. Omitted if the entry has not yet been calculated. allowances: type: array description: >- Allowance line items applied to this entry (e.g., transport, housing). Returned for `EMPLOYEE` payrolls only; omitted for contractor entries and when there are no items. items: $ref: '#/components/schemas/allowance' deductions: type: array description: >- Deduction line items applied to this entry (e.g., income tax, social security, voluntary deductions). Each item's `isStatutory` flag indicates whether the deduction is legally mandated. Returned for `EMPLOYEE` payrolls only; omitted for contractor entries and when there are no items. items: $ref: '#/components/schemas/deduction' employerContributions: type: array description: >- Employer-side contribution line items for this entry (e.g., employer social security). Returned for `EMPLOYEE` payrolls only; omitted for contractor entries and when there are no items. items: $ref: '#/components/schemas/deduction' metadata: type: object description: >- Optional opaque metadata attached to the entry. Stored and returned unchanged. Not used in tax calculations or reports. Do not place regulated PII here. Keys must be 1-50 characters. additionalProperties: type: string maxLength: 200 maxProperties: 20 example: team: engineering region: emea BadRequestError: description: Bad input provided by client allOf: - $ref: '#/components/schemas/Error' - type: object properties: params: description: A map for meta data around the error that occurred type: object example: code: invalid_request_body message: The request body provided is not valid params: field: Value is invalid. payrollStatus: type: string description: > Current payroll status. See [Payroll Lifecycle](/workforce/payroll-lifecycle) for the meaning of each value and the allowed transitions. example: Completed enum: - Created - Pending Submission - Pending Approval - Awaiting Funds - Scheduled - Processing - Completed - Rejected - Deleted amount: type: object required: - amount - currency properties: amount: type: integer description: value in lowest denomination example: 10000 currency: type: string description: currency example: USD payPeriod: type: object properties: fromDate: type: string description: start date format: date toDate: type: string description: end date format: date uuid: type: string format: uuid example: 8ef9a712-cdae-4110-b1ea-9ba95abbee6e allowance: type: object required: - name - isTaxable - amount properties: name: type: string example: Housing isTaxable: type: boolean description: Whether this allowance is included in taxable income. example: true amount: $ref: '#/components/schemas/amount' deduction: type: object required: - name - isStatutory - amount properties: name: type: string example: Income Tax isStatutory: type: boolean description: >- Whether this deduction is mandated by law (e.g., income tax, social security) versus a non-statutory item. example: true amount: $ref: '#/components/schemas/amount' Error: type: object properties: code: description: A machine parsable error code type: string enum: - invalid_request_body - resource_not_found - forbidden - internal_error message: description: A human readable message describing the error type: string securitySchemes: Authorization: type: http scheme: bearer bearerFormat: API_SECRET_KEY ````