To make a payout to an Employee (Gigger) you need to create a Payout object. The Employee is notified of the Payout once the corresponding Invoice is paid. The Employee will need to sign and accept the Payout before it is disbursed to their account.
Attribute | Description |
| Unique identifier for the object. |
| Decimal formatted string of the gross amount. |
| Decimal formatted string of the salary cost. |
| ISO-4217 currency code. |
| String describing the work done, displayed to the recipient. |
| If True will a full salary specification be shown to the Employee, including payroll taxes and Gigapay's fee, in addition to the standard taxes and vacation pay. |
| Unique identifier for the Employee object, that is the recipient of the Payout. This is an expandable object. |
| Unique identifier for the Invoice object the Payout object belongs to. This is an expandable object. |
| JSON-encoded metadata. |
| The time at which the gig will start. Displayed as ISO 8601 string. |
| The time at which the gig will end. Displayed as ISO 8601 string. |
| The time at which the Payout was created at. Displayed as ISO 8601 string. |
| The time at which the Employee was notified of the Payout. Displayed as ISO 8601 string. |
| The time at which the Employee accepted the Payout. Displayed as ISO 8601 string. |
amount
or cost
is required.amount
or cost
is required.{"id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa","amount": "100.00","cost": "137.99","currency": "SEK","description": "Lön genom Gigapay","employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2","invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e","metadata": {"job_id": 127},"start_at": "2019-05-21T08:00:00.000000Z","end_at": "2019-05-21T17:00:00.000000Z","created_at": "2019-05-22T10:32:38.118753Z","notified_at": null,"accepted_at": null,}
{"employee": ["Object with id "+46703000000" does not exist."]}
[{"id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa","amount": "100.00","cost": "137.99","currency": "SEK","description": "Lön genom Gigapay","employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2","invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e","metadata": {"job_id": 127},"start_at": "2019-05-21T08:00:00.000000Z","end_at": "2019-05-21T17:00:00.000000Z","created_at": "2019-05-22T10:32:38.118753Z","notified_at": "2019-05-22T10:38:19.874623Z","accepted_at": "2019-05-23T12:02:53.027482Z",}, {"id": "8a726186-a4e4-42e0-b56e-20fd17dc67ba","amount": "10.00","cost": "13.79","currency": "SEK","description": "Lön genom Gigapay","employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2","invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7","metadata": {"job_id": 128},"start_at": "2019-05-22T08:00:00.000000Z","end_at": "2019-05-22T17:00:00.000000Z","created_at": "2019-05-23T10:32:38.118753Z","notified_at": "2019-05-23T11:46:29.298742Z","accepted_at": "2019-05-23T12:02:16.472846Z",}]
[{},{"employee": ["Object with id "+46703000000" does not exist."]}]
amount
or cost
is required.amount
or cost
is required.{"id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa","amount": "100.00","cost": "137.99","currency": "SEK","description": "Lön genom Gigapay","employee": {"id": "1f1d1263-0e79-4787-b573-6df81b44bfc2","name": "Albin Lindskog","cellphone_number": "+46703000000","email": null,"country": "SWE","metadata": {"user_id": 2,},"created_at": "2019-05-22T10:32:36.118753Z","verified_at": null,},"invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e","metadata": {"job_id": 127},"start_at": "2019-05-21T08:00:00.000000Z","end_at": "2019-05-21T17:00:00.000000Z","created_at": "2019-05-22T10:32:38.118753Z","notified_at": null,"accepted_at": null,}
{"employee": {"non_field_errors": ["Either email or cellphone_number is required."]}}
{"count": 4,"next": null,"previous": "https://api.gigapay.se/v2/payouts/?page=1","results": [{"id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa","amount": "100.00","cost": "137.99","currency": "SEK","description": "Lön genom Gigapay","employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2","invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e","metadata": {"job_id": 127},"start_at": "2019-05-21T08:00:00.000000Z","end_at": "2019-05-21T17:00:00.000000Z","created_at": "2019-05-22T10:32:38.118753Z","notified_at": "2019-05-22T10:38:19.874623Z","accepted_at": "2019-05-23T12:02:53.027482Z",}, {"id": "8a726186-a4e4-42e0-b56e-20fd17dc67ba","amount": "10.00","cost": "13.79","currency": "SEK","description": "Lön genom Gigapay","employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2","invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7","metadata": {"job_id": 128},"start_at": "2019-05-22T08:00:00.000000Z","end_at": "2019-05-22T17:00:00.000000Z","created_at": "2019-05-23T10:32:38.118753Z","notified_at": "2019-05-23T11:46:29.298742Z","accepted_at": "2019-05-23T12:02:16.472846Z",}]}
{"id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa","amount": "100.00","cost": "137.99","currency": "SEK","description": "Lön genom Gigapay","employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2","invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e","metadata": {"job_id": 127},"start_at": "2019-05-21T08:00:00.000000Z","end_at": "2019-05-21T17:00:00.000000Z","created_at": "2019-05-22T10:32:38.118753Z","notified_at": "2019-05-22T10:38:19.874623Z","accepted_at": "2019-05-23T12:02:53.027482Z",}