Settlements

Endpointhttps://api.kontorion.eu/v1

List settlements

GET

https://api.kontorion.eu/v1

/settlements

Lists settlements with cursor-based pagination and the unified field.op=value filter grammar (status, customer_id, currency, settlement_number, created_at, updated_at, finalized_at, paid_at, period_start, period_end).

List settlements › query Parameters

limit

integer

Number of items per page

cursor

string

Pagination cursor

customer_id

string

Filter by customer UUID (supports customer_id.in=...)

status

string

Filter by settlement status (sugar for status.eq=...; supports status.in=a,b)

List settlements › Responses

Paginated list wrapped in data envelope

object[]

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

GET/settlements

curl --request GET \
  --url https://api.kontorion.eu/v1/settlements

shell

Example Responses

{
  "key": [
    {
      "created_at": "created_at",
      "currency": "currency",
      "customer_id": "customer_id",
      "deleted_at": "deleted_at",
      "finalized_at": "finalized_at",
      "gross_earnings": 0,
      "id": "id",
      "lines": [
        {
          "amount": 0,
          "created_at": "created_at",
          "description": "description",
          "id": "id",
          "line_type": "EARNING",
          "metadata": {
            "key": {}
          },
          "organization_id": "organization_id",
          "reference_id": "reference_id",
          "reverse_charge": true,
          "settlement_id": "settlement_id",
          "tax_amount": 0,
          "tax_category_code": "S",
          "tax_rate": 0,
          "tax_rule_id": "tax_rule_id"
        }
      ],
      "metadata": {
        "key": {}
      },
      "net_payout": 0,
      "organization_id": "organization_id",
      "paid_at": "paid_at",
      "period_end": "period_end",
      "period_start": "period_start",
      "settlement_number": "settlement_number",
      "status": "draft",
      "total_fee_tax": 0,
      "total_fees": 0,
      "updated_at": "updated_at"
    }
  ]
}

json

application/json

Generate a draft settlement

POST

https://api.kontorion.eu/v1

/settlements/generate

Creates a draft settlement for a customer over a billing period

Generate a draft settlement › Request Body

currency

string

customer_id

string

object[]

object

period_end

string

period_start

string

Generate a draft settlement › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

POST/settlements/generate

curl --request POST \
  --url https://api.kontorion.eu/v1/settlements/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "currency",
  "customer_id": "customer_id",
  "lines": [
    {
      "amount": 0,
      "description": "description",
      "line_type": "EARNING",
      "metadata": {
        "key": {}
      },
      "reference_id": "reference_id"
    }
  ],
  "metadata": {
    "key": {}
  },
  "period_end": "period_end",
  "period_start": "period_start"
}
'

shell

Example Request Body

{
  "currency": "currency",
  "customer_id": "customer_id",
  "lines": [
    {
      "amount": 0,
      "description": "description",
      "line_type": "EARNING",
      "metadata": {
        "key": {}
      },
      "reference_id": "reference_id"
    }
  ],
  "metadata": {
    "key": {}
  },
  "period_end": "period_end",
  "period_start": "period_start"
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "currency": "currency",
    "customer_id": "customer_id",
    "deleted_at": "deleted_at",
    "finalized_at": "finalized_at",
    "gross_earnings": 0,
    "id": "id",
    "lines": [
      {
        "amount": 0,
        "created_at": "created_at",
        "description": "description",
        "id": "id",
        "line_type": "EARNING",
        "metadata": {
          "key": {}
        },
        "organization_id": "organization_id",
        "reference_id": "reference_id",
        "reverse_charge": true,
        "settlement_id": "settlement_id",
        "tax_amount": 0,
        "tax_category_code": "S",
        "tax_rate": 0,
        "tax_rule_id": "tax_rule_id"
      }
    ],
    "metadata": {
      "key": {}
    },
    "net_payout": 0,
    "organization_id": "organization_id",
    "paid_at": "paid_at",
    "period_end": "period_end",
    "period_start": "period_start",
    "settlement_number": "settlement_number",
    "status": "draft",
    "total_fee_tax": 0,
    "total_fees": 0,
    "updated_at": "updated_at"
  }
}

