In this article, you can read about how to retrieve salary matrices (including salary/invoice calculation for a specific candidate and project), cost centers, work attachments, products, product groups, and credit note reasons via the API.
Salary Matrix
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=salaryMatrixReturns all salary matrices created.
| URL | https://api.recman.io/v2/get/ |
| Scope | salaryMatrix |
| Operation | GET |
Salary Matrix fields
| Field | Description |
|---|---|
| salaryMatrixCategoryId integer | ID of the salary matrix category |
| departmentId integer | Department the matrix belongs to |
| name string | Name of the salary matrix |
| matrix object | Array of matrix rows — see fields below |
Matrix row fields
| Field | Description |
|---|---|
| seniority integer | Seniority level for the row |
| yearSalary integer | Yearly salary for the row |
| hours integer | Hours associated with the row |
| invoiceFactor string | Factor used to calculate the invoice amount |
| invoiceAddition string | Addition applied to the invoice amount |
PARAMS
| key | {{api_key}} |
| scope | salaryMatrix |
Specific Salary Matrix (Salary and Invoice Calculation)
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=fetchSalaryMatrix&candidateId=3776359&
projectId=471029&salaryMatrixCategoryId=2458Get the calculated salary and invoice amount for a specific candidate on a specific project, based on a given salary matrix category.
| URL | https://api.recman.io/v2/get/ |
| Scope | fetchSalaryMatrix |
| Operation | GET |
| Parameters | candidateId, projectId, salaryMatrixCategoryId |
PARAMS
| key | {{api_key}} |
| scope | fetchSalaryMatrix |
| candidateId | 3776359 |
| projectId | 471029 |
| salaryMatrixCategoryId | 2458 |
The response returns the calculated salary and invoice values for that candidate/project combination.
Cost Centre
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=costCentreRetrieve cost centres, including which corporations, users, and departments have access to each one.
| URL | https://api.recman.io/v2/get/ |
| Scope | costCentre |
Cost Centre fields
| Field | Description |
|---|---|
| costCentreId integer | ID of the specific cost centre |
| name string | Name of the specific cost centre |
| active integer | Whether it is active or not. Valid values: 1, 0 |
| editAfterInvoice integer | Whether the cost centre can be edited after invoicing. Valid values: 1, 0 |
| externalId string | Use this if the cost centre also has an ID outside of RecMan |
| access object | See "Access fields" below |
Access fields
| Field | Description |
|---|---|
| corporationIds array of integer | List of IDs for all corporations who have access |
| userIds array of integer | List of IDs for all users who have access |
| departmentIds array of integer | List of IDs for all departments that have access |
| all boolean | Whether all should have access. If the above fields are empty, defaults to true. Valid values: true, false |
PARAMS
| key | {{api_key}} |
| scope | costCentre |
| active | 0 |
Get Work Attachment
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=workAttachment&page=1&workAttachmentId=9687Download an attachment linked to a work entry, invoice, or paycheck.
| URL | https://api.recman.io/v2/get/ |
| Scope | workAttachment |
| Operation | GET |
PARAMS
| key | {{api_key}} |
| scope | workAttachment |
| page | 1 |
| workAttachmentId | 9687 |
Get Products
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=productLists the products available for use on invoice, credit note, and invoice order lines.
| URL | https://api.recman.io/v2/get/ |
| Scope | product |
Product fields
| Field | Description |
|---|---|
| productId integer | ID of the product |
| name string | Name of the product |
| type string | Product type, e.g. staffing |
| creditAccount string | Credit account number |
| debitAccount string | Debit account number |
| vatCode string | VAT code applied to the product |
| productGroupId integer | ID of the product group this product belongs to (0 if none) |
PARAMS
| key | {{api_key}} |
| scope | product |
Get Product Group
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=productGroupLists the product groups used to categorize products.
| URL | https://api.recman.io/v2/get/ |
| Scope | productGroup |
| Operation | GET |
Product Group fields
| Field | Description |
|---|---|
| productGroupId integer | ID of the product group |
| name string | Name of the product group |
PARAMS
| key | {{api_key}} |
| scope | productGroup |
Get Credit Note Reason
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=creditNoteReasonLists the reasons that can be assigned to a credit note.
| URL | https://api.recman.io/v2/get/ |
| Scope | creditNoteReason |
| Operation | GET |
Credit Note Reason fields
| Field | Description |
|---|---|
| creditNoteReasonId integer | ID of the credit note reason |
| corporationId integer | Specifies which corporation has access. 0 means all corporations have access |
| name string | Name of the credit note reason |
| active integer | Whether the credit note reason is active or not. Valid values: 0, 1 |
| externalId string | Use this if the credit note reason also has an ID outside of RecMan |
PARAMS
| key | {{api_key}} |
| scope | creditNoteReason |