List the payslips of a pay run

GET

/pay_runs/{pay_run_id}/payslips

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

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

Authorizations

• ApiKey

Parameters

Path Parameters

pay_run_id

required

string format: uuid

Query Parameters

limit

integer

default: 25 >= 1 <= 100

starting_after

string format: uuid

The next_cursor from the previous page.

Responses

200

OK

Media typeapplication/json

object

object

string

Allowed value: list

data

Array<object>

object

id

string format: uuid

object

string

Allowed value: payslip

pay_run_id

string format: uuid

employee_id

string format: uuid

currency

string

gross

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

net

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

employee_deductions

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

employer_cost

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

tax

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

payment

The amount actually paid, in the payment currency (may differ from the calculation currency).

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

fx_rate_used

string

nullable

payment_status

Whether, and when, this payslip’s pay was sent. The same reading the employee sees in their own portal. state is one of none (the run is not approved yet), not_sent (approved, nothing sent), sent, arrived, returned, refused, or paid_by_employer (the run was marked paid from the employer’s own bank, so there is no per-payment record).

object

state

string

Allowed values: none not_sent sent arrived returned refused paid_by_employer

sent_at

string format: date-time

nullable

settled_at

string format: date-time

nullable

note

The bank’s own words when a payment came back or was refused.

string

nullable

line_items

Array<object>

object

code

string

kind

string

Allowed values: earning deduction employer_cost informational

description

string

nullable

amount

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

base

object

amount_minor

required

Integer amount in the currency’s minor unit. 50000 GHS = 500.00.

integer

currency

required

string

rate_applied

string

nullable

rule_version_ref

The effective-dated statutory row this line was priced against.

string

nullable

created_at

string format: date-time

updated_at

string format: date-time

has_more

boolean

next_cursor

string format: uuid

nullable

Example

{
  "object": "list",
  "data": [
    {
      "object": "payslip",
      "gross": {
        "currency": "GHS"
      },
      "net": {
        "currency": "GHS"
      },
      "employee_deductions": {
        "currency": "GHS"
      },
      "employer_cost": {
        "currency": "GHS"
      },
      "tax": {
        "currency": "GHS"
      },
      "payment": {
        "currency": "GHS"
      },
      "payment_status": {
        "state": "none"
      },
      "line_items": [
        {
          "kind": "earning",
          "amount": {
            "currency": "GHS"
          },
          "base": {
            "currency": "GHS"
          }
        }
      ]
    }
  ]
}

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"
  }
}