v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

invoices

Get an invoice settlement

Retrieve the information of the specific settlement with the matching settlementId.

Scope: invoices:read

get/companies/{companyId}/invoices/{invoiceId}/settlements/{settlementId}

Response

Settlement

idstring uuid

The unique identifier of the settlement

invoiceIdstring uuid

The unique identifier of the invoice this settlement belongs to

type'currency' | 'bankFee' | 'badDebt' | 'balanceAdjustment' | 'paymentServiceFee'

The type of the settlement.

Currency adjustments are for changes in exchange rates. Currency gain or currency loss is reflected in sumBaseCurrency being positive or negative respectively.
Bank fees are for charges from banks or payment providers.
Bad debts are for uncollectible invoices.
Balance adjustments are for correcting discrepancies on invoices without affecting bookkeeping.
Payment service fees are for charges from payment service providers (e.g. Stripe). Available for Swedish companies only. Supports different VAT schemes for domestic, EU, non-EU, and VAT-exempt transactions.

Example response

{
  "id": "c529df79-eb7f-5ef0-a8dc-c2b71f953554",
  "invoiceId": "a419cf69-db6f-4de9-992c-b1a60942a443",
  "type": "bankFee",
  "invoiceSettlementDetails": {
    "date": "2024-10-15",
    "sumBaseCurrency": 15.5
  },
  "journalEntryRef": {
    "id": "55c899c5-82b2-4a09-899e-9dc03342b5dc"
  }
}