Create a new Customer or Supplier

Creates a new Customer or Supplier from scratch

View as Markdown

POST /v1/business-entities

Needs an API key with the write scope.

Parameters

name string Required

A short name for this customer / supplier. This will be the visible name of this business entity.

More parameters

entityCode string

A unique code for this customer / supplier. Should be a unique alpha numeric string.
isCustomer boolean

Should be true if this business entity is a customer.
isSupplier boolean

Should be true if this business entity is a supplier.
legalName string

Legal company name for this business entity that is going to be used in invoices and billing.
vatNumber string

TaxID or VAT number of the business entity.
taxOffice string

Registered Tax office.
address string

Billing Address of the business entity.
city string

City of the registered billing address.
country string

Country of the registered billing address.
district string

District / region of the registered billing address.
state string

State of the registered billing address.
postalCode string

Postal code of the registered billing address.
email string

Contact person's email
phone string

Company's or contact person's phone
iban string

IBAN number of the bank account of the business entity.

Returns

The created customer or supplier.

401: No usable Authorization: Bearer {token} header (1002).
403: The access token is unknown, or lacks the scope this route needs (1001).

POST /v1/business-entities

curl -X POST https://api.nuvio.io/v1/business-entities \
  -H "Authorization: Bearer $NUVIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Supplies"
  }'

const response = await fetch('https://api.nuvio.io/v1/business-entities', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NUVIO_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme Supplies"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://api.nuvio.io/v1/business-entities",
    headers={"Authorization": f"Bearer {os.environ['NUVIO_API_TOKEN']}"},
    json={
        "name": "Acme Supplies",
    },
)
data = response.json()["data"]

Response

{
  "success": true,
  "errors": null,
  "data": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "entityCode": "ACME-01",
    "name": "Acme Supplies",
    "legalName": "Acme Supplies",
    "vatNumber": "INV-2026-0042",
    "taxOffice": "string",
    "address": "100 Main Street",
    "city": "Toronto",
    "country": "string",
    "district": "string",
    "state": "string",
    "postalCode": "ACME-01",
    "email": "billing@example.com",
    "phone": "+1 555 0100",
    "iban": "string",
    "isCustomer": true,
    "isSupplier": true
  }
}