Theme

Payouts

Create a Payout

POST https://cirro.io/api/v2/payouts

Parameters

ParameterTypeNote
amountrequirednumberAmount of payout
titlerequiredstringTitle of the payout
user_idrequiredstringID of the associated user
cost_center_keyrequiredstringA EPAM project code for book keeping in finance. It is required if cost_center_data is not given
cost_center_datarequiredobject (See below)A json object containing customer details. It is required if cost_center_key is not given
descriptionstringDescription of the payout
billing_datestring%Y-%m-%d format; When did the worker perform the work, by default it equals to the creation time of the payout
reference_idstringID of the associated reference e.g. gig
reference_typestringType of the associated reference e.g. Gig
idempotency_keystringThe API supports idempotency for safely retrying requests without accidentally performing the same operation twice

Cost Center Data Parameters

ParameterTypeNote
legal_entityrequiredstringThe legal entity of the customer
inhouserequiredstringYes or No
customer_idstringExternal ID of customer. At least one of customer_id or epam_project_code is required
epam_project_codestringEPAM project code. At least one of customer_id or epam_project_code is required
companystringRequired if customer_id is provided

Description

Returns the Payout object if creation succeeded.

Example

1client = CirroIOV2::Client.new(...)
2client.Payout.create(
3  "amount": 1000,
4  "currency": "USD",
5  "title": "The Golden Bowl",
6  "description": "Language designers want to design the perfect language. They want to be able to say, 'My language is perfect. It can do everything.' But it's just plain impossible to design a perfect language, because there are two ways to look at a language. One way is by looking at what can be done with that language. The other is by looking at how we feel using that language-how we feel while programming.",
7  "billing_date": "2022-06-15",
8  "cost_center_key": "EPM-CRWD",
9  "user_id": 1
10)
Previous
List all