Pricing

The Pricing endpoint allows you to calculate the price of payout you would like to make, and to retrieve the price information about previously made payouts. The endpoint is designed to mirror the Payouts endpoint as closely as possible, e.g. the same request can be used to retrieve the price information of a Payout you'd like to make and to actually make it.

The Price Breakdown

Attribute

Description

amount

Decimal formatted string of the gross amount.

cost

Decimal formatted string of the salary cost.

currency

ISO-4217 currency code.

fee

Decimal formatted string of Gigapay's fee for this Payout.

health_insurance

Decimal formatted string of the cost of mandated health insurance. Will be none if health insurance is not mandated.

payroll

Decimal formatted string of the payroll taxes.

pension

Decimal formatted string of the cost of mandated pension. Will be none if pension is not mandated.

tax

Decimal formatted string of the preliminary income taxes the will be reported and paid on behalf of the recipient.

vat

Decimal formatted string of the VAT for the Payout.

post
Calculate pricing info

https://api.gigapy.se/v2/pricing/
This endpoint allows you to calculate the price of payout you would like to make.
Request
Response
Request
Headers
Authorization
required
string
Authentication token.
Integration-ID
required
string
Integration ID.
Idempotency-Key
optional
string
Idempotency key.
Body Parameters
id
optional
string
A unique identifier for the object. The same identifier can be reused when creating a Payout.
amount
optional
string
A decimal formatted string of the gross amount. Either amount or cost is required.
cost
optional
string
A decimal formatted string of the salary cost. Either amount or cost is required.
currency
required
string
ISO-4217 currency code.
description
required
string
A description of the gig, displayed to the recipient. The max length is 200 characters.
full_salary_specification
optional
boolean
Whether to show a full salary specification to the recipient. Defaults to False.
employee
required
object
Unique identifier for the Employee that is the recipient of the Payout.
metadata
optional
object
JSON-encoded metadata. If none is provided will an empty object be used.
start_at
optional
string
ISO-8601 formatted string specifying when the gig will start. Required for insured gigs.
end_at
optional
string
ISO-8601 formatted string specifying when the gig will end. Required for insured gigs.
Response
200: OK
Pricing successfully calculated.
{
"amount": "3000.00",
"cost": "4139.73",
"currency": "SEK",
"fee": "197.13",
"health_insurance": None,
"payroll": "942.60",
"pension": None,
"tax": "900.00",
"vat": "1034.93"
}
400: Bad Request
Body contained an apparrant error.
{
"employee": [
"Object with id "+46703000000" does not exist."
]
}

post
Calculate bulk pricing info

https://api.gigapay.se/v2/pricing/
The same endpoint can be used to calcualte the pricing info for multiple Payouts at once by posting an array of data.
Request
Response
Request
Headers
Authorization
required
string
Authentication token.
Integration-ID
required
string
Integration ID.
Idempotency-Key
optional
string
Idempotency key.
Body Parameters
required
array
An array of the data required to calculate the pricing info following the same format as above.
Response
200: OK
Pricing info successfully calculated.
[
{
"amount": "1000.00",
"cost": "1379.91",
"currency": "SEK",
"fee": "65.71",
"health_insurance": None,
"payroll": "314.20",
"pension": None,
"tax": "300.00",
"vat": "344.97"
}, {
"amount": "3000.00",
"cost": "4139.73",
"currency": "SEK",
"fee": "197.13",
"health_insurance": None,
"payroll": "942.60",
"pension": None,
"tax": "900.00",
"vat": "1034.93"
}
]
400: Bad Request
Body contained an apparent error. Note that in this example only the data for the second Payout contained an error.
[
{},
{
"employee": [
"Object with id "+46703000000" does not exist."
]
}
]

post
Calculate pricing info with an inline employee

https://api.gigapay.se/v2/pricing/?expand=employee
The same endpoint can be used to calculate the pricing info with an Employee that does not exist yet.
Request
Response
Request
Headers
Authorization
required
string
Authentication Token.
Integration-ID
required
string
Integration ID.
Idempotency-Key
optional
string
Idempotency key.
Body Parameters
id
optional
string
A unique identifier for the object. The same identifier can be reused when creating a Payout.
amount
optional
string
A decimal formatted string of the gross amount. Either amount or cost is required.
cost
optional
string
A decimal formatted string of the salary cost. Either amount or cost is required.
currency
required
string
ISO-4217 currency code.
description
required
string
Description of the gig, displayed to the recipient. The max length is 200 characters.
full_salary_specification
optional
boolean
Whether to show a full salary specification to the recipient. Defaults to False.
employee
required
object
The data required to create an Employee, following the same format as in the Employee endpoint. If there is already an Employee matching the provided data will it be used instead of creating a new Employee.
metadata
optional
object
JSON-encoded metadata. If none is provided will an empty object be used.
start_at
optional
string
ISO-8601 formatted string detailing when the gig will start. Required for insured gigs.
end_at
optional
string
ISO-8601 formatted string detailing when the gig will end. Required for insured gigs.
Response
200: OK
Pricing successfully calculated.
{
"amount": "3000.00",
"cost": "4139.73",
"currency": "SEK",
"fee": "197.13",
"health_insurance": None,
"payroll": "942.60",
"pension": None,
"tax": "900.00",
"vat": "1034.93"
}
400: Bad Request
Body contained an apparent error.
{
"employee": {
"non_field_errors": [
"Either email or cellphone_number is required."
]
}
}

get
List pricing info

https://api.gigapay.se/v2/pricing/
Endpoint for listing pricing info for previously created Payouts. The pricing info is sorted by creation date, with the info for the most recently created payout appearing first.
Request
Response
Request
Headers
Authorization
required
string
Authentication Token.
Integration-ID
required
string
Integration ID.
Query Parameters
page
optional
number
Which page to return.
page_size
optional
number
The number of Payouts to provide pricing info for per page.
employee
optional
string
Filter out the pricing info for all Payouts belonging to the Employee with the provided identifier.
invoice
optional
string
Filter out the pricing info for all Payouts beloning to the Invoice with the provided identifier
Response
200: OK
Pricing info successfully listed.
{
"count": 4,
"next": null,
"previous": "https://api.gigapay.se/v2/payouts/?page=1",
"results": [
{
"amount": "1000.00",
"cost": "1379.91",
"currency": "SEK",
"fee": "65.71",
"health_insurance": None,
"payroll": "314.20",
"pension": None,
"tax": "300.00",
"vat": "344.97"
}, {
"amount": "3000.00",
"cost": "4139.73",
"currency": "SEK",
"fee": "197.13",
"health_insurance": None,
"payroll": "942.60",
"pension": None,
"tax": "900.00",
"vat": "1034.93"
}
]
}

get
Retrieve pricing info

https://api.gigapay.se/v2/pricing/:id/
Endpoint for retrieving the pricing info for a specific Payout.
Request
Response
Request
Path Parameters
id
required
string
The identifier for the Payout to provide pricing info for.
Headers
Authorization
required
string
Authentication token.
Integration-ID
required
string
Integration ID.
Response
200: OK
Pricing info successfully retrieved.
{
"amount": "3000.00",
"cost": "4139.73",
"currency": "SEK",
"fee": "197.13",
"health_insurance": None,
"payroll": "942.60",
"pension": None,
"tax": "900.00",
"vat": "1034.93"
}