Skip to main content
POST
Create partner

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload used to create a partner. The partner is always created under the caller's own client application - there is no way to set clientApplicationId via this request.

name
string
required

Partner name. Required, must be a non-blank string.

partnerCode
string

Partner code. Must be unique; if omitted, one is generated automatically. Free-form string - the server does not enforce a length limit or character-set restriction on it beyond the uniqueness check.

vat
string

VAT number. Free-form string - the server does not validate, normalize, or restrict its format.

sendEventToExternalSystem
boolean

Whether events should be sent to an external system

settings
object

Partner settings map. Only these top-level keys are allowed: maxNumberOfCards, numberOfReportGroups, showReportOverview, fieldSettings, fortnox. Any other top-level key is rejected with INVALID_PARTNER_SETTINGS_KEY.

Response

Partner created

Partner resource returned when a partner is created or updated.

id
string
required

Partner external ID

name
string
required

Partner name

clientApplicationId
string
required

Client application that owns the partner

dateCreated
string<date-time>
required

Creation date

partnerCode
string | null

Partner code

vat
string | null

VAT number

sendEventToExternalSystem
boolean | null

Whether events are sent to an external system

settings
object

Partner settings map. Only these top-level keys are allowed: maxNumberOfCards, numberOfReportGroups, showReportOverview, fieldSettings, fortnox. Any other top-level key is rejected with INVALID_PARTNER_SETTINGS_KEY.