json

application/json

Get a settlement

GET

https://api.kontorion.eu/v1

/settlements/{id}

Retrieves a settlement by ID including its lines

Get a settlement › path Parameters

id

string · required

Settlement UUID

Get a settlement › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

GET/settlements/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/settlements/:id

shell

Example Responses

{
  "key": {
    "created_at": "created_at",
    "currency": "currency",
    "customer_id": "customer_id",
    "deleted_at": "deleted_at",
    "finalized_at": "finalized_at",
    "gross_earnings": 0,
    "id": "id",
    "lines": [
      {
        "amount": 0,
        "created_at": "created_at",
        "description": "description",
        "id": "id",
        "line_type": "EARNING",
        "metadata": {
          "key": {}
        },
        "organization_id": "organization_id",
        "reference_id": "reference_id",
        "reverse_charge": true,
        "settlement_id": "settlement_id",
        "tax_amount": 0,
        "tax_category_code": "S",
        "tax_rate": 0,
        "tax_rule_id": "tax_rule_id"
      }
    ],
    "metadata": {
      "key": {}
    },
    "net_payout": 0,
    "organization_id": "organization_id",
    "paid_at": "paid_at",
    "period_end": "period_end",
    "period_start": "period_start",
    "settlement_number": "settlement_number",
    "status": "draft",
    "total_fee_tax": 0,
    "total_fees": 0,
    "updated_at": "updated_at"
  }
}

json

application/json

Finalize a settlement

POST

https://api.kontorion.eu/v1

/settlements/{id}/finalize

Finalizes a draft settlement, locking it for payout

Finalize a settlement › path Parameters

id

string · required

Settlement UUID

Finalize a settlement › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

POST/settlements/{id}/finalize

curl --request POST \
  --url https://api.kontorion.eu/v1/settlements/:id/finalize

shell

Example Responses

{
  "key": {
    "created_at": "created_at",
    "currency": "currency",
    "customer_id": "customer_id",
    "deleted_at": "deleted_at",
    "finalized_at": "finalized_at",
    "gross_earnings": 0,
    "id": "id",
    "lines": [
      {
        "amount": 0,
        "created_at": "created_at",
        "description": "description",
        "id": "id",
        "line_type": "EARNING",
        "metadata": {
          "key": {}
        },
        "organization_id": "organization_id",
        "reference_id": "reference_id",
        "reverse_charge": true,
        "settlement_id": "settlement_id",
        "tax_amount": 0,
        "tax_category_code": "S",
        "tax_rate": 0,
        "tax_rule_id": "tax_rule_id"
      }
    ],
    "metadata": {
      "key": {}
    },
    "net_payout": 0,
    "organization_id": "organization_id",
    "paid_at": "paid_at",
    "period_end": "period_end",
    "period_start": "period_start",
    "settlement_number": "settlement_number",
    "status": "draft",
    "total_fee_tax": 0,
    "total_fees": 0,
    "updated_at": "updated_at"
  }
}

json

application/json

List settlement lines

GET

https://api.kontorion.eu/v1

/settlements/{id}/lines

Lists all line items for a specific settlement

List settlement lines › path Parameters

id

string · required

Settlement UUID

List settlement lines › Responses

List wrapped in data envelope

object[]

amount

number

created_at

string

description

string

id

string

line_type

string · enum

Enum values:

EARNING

TRANSACTION_FEE

SUBSCRIPTION_FEE

ADVERTISING_FEE

OTHER_FEE

object

organization_id

string

reference_id

string

reverse_charge

boolean

settlement_id

string

tax_amount

number

tax_category_code

string · enum

Enum values:

tax_rate

number

tax_rule_id

string

Record a settlement payout

POST

https://api.kontorion.eu/v1

/settlements/{id}/record-payout

