Download a salary record PDF
Scope: accounting:payrolls.read https://api.alladdin.com/api/v2/salary-records/{salaryRecordId}/pdf
Returns the PDF uploaded for a salary record (Spanish registro salarial). A salary record is a manually entered accounting record, not a document produced by Alladdin's payroll engine, so it has no exported PDF of its own: if no file has been uploaded, the response is 422.
A salary record is NOT a payslip (nómina), which is served by /api/v2/payslips. Ids of both look identical, so asking this endpoint for a payslip id also returns 404.
Parameters
Path parameters
salaryRecordId string required
Salary record ID (24-character hexadecimal ObjectId)
Request
import requests
url = "https://api.alladdin.com/api/v2/salary-records/507f1f77bcf86cd799439011/pdf"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
"string"Success responses
200 Salary record PDF binary content application/pdf string<binary>
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Salary record not found application/json 422 No file has been uploaded for this salary record application/json 429 Rate limit exceeded application/json