Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Payments

Update payment

Endpoint for updating an existing payment.

put/payments/{id}/

Path parameters

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double required

The total amount of the payment including fees. Must be greater than zero.

contactstring

The unique identifier of the contact associated with this payment.

cost_centerstring nullable

The unique identifier of the cost center associated with this payment.

created_tsstring date-time required

The timestamp in UTC when the payment 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
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

datestring date required

The date when the payment was made or received.

employeestring

The unique identifier of the employee associated with this payment. Required for payslip payments.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the payment.

idstring required

The unique identifier of the payment. Read-only field.

legacy_idstring required

[Deprecated] The legacy identifier of the payment.

modified_tsstring date-time required

The timestamp in UTC when the payment was last modified

paid_through_accountstring required

The account used for this payment. Must be a valid payment account.

payment_feesnumber double

The fees paid for this payment. If set, must be greater than zero.

payment_fees_accountstring nullable

The account to categorize the payment fees. Required if payment_fees is set.

payment_requeststring required

The unique identifier of the associated payment request. Read-only field.

payment_typestring required

The derived type of the payment (e.g. SUPPLIER_ADVANCE, CUSTOMER_ADVANCE, INVOICE, BILL). Read-only field.

projectstring nullable

The unique identifier of the project associated with this payment.

referencestring

Response

amountnumber double required

The total amount of the payment including fees. Must be greater than zero.

contactstring

The unique identifier of the contact associated with this payment.

cost_centerstring nullable

The unique identifier of the cost center associated with this payment.

created_tsstring date-time required

The timestamp in UTC when the payment 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
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

datestring date required

The date when the payment was made or received.

employeestring

The unique identifier of the employee associated with this payment. Required for payslip payments.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the payment.

idstring required

The unique identifier of the payment. Read-only field.

legacy_idstring required

[Deprecated] The legacy identifier of the payment.

modified_tsstring date-time required

The timestamp in UTC when the payment was last modified

paid_through_accountstring required

The account used for this payment. Must be a valid payment account.

payment_feesnumber double

The fees paid for this payment. If set, must be greater than zero.

payment_fees_accountstring nullable

The account to categorize the payment fees. Required if payment_fees is set.

payment_requeststring required

The unique identifier of the associated payment request. Read-only field.

payment_typestring required

The derived type of the payment (e.g. SUPPLIER_ADVANCE, CUSTOMER_ADVANCE, INVOICE, BILL). Read-only field.

projectstring nullable

The unique identifier of the project associated with this payment.

referencestring