WAwafeq
Pay Items

Create pay item

Changed on

Endpoint for creating a new pay item.

post/payslips/{payslip_id}/pay-items/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/payslips/{payslip_id}/pay-items/
  • Auth
    API key in header Authorization

Path parameters

payslip_idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: account, account.parent, cost_center. Nested relations are joined with a dot.

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

accountstring required

The account associated with this pay item.

amountnumber double required

The unit amount for the pay item.

cost_centerstring nullable

The cost center associated with this pay item.

created_tsstring date-time required

The timestamp in UTC when the pay item was created

descriptionstring required

The line item description for the pay item.

idstring required

The unique identifier of the pay item.

legacy_idstring required

[Deprecated] The legacy identifier of the pay item.

modified_tsstring date-time required

The timestamp in UTC when the pay item was last modified

Response

accountstring required

The account associated with this pay item.

amountnumber double required

The unit amount for the pay item.

cost_centerstring nullable

The cost center associated with this pay item.

created_tsstring date-time required

The timestamp in UTC when the pay item was created

descriptionstring required

The line item description for the pay item.

idstring required

The unique identifier of the pay item.

legacy_idstring required

[Deprecated] The legacy identifier of the pay item.

modified_tsstring date-time required

The timestamp in UTC when the pay item was last modified

Changes