Marks a finalized settlement as paid out

Record a settlement payout › path Parameters

id

string · required

Settlement UUID

Record a settlement payout › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

POST/settlements/{id}/record-payout

curl --request POST \
  --url https://api.kontorion.eu/v1/settlements/:id/record-payout

shell

Example Responses

{
  "key": {
    "created_at": "created_at",
    "currency": "currency",
    "customer_id": "customer_id",
    "deleted_at": "deleted_at",
    "finalized_at": "finalized_at",
    "gross_earnings": 0,
    "id": "id",
    "lines": [
      {
        "amount": 0,
        "created_at": "created_at",
        "description": "description",
        "id": "id",
        "line_type": "EARNING",
        "metadata": {
          "key": {}
        },
        "organization_id": "organization_id",
        "reference_id": "reference_id",
        "reverse_charge": true,
        "settlement_id": "settlement_id",
        "tax_amount": 0,
        "tax_category_code": "S",
        "tax_rate": 0,
        "tax_rule_id": "tax_rule_id"
      }
    ],
    "metadata": {
      "key": {}
    },
    "net_payout": 0,
    "organization_id": "organization_id",
    "paid_at": "paid_at",
    "period_end": "period_end",
    "period_start": "period_start",
    "settlement_number": "settlement_number",
    "status": "draft",
    "total_fee_tax": 0,
    "total_fees": 0,
    "updated_at": "updated_at"
  }
}

json

application/json

Segment Rules Scheduling/TaxRules

List settlements

GET

https://api.kontorion.eu/v1

/settlements

List settlements › query Parameters

limit

integer

Number of items per page

cursor

string

Pagination cursor

customer_id

string

Filter by customer UUID (supports customer_id.in=...)

status

string

Filter by settlement status (sugar for status.eq=...; supports status.in=a,b)

List settlements › Responses

Paginated list wrapped in data envelope

object[]

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

Generate a draft settlement

POST

https://api.kontorion.eu/v1

/settlements/generate

Creates a draft settlement for a customer over a billing period

Generate a draft settlement › Request Body

currency

string

customer_id

string

object[]

object

period_end

string

period_start

string

Generate a draft settlement › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

Get a settlement

GET

https://api.kontorion.eu/v1

/settlements/{id}

Retrieves a settlement by ID including its lines

Get a settlement › path Parameters

id

string · required

Settlement UUID

Get a settlement › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

Finalize a settlement

POST

https://api.kontorion.eu/v1

/settlements/{id}/finalize

Finalizes a draft settlement, locking it for payout

Finalize a settlement › path Parameters

id

string · required

Settlement UUID

Finalize a settlement › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string

List settlement lines

GET

https://api.kontorion.eu/v1

/settlements/{id}/lines

Lists all line items for a specific settlement

List settlement lines › path Parameters

id

string · required

Settlement UUID

List settlement lines › Responses

List wrapped in data envelope

object[]

amount

number

created_at

string

description

string

id

string

line_type

string · enum

Enum values:

EARNING

TRANSACTION_FEE

SUBSCRIPTION_FEE

ADVERTISING_FEE

OTHER_FEE

object

organization_id

string

reference_id

string

reverse_charge

boolean

settlement_id

string

tax_amount

number

tax_category_code

string · enum

Enum values:

tax_rate

number

tax_rule_id

string

Record a settlement payout

POST

https://api.kontorion.eu/v1

/settlements/{id}/record-payout

Marks a finalized settlement as paid out

Record a settlement payout › path Parameters

id

string · required

Settlement UUID

Record a settlement payout › Responses

Wrapped in data envelope

created_at

string

currency

string

customer_id

string

deleted_at

string

finalized_at

string

gross_earnings

number

id

string

object[]

object

net_payout

number

organization_id

string

paid_at

string

period_end

string

period_start

string

settlement_number

string

status

string · enum

Enum values:

draft

finalized

paid

total_fee_tax

number

total_fees

number

updated_at

string