Faciotech CRM Payroll Enterprise API

Version 1.0.0

Partner-grade payroll APIs for the VeritasRoll module. Covers time-event ingestion, payroll run management, payment batches, statutory filings, general ledger exports, garnishment orders, earned-wage access (EWA), and anomaly management. All POST endpoints that modify financial state support the Idempotency-Key header.

Base URL

https://{tenant}.faciotech.net/api/v1. Replace {tenant} with the tenant subdomain assigned by Faciotech. Endpoint paths below are relative to this URL.

Endpoints

Time Events

• POSTIngest payroll time events /payroll/time-events

Payroll Runs

• GETFetch latest payroll readiness snapshot /payroll/readiness
• GETList payroll runs /payroll/runs
• POSTCreate payroll run /payroll/runs
• GETGet payroll run /payroll/runs/{id}
• DELETEDelete payroll run /payroll/runs/{id}
• POSTApprove payroll run /payroll/runs/{id}/approve
• POSTMark payroll run as paid /payroll/runs/{id}/mark-paid
• POSTApprove payroll approval step /payroll/approvals/{id}/approve
• POSTReject payroll approval step /payroll/approvals/{id}/reject

Payment Batches

• GETList payment batches /payroll/payment-batches
• POSTCreate payment batch for run /payroll/runs/{run_id}/payment-batches
• POSTSubmit payment batch /payroll/payment-batches/{id}/submit
• POSTMark payment batch as complete /payroll/payment-batches/{id}/complete
• POSTReconcile payment transaction /payroll/payment-transactions/{id}/reconcile

Payslips

• GETGet payslip /payroll/payslips/{id}
• GETDownload printable payslip /payroll/payslips/{id}/print

Employee Self-Service

• GETList employee's own payslips /payroll/self-service/payslips
• GETList tax documents /payroll/self-service/tax-documents
• POSTRequest step-up authentication /payroll/self-service/challenge
• PUTUpdate payment method /payroll/self-service/payment-method
• POSTRequest payslip correction /payroll/self-service/corrections

Allowances & Deductions

• GETList employee payroll configs /payroll/employees
• PUTUpdate employee payroll config /payroll/employees/{id}
• GETList allowance types /payroll/allowances
• POSTCreate allowance type /payroll/allowances
• PUTUpdate allowance type /payroll/allowances/{id}
• DELETEDelete allowance type /payroll/allowances/{id}
• GETList deduction types /payroll/deductions
• POSTCreate deduction type /payroll/deductions
• PUTUpdate deduction type /payroll/deductions/{id}
• DELETEDelete deduction type /payroll/deductions/{id}

PAYE Bands

• GETList PAYE bands /payroll/paye-bands
• POSTCreate PAYE band /payroll/paye-bands
• PUTUpdate PAYE band /payroll/paye-bands/{id}
• DELETEDelete PAYE band /payroll/paye-bands/{id}

Filings

• GETList statutory filings /payroll/filings
• POSTGenerate statutory filings for run /payroll/runs/{run_id}/filings/generate
• POSTValidate statutory filing payload /payroll/filings/{id}/validate
• POSTSubmit filing to tax authority connector /payroll/filings/{id}/submit
• GETPoll filing status /payroll/filings/{id}/status
• POSTManually accept filing /payroll/filings/{id}/accept
• POSTManually reject filing /payroll/filings/{id}/reject

GL Exports

• POSTGenerate payroll GL export /payroll/gl-exports
• GETGet GL export details /payroll/gl-exports/{id}

Garnishments

• GETList garnishment cases /payroll/garnishments
• POSTCreate garnishment case /payroll/garnishments
• POSTSimulate garnishment withholding /payroll/garnishments/{id}/simulate

EWA

• GETGet earned wage balance /payroll/ewa/balance
• POSTCreate EWA draw request /payroll/ewa/draws

Anomalies

• GETList payroll anomalies /payroll/anomalies
• POSTResolve anomaly /payroll/anomalies/{id}/resolve

Reports

• GETPayroll summary report /payroll/reports/summary
• GETSSNIT contribution report /payroll/reports/ssnit
• GETPAYE tax report /payroll/reports/paye
• GETBranch summary report /payroll/reports/branch
• GETDesignation summary report /payroll/reports/designation
• GETPayroll trends report /payroll/reports/trends