Update many

patch

https://api.cardda.com/v1/erp/payouts/payables/update_many

Updates many payable

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

amount

string

Only as an example of filtering results that have an amount less than $11000.
For more detailed explanation, go to the How to filter results section.

Body Params

update parameters

company_id

uuid

required

Required. If missing, the request fails with 412 Precondition Failed.

scope

string

enum

required

Required. If missing, the request fails with 412 Precondition Failed. The scope of the update. If the scope is all, all the payables of the company (filtered by the query parameters) will be updated. Otherwise, only the payables with the ids provided in ids will be updated.

Allowed:

ids

array of uuids

The ids of the payables to update when the scope is not all.

ids

due_date

date-time

description

string

payment_date

date-time

The scheduled/expected payment date to apply to the selected payables.

payment_status

string

enum

Only applied for callers with the erp_tradables_manage permission on every selected payable's company; ignored otherwise.

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.

review_status

string

enum

Approval state to apply to the selected payables.

Allowed:

reviewers

array of objects

Reviewers to assign to the selected payables.

reviewers

custom_column_values

array of objects

Custom column values to set on the selected payables.

custom_column_values

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

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.

412Precondition Failed — a required parameter is missing. Both company_id and scope are required; omitting either returns 412 with a body like {"message": "param is missing or the value is empty or invalid: scope"}.