{"path":"/api/company/{company_id}/pays/create","method":"PUT","operation_id":"create_pays_for_date_api_company__company_id__pays_create_put","resolved":true,"request":{"parameters":[{"description":"The unique LP-generated ID of the company.","required":true,"schema":{"type":"integer","title":"Company Id","description":"The unique LP-generated ID of the company."},"example":1,"name":"company_id","in":"path"},{"description":"Set to `True` to group pay results by pay run.","required":false,"schema":{"type":"boolean","title":"Group By Pay Run","description":"Set to `True` to group pay results by pay run.","default":false},"example":false,"name":"group_by_pay_run","in":"query"},{"description":"Set to `True` to group pay results by employee (using either employee_id or employee_number depending on identifier_type).","required":false,"schema":{"type":"boolean","title":"Group By Employee","description":"Set to `True` to group pay results by employee (using either employee_id or employee_number depending on identifier_type).","default":false},"example":false,"name":"group_by_employee","in":"query"},{"description":"If True, and this request creates multiple pays for the same employee in the same pay run with different departments, redistribute the combined tax for those new pays in proportion to each pay's gross. Only affects pays created by this call.","required":false,"schema":{"type":"boolean","title":"Redistribute Tax By Gross","description":"If True, and this request creates multiple pays for the same employee in the same pay run with different departments, redistribute the combined tax for those new pays in proportion to each pay's gross. Only affects pays created by this call.","default":true},"example":true,"name":"redistribute_tax_by_gross","in":"query"},{"description":"Specify which employee identifier to use in 'workers_comp_pays' and when grouping pays by employee:\n- 'employee_id': Use LP-internal database IDs (integers).\n- 'employee_number': Use your own external employee numbers (strings).\nDefault is 'employee_id'. These must be unique for each employee across all companies.","required":false,"schema":{"type":"string","pattern":"^(employee_id|employee_number)$","title":"Identifier Type","description":"Specify which employee identifier to use in 'workers_comp_pays' and when grouping pays by employee:\n- 'employee_id': Use LP-internal database IDs (integers).\n- 'employee_number': Use your own external employee numbers (strings).\nDefault is 'employee_id'. These must be unique for each employee across all companies.","default":"employee_id"},"example":"employee_id","name":"identifier_type","in":"query"},{"description":"The date when these pays were processed, in `YYYY-MM-DD` format. Defaults to today if not provided. The pay run chosen will be the one that matches this date.","required":false,"schema":{"type":"string","title":"Pay Date","description":"The date when these pays were processed, in `YYYY-MM-DD` format. Defaults to today if not provided. The pay run chosen will be the one that matches this date.","default":"2026-04-03"},"example":"2026-04-03","name":"pay_date","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"employee_id":{"type":"integer","title":"Employee Id","description":"The internal Lightning Payroll (LP) unique ID for the employee. Use this if `identifier_type=employee_id`.","example":1234},"employee_number":{"type":"string","maxLength":32,"minLength":0,"title":"Employee Number","description":"The external user-controlled employee number. Required only if `identifier_type=employee_number`. Must be unique across ALL companies.","example":"EMP001"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the pay hours.","example":"Regular Hours, KMs, Overtime, Saturday, etc."},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for the pay hours row, such as hourly rate, per kilometre rate, etc. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"company:73"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","description":"The type of units for the pay hours row, such as hours, kilometres, buckets, etc.","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","description":"Indicates whether the hours are overtime hours, which affects super guarantee calculations.","default":false,"example":false},"value":{"type":"number","title":"Value","description":"The number of units for the pay hours row, such as hours worked, kilometres driven, etc.","example":"37.5"}},"type":"object","required":["description","units","value"],"title":"PayHours"},"type":"array","title":"Hours","description":"Optional list of pay hour items (may be empty), including description, rate, multiplier, or pay-rate mapping keys (`rate_reference` / `rate_description`), units, overtime status, and value.","example":[{"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5"},{"description":"Saturday Overtime","multiplier":"1.5","units":"hours","is_overtime":true,"value":"5.0"},{"description":"Ordinary Time","rate_reference":"system:ordinary_time","units":"hours","value":"7.6"}]},"leave":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the leave.","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","description":"A short identifier for the type of leave. Provide the code with underscores (e.g., ALT_HOLIDAY, ANCILLARY, ANNUAL_HOLIDAYS, COMPASSIONATE, EMPLOYER_FUNDED_PAID_PARENTAL, HOLIDAY, LONG_SERVICE, NZ_BEREAVEMENT, NZ_DEFENCE_FORCE, NZ_EMPLOYMENT_RELATIONS_EDUCATION, NZ_FAMILY_VIOLENCE, NZ_JURY_SERVICE, NZ_TIME_OFF_TO_VOTE, OTHER, PAID_PARENTAL, PAID_PUBLIC_HOLIDAY, SICK, UNPAID, WORKERS_COMP).","example":"HOLIDAY"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"date":{"type":"string","title":"Date","description":"The date of the leave.","example":"2023-01-01"},"hours":{"type":"number","title":"Hours","description":"The number of hours leave taken.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"The dollar amount of leave loading, if applicable.","example":"3.80"}},"additionalProperties":false,"type":"object","required":["description","leave_type","date","hours"],"title":"Leave"},"type":"array","title":"Leave","description":"Optional list of leave items (may be empty), including description, leave type, rate/multiplier, value, date, and optional leave loading amount. `rate` is optional; when omitted the employee's pay_rate_per_hour is used.","example":[{"description":"Annual Leave","leave_type":"HOLIDAY","multiplier":"1.0","value":"7.6","leave_loading_amount":"3.80"}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Department/Cost-centre name or code to be applied to all items in this entire pay. ","example":"Engineering"},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match allowances by `description` instead.\n- The API will attempt to find an existing allowance for the employee with the same `description`.\n  - If a match is found, that allowance will be reused and creation-only required fields can be omitted (e.g. `amount`, `allowance_category`—existing values are reused).\n  - If no match is found, a NEW allowance will be created for this employee. In this case, `description`, `amount` and `allowance_category` (code) are REQUIRED.\n    • `allowance_category` must be one of the codes: AD, CD, KN, LD, MD, OD, QN, RD, TD (labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other). Only codes are accepted for new allowances.     • `is_taxable` defaults to True if not supplied.\n    • `is_itemised` defaults to False if not supplied.\n    • `is_included_in_super_calculations` defaults to True if not supplied.","example":[{"description":"Tool Allowance","amount":"50.00","allowance_category":"TD"},{"description":"Car Allowance","amount":"200.00","is_taxable":true,"is_itemised":true,"is_included_in_super_calculations":false,"allowance_category":"RD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match deductions by `description` instead.\n- The API will attempt to find an existing deduction for the employee with the same `description`.\n  - If a match is found, that deduction will be reused and creation-only required fields can be omitted (e.g. `amount`, `classification`—existing values are reused).\n  - If no match is found, a NEW deduction will be created for this employee. In this case, `description`, `amount`, and `classification` (code) are REQUIRED.\n    • `classification` must be one of: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES. Only codes are accepted for new deductions.\n    • `is_included_in_super_calculations` defaults to True if not supplied.","example":[{"description":"Union Fees","amount":"25.00","classification":"UNION_FEES"},{"description":"Health Insurance","amount":"100.00","classification":"NORMAL","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match bonuses by `description` instead.\n- The API will attempt to find an existing bonus for the employee with the same `description`.\n  - If a match is found, that bonus will be reused and creation-only required fields can be omitted (e.g. `amount`, `tax_method`, and any range dates—existing values are reused).\n  - If no match is found, a NEW bonus will be created for this employee. In this case, `description`, `amount`, and `tax_method` are REQUIRED.\n    • `tax_method` must be one of: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year) (send the *code*, docs show the labels). Defaults to 'NORMAL_EARNINGS' if not supplied.\n    • If `tax_method` is a date-range method, `start_date` and `end_date` are REQUIRED.\n    • `is_included_in_super_calculations` defaults to True if not supplied.\n    • `is_directors_fees` defaults to False if not supplied.\n    • `is_return_to_work` defaults to False if not supplied.","example":[{"description":"Performance Bonus","amount":"500.00","tax_method":"NORMAL_EARNINGS"},{"description":"Director's Fee","amount":"1000.00","tax_method":"SPREAD_OVER_SPECIFIC_RANGE","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":false,"is_directors_fees":true,"is_return_to_work":false}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of pay sacrifices to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match pay sacrifices by `description` instead.\n- The API will attempt to find an existing pay sacrifice for the employee with the same `description`.\n  - If a match is found, that pay sacrifice will be reused and creation-only required fields can be omitted (e.g. `amount`—existing values are reused).\n  - If no match is found, a NEW pay sacrifice will be created for this employee. In this case,    `description` and `amount` are REQUIRED.\n    • `is_included_in_super_calculations` defaults to True if not supplied.\n    • `is_super` defaults to True if not supplied.","example":[{"description":"Laptop Salary Sacrifice"},{"description":"Car Salary Sacrifice","amount":"300.00","is_included_in_super_calculations":false,"is_super":true}]},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match back payments by `description` and `amount` instead.\n- The API will attempt to find an existing back payment for the employee with the same `description` and `amount`.\n  - If a match is found, that back payment will be reused.\n  - If no match is found, a NEW back payment will be created for this employee. In this case, `description`, `amount`, and `stp_category` (code, underscored) are REQUIRED.\n    • `stp_category` must be one of: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED. Only codes are accepted for new back payments.\n    • `tax_method`, `start_date`, and `end_date` are optional.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"GROSS","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","title":"PayCreate"},"type":"array","title":"Pays","description":"A list of new pay objects to create, which were paid or to be paid on the given pay_date. Provide a single `pay_department` string (unique name or code) per pay to assign a cost centre to all pay items."},"example":[{"employee_id":1234,"hours":[{"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5"},{"description":"Saturday Overtime","multiplier":"1.5","units":"hours","is_overtime":true,"value":"5.0"},{"description":"Travel Reimbursement","rate":"0.85","units":"kms","is_overtime":false,"value":"120"},{"description":"Piece Work - Sheep Shearing","rate":"3.50","units":"sheep","is_overtime":false,"value":"90"}],"leave":[{"description":"Annual Leave","leave_type":"HOLIDAY","multiplier":"1.0","hours":"7.6","leave_loading_amount":"3.80","date":"2023-08-15"},{"description":"Personal Leave","leave_type":"SICK","rate":"38.00","hours":"4.0","date":"2023-08-15"}],"pay_department":"Engineering","allowances":[{"description":"Tool Allowance","amount":"50.00","allowance_category":"TD"},{"description":"Car Allowance","amount":"200.00","is_taxable":true,"is_itemised":true,"is_included_in_super_calculations":false,"allowance_category":"AD"}],"deductions":[{"description":"Union Fees","amount":"25.00","classification":"Child Support Deduction"},{"description":"Health Insurance","amount":"100.00","classification":"Normal","is_included_in_super_calculations":true}],"bonuses":[{"description":"Performance Bonus","amount":"500.00","tax_method":"NORMAL_EARNINGS"},{"description":"Director's Fee","amount":"1000.00","tax_method":"SPREAD_OVER_SPECIFIC_RANGE","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":false,"is_directors_fees":true}],"pay_sacrifices":[{"description":"Laptop Salary Sacrifice","amount":"150.00"},{"amount":"300.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":false,"is_super":true}],"back_payments":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"DIRECTOR_S_FEES","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"},{"description":"Award Increase Adjustment","amount":"120.00","stp_category":"OVERTIME","tax_method":"NORMAL_EARNINGS","start_date":"2023-02-01","end_date":"2023-02-28"}]}]}},"required":true}},"response":{"200":{"anyOf":[{"items":{"properties":{"employee_number":{"type":"string","title":"Employee Number"},"pays":{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array","minItems":0,"title":"Pays"}},"type":"object","required":["employee_number","pays"],"title":"EmployeeNumberPays"},"type":"array"},{"items":{"properties":{"employee_id":{"type":"integer","title":"Employee Id"},"pays":{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array","minItems":0,"title":"Pays"}},"type":"object","required":["employee_id","pays"],"title":"EmployeeIDPays"},"type":"array"},{"items":{"properties":{"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run.","example":1001},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"pay_period":{"type":"string","title":"Pay Period","description":"The pay period frequency associated with the pay run (WEEKLY, FORTNIGHTLY, MONTHLY).","example":"WEEKLY"},"pays":{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array","minItems":0,"title":"Pays","description":"A list of basic pay information associated with the pay run."}},"type":"object","required":["pay_run_id","pay_run_end_date","pay_period","pays"],"title":"PayRunPays"},"type":"array"},{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array"}],"title":"Response Create Pays For Date Api Company  Company Id  Pays Create Put"},"422":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"models":{"EmployeeIDPays":{"properties":{"employee_id":{"type":"integer","title":"Employee Id"},"pays":{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array","minItems":0,"title":"Pays"}},"type":"object","required":["employee_id","pays"],"title":"EmployeeIDPays"},"EmployeeNumberPays":{"properties":{"employee_number":{"type":"string","title":"Employee Number"},"pays":{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array","minItems":0,"title":"Pays"}},"type":"object","required":["employee_number","pays"],"title":"EmployeeNumberPays"},"HTTPValidationError":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Pay":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"PayCreate":{"properties":{"employee_id":{"type":"integer","title":"Employee Id","description":"The internal Lightning Payroll (LP) unique ID for the employee. Use this if `identifier_type=employee_id`.","example":1234},"employee_number":{"type":"string","maxLength":32,"minLength":0,"title":"Employee Number","description":"The external user-controlled employee number. Required only if `identifier_type=employee_number`. Must be unique across ALL companies.","example":"EMP001"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the pay hours.","example":"Regular Hours, KMs, Overtime, Saturday, etc."},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for the pay hours row, such as hourly rate, per kilometre rate, etc. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"company:73"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","description":"The type of units for the pay hours row, such as hours, kilometres, buckets, etc.","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","description":"Indicates whether the hours are overtime hours, which affects super guarantee calculations.","default":false,"example":false},"value":{"type":"number","title":"Value","description":"The number of units for the pay hours row, such as hours worked, kilometres driven, etc.","example":"37.5"}},"type":"object","required":["description","units","value"],"title":"PayHours"},"type":"array","title":"Hours","description":"Optional list of pay hour items (may be empty), including description, rate, multiplier, or pay-rate mapping keys (`rate_reference` / `rate_description`), units, overtime status, and value.","example":[{"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5"},{"description":"Saturday Overtime","multiplier":"1.5","units":"hours","is_overtime":true,"value":"5.0"},{"description":"Ordinary Time","rate_reference":"system:ordinary_time","units":"hours","value":"7.6"}]},"leave":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the leave.","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","description":"A short identifier for the type of leave. Provide the code with underscores (e.g., ALT_HOLIDAY, ANCILLARY, ANNUAL_HOLIDAYS, COMPASSIONATE, EMPLOYER_FUNDED_PAID_PARENTAL, HOLIDAY, LONG_SERVICE, NZ_BEREAVEMENT, NZ_DEFENCE_FORCE, NZ_EMPLOYMENT_RELATIONS_EDUCATION, NZ_FAMILY_VIOLENCE, NZ_JURY_SERVICE, NZ_TIME_OFF_TO_VOTE, OTHER, PAID_PARENTAL, PAID_PUBLIC_HOLIDAY, SICK, UNPAID, WORKERS_COMP).","example":"HOLIDAY"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"date":{"type":"string","title":"Date","description":"The date of the leave.","example":"2023-01-01"},"hours":{"type":"number","title":"Hours","description":"The number of hours leave taken.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"The dollar amount of leave loading, if applicable.","example":"3.80"}},"additionalProperties":false,"type":"object","required":["description","leave_type","date","hours"],"title":"Leave"},"type":"array","title":"Leave","description":"Optional list of leave items (may be empty), including description, leave type, rate/multiplier, value, date, and optional leave loading amount. `rate` is optional; when omitted the employee's pay_rate_per_hour is used.","example":[{"description":"Annual Leave","leave_type":"HOLIDAY","multiplier":"1.0","value":"7.6","leave_loading_amount":"3.80"}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Department/Cost-centre name or code to be applied to all items in this entire pay. ","example":"Engineering"},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match allowances by `description` instead.\n- The API will attempt to find an existing allowance for the employee with the same `description`.\n  - If a match is found, that allowance will be reused and creation-only required fields can be omitted (e.g. `amount`, `allowance_category`—existing values are reused).\n  - If no match is found, a NEW allowance will be created for this employee. In this case, `description`, `amount` and `allowance_category` (code) are REQUIRED.\n    • `allowance_category` must be one of the codes: AD, CD, KN, LD, MD, OD, QN, RD, TD (labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other). Only codes are accepted for new allowances.     • `is_taxable` defaults to True if not supplied.\n    • `is_itemised` defaults to False if not supplied.\n    • `is_included_in_super_calculations` defaults to True if not supplied.","example":[{"description":"Tool Allowance","amount":"50.00","allowance_category":"TD"},{"description":"Car Allowance","amount":"200.00","is_taxable":true,"is_itemised":true,"is_included_in_super_calculations":false,"allowance_category":"RD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match deductions by `description` instead.\n- The API will attempt to find an existing deduction for the employee with the same `description`.\n  - If a match is found, that deduction will be reused and creation-only required fields can be omitted (e.g. `amount`, `classification`—existing values are reused).\n  - If no match is found, a NEW deduction will be created for this employee. In this case, `description`, `amount`, and `classification` (code) are REQUIRED.\n    • `classification` must be one of: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES. Only codes are accepted for new deductions.\n    • `is_included_in_super_calculations` defaults to True if not supplied.","example":[{"description":"Union Fees","amount":"25.00","classification":"UNION_FEES"},{"description":"Health Insurance","amount":"100.00","classification":"NORMAL","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match bonuses by `description` instead.\n- The API will attempt to find an existing bonus for the employee with the same `description`.\n  - If a match is found, that bonus will be reused and creation-only required fields can be omitted (e.g. `amount`, `tax_method`, and any range dates—existing values are reused).\n  - If no match is found, a NEW bonus will be created for this employee. In this case, `description`, `amount`, and `tax_method` are REQUIRED.\n    • `tax_method` must be one of: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year) (send the *code*, docs show the labels). Defaults to 'NORMAL_EARNINGS' if not supplied.\n    • If `tax_method` is a date-range method, `start_date` and `end_date` are REQUIRED.\n    • `is_included_in_super_calculations` defaults to True if not supplied.\n    • `is_directors_fees` defaults to False if not supplied.\n    • `is_return_to_work` defaults to False if not supplied.","example":[{"description":"Performance Bonus","amount":"500.00","tax_method":"NORMAL_EARNINGS"},{"description":"Director's Fee","amount":"1000.00","tax_method":"SPREAD_OVER_SPECIFIC_RANGE","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":false,"is_directors_fees":true,"is_return_to_work":false}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of pay sacrifices to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match pay sacrifices by `description` instead.\n- The API will attempt to find an existing pay sacrifice for the employee with the same `description`.\n  - If a match is found, that pay sacrifice will be reused and creation-only required fields can be omitted (e.g. `amount`—existing values are reused).\n  - If no match is found, a NEW pay sacrifice will be created for this employee. In this case,    `description` and `amount` are REQUIRED.\n    • `is_included_in_super_calculations` defaults to True if not supplied.\n    • `is_super` defaults to True if not supplied.","example":[{"description":"Laptop Salary Sacrifice"},{"description":"Car Salary Sacrifice","amount":"300.00","is_included_in_super_calculations":false,"is_super":true}]},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments to be included in the pay.\n\nUsage rules:\n- IDs are not accepted; providing an `id` will raise a 400 Bad Request because it's a forbidden field. Match back payments by `description` and `amount` instead.\n- The API will attempt to find an existing back payment for the employee with the same `description` and `amount`.\n  - If a match is found, that back payment will be reused.\n  - If no match is found, a NEW back payment will be created for this employee. In this case, `description`, `amount`, and `stp_category` (code, underscored) are REQUIRED.\n    • `stp_category` must be one of: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED. Only codes are accepted for new back payments.\n    • `tax_method`, `start_date`, and `end_date` are optional.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"GROSS","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","title":"PayCreate"},"PayRunPays":{"properties":{"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run.","example":1001},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"pay_period":{"type":"string","title":"Pay Period","description":"The pay period frequency associated with the pay run (WEEKLY, FORTNIGHTLY, MONTHLY).","example":"WEEKLY"},"pays":{"items":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the pay.","example":2001},"employee_id":{"type":"integer","title":"Employee Id","description":"The internal unique database identifier of the employee.","example":1234},"employee_number":{"type":"string","title":"Employee Number","description":"The user-controlled unique employee payroll number/code.","example":"EMP001"},"pay_run_id":{"type":"integer","title":"Pay Run Id","description":"The unique identifier of the pay run associated with this pay.","example":1001},"processed_date":{"type":"string","format":"date","title":"Processed Date","description":"The date when the pay was processed.","example":"2023-01-31"},"pay_run_end_date":{"type":"string","format":"date","title":"Pay Run End Date","description":"The end date of the pay run period.","example":"2023-01-31"},"employee_format_name_shorter":{"type":"string","title":"Employee Format Name Shorter","description":"The formatted short name of the employee (e.g., 'J. Doe').","example":"J. Doe"},"employee_last_name":{"type":"string","title":"Employee Last Name","description":"The last name of the employee.","example":"Doe"},"employee_first_name":{"type":"string","title":"Employee First Name","description":"The first name of the employee.","example":"John"},"employee_email_address":{"type":"string","title":"Employee Email Address","description":"The email address of the employee.","example":"john.doe@example.com"},"status":{"type":"string","title":"Status","description":"The status of the pay (e.g., 'processed', 'pending').","example":"processed"},"gross":{"type":"number","title":"Gross","description":"The gross amount of the pay.","example":"5000.00"},"tax":{"type":"number","title":"Tax","description":"The tax amount deducted from the pay.","example":"1000.00"},"net":{"type":"number","title":"Net","description":"The net amount of the pay after deductions.","example":"4000.00"},"super":{"type":"number","title":"Super","description":"The superannuation amount associated with the pay.","example":"500.00"},"total_workers_compensation":{"type":"number","title":"Total Workers Compensation","description":"The total workers' compensation amount.","example":"200.00"},"resc_super_amount":{"type":"number","title":"Resc Super Amount","description":"The Reportable Employer Super Contributions (RESC) amount.","example":"150.00"},"compulsory_super_amount":{"type":"number","title":"Compulsory Super Amount","description":"The compulsory superannuation amount.","example":"350.00"},"format_name":{"type":"string","title":"Format Name","description":"The formatted full name of the employee (e.g., 'John Doe').","example":"John Doe"},"is_complete":{"type":"boolean","title":"Is Complete","description":"Indicates whether the pay process is complete.","example":true},"stp_status":{"type":"string","title":"Stp Status","description":"The Single Touch Payroll (STP) status.","example":"submitted"},"stp_service_action":{"type":"string","title":"Stp Service Action","description":"The STP service action taken.","example":"lodged"},"stp_timestamp":{"type":"string","format":"date","title":"Stp Timestamp","description":"The timestamp when the STP action was performed.","example":"2023-01-31"},"hours":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","example":"Ordinary Time"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this hours row. Provide either `rate` or `multiplier`.","example":"30.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.5 for time-and-a-half, 2.0 for double time).","example":"1.5"},"rate_reference":{"type":"string","title":"Rate Reference","description":"Optional stable pay-rate reference from `GET /api/employees/{employee_id}/pay-rates` (for example `system:ordinary_time`, `employee:42`, `company:73`). Use as an alternative to sending a raw `rate`.","example":"employee:42"},"rate_description":{"type":"string","maxLength":60,"minLength":0,"title":"Rate Description","description":"Optional pay-rate description to resolve a rate by description for this employee. Use when you do not send `rate`. If multiple rates share the same description, the API will return a validation error and require `rate_reference`.","example":"Ordinary Time"},"units":{"type":"string","maxLength":32,"minLength":0,"title":"Units","example":"hours"},"is_overtime":{"type":"boolean","title":"Is Overtime","default":false,"example":false},"value":{"type":"number","title":"Value","example":"37.5"},"id":{"type":"integer","title":"Id"},"pay_amount":{"type":"number","title":"Pay Amount","description":"The total amount for this pay hours row, calculated as rate * value.","example":"1125.00"}},"type":"object","required":["description","units","value","id","pay_amount"],"title":"HoursOut"},"type":"array","title":"Hours","description":"A list of pay hours associated with this pay, including description, rate, units, overtime status, and value.","example":[{"id":1,"description":"Ordinary Time","rate":"30.00","units":"hours","is_overtime":false,"value":"37.5","pay_amount":"1125.00"},{"id":2,"description":"Saturday Overtime","rate":"45.00","units":"hours","is_overtime":true,"value":"5.0","pay_amount":"225.00"}]},"leave":{"items":{"properties":{"name":{"type":"string","title":"Name","example":"Annual Leave"},"leave_type":{"type":"string","title":"Leave Type","example":"annual"},"rate":{"type":"number","title":"Rate","description":"The dollar amount per unit for this leave (e.g., hourly rate). Optional if using `multiplier` or to default to the employee's pay_rate_per_hour.","example":"38.00"},"multiplier":{"type":"number","title":"Multiplier","description":"Alternative to `rate`. Multiplies the employee's pay_rate_per_hour (e.g., 1.0 for base rate, 1.5 for time-and-a-half).","example":"1.0"},"hours":{"type":"number","title":"Hours","example":"7.6"},"value":{"type":"number","title":"Value","description":"Alias for hours to allow legacy payloads providing 'value'.","example":"7.6"},"leave_loading_amount":{"type":"number","title":"Leave Loading Amount","description":"Extra dollar loading applied to the leave (if any).","example":"3.80"},"id":{"type":"integer","title":"Id"},"amount":{"type":"number","title":"Amount","description":"The total amount for this leave row, calculated as rate * time_taken.","example":"288.80"}},"type":"object","required":["name","leave_type","hours","id","amount"],"title":"LeaveOut","description":"What the API returns after create / read."},"type":"array","title":"Leave","description":"A list of leave hours associated with this pay, including description, leave type, rate, value, and optional leave loading amount. Leave types can include: HOLIDAY, SICK, LONG SERVICE, PAID PARENTAL, EMPLOYER FUNDED PAID PARENTAL, WORKERS COMP, COMPASSIONATE, ANCILLARY, PAID PUBLIC HOLIDAY, UNPAID, OTHER.","example":[{"id":10,"name":"Annual Leave","leave_type":"HOLIDAY","rate":"38.00","hours":"7.6","leave_loading_amount":"3.80","amount":"288.80"}]},"leave_balance_rows":{"items":{"properties":{"leave_type":{"type":"string","title":"Leave Type","description":"Short code or internal key for the leave type.","example":"HOLIDAY"},"name":{"type":"string","title":"Name","description":"User-facing name of the leave type.","example":"Annual Leave"},"hours":{"type":"number","title":"Hours","description":"Decimal quantity of leave hours remaining.","example":"32.0"}},"type":"object","required":["leave_type","name"],"title":"LeaveBalanceRow","description":"Return schema for leave balance objects exposed via the API."},"type":"array","title":"Leave Balance Rows","description":"A list of leave balance rows associated with this pay, showing the employee's leave balances.","example":[{"leave_type":"annual","name":"Annual Leave","hours":"120.00"},{"leave_type":"sick","name":"Personal Leave","hours":"80.00"}]},"allowances":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the allowance.\nRequired when creating or matching an allowance.","example":"Tool Allowance"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the allowance.\nRequired when creating a new allowance (or if no allowance matches the description). May be omitted when reusing an existing allowance matched by description.","example":"50.00"},"allowance_category":{"type":"string","title":"Allowance Category","description":"Required allowance category code (e.g. 'TD' for Tools). Only codes are accepted. Codes are required when creating a new allowance; you may omit this when reusing an existing allowance that already has a code. Codes: AD, CD, KN, LD, MD, OD, QN, RD, TD. (Labels for reference: Cents per KM, Award Transport, Laundry, Overtime Meals, Domestic & Overseas Travel/Accommodation, Tools, Tasks, Qualifications/Certificates, Other)","example":"TD"},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether the allowance is taxable.\n- Defaults to True when creating a new employee allowance.\n","example":true},"is_itemised":{"type":"boolean","title":"Is Itemised","description":"Whether the allowance is itemised on the pay.\n- Defaults to False when creating a new employee allowance.\n","example":false},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this allowance is included in superannuation calculations.\n- Defaults to True when creating a new employee allowance.\n","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayAllowance"},"type":"array","title":"Allowances","description":"A list of allowances included in this pay, each with a description and amount.","example":[{"description":"Tool Allowance","amount":"50.00","is_taxable":true,"is_itemised":false,"is_included_in_super_calculations":true,"allowance_category":"TD"}]},"deductions":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the deduction.\nRequired when creating or matching a deduction.","example":"Union Fees"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the deduction.\nRequired when creating a new deduction (or if no deduction matches the description). May be omitted when reusing an existing deduction matched by description.","example":"25.00"},"classification":{"type":"string","title":"Classification","description":"Deduction classification code (use underscores). Codes are required when creating a new deduction; you may omit when reusing an existing deduction. Codes: CHARITY, CHILD_SUPPORT_DEDUCTION, CHILD_SUPPORT_GARNISHEE, NORMAL, UNION_FEES.","example":"UNION_FEES"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this deduction affects superannuation calculations.\n- Defaults to True when creating a new deduction.\n","example":false}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayDeduction"},"type":"array","title":"Deductions","description":"A list of deductions applied to this pay, each with a description and amount.","example":[{"description":"Union Fees","amount":"25.00","is_included_in_super_calculations":false}]},"bonuses":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the bonus.\nRequired when creating a new bonus (or if no bonus matches the description). May be omitted when reusing an existing bonus matched by description.","example":"100.00"},"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the bonus.\nRequired when creating or matching a bonus.","example":"Performance Bonus"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the bonus period. Required when tax_method uses a specific date range.","example":"2023-01-31"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this bonus is included in superannuation calculations.\n- Defaults to True when creating a new employee bonus.\n","example":true},"is_directors_fees":{"type":"boolean","title":"Is Directors Fees","description":"Indicates if the bonus is for director's fees.","example":false},"is_return_to_work":{"type":"boolean","title":"Is Return To Work","description":"Indicates if the bonus is a return to work bonus.","example":false},"tax_method":{"type":"string","title":"Tax Method","description":"The tax calculation method for the bonus. Provide the *code* (e.g. 'NORMAL_EARNINGS'); docs display the readable labels. Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"}},"additionalProperties":false,"type":"object","required":["description"],"title":"PayBonus"},"type":"array","title":"Bonuses","description":"A list of bonuses included in this pay, each with a description and amount.","example":[{"description":"Performance Bonus","amount":"500.00","start_date":"2023-01-01","end_date":"2023-01-31","is_included_in_super_calculations":true,"is_directors_fees":false,"is_return_to_work":false,"tax_method":"NORMAL_EARNINGS"}]},"pay_sacrifices":{"items":{"properties":{"amount":{"type":"number","title":"Amount","description":"The dollar amount for the pay sacrifice.\nRequired when creating a new pay sacrifice (or if no pay sacrifice matches the description). May be omitted when reusing an existing pay sacrifice matched by description.","example":"150.00"},"description":{"type":"string","maxLength":60,"minLength":0,"title":"Description","description":"A brief description of the pay sacrifice.\nRequired when creating or matching a pay sacrifice.","example":"Salary Sacrifice for Car"},"is_included_in_super_calculations":{"type":"boolean","title":"Is Included In Super Calculations","description":"Whether this pay sacrifice is included in superannuation calculations.\n- Defaults to True when creating a new employee pay sacrifice.\n","example":true},"is_super":{"type":"boolean","title":"Is Super","description":"Indicates if the pay sacrifice is for superannuation.","example":true}},"additionalProperties":false,"type":"object","required":["description"],"title":"PaySacrifice"},"type":"array","title":"Pay Sacrifices","description":"A list of salary sacrifices associated with this pay, each with an amount.","example":[{"amount":"150.00","description":"Car Salary Sacrifice","is_included_in_super_calculations":true,"is_super":true}]},"pay_department":{"type":"string","maxLength":32,"minLength":0,"title":"Pay Department","description":"Single department name applied to this pay and all of its items.","example":"Engineering"},"back_payments":{"items":{"properties":{"description":{"type":"string","maxLength":60,"minLength":1,"title":"Description","description":"A brief description of the back payment. Required when creating a new back payment.","example":"Back Pay Adjustment"},"amount":{"type":"number","title":"Amount","description":"The dollar amount for the back payment. Required when creating a new back payment.","example":"200.00"},"stp_category":{"type":"string","title":"Stp Category","description":"The back payment category code (use underscores). Codes are required when creating a new back payment. Codes: BONUS_COMMISSION_NON_DIRECTOR_S_FEES, DIRECTOR_S_FEES, GROSS, ITEMISED_ALLOWANCES, LEAVE, OVERTIME, UNCLASSIFIED.","example":"GROSS"},"tax_method":{"type":"string","title":"Tax Method","description":"The tax method applied to the back payment.Required when creating a new back payment.Allowed codes with labels: NORMAL_EARNINGS = As normal earnings; SPREAD_OVER_SPECIFIC_RANGE = Use date range; SPREAD_OVER_FINANCIAL_YEAR = Over this financial year; METHOD_A_WHOLE_YEAR = Method A (Whole Year); METHOD_A_SPECIFIC_RANGE = Method A (Use Date Range); METHOD_B1 = Method B(i)(Use Date Range); METHOD_B2 = Method B(ii)(Whole Year).","example":"NORMAL_EARNINGS"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date for the back payment period.","example":"2023-01-01"},"end_date":{"type":"string","format":"date","title":"End Date","description":"The end date for the back payment period.","example":"2023-01-31"}},"additionalProperties":false,"type":"object","required":["description","amount"],"title":"BackPayments"},"type":"array","title":"Back Payments","description":"A list of back payments associated with this pay.","example":[{"description":"Back Pay Adjustment","amount":"200.00","stp_category":"ordinary_time_earnings","tax_method":"NORMAL_EARNINGS","start_date":"2023-01-01","end_date":"2023-01-31"}]}},"type":"object","required":["status","hours","leave","leave_balance_rows","allowances","deductions"],"title":"Pay"},"type":"array","minItems":0,"title":"Pays","description":"A list of basic pay information associated with the pay run."}},"type":"object","required":["pay_run_id","pay_run_end_date","pay_period","pays"],"title":"PayRunPays"}}}