Skip to main content
Create a supplier in the accounting system

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
company_id
string<uuid>
required

The workspace company whose accounting system the supplier is created in: the one that company's invoices are sent to.

name
string

The name it gets there. Left out, our supplier's name.

Required string length: 1 - 255
street
string | null

Its postal address there. Left out, our supplier's; null sends none.

Maximum string length: 255
postal_code
string | null

Left out, our supplier's; null sends none.

Maximum string length: 100
city
string | null

Left out, our supplier's; null sends none.

Maximum string length: 100
country
string | null

The address's country, ISO 3166-1 alpha-2. Left out, our supplier's (Norway without one); null sends none.

Pattern: ^[A-Za-z]{2}$
bank_account
string | null

The bank account put on its card there, as the person checked it (the app proposes the invoice's): a Norwegian account, 11 digits or its NO IBAN. Left out or null, none, and the send saves its invoices to pay later until one is on the card.

Maximum string length: 50

Response

The supplier's links.

data
object[]
required

Set while the connection that sends invoices has no link for the supplier and holds no one active supplier with its organization number for sending to link. Its invoices are then held in Inbox (supplier_not_in_erp) and not sent until someone creates or links it: Watchdog never creates a supplier there on its own. can_create: createErpSupplier creates it there from its name, Norwegian organization number and address, and links it. Otherwise someone links it to an entry of that connection's register (linkErpSupplier), or adds it there: no_org_number (no Norwegian organization number, so Watchdog does not create it), same_name (one there has its name but no organization number), ambiguous (several there have its number), inactive (the one with its number is inactive there). From the register as last synced; a create looks there again. Null when no connection sends invoices.