API Reference

Create an invoice settlement

post
https://api.bokio.se/v1/companies//invoices//settlements

Create a settlement for the invoice that will reduce the outstanding amount of the invoice. A negative amount will increase the outstanding amount. For example, in the case of a currency gain.

📘

Settlement types that can be created in Bokio API

  • currency
  • bankFee
  • paymentServiceFee

Scope: invoices:write

Path Params
uuid
required

Unique identifier of the company

uuid
required

Unique identifier of the invoice

Body Params
string
enum
required

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.

  • Payment service fees are for charges from payment service providers (e.g. Stripe). Available for Swedish companies only. Requires vatScheme in the settlement details.

Allowed:
invoiceSettlementDetails
required

The settlement details specific to the settlement type

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?