Partial update payslip

patch

https://api.wafeq.com/v1/payslips/{id}/

Endpoint for partially updating an existing payslip.

Path Params

string

required

Query Params

expand

string

Comma-separated relationships to expand. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

Body Params

A payslip recording the pay of an employee.

branch

string | null

The branch associated with this payslip.

currency

string

enum

The currency used for the payslip.

View the enum reference

employee

string

The employee to whom the payslip belongs.

exchange_rate

double | null

The exchange rate to the organization base currency at the time of the document.

external_id

string

length ≤ 255

External identifier for the payslip.

language

string

enum

The language of the document.

View the enum reference

Allowed:

pay_items

array of objects

The list of pay items included in the payslip.

pay_items

payslip_date

date

The date when the payslip was issued.

payslip_number

string

The unique number assigned to the payslip.

status

string

enum

Defaults to DRAFT

The current status of the payslip (draft or posted).

View the enum reference

Allowed:

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200