Create an imprest fund

post

https://api.cardda.com/v1/erp/payouts/imprest_funds

Creates an imprest fund assigned to user_id (who must be a member of the company).
An initial company-refund payable is created alongside it; supply initial_amount and
an optional bank_account to fund the assignee's reimbursement.

Requires the erp_imprest_funds_create permission (or company admin).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body used to create an imprest fund. user_id (the assignee) is required and must be a member of the company. On creation an initial company-refund payable is also created.

user_id

string

required

Id of the user the fund is assigned to. Must be a member of the company.

description

string

start_date

date

end_date

date

initial_amount

integer

Initial amount funded (defaults to 0). Used for the company-refund payable.

bank_account

object

Optional bank account to link to the initial company-refund payable, so the assignee can be reimbursed.

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 — missing auth, or the assignee is not a member of the company.

404

Not Found — user_id does not match any user.

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

201The created imprest fund. This response is the bare fund record only — unlike the index/show responses it does not embed user, creator, paid_amount, reported_amount, or custom_column_values.