Update one

patch

https://api.cardda.com/v1/erp/payouts/payables/{payable_id}

Updates a payable

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payable_id

string

required

The id of the payable

Body Params

update parameters

due_date

date-time

review_status

string

enum

The approval state of the payable.

Allowed:

description

string

payment_date

date-time

The scheduled/expected payment date for this payable.

payment_status

string

enum

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

Allowed:

status

string

enum

Allowed:

discarded

boolean

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

partially_paid_amount

integer

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

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Pay endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

If the deprecated company_id query parameter is also sent, both values must match;
the API returns 422 Unprocessable Entity when they disagree.

Responses

401

Unauthorized

404

Payable not found

422

Unprocessable Entity

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Body of the updated payable.

400Bad Request — when lowering partially_paid_amount below the already-committed amount. Carries error code payables/min_amount.