In this article, you can read about how to retrieve active and deleted paychecks via the API, and how to insert and delete paycheck export logs and deleted-paycheck export logs.
Get Paycheck
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=paycheck&page=1Retrieve paychecks through the GET method. page is required. If exported is not specified, all paychecks are returned. The paycheck list is sorted descending.
Note
If a paycheck has an attached object, it can be downloaded separately using the workAttachment scope.
| URL | https://api.recman.io/v2/get/ |
| Scope | paycheck |
| Page | Page number, 1000 paychecks per page |
| Parameters | minPaycheckId, payCheckIds, paycheckId, exported, paycheckSystemId |
Parameters explained
| Parameter | Description |
|---|---|
| payCheckIds | Enter several paycheck IDs to list specific ones. Comma-separated, no spaces. |
| paycheckId | Select only one paycheck to export. |
| exported | Request only paychecks that have been exported or not. "0" = Not exported, "1" = Exported. |
| paycheckSystemId | Gives an ID based on what kind of export the paycheck has been exported to. exported must be set to "1" for this parameter to work. |
| minPaycheckId | Lists all paychecks over a specified paycheck ID, and none below. |
PARAMS
| key | {{api_key}} |
| scope | paycheck |
| page | 1 |
Get Paycheck — Deleted
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=deletedPaycheck&page=1Gives you a list of all paychecks that have been deleted. Same pagination and parameters as the standard paycheck scope apply.
| URL | https://api.recman.io/v2/get/ |
| Scope | deletedPaycheck |
| Page | Page number, 1000 paychecks per page |
| Parameters | minPaycheckId, payCheckIds, paycheckId, exported, paycheckSystemId |
PARAMS
| key | {{api_key}} |
| scope | deletedPaycheck |
| page | 1 |
Insert / Delete Paycheck Export Log
POST
https://api.recman.io/v2/post/The POST method is used for inserting and deleting paycheck export logs.
| URL POST | https://api.recman.io/v2/post/ |
| Scope | paycheckExportLog |
| Operation | insert / delete |
Fields
| Field | Description |
|---|---|
| paycheckId integer | Paycheck ID. Required on operation: insert |
| userId integer | User ID. Required on operation: insert |
| paycheckSystemId integer | Paycheck system ID. Required on operation: insert |
| paycheckExportLogId integer | Paycheck export log ID. Required on operation: delete |
Request Body — Insert
| key | {{api_key}} |
| scope | paycheckExportLog |
| operation | insert |
| data.paycheckId | 423562 |
| data.userId | 13236 |
| data.paycheckSystemId | 755682 |
Request Body — Delete
| key | {{api_key}} |
| scope | paycheckExportLog |
| operation | delete |
| data.paycheckExportLogId | 321312 |
Insert / Delete Deleted-Paycheck Export Log
POST
https://api.recman.io/v2/post/The POST method is used for inserting and deleting export logs specifically for deleted paychecks.
Fields and behavior are identical to the standard paycheck export log, but apply to thedeletedPaycheckExportLog scope.
| URL POST | https://api.recman.io/v2/post/ |
| Scope | deletedPaycheckExportLog |
| Operation | insert / delete |
Fields
| Field | Description |
|---|---|
| paycheckId integer | Paycheck ID. Required on operation: insert |
| userId integer | User ID. Required on operation: insert |
| paycheckSystemId integer | Paycheck system ID. Required on operation: insert |
| paycheckExportLogId integer | Paycheck export log ID. Required on operation: delete |
Request Body — Insert
| key | {{api_key}} |
| scope | deletedPaycheckExportLog |
| operation | insert |
| data.paycheckId | 423562 |
| data.userId | 13236 |
| data.paycheckSystemId | 755682 |