Skip to main content
GET
Get a contribution settlement
Preview. A contract we are building with design partners. It is not callable yet, and fields can still change. See Availability.

Authorizations

Authorization
string
header
required

Your partner secret key, mk_live_… for real companies or mk_test_… for test companies. Keep it on your servers. See Authentication.

Path Parameters

company_id
string<uuid>
required

The company's ID. Every company-scoped call works in exactly this company.

settlement_id
string<uuid>
required

Response

The settlement.

id
string<uuid>
required
period
string
required

The month

contribution_account
string
required

The CCC.

status
enum<string>
required

calculated: the TGSS calculated the draft. discrepancy: it does not match the payroll run; discrepancies says where. confirmed: Melso confirmed it and the direct debit is set. paid: charged.

Available options:
requested,
calculated,
discrepancy,
confirmed,
paid,
overdue
due_date
string<date>
required

The last day of the month after period.

employer_contribution
string

An amount in euros as a decimal string with two decimals, such as "121.00".

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"121.00"

employee_contribution
string

An amount in euros as a decimal string with two decimals, such as "121.00".

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"121.00"

total
string

An amount in euros as a decimal string with two decimals, such as "121.00".

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"121.00"

workers
integer
payroll_run_id
string<uuid> | null
discrepancies
object[]
documents
object