Download a payslip as PDF

GET

/payslips/{id}/pdf

curl --request GET \
  --url https://api.usepayloom.com/api/v1/payslips/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pdf \
  --header 'Authorization: Bearer <token>'

• Production
• Staging — demo data, `plm_test_` keys

Rendered on demand — payslips are never stored as files. A payslip snapshots the statutory rules that priced it, so the PDF re-renders identically however long afterwards.

Authorizations

• ApiKey

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

Media typeapplication/pdf

string format: binary

401

Missing, invalid, revoked or expired key.

Media typeapplication/json

object

error

object

code

required

string

Allowed values: missing_token invalid_token revoked expired insufficient_scope organization_not_operable not_found invalid_request validation_failed rate_limited

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "missing_token"
  }
}

403

The key is valid but lacks the required scope.

Media typeapplication/json

object

error

object

code

required

string

Allowed values: missing_token invalid_token revoked expired insufficient_scope organization_not_operable not_found invalid_request validation_failed rate_limited

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "missing_token"
  }
}

404

No such resource in this organization.

Media typeapplication/json

object

error

object

code

required

string

Allowed values: missing_token invalid_token revoked expired insufficient_scope organization_not_operable not_found invalid_request validation_failed rate_limited

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "missing_token"
  }
}