API: Economy – Other Lookup Data

In this article, you can read about how to retrieve salary matrices (including salary/invoice calculations for a specific candidate and project), cost centers, work attachments, products and product groups via the API.

Get Salary Matrix

GET

https://api.recman.io/v2/get/?key={{api_key}}&
scope=salaryMatrix

Returns all salary matrices created.

URLhttps://api.recman.io/v2/get/
scopesalaryMatrix
operationGET

Salary Matrix fields

FieldDescription
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

FieldDescription
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}}
scopesalaryMatrix

Get Specific Salary Matrix

GET

https://api.recman.io/v2/get/?key={{api_key}}&
scope=fetchSalaryMatrix&candidateId=3776359&
projectId=471029&salaryMatrixCategoryId=2458

Get the calculated salary and invoice amount for a specific candidate on a specific project, based on a given salary matrix category.

URLhttps://api.recman.io/v2/get/
scopefetchSalaryMatrix
operationGET
parameterscandidateId, projectId, salaryMatrixCategoryId

PARAMS

key{{api_key}}
scopefetchSalaryMatrix
candidateId3776359
projectId471029
salaryMatrixCategoryId2458

The response returns the calculated salary and invoice values for that candidate/project combination.

Get Cost Centre

GET

https://api.recman.io/v2/get/?key={{api_key}}&
scope=costCentre

Retrieve cost centres, including which corporations, users, and departments have access to each one.

URLhttps://api.recman.io/v2/get/
scopecostCentre

Cost Centre fields

FieldDescription
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

FieldDescription
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}}
scopecostCentre
active0

Get Work Attachment

GET

https://api.recman.io/v2/get/?key={{api_key}}&
scope=workAttachment&page=1&workAttachmentId=9687

Download an attachment linked to a work entry, invoice, or paycheck.

URLhttps://api.recman.io/v2/get/
scopeworkAttachment
operationGET

PARAMS

key{{api_key}}
scopeworkAttachment
page1
workAttachmentId9687

Get Products

GET

https://api.recman.io/v2/get/?key={{api_key}}&
scope=product

Lists the products available for use on invoices, credit notes and invoice order lines.

URLhttps://api.recman.io/v2/get/
scopeproduct

Product fields

FieldDescription
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}}
scopeproduct

Get Product Group

GET

https://api.recman.io/v2/get/?key={{api_key}}&
scope=productGroup

Lists the product groups used to categorize products.

URLhttps://api.recman.io/v2/get/
scopeproductGroup
operationGET

Product Group fields

FieldDescription
productGroupId
integer
ID of the product group
name
string
Name of the product group

PARAMS

key{{api_key}}
scopeproductGroup
Was this article helpful?
0 out of 0 found this helpful