WAwafeq
Payslips

Update payslip

Changed on

Endpoint for updating an existing payslip.

put/payslips/{id}/

Request

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

Path parameters

idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: branch, employee, employee.reimbursements_account, journal, pay_items, pay_items.account, pay_items.cost_center. Nested relations are joined with a dot. 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}.

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double required

The total amount of the payslip.

balancenumber double required

The remaining balance of the payslip.

branchstring nullable

The branch associated with this payslip.

created_tsstring date-time required

The timestamp in UTC when the payslip was created

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

An ISO 4217 currency code.

View the enum reference

employeestring required

The employee to whom the payslip belongs.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the payslip.

idstring required

The unique identifier of the payslip.

language'en' | 'ar'

The language of a document or response.

View the enum reference

legacy_idstring required

[Deprecated] The legacy identifier of the payslip.

modified_tsstring date-time required

The timestamp in UTC when the payslip was last modified

payslip_datestring date required

The date when the payslip was issued.

payslip_numberstring required

The unique number assigned to the payslip.

status'DRAFT' | 'POSTED'

The posting status of a document.

View the enum reference

Response

amountnumber double required

The total amount of the payslip.

balancenumber double required

The remaining balance of the payslip.

branchstring nullable

The branch associated with this payslip.

created_tsstring date-time required

The timestamp in UTC when the payslip was created

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

An ISO 4217 currency code.

View the enum reference

employeestring required

The employee to whom the payslip belongs.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the payslip.

idstring required

The unique identifier of the payslip.

language'en' | 'ar'

The language of a document or response.

View the enum reference

legacy_idstring required

[Deprecated] The legacy identifier of the payslip.

modified_tsstring date-time required

The timestamp in UTC when the payslip was last modified

payslip_datestring date required

The date when the payslip was issued.

payslip_numberstring required

The unique number assigned to the payslip.

status'DRAFT' | 'POSTED'

The posting status of a document.

View the enum reference

Changes

  • b8f5e10134b4Revision changes
    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • breaking

      removed the enum value ar of the request property (media type: application/json)

    • breaking

      removed the enum value ar of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value ar of the request property (media type: multipart/form-data)

    • breaking

      removed the enum value en of the request property (media type: application/json)

    • breaking

      removed the enum value en of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value en of the request property (media type: multipart/form-data)

    • breaking

      the request property type changed from string to no type (media type: application/json)

    • breaking

      the response's property type changed from string to no type for status

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • info

      added the new optional query request parameter expand

    • info

      the request property type was generalized from string to no type (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from string to no type (media type: multipart/form-data)

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed the ar enum value from the response property for the response status

    • info

      removed the en enum value from the response property for the response status

    • info

      added the required property to the response with the status