Payroll
Operations in the Payroll group.
- GET/v1/payroll/accident-insurance
- POST/v1/payroll/accident-insurance
- GET/v1/payroll/accident-insurance.pdf
- POST/v1/payroll/accident-insurance/{id}/cancel
- GET/v1/payroll/annual/tax
- GET/v1/payroll/annual/tax.pdf
- GET/v1/payroll/annual/tax.xml
- GET/v1/payroll/annual/tax/corrections
- POST/v1/payroll/annual/tax/corrections
- PATCH/v1/payroll/annual/tax/corrections/{id}
- DEL/v1/payroll/annual/tax/corrections/{id}
- GET/v1/payroll/annual/tax/filed
- POST/v1/payroll/annual/tax/filed
- POST/v1/payroll/annual/tax/supplementary.xml
- GET/v1/payroll/annual/withholding.xml
- GET/v1/payroll/attendance
- PUT/v1/payroll/attendance/{contractId}/{year}/{month}
- GET/v1/payroll/bonus-requests
- POST/v1/payroll/bonus-requests
- DEL/v1/payroll/bonus-requests/{id}
- GET/v1/payroll/bonus-requests/{id}/request.pdf
- GET/v1/payroll/bonus-requests/{id}/request.xml
- GET/v1/payroll/bonus-requests/preview
- DEL/v1/payroll/contract-amendments/{id}
- GET/v1/payroll/contract-amendments/{id}/amendment.pdf
- GET/v1/payroll/contracts
- POST/v1/payroll/contracts
- GET/v1/payroll/contracts/{id}
- PATCH/v1/payroll/contracts/{id}
- DEL/v1/payroll/contracts/{id}
- GET/v1/payroll/contracts/{id}/allocation
- PUT/v1/payroll/contracts/{id}/allocation
- GET/v1/payroll/contracts/{id}/amendment.pdf
- GET/v1/payroll/contracts/{id}/amendments
- POST/v1/payroll/contracts/{id}/amendments
- GET/v1/payroll/contracts/{id}/contract.pdf
- GET/v1/payroll/contracts/{id}/registration
- GET/v1/payroll/contracts/{id}/registration.pdf
- GET/v1/payroll/contracts/{id}/registration.xml
- GET/v1/payroll/contracts/{id}/service-confirmation.pdf
- POST/v1/payroll/contracts/{id}/sick-benefit.xml
- GET/v1/payroll/contracts/{id}/unemployment-confirmation.pdf
- GET/v1/payroll/contracts/{id}/wage-notice.pdf
- GET/v1/payroll/declaration-changes
- POST/v1/payroll/declaration-changes/{id}/approve
- POST/v1/payroll/declaration-changes/{id}/reject
- GET/v1/payroll/deductions
- POST/v1/payroll/deductions
- PATCH/v1/payroll/deductions/{id}
- DEL/v1/payroll/deductions/{id}
- GET/v1/payroll/document-templates
- PUT/v1/payroll/document-templates/{kind}
- DEL/v1/payroll/document-templates/{kind}
- GET/v1/payroll/employees
- POST/v1/payroll/employees
- GET/v1/payroll/employees/{id}
- PATCH/v1/payroll/employees/{id}
- DEL/v1/payroll/employees/{id}
- PUT/v1/payroll/employees/{id}/children
- GET/v1/payroll/employees/{id}/discount-notice.xml
- GET/v1/payroll/employees/{id}/eldp.pdf
- GET/v1/payroll/employees/{id}/income-confirmation.pdf
- POST/v1/payroll/employees/{id}/protected-account
- GET/v1/payroll/employees/{id}/protected-account.pdf
- POST/v1/payroll/employees/{id}/protected-account/end
- GET/v1/payroll/employees/{id}/record.pdf
- GET/v1/payroll/employees/{id}/self-service-links
- POST/v1/payroll/employees/{id}/self-service-links
- POST/v1/payroll/employees/import
- GET/v1/payroll/employees/import-template.xlsx
- POST/v1/payroll/employees/onboard
- GET/v1/payroll/health-changes
- POST/v1/payroll/health-changes.xdp
- POST/v1/payroll/health-changes.xml
- POST/v1/payroll/health-changes/marks
- DEL/v1/payroll/health-changes/marks/{id}
- GET/v1/payroll/holidays
- GET/v1/payroll/opening-months
- DEL/v1/payroll/opening-months/{id}
- GET/v1/payroll/pay-items
- POST/v1/payroll/pay-items
- PATCH/v1/payroll/pay-items/{id}
- DEL/v1/payroll/pay-items/{id}
- PUT/v1/payroll/pay-items/{id}/assignments
- GET/v1/payroll/pay-items/statutory
- GET/v1/payroll/payments
- POST/v1/payroll/payments/{id}/paid
- POST/v1/payroll/payments/{id}/unpaid
- POST/v1/payroll/preview/gross-to-net
- POST/v1/payroll/preview/net-to-gross
- GET/v1/payroll/rates
- GET/v1/payroll/reports/annual
- GET/v1/payroll/reports/costs
- GET/v1/payroll/reports/wage-sheet
- GET/v1/payroll/reports/wage-sheet.pdf
- GET/v1/payroll/runs
- POST/v1/payroll/runs
- GET/v1/payroll/runs/{id}
- PATCH/v1/payroll/runs/{id}
- DEL/v1/payroll/runs/{id}
- GET/v1/payroll/runs/{id}/filings
- POST/v1/payroll/runs/{id}/filings/{kind}/submitted
- GET/v1/payroll/runs/{id}/filings/health.aap
- GET/v1/payroll/runs/{id}/filings/health.pdf
- GET/v1/payroll/runs/{id}/filings/health.xml
- GET/v1/payroll/runs/{id}/filings/jmhz.xml
- GET/v1/payroll/runs/{id}/filings/social.pdf
- GET/v1/payroll/runs/{id}/filings/tax.pdf
- POST/v1/payroll/runs/{id}/lock
- POST/v1/payroll/runs/{id}/payment-orders
- GET/v1/payroll/runs/{id}/payslips/{itemId}/pdf
- POST/v1/payroll/runs/{id}/payslips/{itemId}/send
- POST/v1/payroll/runs/{id}/payslips/send
- POST/v1/payroll/runs/{id}/recalculate
- POST/v1/payroll/runs/{id}/reopen
- POST/v1/payroll/runs/{id}/review
- POST/v1/payroll/runs/{id}/unlock
- POST/v1/payroll/self-service-links/{id}/revoke
- GET/v1/payroll/settings
- PUT/v1/payroll/settings
- GET/v1/payroll/settlements
- POST/v1/payroll/settlements
- GET/v1/payroll/settlements/{id}
- PATCH/v1/payroll/settlements/{id}
- DEL/v1/payroll/settlements/{id}
- POST/v1/payroll/settlements/{id}/approve
- POST/v1/payroll/settlements/{id}/calculate
- GET/v1/payroll/settlements/{id}/calculation.pdf
- POST/v1/payroll/settlements/{id}/reopen
- POST/v1/payroll/settlements/preview
- GET/v1/payroll/sick-notes
- POST/v1/payroll/sick-notes/{id}/hzupn.xml
- GET/v1/payroll/sick-notes/direct
- POST/v1/payroll/sick-notes/direct
- POST/v1/payroll/sick-notes/direct/{id}/poll
- POST/v1/payroll/sick-notes/import
- POST/v1/payroll/sick-notes/insert
Statutory employer liability insurance of a year (vyhláška 125/1993 Sb.), by quarter: what is raised, what would be raised, and why not yet. The decree has no advances and no annual settlement: each quarter stands on the previous quarter's bases
/v1/payroll/accident-insuranceStatutory employer liability insurance of a year (vyhláška 125/1993 Sb.), by quarter: what is raised, what would be raised, and why not yet. The decree has no advances and no annual settlement: each quarter stands on the previous quarter's bases
MCP tool: get-payroll-accident-insurance
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
yearintegerrequiredinsurernull | stringrequiredokecnull | stringrequiredratePermillenull | numberrequiredquartersobject[]requiredquarterinteger | nullrequiredpremiumanyrequiredpreviewnull | objectrequiredyearintegerrequiredquarterinteger | nullrequiredbasisstringrequiredbaseHalerinteger | nullrequiredratePermillenumberrequiredamountHalerinteger | nullrequiredminimumAppliedbooleanrequireddueDatenull | stringrequireddateproblemsstring[]requiredtotalHalerinteger | nullrequiredRaise a quarter's premium as an Ostatní závazek to the insurer: MD 548 / D 325 in double entry, an expense when paid in the cash book. Goes on a payment order like any other payable. A company that moved here mid-year states the previous quarter's base
/v1/payroll/accident-insuranceRaise a quarter's premium as an Ostatní závazek to the insurer: MD 548 / D 325 in double entry, an expense when paid in the cash book. Goes on a payment order like any other payable. A company that moved here mid-year states the previous quarter's base
MCP tool: create-payroll-accident-premium
Request body
yearintegerrequiredmin 2000max 2100quarterintegerrequiredmin 1max 4baseHalerintegermin 0max 9007199254740991issueDatestringYYYY-MM-DDResponse · 201
idstringrequiredyearintegerrequiredquarterintegerrequiredinsurerstringrequiredbasisstringrequiredbaseHalerintegerrequiredratePermillenumberrequiredamountHalerintegerrequireddueDatestringrequireddatedocumentIdstringrequireddocumentNumbernull | stringrequiredOverview of a year's premiums as PDF. An employer must be able to prove what was paid and how it was worked out (§ 12 odst. 7 vyhlášky 125/1993 Sb.)
/v1/payroll/accident-insurance.pdfOverview of a year's premiums as PDF. An employer must be able to prove what was paid and how it was worked out (§ 12 odst. 7 vyhlášky 125/1993 Sb.)
MCP tool: get-payroll-accident-insurance-pdf
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
Returns a application/pdf file.
Withdraw a raised premium, so a wrong quarter can be raised again: cancels its Ostatní závazek, which must not be paid
/v1/payroll/accident-insurance/{id}/cancelWithdraw a raised premium, so a wrong quarter can be raised again: cancels its Ostatní závazek, which must not be paid
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: cancel-payroll-accident-premium
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredFigures for the annual tax settlement (Vyúčtování daně) by month, from locked runs
/v1/payroll/annual/taxFigures for the annual tax settlement (Vyúčtování daně) by month, from locked runs
MCP tool: get-payroll-annual-tax
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
yearintegerrequiredmonthsobject[]requiredrunIdnull | stringrequiredmonthinteger | nullrequiredemployeeCountintegerrequiredtaxableHalerintegerrequiredadvanceHalerintegerrequiredbonusHalerintegerrequiredadvancePayableHalerintegerrequiredwithholdingTaxHalerintegerrequiredWorking paper for the annual tax settlement as PDF. The EPO file is `tax.xml`
/v1/payroll/annual/tax.pdfWorking paper for the annual tax settlement as PDF. The EPO file is `tax.xml`
MCP tool: get-payroll-annual-tax-pdf
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
Returns a application/pdf file.
Vyúčtování daně z příjmů ze závislé činnosti as EPO XML (DPZVD6 09.03.01) for a whole year, with Přílohy 1 to 4. Valid against the official XSD; the portal runs further checks. Refused from 2027, when the Vyúčtování is abolished. A dodatečné one is a separate operation
/v1/payroll/annual/tax.xmlVyúčtování daně z příjmů ze závislé činnosti as EPO XML (DPZVD6 09.03.01) for a whole year, with Přílohy 1 to 4. Valid against the official XSD; the portal runs further checks. Refused from 2027, when the Vyúčtování is abolished. A dodatečné one is a separate operation
MCP tool: get-payroll-annual-tax-xml
Query parameters
yearintegerrequiredmin 2000max 2100type"B" | "O"Response · 200
Returns a application/xml file.
Corrections of advances, tax, and bonuses under § 38i ZDP that go on Příloha 3 and 4 of the Vyúčtování
/v1/payroll/annual/tax/correctionsCorrections of advances, tax, and bonuses under § 38i ZDP that go on Příloha 3 and 4 of the Vyúčtování
MCP tool: list-payroll-tax-corrections
Query parameters
yearintegermin 2000max 2100limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"payroll_tax_correction"requiredidstringrequiredemployeeIdnull | stringrequiredsubjectstringrequiredwrongYearintegerrequiredwrongMonthinteger | nullrequireddueDatenull | stringrequireddatecorrectedYearintegerrequiredcorrectedMonthintegerrequiredsettledOnnull | stringrequireddatebonusRequestedOnstring | nullrequiredamountHalerintegerrequirednotenull | stringrequiredtotalintegerhasMorebooleanrequiredRecord a correction under § 38i ZDP. A returned amount is negative, a debt positive, as the annex states it. It does not change a locked run or pay anything
/v1/payroll/annual/tax/correctionsRecord a correction under § 38i ZDP. A returned amount is negative, a debt positive, as the annex states it. It does not change a locked run or pay anything
MCP tool: create-payroll-tax-correction
Request body
employeeIdstring | nullsubject"advance" | "tax" | "monthly_bonus" | "settlement_bonus"requiredwrongYearintegerrequiredmin 2000max 2100wrongMonthinteger | nulldueDatestring | nullcorrectedYearintegerrequiredmin 2000max 2100correctedMonthintegerrequiredmin 1max 12settledOnstring | nullbonusRequestedOnstring | nullamountHalerintegerrequiredmin -9007199254740991max 9007199254740991notestring | nullResponse · 201
idstringrequiredemployeeIdnull | stringrequiredsubjectstringrequiredwrongYearintegerrequiredwrongMonthinteger | nullrequireddueDatenull | stringrequireddatecorrectedYearintegerrequiredcorrectedMonthintegerrequiredsettledOnnull | stringrequireddatebonusRequestedOnstring | nullrequiredamountHalerintegerrequirednotenull | stringrequiredChange a recorded correction under § 38i ZDP
/v1/payroll/annual/tax/corrections/{id}Change a recorded correction under § 38i ZDP
MCP tool: update-payroll-tax-correction
Path parameters
idstringrequiredRequest body
employeeIdstring | nullsubject"advance" | "tax" | "monthly_bonus" | "settlement_bonus"wrongYearintegermin 2000max 2100wrongMonthinteger | nulldueDatestring | nullcorrectedYearintegermin 2000max 2100correctedMonthintegermin 1max 12settledOnstring | nullbonusRequestedOnstring | nullamountHalerintegermin -9007199254740991max 9007199254740991notestring | nullResponse · 200
idstringrequiredemployeeIdnull | stringrequiredsubjectstringrequiredwrongYearintegerrequiredwrongMonthinteger | nullrequireddueDatenull | stringrequireddatecorrectedYearintegerrequiredcorrectedMonthintegerrequiredsettledOnnull | stringrequireddatebonusRequestedOnstring | nullrequiredamountHalerintegerrequirednotenull | stringrequiredDelete a recorded correction under § 38i ZDP
/v1/payroll/annual/tax/corrections/{id}Delete a recorded correction under § 38i ZDP
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-tax-correction
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredRecorded filings of the Vyúčtování for a year, with what each of them said
/v1/payroll/annual/tax/filedRecorded filings of the Vyúčtování for a year, with what each of them said
MCP tool: list-payroll-annual-tax-filings
Query parameters
yearintegerrequiredmin 2000max 2100limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"payroll_annual_tax_filing"requiredidstringrequiredyearintegerrequiredtypestringrequiredsubmittedAtnull | stringrequireddate-timenotestring | nullrequiredcolumn9integer[]requiredtotalintegerhasMorebooleanrequiredRecord that a Vyúčtování was filed and keep what it said, so a dodatečné one can be compared to it. DameDoklad does not submit it for you
/v1/payroll/annual/tax/filedRecord that a Vyúčtování was filed and keep what it said, so a dodatečné one can be compared to it. DameDoklad does not submit it for you
MCP tool: record-payroll-annual-tax-filing
Request body
yearintegerrequiredmin 2000max 2100type"B" | "O" | "D" | "E"filedOnstringrequiredYYYY-MM-DDnotestring | nullResponse · 201
idstringrequiredyearintegerrequiredtypestringrequiredsubmittedAtnull | stringrequireddate-timenotestring | nullrequiredcolumn9integer[]requiredDodatečné or dodatečné opravné Vyúčtování (§ 141 daňového řádu) as EPO XML: all months in full, sloupec 10 as the difference against what was filed, and the reasons. Needs a recorded filing of that year or the filed sloupec 9 by month
/v1/payroll/annual/tax/supplementary.xmlDodatečné or dodatečné opravné Vyúčtování (§ 141 daňového řádu) as EPO XML: all months in full, sloupec 10 as the difference against what was filed, and the reasons. Needs a recorded filing of that year or the filed sloupec 9 by month
MCP tool: create-payroll-supplementary-tax-xml
Request body
yearintegerrequiredmin 2000max 2100type"D" | "E"discoveredOnstringrequiredYYYY-MM-DDreasonsstringrequiredmax 5000 charsfiledColumn9integer[]Response · 200
Returns a application/xml file.
Vyúčtování daně vybírané srážkou as EPO XML (DPSVD2 09.04.01) for income of natural persons in a whole year. Valid against the official XSD; the portal runs further checks
/v1/payroll/annual/withholding.xmlVyúčtování daně vybírané srážkou as EPO XML (DPSVD2 09.04.01) for income of natural persons in a whole year. Valid against the official XSD; the portal runs further checks
MCP tool: get-payroll-annual-withholding-xml
Query parameters
yearintegerrequiredmin 2000max 2100type"B" | "O"Response · 200
Returns a application/xml file.
Get the attendance grid of a month: calendar with holidays and one row per contract, with hours and remaining vacation
/v1/payroll/attendanceGet the attendance grid of a month: calendar with holidays and one row per contract, with hours and remaining vacation
MCP tool: get-payroll-attendance
Query parameters
yearintegerrequiredmin 2000max 2100monthintegerrequiredmin 1max 12Response · 200
yearintegerrequiredmonthinteger | nullrequiredlockedbooleanrequiredfundDaysintegerrequiredcalendarobject[]requireddayintegerrequiredweekdayintegerrequiredisWeekendbooleanrequiredholidaynull | stringrequiredrowsobject[]requiredcontractIdnull | stringrequiredallocationMethodstringrequiredemployeeIdnull | stringrequiredemployeeNamestringrequiredtypestringrequiredpositionnull | stringrequiredwageTypestringrequiredscheduledbooleanrequireddailyMilliintegerrequiredstartDatestringrequireddateendDatestring | nullrequireddaysobjectrequiredworkedHoursMilliintegerrequiredextraShiftsintegerrequiredovertimeMilliintegerrequirednightMilliintegerrequiredweekendMilliintegerrequiredholidayWorkedMilliintegerrequireddifficultMilliintegerrequiredbonusHalerintegerrequiredotherTaxableHalerintegerrequiredotherExemptHalerintegerrequiredallocationany[]requirednotestring | nullrequiredsummarynull | objectrequiredfromstringrequireddatetostringrequireddateactivebooleanrequiredemployedDaysintegerrequiredcalendarDaysintegerrequiredfundFullMilliintegerrequiredfundEmployedMilliintegerrequiredworkedMilliintegerrequiredweekendWorkedMilliintegerrequiredholidayWorkedMilliintegerrequiredholidayMilliintegerrequiredvacationMilliintegerrequiredsickPaidMilliintegerrequiredsickUnpaidMilliintegerrequiredocrMilliintegerrequiredpaidLeaveMilliintegerrequiredunpaidLeaveMilliintegerrequiredabsentMilliintegerrequiredobstacleMilliintegerrequiredabsenceInFundMilliintegerrequiredsickDaysintegerrequiredocrDaysintegerrequiredhealthExcludedDaysintegerrequiredworkedDaysintegerrequiredshiftsintegerrequiredsickStreakAtEndintegerrequiredvacationEntitlementMilliintegerrequiredvacationUsedMilliintegerrequiredearlierMonthsany[]tipsHalerintegerseveranceHalerintegerdamagesHalerintegertipsExemptHalerinteger | nullSave a contract's attendance for a month: day codes (vacation, sick, ocr, paid_leave, unpaid_leave, ...), overtime, premiums, bonus
/v1/payroll/attendance/{contractId}/{year}/{month}Save a contract's attendance for a month: day codes (vacation, sick, ocr, paid_leave, unpaid_leave, ...), overtime, premiums, bonus
MCP tool: save-payroll-attendance
Path parameters
contractIdstringrequiredyearstringrequiredmonthstringrequiredRequest body
daysobjectworkedHoursMilliintegermin 0max 9007199254740991extraShiftsintegermin 0max 62overtimeMilliintegermin 0max 9007199254740991nightMilliintegermin 0max 9007199254740991weekendMilliintegermin 0max 9007199254740991holidayWorkedMilliintegermin 0max 9007199254740991difficultMilliintegermin 0max 9007199254740991bonusHalerintegermin 0max 9007199254740991otherTaxableHalerintegermin 0max 9007199254740991otherExemptHalerintegermin 0max 9007199254740991severanceHalerintegermin 0max 9007199254740991damagesHalerintegermin 0max 9007199254740991tipsHalerintegermin 0max 9007199254740991tipsExemptHalerinteger | nullearlierMonthsobject[]monthintegerrequiredmin 1max 11taxableHalerintegerrequiredmin 0max 9007199254740991allocationobject[]centerIdstring | nullactivityIdstring | nullprojectIdstring | nullhoursMilliintegerrequiredmin 0max 9007199254740991notestring | nullResponse · 200
idstringrequiredcontractIdstringrequiredyearintegerrequiredmonthintegerrequireddaysobjectrequiredworkedHoursMilliintegerrequiredextraShiftsintegerrequiredovertimeMilliintegerrequirednightMilliintegerrequiredweekendMilliintegerrequiredholidayWorkedMilliintegerrequireddifficultMilliintegerrequiredbonusHalerintegerrequiredotherTaxableHalerintegerrequiredotherExemptHalerintegerrequiredallocationobject[]requiredcenterIdstring | nullrequiredactivityIdnull | stringrequiredprojectIdstring | nullrequiredhoursMilliintegerrequirednotestring | nullrequiredsummarynull | objectrequiredfromstringrequireddatetostringrequireddateactivebooleanrequiredemployedDaysintegerrequiredcalendarDaysintegerrequiredfundFullMilliintegerrequiredfundEmployedMilliintegerrequiredworkedMilliintegerrequiredweekendWorkedMilliintegerrequiredholidayWorkedMilliintegerrequiredholidayMilliintegerrequiredvacationMilliintegerrequiredsickPaidMilliintegerrequiredsickUnpaidMilliintegerrequiredocrMilliintegerrequiredpaidLeaveMilliintegerrequiredunpaidLeaveMilliintegerrequiredabsentMilliintegerrequiredobstacleMilliintegerrequiredabsenceInFundMilliintegerrequiredsickDaysintegerrequiredocrDaysintegerrequiredhealthExcludedDaysintegerrequiredworkedDaysintegerrequiredshiftsintegerrequiredsickStreakAtEndintegerrequiredearlierMonthsobject[]monthintegerrequiredtaxableHalerintegerrequiredtipsHalerintegerseveranceHalerintegerdamagesHalerintegertipsExemptHalerinteger | nullList requests for a tax bonus paid from own funds
/v1/payroll/bonus-requestsList requests for a tax bonus paid from own funds
MCP tool: list-payroll-bonus-requests
Query parameters
yearintegerrequiredmin 2000max 2100limitintegermin 1max 500offsetintegermin 0max 9007199254740991Response · 200
dataany[]requiredtotalintegerhasMorebooleanrequiredRecord a request for a tax bonus paid from own funds. The amount then stops counting against later months' advances. Refused once the next month has already taken it off. You file the XML yourself
/v1/payroll/bonus-requestsRecord a request for a tax bonus paid from own funds. The amount then stops counting against later months' advances. Refused once the next month has already taken it off. You file the XML yourself
MCP tool: create-payroll-bonus-request
Request body
kind"monthly" | "settlement"requiredtype"regular" | "additional"yearintegerrequiredmin 2000max 2100monthintegermin 1max 12requestedHalerintegermin 0max 9007199254740991filedOnstringYYYY-MM-DDResponse · 201
idstringrequiredkindstringrequiredtypestringrequiredyearintegerrequiredmonthinteger | nullrequiredtotalHalerintegerrequiredfromAdvancesHalerintegerrequiredownFundsHalerintegerrequiredrequestedHalerintegerrequiredpaidOnnull | stringrequireddatefiledOnstringrequireddateRemove a recorded request, so the amount counts against later advances again
/v1/payroll/bonus-requests/{id}Remove a recorded request, so the amount counts against later advances again
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-bonus-request
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredThe request as a PDF working paper by the lines of forms 25 5241 and 25 5246. Not the printed form
/v1/payroll/bonus-requests/{id}/request.pdfThe request as a PDF working paper by the lines of forms 25 5241 and 25 5246. Not the printed form
MCP tool: get-payroll-bonus-request-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
The request as an EPO file: DPZMB1 for a month, DPZDB1 for a settlement. Valid against the published XSD. With keep=true the money stays for tax due (line d), otherwise it comes back to the company's default bank account. You file it: nothing goes to the portal from here
/v1/payroll/bonus-requests/{id}/request.xmlThe request as an EPO file: DPZMB1 for a month, DPZDB1 for a settlement. Valid against the published XSD. With keep=true the money stays for tax due (line d), otherwise it comes back to the company's default bank account. You file it: nothing goes to the portal from here
MCP tool: get-payroll-bonus-request-xml
Path parameters
idstringrequiredQuery parameters
keep"true" | "false"Response · 200
Returns a application/xml file.
What a request for a tax bonus paid from own funds would say: for a month (§ 35d odst. 5 ZDP) or a settlement's doplatek (§ 35d odst. 9). Without a request the app takes the amount off later months' advances, until December
/v1/payroll/bonus-requests/previewWhat a request for a tax bonus paid from own funds would say: for a month (§ 35d odst. 5 ZDP) or a settlement's doplatek (§ 35d odst. 9). Without a request the app takes the amount off later months' advances, until December
MCP tool: get-payroll-bonus-request-preview
Query parameters
kind"monthly" | "settlement"requiredyearintegerrequiredmin 2000max 2100monthintegermin 1max 12Response · 200
kindstringrequiredyearintegerrequiredmonthinteger | nullrequiredtotalHalerinteger | nullrequiredfromAdvancesHalerintegerrequiredownFundsHalerintegerrequiredpaidOnnull | stringrequireddateproblemsany[]requiredWithdraw the newest amendment of a contract and put back what it changed. Refused when a locked run has used it or a later amendment stands on it
/v1/payroll/contract-amendments/{id}Withdraw the newest amendment of a contract and put back what it changed. Refused when a locked run has used it or a later amendment stands on it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-contract-amendment
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredA recorded amendment as a PDF in Czech, with the values it replaced
/v1/payroll/contract-amendments/{id}/amendment.pdfA recorded amendment as a PDF in Czech, with the values it replaced
MCP tool: get-payroll-contract-amendment-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
List employment contracts (HPP, DPČ, DPP). One person can hold several at once
/v1/payroll/contractsList employment contracts (HPP, DPČ, DPP). One person can hold several at once
MCP tool: list-payroll-contracts
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991employeeIdstringactive"true" | "false"Response · 200
dataobject[]requiredobject"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringtotalintegerhasMorebooleanrequiredCreate an employment contract: type, dates, wage, work time fund, vacation entitlement
/v1/payroll/contractsCreate an employment contract: type, dates, wage, work time fund, vacation entitlement
MCP tool: create-payroll-contract
Request body
employeeIdstringrequiredtype"hpp" | "dpc" | "dpp"requiredpositionstring | nullqualificationstring | nullexposureNotestring | nullsignedOnstring | nullstartDatestringrequiredYYYY-MM-DDendDatestring | nullendReasonstring | nullwageType"monthly" | "hourly"baseWageHalerintegermin 0max 9007199254740991hourlyRateHalerintegermin 0max 9007199254740991weeklyHoursMilliintegermin 0max 168000irregularSchedulebooleanvacationHoursMilliintegermin 0max 9007199254740991smallScopeboolean | nullaverageHourlyHalerinteger | nullmealAllowancePerShiftHalerintegermin 0max 9007199254740991mealVoucherEmployerPerShiftHalerintegermin 0max 9007199254740991mealVoucherEmployeePerShiftHalerintegermin 0max 9007199254740991centerIdstring | nullactivityIdstring | nullprojectIdstring | nullidPpvstring | nulliscoCodestring | nullemploymentStatusCodestringworkModeCode"1" | "2" | "3" | "4"workCitystring | nullworkMunicipalityCodestring | nullregisteredAtstring | nullderegisteredAtstring | nullderegistrationobject | nullnoDataReason"2" | "3" | nullemploymentKind"1" | "2"endReasonCodeintegermin 1max 15averageNetMonthlyHalerinteger | nullseveranceDuebooleanseverancePaidInFullbooleanseveranceHalerintegermin 0max 9007199254740991replacementHalerintegermin 0max 9007199254740991pensionFromstring | nullpensionTostring | nullnotestring | nullResponse · 201
idstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringGet an employment contract
/v1/payroll/contracts/{id}Get an employment contract
MCP tool: get-payroll-contract
Path parameters
idstringrequiredResponse · 200
idstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringUpdate an employment contract. Locked payroll runs keep the values they were calculated with
/v1/payroll/contracts/{id}Update an employment contract. Locked payroll runs keep the values they were calculated with
MCP tool: update-payroll-contract
Path parameters
idstringrequiredRequest body
type"hpp" | "dpc" | "dpp"positionstring | nullqualificationstring | nullexposureNotestring | nullsignedOnstring | nullstartDatestringYYYY-MM-DDendDatestring | nullendReasonstring | nullwageType"monthly" | "hourly"baseWageHalerintegermin 0max 9007199254740991hourlyRateHalerintegermin 0max 9007199254740991weeklyHoursMilliintegermin 0max 168000irregularSchedulebooleanvacationHoursMilliintegermin 0max 9007199254740991smallScopeboolean | nullaverageHourlyHalerinteger | nullmealAllowancePerShiftHalerintegermin 0max 9007199254740991mealVoucherEmployerPerShiftHalerintegermin 0max 9007199254740991mealVoucherEmployeePerShiftHalerintegermin 0max 9007199254740991centerIdstring | nullactivityIdstring | nullprojectIdstring | nullidPpvstring | nulliscoCodestring | nullemploymentStatusCodestringworkModeCode"1" | "2" | "3" | "4"workCitystring | nullworkMunicipalityCodestring | nullregisteredAtstring | nullderegisteredAtstring | nullderegistrationobject | nullnoDataReason"2" | "3" | nullemploymentKind"1" | "2"endReasonCodeintegermin 1max 15averageNetMonthlyHalerinteger | nullseveranceDuebooleanseverancePaidInFullbooleanseveranceHalerintegermin 0max 9007199254740991replacementHalerintegermin 0max 9007199254740991pensionFromstring | nullpensionTostring | nullnotestring | nullResponse · 200
idstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringDelete a contract that has never been paid
/v1/payroll/contracts/{id}Delete a contract that has never been paid
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-contract
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredHow a contract's wage is split across cost centers, activities, and projects
/v1/payroll/contracts/{id}/allocationHow a contract's wage is split across cost centers, activities, and projects
MCP tool: get-payroll-cost-allocation
Path parameters
idstringrequiredResponse · 200
contractIdstringrequiredmethodnull | stringrequiredrowsobject[]requiredidstringrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdnull | stringrequiredshareBpintegerrequiredSplit a contract's wage: fixed percentages that add up to 100 %, hours from each month's attendance, or the contract's own dimensions
/v1/payroll/contracts/{id}/allocationSplit a contract's wage: fixed percentages that add up to 100 %, hours from each month's attendance, or the contract's own dimensions
MCP tool: replace-payroll-cost-allocation
Path parameters
idstringrequiredRequest body
method"default" | "fixed" | "attendance"requiredrowsobject[]centerIdstring | nullactivityIdstring | nullprojectIdstring | nullshareBpintegerrequiredmin 1max 10000Response · 200
contractIdstringrequiredmethodnull | stringrequiredrowsobject[]requiredidstringrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdnull | stringrequiredshareBpintegerrequiredAmendment to a contract as a PDF template in Czech (§ 40 of the Labour Code): what changes and from when. This paper alone changes nothing in the app: POST /payroll/contracts/:id/amendments records it on the contract
/v1/payroll/contracts/{id}/amendment.pdfAmendment to a contract as a PDF template in Czech (§ 40 of the Labour Code): what changes and from when. This paper alone changes nothing in the app: POST /payroll/contracts/:id/amendments records it on the contract
MCP tool: get-payroll-amendment-pdf
Path parameters
idstringrequiredQuery parameters
effectiveFromstringYYYY-MM-DDpositionstringmax 200 charsworkCitystringmax 200 charsbaseWageHalerintegermax 9007199254740991hourlyRateHalerintegermax 9007199254740991weeklyHoursMilliintegermax 60000endDatestringYYYY-MM-DDResponse · 200
Returns a application/pdf file.
Amendments recorded on a contract, newest first
/v1/payroll/contracts/{id}/amendmentsAmendments recorded on a contract, newest first
MCP tool: list-payroll-contract-amendments
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"payroll_contract_amendment"requiredidstringrequiredcontractIdstringrequiredeffectiveFromstringrequireddatesignedOnnull | stringrequireddatechangesobjectrequiredpositionnull | stringbaseWageHalerintegerworkCitynull | stringbeforeobjectrequiredpositionnull | stringbaseWageHalerintegerworkCitynull | stringstatusstringrequiredtotalintegerhasMorebooleanrequiredRecord an amendment (§ 40 of the Labour Code) and change the contract: at once when it is due, otherwise on its date. Runs of earlier months keep the old values. A change of wage or hours may start on any day: that month is paid pro rata, each part by the wage and hours it had. A locked run from that date on blocks it
/v1/payroll/contracts/{id}/amendmentsRecord an amendment (§ 40 of the Labour Code) and change the contract: at once when it is due, otherwise on its date. Runs of earlier months keep the old values. A change of wage or hours may start on any day: that month is paid pro rata, each part by the wage and hours it had. A locked run from that date on blocks it
MCP tool: create-payroll-contract-amendment
Path parameters
idstringrequiredRequest body
effectiveFromstringrequiredYYYY-MM-DDsignedOnstringYYYY-MM-DDpositionstringmax 200 charsworkCitystringmax 200 charsbaseWageHalerintegermin 0max 9007199254740991hourlyRateHalerintegermin 0max 9007199254740991weeklyHoursMilliintegermax 60000endDatestringYYYY-MM-DDResponse · 201
idstringrequiredcontractIdstringrequiredeffectiveFromstringrequireddatesignedOnnull | stringrequireddatechangesobjectrequiredpositionnull | stringbaseWageHalerintegerworkCitynull | stringbeforeobjectrequiredpositionnull | stringbaseWageHalerintegerworkCitynull | stringstatusstringrequiredEmployment contract, or the DPP or DPČ agreement, as a PDF template in Czech with what § 34, § 37, § 75, § 76 and § 77a of the Labour Code require. A probation period up to 4 months, 8 for a manager (§ 35)
/v1/payroll/contracts/{id}/contract.pdfEmployment contract, or the DPP or DPČ agreement, as a PDF template in Czech with what § 34, § 37, § 75, § 76 and § 77a of the Labour Code require. A probation period up to 4 months, 8 for a manager (§ 35)
MCP tool: get-payroll-contract-pdf
Path parameters
idstringrequiredQuery parameters
probationMonthsintegermin 1max 8managerial"true" | "false"Response · 200
Returns a application/pdf file.
What is still missing before the přihláška or odhláška of a contract can be exported
/v1/payroll/contracts/{id}/registrationWhat is still missing before the přihláška or odhláška of a contract can be exported
MCP tool: check-payroll-registration
Path parameters
idstringrequiredQuery parameters
action"start" | "end"requiredschemaVersion"1.4" | "1.5"Response · 200
actionstringrequiredaverageNetHalerinteger | nullrequiredproblemsstring[]requiredPřihláška or odhláška of an employee as PDF
/v1/payroll/contracts/{id}/registration.pdfPřihláška or odhláška of an employee as PDF
MCP tool: get-payroll-registration-pdf
Path parameters
idstringrequiredQuery parameters
action"start" | "end"requiredschemaVersion"1.4" | "1.5"Response · 200
Returns a application/pdf file.
Export a přihláška (start) or odhláška (end) of an employee as XML, which replaced the ONZ form from April 2026: REGZEC 1.4.0.4, or REGZEC27 1.5 from 1 January 2027 or when asked for by `schemaVersion`. An odhláška carries the data for unemployment support
/v1/payroll/contracts/{id}/registration.xmlExport a přihláška (start) or odhláška (end) of an employee as XML, which replaced the ONZ form from April 2026: REGZEC 1.4.0.4, or REGZEC27 1.5 from 1 January 2027 or when asked for by `schemaVersion`. An odhláška carries the data for unemployment support
MCP tool: get-payroll-registration-xml
Path parameters
idstringrequiredQuery parameters
action"start" | "end"requiredschemaVersion"1.4" | "1.5"Response · 200
Returns a application/xml file.
Potvrzení o zaměstnání, the zápočtový list, as a PDF in Czech with the points of § 313 odst. 1 of the Labour Code, for a job that has ended
/v1/payroll/contracts/{id}/service-confirmation.pdfPotvrzení o zaměstnání, the zápočtový list, as a PDF in Czech with the points of § 313 odst. 1 of the Labour Code, for a job that has ended
MCP tool: get-payroll-service-confirmation-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
NEMPRI25: the employer's attachment to a benefit claim for any of the six kinds (NEM, OSE, VPM, PPM, OPP, DLO), with the reckoning period from locked runs. Valid against the official XSD; ČSSZ's logical checks are partly reproduced
/v1/payroll/contracts/{id}/sick-benefit.xmlNEMPRI25: the employer's attachment to a benefit claim for any of the six kinds (NEM, OSE, VPM, PPM, OPP, DLO), with the reckoning period from locked runs. Valid against the official XSD; ČSSZ's logical checks are partly reproduced
MCP tool: create-payroll-sick-benefit-xml
Path parameters
idstringrequiredRequest body
kind"NEM" | "OSE" | "VPM" | "PPM" | "OPP" | "DLO"requiredeventDatestringrequiredYYYY-MM-DDdecisionNumberstringmax 18 charscorrectionbooleanprobableIncomeHalerinteger | nulldetailobjectrequiredworkedbooleanworkedHoursnumbermin 0max 24scheduleHoursnumbermin 0max 24smallScopeIncomeintegermin 0max 9007199254740991studentbooleanholidaysbooleanpensionerbooleanpensionType"A" | "B" | "C" | "I1" | "I3" | "S"firstJobLeavebooleanunpaidLeavebooleanunpaidLeaveFromstringYYYY-MM-DDunpaidLeaveTostringYYYY-MM-DDtransferredbooleantransferredOnstringYYYY-MM-DDstartsMaternitybooleanchildBirthDatestringYYYY-MM-DDattachmentbooleaninsolvencybooleanstage"start" | "continues" | "end"paymentobjectlastDayScheduleHoursnumbermin 0max 24lastDayWorkedHoursnumbermin 0max 24plannedShiftsbooleanplannedShiftsWorkedbooleanreturnedOnstringYYYY-MM-DDworkedDaysobject[]fromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDleavebooleanleaveDaysobject[]fromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDclaimobjectfromstringYYYY-MM-DDtostringYYYY-MM-DDpersonobjectfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nulltakeoverReason"DOH" | "ONE" | "ROZ" | "UMR"childrenobject[]firstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullpaternityReason"OTC" | "ZEM" | "PEC"childobjectfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullrelationCodestringalternatingbooleancaredPersonallybooleancaredDaysobject[]fromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDreason"ill" | "quarantine" | "carer_unable" | "school_closed"schoolNamestring | nullschoolIcostringsameHouseholdbooleansingleParentbooleancaresForChildUnder16booleanmaternityByOtherbooleanResponse · 200
Returns a application/xml file.
Confirmation for the Úřad práce (§ 313 odst. 2 of the Labour Code) as a PDF with the data of its form S 15: the job, the average monthly net earnings by § 356 odst. 3, and how it ended
/v1/payroll/contracts/{id}/unemployment-confirmation.pdfConfirmation for the Úřad práce (§ 313 odst. 2 of the Labour Code) as a PDF with the data of its form S 15: the job, the average monthly net earnings by § 356 odst. 3, and how it ended
MCP tool: get-payroll-unemployment-confirmation-pdf
Path parameters
idstringrequiredQuery parameters
reason"serious_breach" | "sick_regime" | "organizational" | "health" | "employer_breach" | "employee" | "agreement"reasonTextstringmax 200 charsaverageNetMonthlyHalerintegermin 0max 9007199254740991Response · 200
Returns a application/pdf file.
Mzdový výměr as a PDF in Czech (§ 113 odst. 4 of the Labour Code): how the employee is paid, when, and where
/v1/payroll/contracts/{id}/wage-notice.pdfMzdový výměr as a PDF in Czech (§ 113 odst. 4 of the Labour Code): how the employee is paid, when, and where
MCP tool: get-payroll-wage-notice-pdf
Path parameters
idstringrequiredQuery parameters
validFromstringYYYY-MM-DDResponse · 200
Returns a application/pdf file.
List tax declaration changes handed in by employees, newest first
/v1/payroll/declaration-changesList tax declaration changes handed in by employees, newest first
MCP tool: list-payroll-declaration-changes
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"pending" | "approved" | "rejected"Response · 200
dataobject[]requiredobject"payroll_declaration_change"requiredidstringrequiredemployeeIdstringrequiredemployeeNamestringstatusstringrequiredsubmittedAtstringrequireddate-timedecidedAtnull | stringrequireddate-timedecisionNotenull | stringrequiredchangeobjectrequiredztppbooleanaddChildrenobject[]firstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumberstringbirthDatenull | stringrequireddatebirthNumberMaskednull | stringrequestSettlementYearintegerdisabilitystringtotalintegerhasMorebooleanrequiredApply a declaration change to the personal card. A child counts from the month after the change was handed in, a newborn from the month of birth (§ 38k ZDP). A request for the annual settlement starts one
/v1/payroll/declaration-changes/{id}/approveApply a declaration change to the personal card. A child counts from the month after the change was handed in, a newborn from the month of birth (§ 38k ZDP). A request for the annual settlement starts one
MCP tool: approve-payroll-declaration-change
Path parameters
idstringrequiredRequest body
notestring | nullResponse · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringstatusstringrequiredsubmittedAtstringrequireddate-timedecidedAtnull | stringrequireddate-timedecisionNotenull | stringrequiredchangeobjectrequiredztppbooleanaddChildrenobject[]firstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumberstringbirthDatenull | stringrequireddatebirthNumberMaskednull | stringrequestSettlementYearintegerdisabilitystringTurn down a declaration change. Nothing on the personal card changes
/v1/payroll/declaration-changes/{id}/rejectTurn down a declaration change. Nothing on the personal card changes
MCP tool: reject-payroll-declaration-change
Path parameters
idstringrequiredRequest body
notestring | nullResponse · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringstatusstringrequiredsubmittedAtstringrequireddate-timedecidedAtnull | stringrequireddate-timedecisionNotenull | stringrequiredchangeobjectrequiredztppbooleanaddChildrenobject[]firstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumberstringbirthDatenull | stringrequireddatebirthNumberMaskednull | stringrequestSettlementYearintegerdisabilitystringList wage deductions: attachments of earnings, agreements, advances
/v1/payroll/deductionsList wage deductions: attachments of earnings, agreements, advances
MCP tool: list-payroll-deductions
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDemployeeIdstringResponse · 200
dataobject[]requiredobject"payroll_deduction"requiredidstringrequiredemployeeIdstringrequiredkindstringrequirednamestringrequiredamountHalerintegerrequiredremainingHalerinteger | nullrequiredreceivedOnnull | stringrequireddateaccountNumbernull | stringrequiredvariableSymbolnull | stringrequiredspecificSymbolstring | nullrequiredisActivebooleanrequirednotenull | stringrequiredtotalintegerhasMorebooleanrequiredAdd a wage deduction. Attachments are limited by the protected amount each month
/v1/payroll/deductionsAdd a wage deduction. Attachments are limited by the protected amount each month
MCP tool: create-payroll-deduction
Request body
employeeIdstringrequiredkind"attachment_priority" | "attachment_other" | "agreement" | "advance" | "other"requirednamestringrequiredmax 200 charsamountHalerintegermin 0max 9007199254740991remainingHalerinteger | nullreceivedOnstring | nullaccountNumberstring | nullvariableSymbolstring | nullspecificSymbolstring | nullisActivebooleannotestring | nullResponse · 201
idstringrequiredemployeeIdstringrequiredkindstringrequirednamestringrequiredamountHalerintegerrequiredremainingHalerinteger | nullrequiredreceivedOnnull | stringrequireddateaccountNumbernull | stringrequiredvariableSymbolnull | stringrequiredspecificSymbolstring | nullrequiredisActivebooleanrequirednotenull | stringrequiredUpdate a wage deduction
/v1/payroll/deductions/{id}Update a wage deduction
MCP tool: update-payroll-deduction
Path parameters
idstringrequiredRequest body
kind"attachment_priority" | "attachment_other" | "agreement" | "advance" | "other"namestringmax 200 charsamountHalerintegermin 0max 9007199254740991remainingHalerinteger | nullreceivedOnstring | nullaccountNumberstring | nullvariableSymbolstring | nullspecificSymbolstring | nullisActivebooleannotestring | nullResponse · 200
idstringrequiredemployeeIdstringrequiredkindstringrequirednamestringrequiredamountHalerintegerrequiredremainingHalerinteger | nullrequiredreceivedOnnull | stringrequireddateaccountNumbernull | stringrequiredvariableSymbolnull | stringrequiredspecificSymbolstring | nullrequiredisActivebooleanrequirednotenull | stringrequiredDelete a wage deduction
/v1/payroll/deductions/{id}Delete a wage deduction
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-deduction
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredThe wording of the personnel documents this company can change, with the default of each passage and what each has to keep. Rows the law requires are written by the app and are not here
/v1/payroll/document-templatesThe wording of the personnel documents this company can change, with the default of each passage and what each has to keep. Rows the law requires are written by the app and are not here
MCP tool: list-payroll-document-templates
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"payroll_document_template"requiredkindstringrequiredlabelnull | stringrequiredcustomizedbooleanrequiredplaceholdersstring[]requiredblocksobject[]requiredkeystringrequiredlabelnull | stringrequireddefaultTextstringrequiredtextstringrequiredplaceholdersstring[]requiredmentionsstring[]requiredextraSectionsobject[]requiredtextstringrequiredheadingstringrequiredtotalintegerhasMorebooleanrequiredSave a company's wording of one document and its own extra sections. Refused with the reasons when a passage drops what it has to keep, is empty, or names a figure the app does not know
/v1/payroll/document-templates/{kind}Save a company's wording of one document and its own extra sections. Refused with the reasons when a passage drops what it has to keep, is empty, or names a figure the app does not know
MCP tool: save-payroll-document-template
Path parameters
kindstringrequiredRequest body
blocksobjectextraSectionsobject[]headingstringrequiredmax 200 charstextstringrequiredmax 4000 charsResponse · 200
kindstringrequiredlabelnull | stringrequiredcustomizedbooleanrequiredplaceholdersstring[]requiredblocksobject[]requiredkeystringrequiredlabelnull | stringrequireddefaultTextstringrequiredtextstringrequiredplaceholdersstring[]requiredmentionsstring[]requiredextraSectionsobject[]requiredtextstringrequiredheadingstringrequiredGo back to the app's wording of one document
/v1/payroll/document-templates/{kind}Go back to the app's wording of one document
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: reset-payroll-document-template
Path parameters
kindstringrequiredResponse · 200
kindstringrequiredlabelnull | stringrequiredcustomizedbooleanrequiredplaceholdersstring[]requiredblocksobject[]requiredkeystringrequiredlabelnull | stringrequireddefaultTextstringrequiredtextstringrequiredplaceholdersstring[]requiredmentionsstring[]requiredextraSectionsobject[]requiredtextstringrequiredheadingstringrequiredList employees. Rodné číslo and bank account are masked here
/v1/payroll/employeesList employees. Rodné číslo and bank account are masked here
MCP tool: list-payroll-employees
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsstatus"active" | "inactive"Response · 200
dataobject[]requiredobject"employee"requiredidstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredtotalintegerhasMorebooleanrequiredCreate an employee. Rodné číslo is validated and stored encrypted
/v1/payroll/employeesCreate an employee. Rodné číslo is validated and stored encrypted
MCP tool: create-payroll-employee
Request body
firstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charstitlestring | nullbirthNamestring | nullbirthNumberstring | nullbirthDatestring | nullbirthPlacestring | nullgender"male" | "female" | nullcitizenshipstring2 charsstreetstring | nullhouseNumberstring | nullorientationNumberstring | nullcitystring | nullpostalCodestring | nullcountrystring2 charsemailstring | nullphonestring | nullbankAccountstring | nullhealthInsurerCode"111" | "201" | "205" | "207" | "209" | "211" | "213" | nulldisability"none" | "first_second" | "third"ztppbooleanztpbooleanpensionerbooleanpensionerDiscountFromstring | nullstudentbooleanstudentUntilstring | nullchildrenOtherPersonobject | nullfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullstateInsuredbooleanselfEmployedMinimumbooleanotherEmployerMinimumbooleanemployerDiscountGroup"age55" | "parent_under10" | "carer" | "student_under26" | "retraining" | "disabled" | "under21" | nullemployerDiscountNotifiedbooleanhasDeclarationbooleandeclarationSignedOnstring | nulldependentsintegermin 0max 20ikMpsvstring | nulleducationCodestring | nullstudentCreditbooleandoctoralStudentbooleantaxNonResidentbooleanforeignTaxIdstring | nullforeignTaxIdType"R" | "D" | "S" | "J" | nullidentityDocumentNumberstring | nullidentityDocumentType"I" | "P" | "D" | "O" | nullidentityDocumentCountrystring | nullstatus"active" | "inactive"notestring | nullchildrenobject[]firstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullztppbooleanclaimFromstring | nullclaimTostring | nullResponse · 201
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredGet the personal card of an employee, with the full rodné číslo, bank account, children, and contracts
/v1/payroll/employees/{id}Get the personal card of an employee, with the full rodné číslo, bank account, children, and contracts
MCP tool: get-payroll-employee
Path parameters
idstringrequiredResponse · 200
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredUpdate the personal card of an employee
/v1/payroll/employees/{id}Update the personal card of an employee
MCP tool: update-payroll-employee
Path parameters
idstringrequiredRequest body
firstNamestringmax 200 charslastNamestringmax 200 charstitlestring | nullbirthNamestring | nullbirthNumberstring | nullbirthDatestring | nullbirthPlacestring | nullgender"male" | "female" | nullcitizenshipstring2 charsstreetstring | nullhouseNumberstring | nullorientationNumberstring | nullcitystring | nullpostalCodestring | nullcountrystring2 charsemailstring | nullphonestring | nullbankAccountstring | nullhealthInsurerCode"111" | "201" | "205" | "207" | "209" | "211" | "213" | nulldisability"none" | "first_second" | "third"ztppbooleanztpbooleanpensionerbooleanpensionerDiscountFromstring | nullstudentbooleanstudentUntilstring | nullchildrenOtherPersonobject | nullfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullstateInsuredbooleanselfEmployedMinimumbooleanotherEmployerMinimumbooleanemployerDiscountGroup"age55" | "parent_under10" | "carer" | "student_under26" | "retraining" | "disabled" | "under21" | nullemployerDiscountNotifiedbooleanhasDeclarationbooleandeclarationSignedOnstring | nulldependentsintegermin 0max 20ikMpsvstring | nulleducationCodestring | nullstudentCreditbooleandoctoralStudentbooleantaxNonResidentbooleanforeignTaxIdstring | nullforeignTaxIdType"R" | "D" | "S" | "J" | nullidentityDocumentNumberstring | nullidentityDocumentType"I" | "P" | "D" | "O" | nullidentityDocumentCountrystring | nullstatus"active" | "inactive"notestring | nullResponse · 200
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredDelete an employee who has never been paid. Anyone with payroll history must be kept for the statutory period
/v1/payroll/employees/{id}Delete an employee who has never been paid. Anyone with payroll history must be kept for the statutory period
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-employee
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredReplace the list of children claimed for the tax credit. Order sets first, second, third child
/v1/payroll/employees/{id}/childrenReplace the list of children claimed for the tax credit. Order sets first, second, third child
MCP tool: replace-payroll-employee-children
Path parameters
idstringrequiredRequest body
childrenobject[]requiredfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullztppbooleanclaimFromstring | nullclaimTostring | nullResponse · 200
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredOZUSPOJ23: the notice of intent to apply the employer discount on social insurance (§ 7b zák. 589/1992 Sb.), for one employee. Valid against the official XSD
/v1/payroll/employees/{id}/discount-notice.xmlOZUSPOJ23: the notice of intent to apply the employer discount on social insurance (§ 7b zák. 589/1992 Sb.), for one employee. Valid against the official XSD
MCP tool: get-payroll-discount-notice-xml
Path parameters
idstringrequiredQuery parameters
action"start" | "end" | "cancel"requiredfromstringYYYY-MM-DDtostringYYYY-MM-DDResponse · 200
Returns a application/xml file.
Evidenční list důchodového pojištění of an employee for a year, as PDF
/v1/payroll/employees/{id}/eldp.pdfEvidenční list důchodového pojištění of an employee for a year, as PDF
MCP tool: get-payroll-eldp-pdf
Path parameters
idstringrequiredQuery parameters
yearintegerrequiredmin 2000max 2100Response · 200
Returns a application/pdf file.
Potvrzení o zdanitelných příjmech of an employee for a year, as PDF
/v1/payroll/employees/{id}/income-confirmation.pdfPotvrzení o zdanitelných příjmech of an employee for a year, as PDF
MCP tool: get-payroll-income-confirmation-pdf
Path parameters
idstringrequiredQuery parameters
yearintegerrequiredmin 2000max 2100Response · 200
Returns a application/pdf file.
Record that the wage goes to a protected account (chráněný účet, § 304c to § 304e OSŘ): the bank account the confirmation names as its source. From then on a run pays this wage from that account
/v1/payroll/employees/{id}/protected-accountRecord that the wage goes to a protected account (chráněný účet, § 304c to § 304e OSŘ): the bank account the confirmation names as its source. From then on a run pays this wage from that account
MCP tool: set-payroll-protected-account
Path parameters
idstringrequiredRequest body
bankAccountIdstringrequiredconfirmedOnstringYYYY-MM-DDResponse · 200
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredThe data for the confirmation of a protected account (§ 304d odst. 1 OSŘ) as a PDF working paper. The law wants the ministry's own form, so this is not it
/v1/payroll/employees/{id}/protected-account.pdfThe data for the confirmation of a protected account (§ 304d odst. 1 OSŘ) as a PDF working paper. The law wants the ministry's own form, so this is not it
MCP tool: get-payroll-protected-account-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
The employee brought the bank's confirmation that the account is no longer protected (§ 304e odst. 2 OSŘ): the wage is free to leave from any account again
/v1/payroll/employees/{id}/protected-account/endThe employee brought the bank's confirmation that the account is no longer protected (§ 304e odst. 2 OSŘ): the wage is free to leave from any account again
MCP tool: clear-payroll-protected-account
Path parameters
idstringrequiredResponse · 200
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredEvidenční list zaměstnance (personal record) as PDF
/v1/payroll/employees/{id}/record.pdfEvidenční list zaměstnance (personal record) as PDF
MCP tool: get-payroll-employee-record-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
List an employee's links with their audit trail. The URL itself cannot be read again
/v1/payroll/employees/{id}/self-service-linksList an employee's links with their audit trail. The URL itself cannot be read again
MCP tool: list-payroll-self-service-links
Path parameters
idstringrequiredQuery parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requiredobject"payroll_self_service_link"requiredidstringrequiredemployeeIdstringrequiredscopesstring[]requiredexpiresAtstringrequireddate-timerevokedAtnull | stringrequireddate-timelastUsedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeactivebooleanrequiredurlstringsentbooleaneventsobject[]actionstringrequiredsubjectIdnull | stringrequiredatstringrequireddate-timetotalintegerhasMorebooleanrequiredCreate a link an employee opens without logging in to download payslips and hand in tax declaration changes. The URL is returned once and can be e-mailed
/v1/payroll/employees/{id}/self-service-linksCreate a link an employee opens without logging in to download payslips and hand in tax declaration changes. The URL is returned once and can be e-mailed
MCP tool: create-payroll-self-service-link
Path parameters
idstringrequiredRequest body
scopes"payslips" | "declaration"[]expiresInDaysintegermin 1max 90sendbooleanResponse · 201
idstringrequiredemployeeIdstringrequiredscopesstring[]requiredexpiresAtstringrequireddate-timerevokedAtnull | stringrequireddate-timelastUsedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeactivebooleanrequiredurlstringsentbooleaneventsobject[]actionstringrequiredsubjectIdnull | stringrequiredatstringrequireddate-timeImport employees from XLSX for a company coming from POHODA, which does not export them to XML: cards and contracts, and on further sheets children, deductions, attendance and wages of past months. A second row with the same person adds a contract. dryRun only validates
/v1/payroll/employees/importImport employees from XLSX for a company coming from POHODA, which does not export them to XML: cards and contracts, and on further sheets children, deductions, attendance and wages of past months. A second row with the same person adds a contract. dryRun only validates. Past months go where past months count: the annual social cap, average earnings, the year-end settlement, ELDP and the income confirmation. They post nothing and are not paid. A month that already has a run here is refused, so nothing counts twice.
MCP tool: import-payroll-employees
Request body
fileBase64stringrequiredmax 40000000 charsdryRunbooleanResponse · 200
dryRunbooleanrequiredemployeesintegerrequiredcontractsintegerrequiredimportedEmployeesintegerrequiredimportedContractsintegerrequirederrorsobject[]requiredlineintegerrequiredmessagenull | stringrequirednamenull | stringrequiredpreviewobject[]requirednamenull | stringrequiredexistingbooleanrequiredcontractsobject[]requiredtypestringrequiredpositionnull | stringrequiredstartDatestringrequireddatechildrenintegerdeductionsintegerattendanceMonthsintegerwageMonthsintegerDownload the XLSX template for importing employees and contracts, with an example row
/v1/payroll/employees/import-template.xlsxDownload the XLSX template for importing employees and contracts, with an example row
MCP tool: download-payroll-employee-import-template
Response · 200
Returns a application/vnd.openxmlformats-officedocument.spreadsheetml.sheet file.
Onboard a new hire in one step: personal card, children, and the first contract
/v1/payroll/employees/onboardOnboard a new hire in one step: personal card, children, and the first contract
MCP tool: onboard-payroll-employee
Request body
employeeobjectrequiredfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charstitlestring | nullbirthNamestring | nullbirthNumberstring | nullbirthDatestring | nullbirthPlacestring | nullgender"male" | "female" | nullcitizenshipstring2 charsstreetstring | nullhouseNumberstring | nullorientationNumberstring | nullcitystring | nullpostalCodestring | nullcountrystring2 charsemailstring | nullphonestring | nullbankAccountstring | nullhealthInsurerCode"111" | "201" | "205" | "207" | "209" | "211" | "213" | nulldisability"none" | "first_second" | "third"ztppbooleanztpbooleanpensionerbooleanpensionerDiscountFromstring | nullstudentbooleanstudentUntilstring | nullchildrenOtherPersonobject | nullfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullstateInsuredbooleanselfEmployedMinimumbooleanotherEmployerMinimumbooleanemployerDiscountGroup"age55" | "parent_under10" | "carer" | "student_under26" | "retraining" | "disabled" | "under21" | nullemployerDiscountNotifiedbooleanhasDeclarationbooleandeclarationSignedOnstring | nulldependentsintegermin 0max 20ikMpsvstring | nulleducationCodestring | nullstudentCreditbooleandoctoralStudentbooleantaxNonResidentbooleanforeignTaxIdstring | nullforeignTaxIdType"R" | "D" | "S" | "J" | nullidentityDocumentNumberstring | nullidentityDocumentType"I" | "P" | "D" | "O" | nullidentityDocumentCountrystring | nullstatus"active" | "inactive"notestring | nullchildrenobject[]firstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullztppbooleanclaimFromstring | nullclaimTostring | nullcontractobjectrequiredtype"hpp" | "dpc" | "dpp"requiredpositionstring | nullqualificationstring | nullexposureNotestring | nullsignedOnstring | nullstartDatestringrequiredYYYY-MM-DDendDatestring | nullendReasonstring | nullwageType"monthly" | "hourly"baseWageHalerintegermin 0max 9007199254740991hourlyRateHalerintegermin 0max 9007199254740991weeklyHoursMilliintegermin 0max 168000irregularSchedulebooleanvacationHoursMilliintegermin 0max 9007199254740991smallScopeboolean | nullaverageHourlyHalerinteger | nullmealAllowancePerShiftHalerintegermin 0max 9007199254740991mealVoucherEmployerPerShiftHalerintegermin 0max 9007199254740991mealVoucherEmployeePerShiftHalerintegermin 0max 9007199254740991centerIdstring | nullactivityIdstring | nullprojectIdstring | nullidPpvstring | nulliscoCodestring | nullemploymentStatusCodestringworkModeCode"1" | "2" | "3" | "4"workCitystring | nullworkMunicipalityCodestring | nullregisteredAtstring | nullderegisteredAtstring | nullderegistrationobject | nullnoDataReason"2" | "3" | nullemploymentKind"1" | "2"endReasonCodeintegermin 1max 15averageNetMonthlyHalerinteger | nullseveranceDuebooleanseverancePaidInFullbooleanseveranceHalerintegermin 0max 9007199254740991replacementHalerintegermin 0max 9007199254740991pensionFromstring | nullpensionTostring | nullnotestring | nullResponse · 201
idstringrequirednamenull | stringrequiredfirstNamestringrequiredlastNamestringrequiredtitlestring | nullrequiredbirthNamestring | nullrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddatebirthPlacenull | stringrequiredgendernull | stringrequiredcitizenshipstringrequiredstreetnull | stringrequiredhouseNumbernull | stringrequiredorientationNumberstring | nullrequiredcitynull | stringrequiredpostalCodenull | stringrequiredcountrystringrequiredemailnull | stringrequiredphonestring | nullrequiredbankAccountMaskednull | stringrequiredprotectedAccountSourceIdnull | stringrequiredprotectedAccountConfirmedOnnull | stringrequireddatehealthInsurerCodenull | stringrequiredhealthInsurerNamenull | stringrequireddisabilitystringrequiredztppbooleanrequiredztpbooleanrequiredpensionerbooleanrequiredpensionerDiscountFromnull | stringrequireddatestudentbooleanrequiredstudentUntilstring | nullrequiredstateInsuredbooleanrequiredselfEmployedMinimumbooleanrequiredotherEmployerMinimumbooleanrequiredemployerDiscountGroupnull | stringrequiredemployerDiscountNotifiedbooleanrequiredhasDeclarationbooleanrequireddeclarationSignedOnnull | stringrequireddatedependentsintegerrequiredikMpsvnull | stringrequirededucationCodestring | nullrequiredstudentCreditbooleanrequireddoctoralStudentbooleanrequiredtaxNonResidentbooleanrequiredforeignTaxIdnull | stringrequiredforeignTaxIdTypenull | stringrequiredidentityDocumentNumbernull | stringrequiredidentityDocumentTypenull | stringrequiredidentityDocumentCountrynull | stringrequiredstatusstringrequirednotestring | nullrequiredcontractsobject[]object"employment_contract"requiredidstringrequiredemployeeIdstringrequiredtypestringrequiredpositionnull | stringrequiredsignedOnstring | nullrequiredstartDatestringrequireddateendDatenull | stringrequireddateendReasonstring | nullrequiredwageTypestringrequiredbaseWageHalerintegerrequiredhourlyRateHalerintegerrequiredweeklyHoursMilliintegerrequiredirregularSchedulebooleanrequiredvacationHoursMilliintegerrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredmealAllowancePerShiftHalerintegerrequiredmealVoucherEmployerPerShiftHalerintegerrequiredmealVoucherEmployeePerShiftHalerintegerrequiredcenterIdnull | stringrequiredactivityIdstring | nullrequiredprojectIdstring | nullrequiredidPpvnull | stringrequirediscoCodenull | stringrequiredemploymentStatusCodestringrequiredworkModeCodestringrequiredworkCitynull | stringrequiredworkMunicipalityCodenull | stringrequiredregisteredAtstring | nullrequiredderegisteredAtstring | nullrequiredallocationMethodstringrequiredderegistrationnull | objectrequiredseveranceDuebooleanendReasonCodeintegerseveranceHalerintegerseverancePaidInFullbooleannoDataReasonstringaverageNetMonthlyHalerintegernotestring | nullrequiredemployeeNamestringqualificationnull | stringexposureNotenull | stringonboardingobjectpersonalbooleanrequiredinsurerbooleanrequiredbankbooleanrequiredcontractbooleanrequireddeclarationbooleanrequiredregisteredbooleanrequiredchildrenOtherPersonnull | objectlastNamestringrequiredbirthDatenull | stringrequireddatefirstNamestringrequiredbirthNumberMaskednull | stringrequiredbirthNumbernull | stringbankAccountnull | stringchildrenobject[]object"employee_child"requiredidstringrequiredfirstNamenull | stringrequiredlastNamenull | stringrequiredbirthNumbernull | stringrequiredbirthNumberMaskednull | stringrequiredbirthDatenull | stringrequireddateztppbooleanrequiredclaimFromnull | stringrequireddateclaimTonull | stringrequireddatepositioninteger | nullrequiredWhat a Hromadné oznámení zaměstnavatele of a period says for one insurer, worked out from contracts. Tells where the XML format comes from, whether that insurer itself publishes it, and which form an XDP belongs to
/v1/payroll/health-changesWhat a Hromadné oznámení zaměstnavatele of a period says for one insurer, worked out from contracts. Tells where the XML format comes from, whether that insurer itself publishes it, and which form an XDP belongs to
MCP tool: get-payroll-health-changes
Query parameters
insurer"111" | "201" | "205" | "207" | "209" | "211" | "213"requiredfromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDResponse · 200
insurerstringrequiredxmlFormatSourcenull | stringrequiredlinesobject[]requiredemployeeIdnull | stringrequirednamenull | stringrequiredcodenull | stringrequireddatestringrequireddateuncertainbooleanrequiredaddedobject[]idstringrequiredemployeeIdnull | stringrequirednamenull | stringrequiredcodenull | stringrequireddatestringrequireddateskippedobject[]idstringrequiredemployeeIdnull | stringrequirednamenull | stringrequiredcodenull | stringrequireddatestringrequireddatexmlFormatPublishedbooleanxdpFormnull | stringThe data of the insurer's Hromadné oznámení form as an XDP, for VZP, VoZP, ZPŠ, ZP MV and RBP. Adobe Reader opens it together with the PDF it names, and you send that PDF. Refused for ČPZP and OZP, which take the XML, and when a value would be cut by the form
/v1/payroll/health-changes.xdpThe data of the insurer's Hromadné oznámení form as an XDP, for VZP, VoZP, ZPŠ, ZP MV and RBP. Adobe Reader opens it together with the PDF it names, and you send that PDF. Refused for ČPZP and OZP, which take the XML, and when a value would be cut by the form
MCP tool: create-payroll-health-changes-xdp
Request body
insurer"111" | "201" | "205" | "207" | "209" | "211" | "213"requiredfromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDextraobject[]employeeIdstringrequiredcode"P" | "A" | "E" | "C" | "O" | "Q" | "M" | "U" | "D" | "H" | "I" | "J" | "G" | "F" | "L" | "T" | "N" | "K" | "S" | "R" | "W" | "V" | "X" | "Y" | "Z"requireddatestringrequiredYYYY-MM-DDskipobject[]employeeIdstringrequiredcode"P" | "A" | "E" | "C" | "O" | "Q" | "M" | "U" | "D" | "H" | "I" | "J" | "G" | "F" | "L" | "T" | "N" | "K" | "S" | "R" | "W" | "V" | "X" | "Y" | "Z"requireddatestringrequiredYYYY-MM-DDResponse · 200
Returns a application/xml file.
Hromadné oznámení zaměstnavatele as the shared XML (hromadneOznameniZamestnavatele v8), whose schema lists all seven insurers. Valid against the XSD. ČPZP, OZP and RBP publish the schema; for VZP, VoZP, ZPŠ and ZP MV ask the insurer whether it takes the file. You file it on the insurer's portal or to its data box
/v1/payroll/health-changes.xmlHromadné oznámení zaměstnavatele as the shared XML (hromadneOznameniZamestnavatele v8), whose schema lists all seven insurers. Valid against the XSD. ČPZP, OZP and RBP publish the schema; for VZP, VoZP, ZPŠ and ZP MV ask the insurer whether it takes the file. You file it on the insurer's portal or to its data box
MCP tool: create-payroll-health-changes-xml
Request body
insurer"111" | "201" | "205" | "207" | "209" | "211" | "213"requiredfromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDextraobject[]employeeIdstringrequiredcode"P" | "A" | "E" | "C" | "O" | "Q" | "M" | "U" | "D" | "H" | "I" | "J" | "G" | "F" | "L" | "T" | "N" | "K" | "S" | "R" | "W" | "V" | "X" | "Y" | "Z"requireddatestringrequiredYYYY-MM-DDskipobject[]employeeIdstringrequiredcode"P" | "A" | "E" | "C" | "O" | "Q" | "M" | "U" | "D" | "H" | "I" | "J" | "G" | "F" | "L" | "T" | "N" | "K" | "S" | "R" | "W" | "V" | "X" | "Y" | "Z"requireddatestringrequiredYYYY-MM-DDResponse · 200
Returns a application/xml file.
Keep a line on the Hromadné oznámení of its month: `add` a change the contracts cannot show, such as maternity (M, U) or a pension (D, H), or `skip` one they show that is not to be filed. It stays for every later look and file
/v1/payroll/health-changes/marksKeep a line on the Hromadné oznámení of its month: `add` a change the contracts cannot show, such as maternity (M, U) or a pension (D, H), or `skip` one they show that is not to be filed. It stays for every later look and file
MCP tool: create-payroll-health-change-mark
Request body
insurer"111" | "201" | "205" | "207" | "209" | "211" | "213"requiredemployeeIdstringrequiredcode"P" | "A" | "E" | "C" | "O" | "Q" | "M" | "U" | "D" | "H" | "I" | "J" | "G" | "F" | "L" | "T" | "N" | "K" | "S" | "R" | "W" | "V" | "X" | "Y" | "Z"requireddatestringrequiredYYYY-MM-DDaction"add" | "skip"requiredResponse · 201
idstringrequiredemployeeIdstringrequirednamenull | stringrequiredcodestringrequireddatestringrequireddateactionstringrequiredTake back an added line, or bring back a line that was left out
/v1/payroll/health-changes/marks/{id}Take back an added line, or bring back a line that was left out
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-health-change-mark
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList Czech public holidays of a year
/v1/payroll/holidaysList Czech public holidays of a year
MCP tool: list-payroll-holidays
Query parameters
yearintegerrequiredmin 2000max 2100limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataobject[]requireddatestringrequireddatenamenull | stringrequiredtotalintegerhasMorebooleanrequiredList past months taken over from the previous program. They count in the annual social cap, averages, the year-end settlement, ELDP and the income confirmation, and post nothing
/v1/payroll/opening-monthsList past months taken over from the previous program. They count in the annual social cap, averages, the year-end settlement, ELDP and the income confirmation, and post nothing
MCP tool: list-payroll-opening-months
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDemployeeIdstringyearintegermin 2000max 2100Response · 200
dataobject[]requiredobject"payroll_opening_month"requiredidstringrequiredemployeeIdstringrequiredcontractIdnull | stringrequiredemployeeNamestringrequiredyearintegerrequiredmonthintegerrequiredgrossHalerintegerrequiredtaxableHalerintegerrequiredtaxBaseHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingBaseHalerintegerrequiredwithholdingHalerintegerrequiredsocialBaseHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthBaseHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequirednetHalerintegerrequiredworkedHoursMilliintegerrequiredworkedDaysintegerrequiredsickDaysintegerrequiredocrDaysintegerrequiredunpaidLeaveMilliintegerrequirednotestring | nullrequiredtotalintegerhasMorebooleanrequiredRemove a past month taken over by mistake, so it can be imported again
/v1/payroll/opening-months/{id}Remove a past month taken over by mistake, so it can be imported again
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-opening-month
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredList company pay item templates: bonuses, premium rates, meal vouchers, and benefits, with the contracts they apply to
/v1/payroll/pay-itemsList company pay item templates: bonuses, premium rates, meal vouchers, and benefits, with the contracts they apply to
MCP tool: list-payroll-pay-items
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsResponse · 200
dataany[]requiredtotalintegerhasMorebooleanrequiredCreate a pay item template. A premium rate below the statutory minimum is refused, except an agreed lower rate for night and weekend work
/v1/payroll/pay-itemsCreate a pay item template. A premium rate below the statutory minimum is refused, except an agreed lower rate for night and weekend work
MCP tool: create-payroll-pay-item
Request body
namestringrequiredmax 200 charscategory"bonus" | "premium" | "benefit"requiredcalc"fixed" | "per_shift" | "per_hour" | "percent_of_base" | "percent_of_average"requiredtreatment"taxable" | "benefit" | "health_care" | "meal_allowance" | "meal_voucher"amountHalerintegermin 0max 9007199254740991employeeAmountHalerintegermin 0max 9007199254740991rateBpintegermin 0max 100000hoursBasis"worked" | "overtime" | "night" | "weekend" | "holiday" | "difficult"premiumKind"overtime" | "night" | "weekend" | "holiday" | "difficult" | nullagreedBelowStatutorybooleanexemptGroup"none" | "health" | "leisure" | "recreation" | "retirement"appliesToAllbooleanvalidFromstring | nullvalidTostring | nullisActivebooleannotestring | nullResponse · 201
idstringrequirednamestringrequiredcategorystringrequiredcalcstringrequiredtreatmentstringrequiredamountHalerintegerrequiredemployeeAmountHalerintegerrequiredrateBpintegerrequiredhoursBasisstringrequiredpremiumKindnull | stringrequiredagreedBelowStatutorybooleanrequiredexemptGroupstringrequiredappliesToAllbooleanrequiredvalidFromnull | stringrequiredvalidTonull | stringrequiredisActivebooleanrequirednotestring | nullrequiredassignmentsobject[]requiredcontractIdnull | stringrequiredamountHalerinteger | nullrequiredrateBpinteger | nullrequiredvalidFromstring | nullrequiredvalidTostring | nullrequiredUpdate a pay item template. Locked runs keep the values they were calculated with
/v1/payroll/pay-items/{id}Update a pay item template. Locked runs keep the values they were calculated with
MCP tool: update-payroll-pay-item
Path parameters
idstringrequiredRequest body
namestringmax 200 charscategory"bonus" | "premium" | "benefit"calc"fixed" | "per_shift" | "per_hour" | "percent_of_base" | "percent_of_average"treatment"taxable" | "benefit" | "health_care" | "meal_allowance" | "meal_voucher"amountHalerintegermin 0max 9007199254740991employeeAmountHalerintegermin 0max 9007199254740991rateBpintegermin 0max 100000hoursBasis"worked" | "overtime" | "night" | "weekend" | "holiday" | "difficult"premiumKind"overtime" | "night" | "weekend" | "holiday" | "difficult" | nullagreedBelowStatutorybooleanexemptGroup"none" | "health" | "leisure" | "recreation" | "retirement"appliesToAllbooleanvalidFromstring | nullvalidTostring | nullisActivebooleannotestring | nullResponse · 200
idstringrequirednamestringrequiredcategorystringrequiredcalcstringrequiredtreatmentstringrequiredamountHalerintegerrequiredemployeeAmountHalerintegerrequiredrateBpintegerrequiredhoursBasisstringrequiredpremiumKindnull | stringrequiredagreedBelowStatutorybooleanrequiredexemptGroupstringrequiredappliesToAllbooleanrequiredvalidFromnull | stringrequiredvalidTonull | stringrequiredisActivebooleanrequirednotestring | nullrequiredassignmentsobject[]requiredcontractIdnull | stringrequiredamountHalerinteger | nullrequiredrateBpinteger | nullrequiredvalidFromstring | nullrequiredvalidTostring | nullrequiredDelete a pay item template and its assignments. Locked runs keep the amounts they already hold
/v1/payroll/pay-items/{id}Delete a pay item template and its assignments. Locked runs keep the amounts they already hold
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-pay-item
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredSet which contracts a pay item applies to, each optionally with its own amount, rate, and months
/v1/payroll/pay-items/{id}/assignmentsSet which contracts a pay item applies to, each optionally with its own amount, rate, and months
MCP tool: replace-payroll-pay-item-assignments
Path parameters
idstringrequiredRequest body
assignmentsobject[]requiredcontractIdstringrequiredamountHalerinteger | nullrateBpinteger | nullvalidFromstring | nullvalidTostring | nullResponse · 200
idstringrequirednamestringrequiredcategorystringrequiredcalcstringrequiredtreatmentstringrequiredamountHalerintegerrequiredemployeeAmountHalerintegerrequiredrateBpintegerrequiredhoursBasisstringrequiredpremiumKindnull | stringrequiredagreedBelowStatutorybooleanrequiredexemptGroupstringrequiredappliesToAllbooleanrequiredvalidFromnull | stringrequiredvalidTonull | stringrequiredisActivebooleanrequirednotestring | nullrequiredassignmentsobject[]requiredcontractIdnull | stringrequiredamountHalerinteger | nullrequiredrateBpinteger | nullrequiredvalidFromstring | nullrequiredvalidTostring | nullrequiredStatutory minimum premiums and benefit limits of a year, with the section of the Labour Code or the Income Tax Act
/v1/payroll/pay-items/statutoryStatutory minimum premiums and benefit limits of a year, with the section of the Labour Code or the Income Tax Act
MCP tool: get-payroll-statutory-premiums
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
yearintegerrequiredpremiumsobject[]requiredkindstringrequiredminimumBpintegerrequiredbasestringrequiredsectionstringrequiredagreeablebooleanrequiredmealExemptPerShiftHalerinteger | nullrequiredbenefitLimitsobjectrequiredhealthobjectrequiredlimitHalerintegerrequiredsectionstringrequiredleisureobjectrequiredlimitHalerinteger | nullrequiredsectionstringrequiredretirementobjectrequiredlimitHalerintegerrequiredsectionstringrequiredrecreationobjectlimitHalerintegerrequiredsectionstringrequiredList payroll payments. With status=due this is the list the bank module turns into payment orders: payouts, deductions, ČSSZ, health insurers, tax
/v1/payroll/paymentsList payroll payments. With status=due this is the list the bank module turns into payment orders: payouts, deductions, ČSSZ, health insurers, tax
MCP tool: list-payroll-payments
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDstatus"due" | "paid"runIdstringkind"wage" | "reimbursement" | "social" | "health" | "tax_advance" | "tax_withholding" | "deduction"Response · 200
dataobject[]requiredobject"payroll_payment"requiredidstringrequiredrunIdstringrequiredkindstringrequiredemployeeIdnull | stringrequiredhealthInsurerCodenull | stringrequiredrecipientstringrequiredaccountNumbernull | stringrequiredaccountMissingbooleanrequiredvariableSymbolnull | stringrequiredspecificSymbolstring | nullrequiredconstantSymbolnull | stringrequiredamountHalerintegerrequireddueDatestringrequireddatestatusstringrequiredpaidOnnull | stringrequireddatejournalEntryIdnull | stringrequiredcashEntryIdnull | stringrequiredtotalintegerhasMorebooleanrequiredMark a payroll payment as paid by hand. A transfer goes through a bank account, posts MD 331/336/342/379 / D 221xxx on its analytic, and a later statement line takes it over. Cash goes through a register with registerId
/v1/payroll/payments/{id}/paidMark a payroll payment as paid by hand. A transfer goes through a bank account, posts MD 331/336/342/379 / D 221xxx on its analytic, and a later statement line takes it over. Cash goes through a register with registerId
MCP tool: mark-payroll-payment-paid
Path parameters
idstringrequiredRequest body
paidOnstringrequiredYYYY-MM-DDregisterIdstringbankAccountIdstringResponse · 200
idstringrequiredrunIdstringrequiredkindstringrequiredemployeeIdnull | stringrequiredhealthInsurerCodenull | stringrequiredrecipientstringrequiredaccountNumbernull | stringrequiredaccountMissingbooleanrequiredvariableSymbolnull | stringrequiredspecificSymbolstring | nullrequiredconstantSymbolnull | stringrequiredamountHalerintegerrequireddueDatestringrequireddatestatusstringrequiredpaidOnnull | stringrequireddatejournalEntryIdnull | stringrequiredcashEntryIdnull | stringrequiredUndo a payment mark: reverses what it posted, and the hand-typed movement goes with it. A payment paired with a statement line is unpaired there
/v1/payroll/payments/{id}/unpaidUndo a payment mark: reverses what it posted, and the hand-typed movement goes with it. A payment paired with a statement line is unpaired there
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: mark-payroll-payment-unpaid
Path parameters
idstringrequiredResponse · 200
idstringrequiredrunIdstringrequiredkindstringrequiredemployeeIdnull | stringrequiredhealthInsurerCodenull | stringrequiredrecipientstringrequiredaccountNumbernull | stringrequiredaccountMissingbooleanrequiredvariableSymbolnull | stringrequiredspecificSymbolstring | nullrequiredconstantSymbolnull | stringrequiredamountHalerintegerrequireddueDatestringrequireddatestatusstringrequiredpaidOnnull | stringrequireddatejournalEntryIdnull | stringrequiredcashEntryIdnull | stringrequiredFree-form planning: net pay and employer cost for a gross monthly wage. Saves nothing
/v1/payroll/preview/gross-to-netFree-form planning: net pay and employer cost for a gross monthly wage. Saves nothing
MCP tool: preview-payroll-gross-to-net
Request body
yearintegerrequiredmin -9007199254740991max 9007199254740991type"hpp" | "dpc" | "dpp"personobjecthasDeclarationbooleanchildrenobject[]ztppbooleandisability"none" | "first_second" | "third"ztppbooleanpensionerDiscountbooleanhealthMinimumExemptbooleangrossHalerintegerrequiredmin 0max 9007199254740991Response · 200
grossHalerintegerrequirednetHalerintegerrequiredresultnull | objectrequiredyearintegerrequiredmonthinteger | nullrequiredcontractsobject[]requiredcontractIdnull | stringrequiredtypestringrequiredcenterOidanyrequiredactivityOidanyrequiredprojectOidanyrequiredallocationsobject[]requiredcenterOidanyrequiredactivityOidanyrequiredprojectOidanyrequiredshareBpintegerrequiredwageHalerintegerrequiredmealHalerintegerrequiredemployerHalerintegerrequiredbenefitsany[]requiredbenefitEmployerHalerintegerrequiredparticipatesbooleanrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredattendanceobjectrequiredfromstringrequireddatetostringrequireddateactivebooleanrequiredemployedDaysintegerrequiredcalendarDaysintegerrequiredfundFullMilliintegerrequiredfundEmployedMilliintegerrequiredworkedMilliintegerrequiredweekendWorkedMilliintegerrequiredholidayWorkedMilliintegerrequiredholidayMilliintegerrequiredvacationMilliintegerrequiredsickPaidMilliintegerrequiredsickUnpaidMilliintegerrequiredocrMilliintegerrequiredpaidLeaveMilliintegerrequiredunpaidLeaveMilliintegerrequiredabsentMilliintegerrequiredobstacleMilliintegerrequiredabsenceInFundMilliintegerrequiredsickDaysintegerrequiredocrDaysintegerrequiredhealthExcludedDaysintegerrequiredworkedDaysintegerrequiredshiftsintegerrequiredsickStreakAtEndintegerrequiredcomponentsarray | nullrequiredcodenull | stringrequiredamountHalerinteger | nullrequiredhoursMilliintegerrequiredtaxableHalerintegerrequiredgrossHalerintegerrequiredsickPayHalerintegerrequiredmealExemptHalerintegerrequiredvoucherEmployerHalerintegerrequiredsocialBaseHalerintegerrequiredhealthBaseHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredcostShareintegerrequiredinsurableHalerintegergrossHalerintegerrequiredtaxableHalerintegerrequiredsickPayHalerintegerrequiredotherExemptHalerintegerrequiredmealExemptHalerintegerrequiredvoucherEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredbenefitEmployerHalerintegerrequiredsettlementanyrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeBeforeDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdanyrequiredemployerDiscountReasonanyrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredminimumBaseHalerintegerrequiredshortfallHalerintegerrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredtaxobjectrequiredwithholdingBaseHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateBaseHalerintegerrequiredseparateAdvanceHalerintegerrequiredadvanceTaxableHalerintegerrequiredadvanceBaseHalerintegerrequiredadvanceHalerintegerrequiredpersonalCreditHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredchildCreditClaimHalerintegerrequiredchildCreditHalerintegerrequiredbonusHalerintegerrequiredadvanceAfterCreditsHalerintegerrequireddeductionsany[]requiredattachmentLimitsobjectrequiredprotectedHalerintegerrequiredthirdHalerintegerrequiredaboveHalerintegerrequiredpriorityPoolHalerintegerrequiredotherPoolHalerintegerrequireddeductionsHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredwarningsany[]requiredtipsHalerintegertipExemptHalerintegerFree-form planning: the smallest gross monthly wage that gives at least the wanted net pay. Saves nothing
/v1/payroll/preview/net-to-grossFree-form planning: the smallest gross monthly wage that gives at least the wanted net pay. Saves nothing
MCP tool: preview-payroll-net-to-gross
Request body
yearintegerrequiredmin -9007199254740991max 9007199254740991type"hpp" | "dpc" | "dpp"personobjecthasDeclarationbooleanchildrenobject[]ztppbooleandisability"none" | "first_second" | "third"ztppbooleanpensionerDiscountbooleanhealthMinimumExemptbooleannetHalerintegerrequiredmin 0max 9007199254740991Response · 200
grossHalerintegerrequirednetHalerintegerrequiredresultnull | objectrequiredyearintegerrequiredmonthinteger | nullrequiredcontractsobject[]requiredcontractIdnull | stringrequiredtypestringrequiredcenterOidanyrequiredactivityOidanyrequiredprojectOidanyrequiredallocationsobject[]requiredcenterOidanyrequiredactivityOidanyrequiredprojectOidanyrequiredshareBpintegerrequiredwageHalerintegerrequiredmealHalerintegerrequiredemployerHalerintegerrequiredbenefitsany[]requiredbenefitEmployerHalerintegerrequiredparticipatesbooleanrequiredsmallScopeboolean | nullrequiredaverageHourlyHalerinteger | nullrequiredattendanceobjectrequiredfromstringrequireddatetostringrequireddateactivebooleanrequiredemployedDaysintegerrequiredcalendarDaysintegerrequiredfundFullMilliintegerrequiredfundEmployedMilliintegerrequiredworkedMilliintegerrequiredweekendWorkedMilliintegerrequiredholidayWorkedMilliintegerrequiredholidayMilliintegerrequiredvacationMilliintegerrequiredsickPaidMilliintegerrequiredsickUnpaidMilliintegerrequiredocrMilliintegerrequiredpaidLeaveMilliintegerrequiredunpaidLeaveMilliintegerrequiredabsentMilliintegerrequiredobstacleMilliintegerrequiredabsenceInFundMilliintegerrequiredsickDaysintegerrequiredocrDaysintegerrequiredhealthExcludedDaysintegerrequiredworkedDaysintegerrequiredshiftsintegerrequiredsickStreakAtEndintegerrequiredcomponentsarray | nullrequiredcodenull | stringrequiredamountHalerinteger | nullrequiredhoursMilliintegerrequiredtaxableHalerintegerrequiredgrossHalerintegerrequiredsickPayHalerintegerrequiredmealExemptHalerintegerrequiredvoucherEmployerHalerintegerrequiredsocialBaseHalerintegerrequiredhealthBaseHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredcostShareintegerrequiredinsurableHalerintegergrossHalerintegerrequiredtaxableHalerintegerrequiredsickPayHalerintegerrequiredotherExemptHalerintegerrequiredmealExemptHalerintegerrequiredvoucherEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredbenefitEmployerHalerintegerrequiredsettlementanyrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeBeforeDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdanyrequiredemployerDiscountReasonanyrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredminimumBaseHalerintegerrequiredshortfallHalerintegerrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredtaxobjectrequiredwithholdingBaseHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateBaseHalerintegerrequiredseparateAdvanceHalerintegerrequiredadvanceTaxableHalerintegerrequiredadvanceBaseHalerintegerrequiredadvanceHalerintegerrequiredpersonalCreditHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredchildCreditClaimHalerintegerrequiredchildCreditHalerintegerrequiredbonusHalerintegerrequiredadvanceAfterCreditsHalerintegerrequireddeductionsany[]requiredattachmentLimitsobjectrequiredprotectedHalerintegerrequiredthirdHalerintegerrequiredaboveHalerintegerrequiredpriorityPoolHalerintegerrequiredotherPoolHalerintegerrequireddeductionsHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredwarningsany[]requiredtipsHalerintegertipExemptHalerintegerGet the legal payroll parameters of a year: average wage, minimum wage, rates, limits
/v1/payroll/ratesGet the legal payroll parameters of a year: average wage, minimum wage, rates, limits
MCP tool: get-payroll-rates
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
supportedYearsinteger[]requiredyearintegerrequiredaverageWageintegerrequiredminimumWageMonthlyintegerrequiredminimumWageHourlyHalerintegerrequiredsocialobjectrequiredemployerBpintegerrequiredemployeeBpintegerrequiredemployeeSicknessBpintegerrequiredemployeePensionBpintegerrequiredmaxAssessmentBaseintegerrequiredpensionerDiscountBpintegerrequiredemployerDiscountobjectrequiredbpintegerrequiredminWeeklyHoursintegerrequiredmaxWeeklyHoursintegerrequiredmaxMonthlyBaseintegerrequiredmaxHourlyBaseintegerrequiredmaxMonthlyHoursintegerrequiredparticipationobjectrequireddppThresholdintegerrequiredsmallScopeThresholdintegerrequiredhealthobjectrequiredtotalBpintegerrequiredminimumBaseintegerrequiredtaxobjectrequiredrateBpinteger | nullrequiredhigherRateBpintegerrequiredmonthlyThresholdintegerrequiredwithholdingRateBpintegerrequiredtaxpayerCreditintegerrequireddisabilityFirstSecondCreditintegerrequireddisabilityThirdCreditintegerrequiredztppCreditintegerrequiredchildCreditsinteger[]requiredminimumMonthlyBonusintegerrequiredbonusIncomeThresholdintegerrequiredseparateAdvancebooleanstudentCreditintegerstudentAgeLimitintegerdoctoralAgeLimitintegersickPayobjectrequiredthresholdsHalerinteger[]requiredweightsBpinteger[]requiredrateBpinteger | nullrequiredpaidCalendarDaysintegerrequiredpremiumsobjectrequiredovertimeBpintegerrequirednightBpintegerrequiredweekendBpintegerrequiredholidayBpintegerrequireddifficultBpOfMinimumWageintegerrequiredmealsobjectrequiredexemptPerShiftHalerinteger | nullrequiredminimumHoursPerShiftintegerrequiredattachmentsnull | objectrequiredbaseSumintegerrequireddebtorShareBpintegerrequireddependentDivisorintegerrequiredfullSeizureThresholdintegerrequiredinsolvencyMonthlyWithVatHalerintegerrequiredbenefitsobjectrequiredhealthLimitHalerintegerrequiredleisureLimitHalerinteger | nullrequiredretirementLimitHalerintegerrequiredrecreationLimitHalerintegerhealthCareOutsideIncomebooleanagreementsobjectrequireddppYearlyHoursintegerrequireddpcWeeklyHoursintegerrequiredpendingobjectmealsstringrequiredattachmentsstringrequiredtipsobjectexemptShareBpintegerrequiredAnnual totals per employee from locked runs
/v1/payroll/reports/annualAnnual totals per employee from locked runs
MCP tool: get-payroll-annual-totals
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
dataobject[]requiredemployeeIdnull | stringrequiredemployeeNamestringrequiredmonthsintegerrequiredgrossHalerintegerrequiredsocialEmployeeHalerintegerrequiredhealthEmployeeHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequirednetHalerintegerrequiredemployerCostHalerintegerrequiredtotalintegerrequiredhasMorebooleanrequiredLabour cost by month and by cost center, from locked runs
/v1/payroll/reports/costsLabour cost by month and by cost center, from locked runs
MCP tool: get-payroll-cost-overview
Query parameters
yearintegerrequiredmin 2000max 2100Response · 200
yearintegerrequiredmonthsobject[]requiredmonthinteger | nullrequiredgrossHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployerHalerintegerrequiredtotalHalerinteger | nullrequiredcentersobject[]requiredcenterIdnull | stringrequiredtotalHalerinteger | nullrequiredMzdový list: one employee, month by month, from locked runs
/v1/payroll/reports/wage-sheetMzdový list: one employee, month by month, from locked runs
MCP tool: get-payroll-wage-sheet
Query parameters
yearintegerrequiredmin 2000max 2100employeeIdstringrequiredResponse · 200
yearintegerrequiredemployeeIdnull | stringrequiredmonthsobject[]requiredmonthinteger | nullrequiredgrossHalerintegerrequiredsocialEmployeeHalerintegerrequiredhealthEmployeeHalerintegerrequiredtaxHalerintegerrequiredwithholdingHalerintegerrequiredbonusHalerintegerrequireddeductionsHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredMzdový list as PDF
/v1/payroll/reports/wage-sheet.pdfMzdový list as PDF
MCP tool: get-payroll-wage-sheet-pdf
Query parameters
yearintegerrequiredmin 2000max 2100employeeIdstringrequiredResponse · 200
Returns a application/pdf file.
List monthly payroll runs
/v1/payroll/runsList monthly payroll runs
MCP tool: list-payroll-runs
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDyearintegermin 2000max 2100Response · 200
dataobject[]requiredobject"payroll_run"requiredidstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredsocialobjectrequirednetHalerintegerrequiredwarningsobject[]requiredcontractsobject[]requireddeductionsobject[]requiredgrossHalerintegerrequiredsettlementnull | objectrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]reimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegertotalintegerhasMorebooleanrequiredStart the payroll of a month as a draft and calculate every employee with a contract in that month
/v1/payroll/runsStart the payroll of a month as a draft and calculate every employee with a contract in that month
MCP tool: create-payroll-run
Request body
yearintegerrequiredmin -9007199254740991max 9007199254740991monthintegerrequiredmin 1max 12paymentDatestringYYYY-MM-DDtipFoodIncomeHalerinteger | nullResponse · 201
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerGet a payroll run with the calculation of every employee
/v1/payroll/runs/{id}Get a payroll run with the calculation of every employee
MCP tool: get-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerChange the payment date, the note, or the month's food service income behind the exempt tips (§ 6 odst. 9 písm. g) ZDP from 2027) of a payroll run that is not locked. A new income recalculates the run
/v1/payroll/runs/{id}Change the payment date, the note, or the month's food service income behind the exempt tips (§ 6 odst. 9 písm. g) ZDP from 2027) of a payroll run that is not locked. A new income recalculates the run
MCP tool: update-payroll-run
Path parameters
idstringrequiredRequest body
paymentDatestring | nullnotestring | nulltipFoodIncomeHalerinteger | nullResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerDelete a payroll run that is not locked
/v1/payroll/runs/{id}Delete a payroll run that is not locked
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredOverview of what a month must report: social insurance, each health insurer, tax, and whether the JMHZ XML is ready
/v1/payroll/runs/{id}/filingsOverview of what a month must report: social insurance, each health insurer, tax, and whether the JMHZ XML is ready
MCP tool: get-payroll-filings
Path parameters
idstringrequiredResponse · 200
runIdnull | stringrequiredstatusstringrequiredtotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredinsurersobject[]requiredcodenull | stringrequirednamenull | stringrequiredxmlFilebooleanrequiredemployeeCountintegerrequiredbaseHalerinteger | nullrequiredpremiumHalerintegerrequiredjmhzProblemsstring[]requiredfilingsobject[]requiredkindstringrequiredtypestringrequiredguidnull | stringrequiredgeneratedAtstringrequireddate-timesubmittedAtnull | stringrequireddate-timeRecord that a filing was submitted to the authority. DameDoklad does not submit it for you
/v1/payroll/runs/{id}/filings/{kind}/submittedRecord that a filing was submitted to the authority. DameDoklad does not submit it for you
MCP tool: mark-payroll-filing-submitted
Path parameters
idstringrequiredkindstringrequiredRequest body
notestring | nullResponse · 200
runIdnull | stringrequiredkindstringrequiredsubmittedAtnull | stringrequireddate-timePřehled o platbě pojistného as the fixed-length file VZP publishes (methodology 3.8.1.2), for VZP only. Other insurers have `health.xml`
/v1/payroll/runs/{id}/filings/health.aapPřehled o platbě pojistného as the fixed-length file VZP publishes (methodology 3.8.1.2), for VZP only. Other insurers have `health.xml`
MCP tool: get-payroll-health-overview-file
Path parameters
idstringrequiredResponse · 200
Returns a text/plain file.
Přehled o platbě pojistného for one health insurer as a working paper in PDF. It is not the insurer's own form; VZP also has the file `health.aap`
/v1/payroll/runs/{id}/filings/health.pdfPřehled o platbě pojistného for one health insurer as a working paper in PDF. It is not the insurer's own form; VZP also has the file `health.aap`
MCP tool: get-payroll-health-overview-pdf
Path parameters
idstringrequiredQuery parameters
insurer"111" | "201" | "205" | "207" | "209" | "211" | "213"requiredResponse · 200
Returns a application/pdf file.
Přehled o platbě pojistného as the shared XML of the insurers (prehledPlatbyZamestnavatele v8), for ČPZP, OZP and ZP MV ČR, which publish it. Valid against the XSD. Refused for an insurer whose own publication of the format was not found
/v1/payroll/runs/{id}/filings/health.xmlPřehled o platbě pojistného as the shared XML of the insurers (prehledPlatbyZamestnavatele v8), for ČPZP, OZP and ZP MV ČR, which publish it. Valid against the XSD. Refused for an insurer whose own publication of the format was not found
MCP tool: get-payroll-health-overview-xml
Path parameters
idstringrequiredQuery parameters
insurer"111" | "201" | "205" | "207" | "209" | "211" | "213"requiredtype"radny" | "opravny"Response · 200
Returns a application/xml file.
Export the jednotné měsíční hlášení zaměstnavatele as XML: schema MH 1.4.3.6, or MH 1.5.0.3 for months from January 2027. ČSSZ still calls 1.5 a final draft. Requires a locked run, the ČSSZ variable symbol, IK MPSV, and idPpv
/v1/payroll/runs/{id}/filings/jmhz.xmlExport the jednotné měsíční hlášení zaměstnavatele as XML: schema MH 1.4.3.6, or MH 1.5.0.3 for months from January 2027. ČSSZ still calls 1.5 a final draft. Requires a locked run, the ČSSZ variable symbol, IK MPSV, and idPpv
MCP tool: get-payroll-jmhz-xml
Path parameters
idstringrequiredQuery parameters
type"R" | "O" | "S"Response · 200
Returns a application/xml file.
Přehled o výši pojistného as PDF. From 2026 this is a working paper, the figures are filed in the JMHZ
/v1/payroll/runs/{id}/filings/social.pdfPřehled o výši pojistného as PDF. From 2026 this is a working paper, the figures are filed in the JMHZ
MCP tool: get-payroll-social-overview-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
Monthly tax overview as PDF: advances, bonuses, and withholding tax per employee
/v1/payroll/runs/{id}/filings/tax.pdfMonthly tax overview as PDF: advances, bonuses, and withholding tax per employee
MCP tool: get-payroll-tax-overview-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
Lock a reviewed run: posts to the books in double entry and creates the payments that fall due
/v1/payroll/runs/{id}/lockLock a reviewed run: posts to the books in double entry and creates the payments that fall due
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: lock-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerPut everything a locked run still owes on payment orders: net pay per employee, deductions, ČSSZ, each insurer, tax. One order per day and bank account, with the published accounts and variable symbols unless settings say otherwise. Payments pair when the statement arrives. A wage to a protected account leaves from the account its confirmation names. What has no account comes back in `skipped`
/v1/payroll/runs/{id}/payment-ordersPut everything a locked run still owes on payment orders: net pay per employee, deductions, ČSSZ, each insurer, tax. One order per day and bank account, with the published accounts and variable symbols unless settings say otherwise. Payments pair when the statement arrives. A wage to a protected account leaves from the account its confirmation names. What has no account comes back in `skipped`
MCP tool: create-payroll-run-payment-orders
Path parameters
idstringrequiredRequest body
bankAccountIdstringResponse · 201
runIdnull | stringrequiredordersobject[]requiredidstringrequirednumberinteger | nullrequiredexecutionDatestringrequireddatetotalHalerinteger | nullrequireditemCountintegerrequiredskippedobject[]requiredpaymentIdnull | stringrequiredkindstringrequiredrecipientstringrequiredreasonnull | stringrequiredDownload the payslip of one employee as PDF
/v1/payroll/runs/{id}/payslips/{itemId}/pdfDownload the payslip of one employee as PDF
MCP tool: get-payroll-payslip-pdf
Path parameters
idstringrequireditemIdstringrequiredResponse · 200
Returns a application/pdf file.
E-mail the payslip PDF to one employee. Only a locked run can be sent
/v1/payroll/runs/{id}/payslips/{itemId}/sendE-mail the payslip PDF to one employee. Only a locked run can be sent
MCP tool: send-payroll-payslip
Path parameters
idstringrequireditemIdstringrequiredResponse · 200
itemIdnull | stringrequiredstatusstringrequirederrorCodenull | stringrequiredE-mail payslips to everyone in a locked run who has an address on file
/v1/payroll/runs/{id}/payslips/sendE-mail payslips to everyone in a locked run who has an address on file
MCP tool: send-payroll-payslips
Path parameters
idstringrequiredResponse · 200
resultsobject[]requireditemIdnull | stringrequiredstatusstringrequirederrorCodestring | nullrequiredRecalculate a draft run from the current contracts, attendance, and deductions
/v1/payroll/runs/{id}/recalculateRecalculate a draft run from the current contracts, attendance, and deductions
MCP tool: recalculate-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerSend a run in review back to draft
/v1/payroll/runs/{id}/reopenSend a run in review back to draft
MCP tool: reopen-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerRecalculate a draft one last time and move it to review
/v1/payroll/runs/{id}/reviewRecalculate a draft one last time and move it to review
MCP tool: review-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerUnlock a run back to review: reverses its journal entry and removes its payments. Refused once a payment is paid
/v1/payroll/runs/{id}/unlockUnlock a run back to review: reverses its journal entry and removes its payments. Refused once a payment is paid
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: unlock-payroll-run
Path parameters
idstringrequiredResponse · 200
idstringrequiredyearintegerrequiredmonthintegerrequiredperiodstringrequiredstatusstringrequiredpaymentDatenull | stringrequireddatetotalsobjectrequirednetHalerintegerrequiredbonusHalerintegerrequiredgrossHalerintegerrequiredpayoutHalerintegerrequiredadvanceHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredemployeeCountintegerrequireddeductionsHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredemployerCostHalerintegerrequiredhealthPayableHalerintegerrequiredsocialPayableHalerintegerrequiredadvanceCarryInHalerintegerrequiredadvancePayableHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredwithholdingTaxHalerintegerrequiredadvanceCarryOutHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredemployerDiscountHalerintegerrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredsettlementBonusTopupHalerintegerrequiredsettlementOverpaymentHalerintegerrequiredsocialEmployeeBeforeDiscountHalerintegerrequiredjournalEntryIdnull | stringrequiredreviewedAtnull | stringrequireddate-timelockedAtnull | stringrequireddate-timenotenull | stringrequiredtipFoodIncomeHalerinteger | nullitemsobject[]object"payroll_run_item"requiredidstringrequiredrunIdstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredhealthInsurerCodenull | stringrequiredgrossHalerintegerrequiredtaxableHalerintegerrequirednetHalerintegerrequiredpayoutHalerintegerrequiredemployerCostHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredtaxHalerintegerrequiredbonusHalerintegerrequiredwithholdingHalerintegerrequireddeductionsHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringresultobjectrequiredtaxobjectrequiredbonusHalerintegerrequiredadvanceHalerintegerrequiredadvanceBaseHalerintegerrequiredchildCreditHalerintegerrequiredseparateBaseHalerintegerrequiredadvanceTaxableHalerintegerrequiredpersonalCreditHalerintegerrequiredwithholdingTaxHalerintegerrequiredseparateAdvanceHalerintegerrequiredwithholdingBaseHalerintegerrequiredchildCreditClaimHalerintegerrequiredadvanceAfterCreditsHalerintegerrequiredpersonalCreditClaimHalerintegerrequiredseparateDppbooleanseparateOtherbooleanmultiMonthobjectyearintegerrequiredmonthinteger | nullrequiredhealthobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredshortfallHalerintegerrequiredminimumBaseHalerintegerrequiredsocialobjectrequiredbaseHalerinteger | nullrequiredemployeeHalerintegerrequiredemployerHalerintegerrequiredemployerDiscountReasonanyrequiredpensionerDiscountHalerintegerrequiredemployerDiscountBaseHalerintegerrequiredemployerDiscountContractIdnull | stringrequiredemployeeBeforeDiscountHalerintegerrequirednetHalerintegerrequiredwarningsobject[]requiredcodenull | stringrequiredamountHalerinteger | nulldeductionIdnull | stringcontractsobject[]requiredtypestringrequiredbenefitsobject[]requiredcenterOidnull | stringrequiredcostShareintegerrequiredattendanceobjectrequiredcomponentsarray | nullrequiredcontractIdnull | stringrequiredgrossHalerintegerrequiredprojectOidanyrequiredsmallScopeboolean | nullrequiredactivityOidanyrequiredallocationsobject[]requiredparticipatesbooleanrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequiredhealthBaseHalerintegerrequiredmealExemptHalerintegerrequiredsocialBaseHalerintegerrequiredaverageHourlyHalerinteger | nullrequiredhealthEmployeeHalerintegerrequiredhealthEmployerHalerintegerrequiredsocialEmployeeHalerintegerrequiredsocialEmployerHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployerHalerintegerrequiredinsurableHalerintegerdeductionsobject[]requiredidnull | stringrequiredkindstringrequiredamountHalerinteger | nullrequiredrequestedHalerintegerrequirednamenull | stringaccountNumbernull | stringremainingHalerinteger | nullspecificSymbolstring | nullvariableSymbolnull | stringgrossHalerintegerrequiredsettlementnull | objectrequiredidstringrequiredyearintegerrequiredtotalHalerinteger | nullrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredpayoutHalerintegerrequiredsickPayHalerintegerrequiredtaxableHalerintegerrequireddeductionsHalerintegerrequiredmealExemptHalerintegerrequiredattachmentLimitsobjectrequiredaboveHalerintegerrequiredthirdHalerintegerrequiredotherPoolHalerintegerrequiredprotectedHalerintegerrequiredpriorityPoolHalerintegerrequiredotherExemptHalerintegerrequiredemployerCostHalerintegerrequiredbenefitEmployerHalerintegerrequiredvoucherEmployeeHalerintegerrequiredvoucherEmployerHalerintegerrequiredreimbursementsobject[]idstringrequiredamountHalerinteger | nullrequireddescriptionnull | stringrequiredtravelOrderIdstringrequiredreimbursementHalerintegerreimbursementVatHalerintegertipsHalerintegertipExemptHalerintegerRevoke a link at once. Whoever holds it can no longer use it
/v1/payroll/self-service-links/{id}/revokeRevoke a link at once. Whoever holds it can no longer use it
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: revoke-payroll-self-service-link
Path parameters
idstringrequiredResponse · 200
idstringrequiredemployeeIdstringrequiredscopesstring[]requiredexpiresAtstringrequireddate-timerevokedAtnull | stringrequireddate-timelastUsedAtnull | stringrequireddate-timecreatedAtstringrequireddate-timeactivebooleanrequiredurlstringsentbooleaneventsobject[]actionstringrequiredsubjectIdnull | stringrequiredatstringrequireddate-timeGet payroll settings: ČSSZ variable symbol, okresní správa, pay day, and accounts for contributions
/v1/payroll/settingsGet payroll settings: ČSSZ variable symbol, okresní správa, pay day, and accounts for contributions
MCP tool: get-payroll-settings
Response · 200
idnull | stringrequiredcsszVariableSymbolnull | stringrequiredcsszDistrictCodenull | stringrequiredtaxOfficeCodenull | stringrequiredtaxOfficenull | stringrequiredaccidentInsurernull | stringrequiredaccidentOkecnull | stringrequiredaccidentRatePermillenull | numberrequiredpayDayintegerrequiredsocialAccountnull | stringrequiredtaxAccountstring | nullrequiredtaxVariableSymbolstring | nullrequiredwithholdingAccountstring | nullrequiredwithholdingVariableSymbolstring | nullrequiredhealthAccountsobjectrequirednotificationEmailstring | nullrequiredtaxWorkplaceCodenull | stringrequiredtaxSubjectTypestringrequiredtaxSubjectFirstNamestring | nullrequiredtaxSubjectLastNamestring | nullrequiredcontactNamenull | stringrequiredcontactPhonenull | stringrequiredcontactEmailnull | stringrequiredvzpBranchstringrequiredownershipFormnull | stringrequiredcollectiveAgreementsstring[]requireddisabledQuotanull | objectrequireddisabledFteintegerrequiredemployeesFtenumberrequiredsharePercentnumberrequiredSave payroll settings. An account entered here wins over the one the office publishes. An insurer and a rate here drive the statutory liability insurance
/v1/payroll/settingsSave payroll settings. An account entered here wins over the one the office publishes. An insurer and a rate here drive the statutory liability insurance
MCP tool: update-payroll-settings
Request body
csszVariableSymbolstring | nullcsszDistrictCodestring | nulltaxOfficeCodestring | nullaccidentInsurer"kooperativa" | "generali" | nullaccidentOkecstring | nullaccidentRatePermillenumber | nulltaxOffice"praha" | "stredocesky" | "jihocesky" | "plzensky" | "karlovarsky" | "ustecky" | "liberecky" | "kralovehradecky" | "pardubicky" | "vysocina" | "jihomoravsky" | "olomoucky" | "moravskoslezsky" | "zlinsky" | "specializovany" | nullpayDayintegermin 1max 28socialAccountstring | nulltaxAccountstring | nulltaxVariableSymbolstring | nullwithholdingAccountstring | nullwithholdingVariableSymbolstring | nullhealthAccountsobjectnotificationEmailstring | nulltaxWorkplaceCodestring | nulltaxSubjectType"P" | "F"taxSubjectFirstNamestring | nulltaxSubjectLastNamestring | nullcontactNamestring | nullcontactPhonestring | nullcontactEmailstring | nullvzpBranchstringownershipForm"1" | "2" | "3" | "4" | nullcollectiveAgreements"1" | "2" | "3" | "4" | "5"[]disabledQuotaobject | nullemployeesFtenumberrequiredmin 0disabledFtenumberrequiredmin 0sharePercentnumberrequiredmin 0max 100Response · 200
idnull | stringrequiredcsszVariableSymbolnull | stringrequiredcsszDistrictCodenull | stringrequiredtaxOfficeCodenull | stringrequiredtaxOfficenull | stringrequiredaccidentInsurernull | stringrequiredaccidentOkecnull | stringrequiredaccidentRatePermillenull | numberrequiredpayDayintegerrequiredsocialAccountnull | stringrequiredtaxAccountstring | nullrequiredtaxVariableSymbolstring | nullrequiredwithholdingAccountstring | nullrequiredwithholdingVariableSymbolstring | nullrequiredhealthAccountsobjectrequirednotificationEmailstring | nullrequiredtaxWorkplaceCodenull | stringrequiredtaxSubjectTypestringrequiredtaxSubjectFirstNamestring | nullrequiredtaxSubjectLastNamestring | nullrequiredcontactNamenull | stringrequiredcontactPhonenull | stringrequiredcontactEmailnull | stringrequiredvzpBranchstringrequiredownershipFormnull | stringrequiredcollectiveAgreementsstring[]requireddisabledQuotanull | objectrequireddisabledFteintegerrequiredemployeesFtenumberrequiredsharePercentnumberrequiredList annual tax settlements (roční zúčtování) by tax year and status
/v1/payroll/settlementsList annual tax settlements (roční zúčtování) by tax year and status
MCP tool: list-payroll-tax-settlements
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsfromstringYYYY-MM-DDtostringYYYY-MM-DDyearintegermin 2000max 2100status"requested" | "calculated" | "approved" | "paid" | "closed"Response · 200
dataany[]requiredtotalintegerhasMorebooleanrequiredRecord an employee's request for an annual tax settlement, with deductions, credits, and documents from previous payers
/v1/payroll/settlementsRecord an employee's request for an annual tax settlement, with deductions, credits, and documents from previous payers
MCP tool: create-payroll-tax-settlement
Request body
employeeIdstringrequiredtaxYearintegerrequiredmin -9007199254740991max 9007199254740991requestedOnstringYYYY-MM-DDinputsobjectpreviousPayersobject[]namestringrequiredmax 200 charsincomeHalerintegerrequiredmin 0max 9007199254740991advancesHalerintegerrequiredmin 0max 9007199254740991bonusesHalerintegermin 0max 9007199254740991documentReceivedOnstringrequiredYYYY-MM-DDfilesReturnbooleanotherConcurrentPayerbooleandeductionsobjectdonationsHalerintegermin 0max 9007199254740991interestHalerintegermin 0max 9007199254740991interestMonthsintegermin 0max 12pensionSupplementHalerintegermin 0max 9007199254740991supplementaryPensionHalerintegermin 0max 9007199254740991pensionInstitutionHalerintegermin 0max 9007199254740991lifeInsuranceHalerintegermin 0max 9007199254740991longTermInvestmentHalerintegermin 0max 9007199254740991longTermCareHalerintegermin 0max 9007199254740991creditsobjectstoppedExecutionHalerintegermin 0max 9007199254740991spouseMonthsintegermin 0max 12spouseZtppMonthsintegermin 0max 12disabilityFirstSecondMonthsintegermin 0max 12disabilityThirdMonthsintegermin 0max 12ztppMonthsintegermin 0max 12studentMonthsintegermin 0max 12childPlacementobject[]childNamestringmax 200 charsspentHalerintegerrequiredmin 0max 9007199254740991householdsintegermin 1max 10agreedCapHalerinteger | nullspouseobject | nullfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullztppbooleanchildrenobject[] | nullmonthsintegerrequiredmin 0max 12ztppMonthsintegermin 0max 12Response · 201
idstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredtaxYearintegerrequiredstatusstringrequiredrequestedOnstringrequireddatesourcestringrequireddeadlinesobjectrequiredrequestBystringrequireddatecalculateBystringrequireddatepayWithWageOfobjectrequiredyearintegerrequiredmonthinteger | nullrequiredinputsobjectrequireddeductionsobjectinterestHalerintegerrequiredlifeInsuranceHalerintegerpreviousPayersobject[]namenull | stringrequiredincomeHalerintegerrequiredadvancesHalerintegerrequireddocumentReceivedOnstringrequireddatespousenull | objectrequiredlastNamenull | stringrequiredfirstNamenull | stringrequiredbirthNumberMaskednull | stringrequiredcreditsobjectspouseMonthsintegerrequiredchildrenobject[]monthsintegerrequiredresultnull | objectrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredr23integerr24integerr25integerr26integerr27integerr28integerr29integerr30integerr31integerr32aintegerr32bintegeryearintegerrequiredmonthsintegerrequiredcreditsobjectrequiredztppMonthsintegerrequireddisabilityThirdMonthsintegerrequireddisabilityFirstSecondMonthsintegerrequiredstudentMonthsintegerspouseMonthsintegerchildrenobject[]requiredmonthsintegerrequiredztppMonthsintegerproblemsobject[]requiredcodenull | stringrequiredtextstringrequiredpayoutHalerintegerrequiredbalanceHalerintegerrequiredshortfallHalerintegerrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredbelowPayoutMinimumbooleanrequiredformPendingbooleanoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredcalculatedAtnull | stringrequireddate-timeapprovedAtnull | stringrequireddate-timepayoutRunIdnull | stringrequiredpaidAtnull | stringrequireddate-timeGet one annual tax settlement with its calculation by the rows of tiskopis 25 5460/1
/v1/payroll/settlements/{id}Get one annual tax settlement with its calculation by the rows of tiskopis 25 5460/1
MCP tool: get-payroll-tax-settlement
Path parameters
idstringrequiredResponse · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredtaxYearintegerrequiredstatusstringrequiredrequestedOnstringrequireddatesourcestringrequireddeadlinesobjectrequiredrequestBystringrequireddatecalculateBystringrequireddatepayWithWageOfobjectrequiredyearintegerrequiredmonthinteger | nullrequiredinputsobjectrequireddeductionsobjectinterestHalerintegerrequiredlifeInsuranceHalerintegerpreviousPayersobject[]namenull | stringrequiredincomeHalerintegerrequiredadvancesHalerintegerrequireddocumentReceivedOnstringrequireddatespousenull | objectrequiredlastNamenull | stringrequiredfirstNamenull | stringrequiredbirthNumberMaskednull | stringrequiredcreditsobjectspouseMonthsintegerrequiredchildrenobject[]monthsintegerrequiredresultnull | objectrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredr23integerr24integerr25integerr26integerr27integerr28integerr29integerr30integerr31integerr32aintegerr32bintegeryearintegerrequiredmonthsintegerrequiredcreditsobjectrequiredztppMonthsintegerrequireddisabilityThirdMonthsintegerrequireddisabilityFirstSecondMonthsintegerrequiredstudentMonthsintegerspouseMonthsintegerchildrenobject[]requiredmonthsintegerrequiredztppMonthsintegerproblemsobject[]requiredcodenull | stringrequiredtextstringrequiredpayoutHalerintegerrequiredbalanceHalerintegerrequiredshortfallHalerintegerrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredbelowPayoutMinimumbooleanrequiredformPendingbooleanoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredcalculatedAtnull | stringrequireddate-timeapprovedAtnull | stringrequireddate-timepayoutRunIdnull | stringrequiredpaidAtnull | stringrequireddate-timeChange the request date or the inputs of a settlement that is not approved. Any calculation must be run again
/v1/payroll/settlements/{id}Change the request date or the inputs of a settlement that is not approved. Any calculation must be run again
MCP tool: update-payroll-tax-settlement
Path parameters
idstringrequiredRequest body
requestedOnstringYYYY-MM-DDinputsobjectpreviousPayersobject[]namestringrequiredmax 200 charsincomeHalerintegerrequiredmin 0max 9007199254740991advancesHalerintegerrequiredmin 0max 9007199254740991bonusesHalerintegermin 0max 9007199254740991documentReceivedOnstringrequiredYYYY-MM-DDfilesReturnbooleanotherConcurrentPayerbooleandeductionsobjectdonationsHalerintegermin 0max 9007199254740991interestHalerintegermin 0max 9007199254740991interestMonthsintegermin 0max 12pensionSupplementHalerintegermin 0max 9007199254740991supplementaryPensionHalerintegermin 0max 9007199254740991pensionInstitutionHalerintegermin 0max 9007199254740991lifeInsuranceHalerintegermin 0max 9007199254740991longTermInvestmentHalerintegermin 0max 9007199254740991longTermCareHalerintegermin 0max 9007199254740991creditsobjectstoppedExecutionHalerintegermin 0max 9007199254740991spouseMonthsintegermin 0max 12spouseZtppMonthsintegermin 0max 12disabilityFirstSecondMonthsintegermin 0max 12disabilityThirdMonthsintegermin 0max 12ztppMonthsintegermin 0max 12studentMonthsintegermin 0max 12childPlacementobject[]childNamestringmax 200 charsspentHalerintegerrequiredmin 0max 9007199254740991householdsintegermin 1max 10agreedCapHalerinteger | nullspouseobject | nullfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullztppbooleanchildrenobject[] | nullmonthsintegerrequiredmin 0max 12ztppMonthsintegermin 0max 12Response · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredtaxYearintegerrequiredstatusstringrequiredrequestedOnstringrequireddatesourcestringrequireddeadlinesobjectrequiredrequestBystringrequireddatecalculateBystringrequireddatepayWithWageOfobjectrequiredyearintegerrequiredmonthinteger | nullrequiredinputsobjectrequireddeductionsobjectinterestHalerintegerrequiredlifeInsuranceHalerintegerpreviousPayersobject[]namenull | stringrequiredincomeHalerintegerrequiredadvancesHalerintegerrequireddocumentReceivedOnstringrequireddatespousenull | objectrequiredlastNamenull | stringrequiredfirstNamenull | stringrequiredbirthNumberMaskednull | stringrequiredcreditsobjectspouseMonthsintegerrequiredchildrenobject[]monthsintegerrequiredresultnull | objectrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredr23integerr24integerr25integerr26integerr27integerr28integerr29integerr30integerr31integerr32aintegerr32bintegeryearintegerrequiredmonthsintegerrequiredcreditsobjectrequiredztppMonthsintegerrequireddisabilityThirdMonthsintegerrequireddisabilityFirstSecondMonthsintegerrequiredstudentMonthsintegerspouseMonthsintegerchildrenobject[]requiredmonthsintegerrequiredztppMonthsintegerproblemsobject[]requiredcodenull | stringrequiredtextstringrequiredpayoutHalerintegerrequiredbalanceHalerintegerrequiredshortfallHalerintegerrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredbelowPayoutMinimumbooleanrequiredformPendingbooleanoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredcalculatedAtnull | stringrequireddate-timeapprovedAtnull | stringrequireddate-timepayoutRunIdnull | stringrequiredpaidAtnull | stringrequireddate-timeDelete a settlement that has not been approved
/v1/payroll/settlements/{id}Delete a settlement that has not been approved
IrreversibleThis operation cannot be undone. MCP clients ask for confirmation first.
MCP tool: delete-payroll-tax-settlement
Path parameters
idstringrequiredResponse · 200
idstringrequireddeletedbooleanrequiredApprove a calculated settlement. A refund is then paid by the next payroll run that locks; with nothing to pay the settlement closes
/v1/payroll/settlements/{id}/approveApprove a calculated settlement. A refund is then paid by the next payroll run that locks; with nothing to pay the settlement closes
MCP tool: approve-payroll-tax-settlement
Path parameters
idstringrequiredResponse · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredtaxYearintegerrequiredstatusstringrequiredrequestedOnstringrequireddatesourcestringrequireddeadlinesobjectrequiredrequestBystringrequireddatecalculateBystringrequireddatepayWithWageOfobjectrequiredyearintegerrequiredmonthinteger | nullrequiredinputsobjectrequireddeductionsobjectinterestHalerintegerrequiredlifeInsuranceHalerintegerpreviousPayersobject[]namenull | stringrequiredincomeHalerintegerrequiredadvancesHalerintegerrequireddocumentReceivedOnstringrequireddatespousenull | objectrequiredlastNamenull | stringrequiredfirstNamenull | stringrequiredbirthNumberMaskednull | stringrequiredcreditsobjectspouseMonthsintegerrequiredchildrenobject[]monthsintegerrequiredresultnull | objectrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredr23integerr24integerr25integerr26integerr27integerr28integerr29integerr30integerr31integerr32aintegerr32bintegeryearintegerrequiredmonthsintegerrequiredcreditsobjectrequiredztppMonthsintegerrequireddisabilityThirdMonthsintegerrequireddisabilityFirstSecondMonthsintegerrequiredstudentMonthsintegerspouseMonthsintegerchildrenobject[]requiredmonthsintegerrequiredztppMonthsintegerproblemsobject[]requiredcodenull | stringrequiredtextstringrequiredpayoutHalerintegerrequiredbalanceHalerintegerrequiredshortfallHalerintegerrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredbelowPayoutMinimumbooleanrequiredformPendingbooleanoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredcalculatedAtnull | stringrequireddate-timeapprovedAtnull | stringrequireddate-timepayoutRunIdnull | stringrequiredpaidAtnull | stringrequireddate-timeCalculate the settlement from the locked months of the tax year and the entered inputs. Returns whatever bars it in `problems`
/v1/payroll/settlements/{id}/calculateCalculate the settlement from the locked months of the tax year and the entered inputs. Returns whatever bars it in `problems`
MCP tool: calculate-payroll-tax-settlement
Path parameters
idstringrequiredResponse · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredtaxYearintegerrequiredstatusstringrequiredrequestedOnstringrequireddatesourcestringrequireddeadlinesobjectrequiredrequestBystringrequireddatecalculateBystringrequireddatepayWithWageOfobjectrequiredyearintegerrequiredmonthinteger | nullrequiredinputsobjectrequireddeductionsobjectinterestHalerintegerrequiredlifeInsuranceHalerintegerpreviousPayersobject[]namenull | stringrequiredincomeHalerintegerrequiredadvancesHalerintegerrequireddocumentReceivedOnstringrequireddatespousenull | objectrequiredlastNamenull | stringrequiredfirstNamenull | stringrequiredbirthNumberMaskednull | stringrequiredcreditsobjectspouseMonthsintegerrequiredchildrenobject[]monthsintegerrequiredresultnull | objectrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredr23integerr24integerr25integerr26integerr27integerr28integerr29integerr30integerr31integerr32aintegerr32bintegeryearintegerrequiredmonthsintegerrequiredcreditsobjectrequiredztppMonthsintegerrequireddisabilityThirdMonthsintegerrequireddisabilityFirstSecondMonthsintegerrequiredstudentMonthsintegerspouseMonthsintegerchildrenobject[]requiredmonthsintegerrequiredztppMonthsintegerproblemsobject[]requiredcodenull | stringrequiredtextstringrequiredpayoutHalerintegerrequiredbalanceHalerintegerrequiredshortfallHalerintegerrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredbelowPayoutMinimumbooleanrequiredformPendingbooleanoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredcalculatedAtnull | stringrequireddate-timeapprovedAtnull | stringrequireddate-timepayoutRunIdnull | stringrequiredpaidAtnull | stringrequireddate-timeVýpočet daně a daňového zvýhodnění of a settlement as PDF, by the rows of tiskopis 25 5460/1 vzor 29. The rows match, the page is not the printed form
/v1/payroll/settlements/{id}/calculation.pdfVýpočet daně a daňového zvýhodnění of a settlement as PDF, by the rows of tiskopis 25 5460/1 vzor 29. The rows match, the page is not the printed form
MCP tool: get-payroll-tax-settlement-pdf
Path parameters
idstringrequiredResponse · 200
Returns a application/pdf file.
Return an approved settlement to calculated. Refused once a locked run has paid it: unlock that run first
/v1/payroll/settlements/{id}/reopenReturn an approved settlement to calculated. Refused once a locked run has paid it: unlock that run first
MCP tool: reopen-payroll-tax-settlement
Path parameters
idstringrequiredResponse · 200
idstringrequiredemployeeIdstringrequiredemployeeNamestringrequiredtaxYearintegerrequiredstatusstringrequiredrequestedOnstringrequireddatesourcestringrequireddeadlinesobjectrequiredrequestBystringrequireddatecalculateBystringrequireddatepayWithWageOfobjectrequiredyearintegerrequiredmonthinteger | nullrequiredinputsobjectrequireddeductionsobjectinterestHalerintegerrequiredlifeInsuranceHalerintegerpreviousPayersobject[]namenull | stringrequiredincomeHalerintegerrequiredadvancesHalerintegerrequireddocumentReceivedOnstringrequireddatespousenull | objectrequiredlastNamenull | stringrequiredfirstNamenull | stringrequiredbirthNumberMaskednull | stringrequiredcreditsobjectspouseMonthsintegerrequiredchildrenobject[]monthsintegerrequiredresultnull | objectrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredr23integerr24integerr25integerr26integerr27integerr28integerr29integerr30integerr31integerr32aintegerr32bintegeryearintegerrequiredmonthsintegerrequiredcreditsobjectrequiredztppMonthsintegerrequireddisabilityThirdMonthsintegerrequireddisabilityFirstSecondMonthsintegerrequiredstudentMonthsintegerspouseMonthsintegerchildrenobject[]requiredmonthsintegerrequiredztppMonthsintegerproblemsobject[]requiredcodenull | stringrequiredtextstringrequiredpayoutHalerintegerrequiredbalanceHalerintegerrequiredshortfallHalerintegerrequiredbonusTopupHalerintegerrequiredoverpaymentHalerintegerrequiredbelowPayoutMinimumbooleanrequiredformPendingbooleanoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredcalculatedAtnull | stringrequireddate-timeapprovedAtnull | stringrequireddate-timepayoutRunIdnull | stringrequiredpaidAtnull | stringrequireddate-timeWork out a settlement without recording it, also for a year whose form is not published yet (2027), with the student credit and the child placement credit (§ 35bc, § 35bd ZDP). Nothing is stored and no form or filing comes of it: `formPending` says so
/v1/payroll/settlements/previewWork out a settlement without recording it, also for a year whose form is not published yet (2027), with the student credit and the child placement credit (§ 35bc, § 35bd ZDP). Nothing is stored and no form or filing comes of it: `formPending` says so
MCP tool: preview-payroll-tax-settlement
Request body
employeeIdstringrequiredtaxYearintegerrequiredmin -9007199254740991max 9007199254740991inputsobjectpreviousPayersobject[]namestringrequiredmax 200 charsincomeHalerintegerrequiredmin 0max 9007199254740991advancesHalerintegerrequiredmin 0max 9007199254740991bonusesHalerintegermin 0max 9007199254740991documentReceivedOnstringrequiredYYYY-MM-DDfilesReturnbooleanotherConcurrentPayerbooleandeductionsobjectdonationsHalerintegermin 0max 9007199254740991interestHalerintegermin 0max 9007199254740991interestMonthsintegermin 0max 12pensionSupplementHalerintegermin 0max 9007199254740991supplementaryPensionHalerintegermin 0max 9007199254740991pensionInstitutionHalerintegermin 0max 9007199254740991lifeInsuranceHalerintegermin 0max 9007199254740991longTermInvestmentHalerintegermin 0max 9007199254740991longTermCareHalerintegermin 0max 9007199254740991creditsobjectstoppedExecutionHalerintegermin 0max 9007199254740991spouseMonthsintegermin 0max 12spouseZtppMonthsintegermin 0max 12disabilityFirstSecondMonthsintegermin 0max 12disabilityThirdMonthsintegermin 0max 12ztppMonthsintegermin 0max 12studentMonthsintegermin 0max 12childPlacementobject[]childNamestringmax 200 charsspentHalerintegerrequiredmin 0max 9007199254740991householdsintegermin 1max 10agreedCapHalerinteger | nullspouseobject | nullfirstNamestringrequiredmax 200 charslastNamestringrequiredmax 200 charsbirthNumberstring | nullbirthDatestring | nullztppbooleanchildrenobject[] | nullmonthsintegerrequiredmin 0max 12ztppMonthsintegermin 0max 12Response · 200
employeeIdnull | stringrequiredtaxYearintegerrequiredmonthsintegerrequiredyearintegerrequiredformPendingbooleanrequiredrowsobjectrequiredr1integerrequiredr2integerrequiredr3integerrequiredr4integerrequiredr5integerrequiredr6integerrequiredr7integerrequiredr8integerrequiredr9integerrequiredr10integerrequiredr11integerrequiredr12integerrequiredr13integerrequiredr14integerrequiredr15integerrequiredr16integerrequiredr17integerrequiredr18integerrequiredr19integerrequiredr20integerrequiredr21integerrequiredr22integerrequiredstudentCreditHalerintegerrequiredchildPlacementHalerintegerrequiredr23integerrequiredoverpaymentHalerintegerrequiredbonusTopupHalerintegerrequiredpayoutHalerintegerrequiredshortfallHalerintegerrequiredbalanceHalerintegerrequiredbelowPayoutMinimumbooleanrequiredList eNeschopenka sick notes
/v1/payroll/sick-notesList eNeschopenka sick notes
MCP tool: list-payroll-sick-notes
Query parameters
limitintegermin 1max 500offsetintegermin 0max 9007199254740991searchstringmax 200 charsstatus"open" | "closed" | "cancelled"Response · 200
dataobject[]requiredobject"payroll_sick_note"requiredidstringrequiredemployeeIdnull | stringrequireddecisionNumberstringrequirednamenull | stringrequiredbirthDatenull | stringrequireddatefromstringrequireddatetostringrequireddatestatusstringrequiredworkAccidentbooleanrequirednotenull | stringrequiredinsertedAtstring | nullrequiredtotalintegerhasMorebooleanrequiredHZUPN20: the employer's report when a sick note ends (§ 97 odst. 4 zák. 187/2006 Sb.), valid against the ČSSZ XSD. You send it: nothing goes to ČSSZ from here
/v1/payroll/sick-notes/{id}/hzupn.xmlHZUPN20: the employer's report when a sick note ends (§ 97 odst. 4 zák. 187/2006 Sb.), valid against the ČSSZ XSD. You send it: nothing goes to ČSSZ from here
MCP tool: create-payroll-sick-end-xml
Path parameters
idstringrequiredRequest body
returnedbooleanrequiredreturnDatestringYYYY-MM-DDreasonstringmax 200 charshoursWorkednumbermin 0max 24shiftHoursnumbermin 0max 24workedIntervalsobject[]fromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDcorrectionbooleanResponse · 200
Returns a application/xml file.
Whether eNeschopenka notifications can be read straight from ČSSZ (DZDPN20-V2), on which channel, and the latest queries. Off unless the operator enabled it
/v1/payroll/sick-notes/directWhether eNeschopenka notifications can be read straight from ČSSZ (DZDPN20-V2), on which channel, and the latest queries. Off unless the operator enabled it
MCP tool: get-payroll-dzdpn-status
Response · 200
enabledbooleanrequiredchannelEnabledbooleanrequiredmodenull | stringrequiredcertificateSubjectnull | stringrequiredcertificateNotAfternull | stringrequireddate-timequeriesobject[]requiredobject"payroll_dzdpn_query"requiredidstringrequiredfromstringrequireddatetostringrequireddatemodestringrequiredstatusstringrequiredmessagenull | stringrequirednotificationCountintegerrequiredimportedCountintegerrequiredcreatedAtstringrequireddate-timeansweredAtnull | stringrequireddate-timeAsk ČSSZ for the eNeschopenka notifications of up to 31 days (DZDPN20-V2), signed and encrypted over the cssz_vrep channel. ČSSZ answers later: read it with the poll operation. ČSSZ refuses a repeated request the same day, and so does the app
/v1/payroll/sick-notes/directAsk ČSSZ for the eNeschopenka notifications of up to 31 days (DZDPN20-V2), signed and encrypted over the cssz_vrep channel. ČSSZ answers later: read it with the poll operation. ČSSZ refuses a repeated request the same day, and so does the app
MCP tool: create-payroll-dzdpn-query
Request body
fromstringrequiredYYYY-MM-DDtostringrequiredYYYY-MM-DDResponse · 201
idstringrequiredfromstringrequireddatetostringrequireddatemodestringrequiredstatusstringrequiredmessagenull | stringrequirednotificationCountintegerrequiredimportedCountintegerrequiredcreatedAtstringrequireddate-timeansweredAtnull | stringrequireddate-timeSee whether ČSSZ has answered a query. An answer is decrypted, read into sick notes as a file import would be, and the transaction closed. What was imported is matched to employees; the answer itself is not stored
/v1/payroll/sick-notes/direct/{id}/pollSee whether ČSSZ has answered a query. An answer is decrypted, read into sick notes as a file import would be, and the transaction closed. What was imported is matched to employees; the answer itself is not stored
MCP tool: poll-payroll-dzdpn-query
Path parameters
idstringrequiredResponse · 200
idstringrequiredfromstringrequireddatetostringrequireddatemodestringrequiredstatusstringrequiredmessagenull | stringrequirednotificationCountintegerrequiredimportedCountintegerrequiredcreatedAtstringrequireddate-timeansweredAtnull | stringrequireddate-timeRead eNeschopenka notifications from ČSSZ, a data box XML or a DZDPN20-V2 answer, into sick notes, and match them to employees. Importing the same file again changes nothing. Nothing goes to ČSSZ
/v1/payroll/sick-notes/importRead eNeschopenka notifications from ČSSZ, a data box XML or a DZDPN20-V2 answer, into sick notes, and match them to employees. Importing the same file again changes nothing. Nothing goes to ČSSZ
MCP tool: import-payroll-sick-notes
Request body
xmlstringrequiredmax 5000000 charsResponse · 201
notificationCountintegerrequiredimportedintegerrequiredupdatedintegerrequiredignoredintegerrequiredunmatchedobject[]requiredobject"payroll_sick_note"requiredidstringrequiredemployeeIdnull | stringrequireddecisionNumberstringrequirednamenull | stringrequiredbirthDatenull | stringrequireddatefromstringrequireddatetostringrequireddatestatusstringrequiredworkAccidentbooleanrequirednotenull | stringrequiredinsertedAtstring | nullrequiredMark the days of matched sick notes as sick in attendance. An open note runs to today, so inserting again extends it. A locked month or another absence on the day is left alone and reported
/v1/payroll/sick-notes/insertMark the days of matched sick notes as sick in attendance. An open note runs to today, so inserting again extends it. A locked month or another absence on the day is left alone and reported
MCP tool: insert-payroll-sick-notes
Request body
noteIdsstring[]Response · 200
insertedCountintegerrequiredresultsobject[]requiredidstringrequirednamenull | stringrequiredconflictsstring[]requiredlockedMonthsstring[]required