Sign in
Payable

Update one

Updates a payable

patch/v1/erp/payouts/payables/{payable_id}

Path parameters

payable_idstring required

The id of the payable

Parameters

#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0 — unresolved $ref

Request body

due_datestring date-time
review_status'pending' | 'approved' | 'declined'

The approval state of the payable.

descriptionstring
payment_datestring date-time

The scheduled/expected payment date for this payable.

payment_status'paid' | 'partially_paid' | 'non_paid'

Only editable by callers with the erp_tradables_manage permission on the payable's company; ignored otherwise.

status'uninitiated' | 'in_review' | 'approved'
discardedboolean

Whether the payable has been discarded or not. A discarded payable will not be obtained in the index.

partially_paid_amountinteger

The amount that has been paid for this payable. This amount is not necessarily the same as the total paid amount of the payable.

Response

Body of the updated payable.

idstring uuid required
source_typestring
source_idstring
amountinteger required
status'uninitiated' | 'in_review' | 'approved' required
due_datestring date-time

The date in which the payable is due.

payment_status'paid' | 'partially_paid' | 'non_paid'
company_idstring uuid required
issue_datestring date-time

The date in which the payable was issued.

currencystring required
document_typeinteger required

An integer representing the type of document. Refer to the document_types mapping for possible values and their corresponding document types.

sender_idstring uuid
recipient_idstring uuid
counterpart_company_idstring uuid required

The id of the counterpart company. This is the company that will receive the payment.

descriptionstring
discardedboolean

Whether the payable has been discarded or not. A discarded payable will not be obtained in the index.

partially_paid_amountinteger
paid_amountinteger

The amount that has been paid for this payable. This amount is calculated using the partially_paid_amount param, the amount of the bank transactions related to the payable and the amount of the credit notes related.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.