Create/Update organization

post

https://stage-expense.findity.com/api/admin/organizations/externalid/{externalId}/

Creates a new organization or updates an existing one, identified by its external source ID. If no organization exists with this external ID, a new one is created — className is required in this case. If one exists, the supplied fields are merged into it.

Path Params

externalId

string

required

The external source id of the organization

Body Params

The organization payload. When creating, className is required and must be com.findity.consumer.Company. When updating, only the fields you want to change need to be supplied.

vat

string

VAT or company registration number for the organization.

partnerCode

string

Code of the partner that should own this organization. The partner must exist in the calling client application.

address

object

The organization's primary address.

className

string

Required when creating an organization, and should then always be set to com.findity.consumer.Company

licenses

object of objects

License assignments to grant the organization. Array of {type, price, quantity} items.

settings

object

Organization-level settings. All fields are optional.

name

string

Display name of the organization.

externalSourceId

string

The external identifier used to identify this specific Organization. This variable is required if you are creating or updating an Organization

Headers

Content-Type

string

Defaults to application/json

Standard application/json content type.

X-Findity-ApiVersion

string

Defaults to 3

Findity API version. Use 3 for the current admin API.

Response

200

Organization created or updated successfully. Returns the resulting organization object in the same shape as GET.

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here!