In this article, you can read about how to insert payroll records for a candidate and how to attach a payslip file (e.g., PDF) to that payroll record.
Insert Payroll
POST
https://api.recman.io/v2/post/Here you can find an overview of how to request payrolls and what you can do with it.
| URL POST | https://api.recman.io/v2/post/ |
| Scope | payroll |
| Operation | insert |
Payroll fields
| Field | Description |
|---|---|
| candidateId integer | ID of the candidate to insert the payroll for |
| grossAmount integer | The amount before deduction |
| netAmount integer | The amount after deduction |
| year integer | Which year the payroll was created. Format: yyyy |
| month integer | Which month the payroll was created. Format: m |
| date date | Which date the payroll was uploaded. Format: y-m-d |
| attachments object | See "Attaching a File to a Payroll Record" below |
Request Body
| key | {{api_key}} |
| scope | payroll |
| operation | insert |
| data.candidateId | 3772436 |
| data.grossAmount | 1000 |
| data.netAmount | 1000 |
| data.year | 2022 |
| data.month | 1 |
| data.date | 2022-05-25 21:05:16 |
Attaching a File to a Payroll Record
POST
https://api.recman.io/v2/post/A file (e.g. a payslip PDF) can be attached to a payroll record at the same time it is inserted, by including an attachments object in the request.
Attachments — sub-fields
| Field | Description |
|---|---|
| name string | Name of the file to be uploaded |
| ext string | File extension type. Valid values: pdf, docx, etc. |
| base64 string | Base64-encoded string of the file |
Request Body
| key | {{api_key}} |
| scope | payroll |
| operation | insert |
| data.candidateId | 3772436 |
| data.grossAmount | 1000 |
| data.netAmount | 1000 |
| data.year | 2022 |
| data.month | 1 |
| data.date | 2022-05-25 21:05:16 |
| data.attachments.name | attachmentsName.pdf |
| data.attachments.ext | |
| data.attachments.base64 | (base64-encoded file content) |