Update Fund

patch

https://xcore.xpendit.com/public/v1/enterprises/{id_enterprise}/subsidiaries/{id_subsidiary}/funds/{id}/

Update the specified fund status to open or update its details. When updating to open status from pending, the current amount will be reset to the initial amount. Cannot update to open status from pending_approval or when already open. Updating to settled registers the settlement of the remaining balance (including overdrawn funds) and marks the fund as settled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Id of the desired object

id_enterprise

string

required

Id of the selected enterprise

id_subsidiary

string

required

Id of the selected subsidiary

Body Params

status

string

enum

The new status of the fund. Set to 'open' (allowed from 'pending' or 'closed'), 'closed' (allowed from 'pending' or 'open') or 'settled' (allowed from 'pending_settlement' or 'open'; requires payment_date and payment_method).

Allowed:

payment_method

string

enum

Payment method of the fund.

Allowed:

payment_date

string

Payment date of the fund, must be a valid date in the format YYYY-MM-DD and must be in the past

admin_user_id

string

ID of the admin performing the action. Required to open a fund. To settle a fund it must belong to the enterprise and be allowed to settle it; it can be omitted only if the enterprise has settling without admin enabled.

payment_reference

string

Payment reference in the ERP, stored on the settlement.

additional_information

string

Notes stored on the settlement.

file

string

Settlement document as a base64 data URL.

expected_amount

number

Fund current_amount seen by the client; if it differs from the current balance the settlement is rejected.

Responses

200

400Bad request. Extra fields can be included, one per field with error list.

403Authentication error

404Resource not found