Create partner

post

https://stage-api.findity.com/api/v1/admin/partners

Creates a new partner. Only name is required (it must be a non-blank string); partnerCode, vat, sendEventToExternalSystem and settings are optional. The partner is always created under the caller's own client application - clientApplicationId cannot be set via the request body and is derived from the caller. The created partner is returned including its generated id and dateCreated.

Body Params

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.

Responses

201Partner created

400Bad request - invalid JSON body, no known properties, missing/invalid name, an unrecognized settings key, or a duplicate partnerCode