Customers & Suppliers

All API Operations related with Customers & Suppliers

READ Scope

List all Customers or Suppliers

Retrieves all the customers or suppliers that match with provided filters

GEThttps://api.nuvio.io/v1/business-entities

Query parameters

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataarray of Business Entities

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/business-entities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "entityCode": "text",
      "name": "text",
      "legalName": "text",
      "vatNumber": "text",
      "taxOffice": "text",
      "address": "text",
      "city": "text",
      "country": "text",
      "district": "text",
      "state": "text",
      "postalCode": "text",
      "email": "text",
      "phone": "text",
      "iban": "text",
      "isCustomer": false,
      "isSupplier": false
    }
  ]
}

Get a Customer or Supplier by ID

Retrieves a customer or supplier by its unique ID or user-generated customer or supplier ID.

GEThttps://api.nuvio.io/v1/business-entities/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataBusiness Entity

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/business-entities/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "entityCode": "text",
    "name": "text",
    "legalName": "text",
    "vatNumber": "text",
    "taxOffice": "text",
    "address": "text",
    "city": "text",
    "country": "text",
    "district": "text",
    "state": "text",
    "postalCode": "text",
    "email": "text",
    "phone": "text",
    "iban": "text",
    "isCustomer": false,
    "isSupplier": false
  }
}

WRITE Scope

Create a new Customer or Supplier

Creates a new Customer or Supplier from scratch

POSThttps://api.nuvio.io/v1/business-entities

Body

application/jsontext/jsonapplication/*+json

entityCodestring

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

name*string

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

isCustomerboolean

Should be true if this business entity is a customer.

isSupplierboolean

Should be true if this business entity is a supplier.

legalNamestring

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

vatNumberstring

TaxID or VAT number of the business entity.

taxOfficestring

Registered Tax office.

addressstring

Billing Address of the business entity.

citystring

City of the registered billing address.

countrystring

Country of the registered billing address. You can find the available countries here.

districtstring

District / region of the registered billing address.

statestring

State of the registered billing address.

postalCodestring

Postal code of the registered billing address.

emailstring

Contact person's email

phonestring

Company's or contact person's phone

ibanstring

IBAN number of the bank account of the business entity.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataBusiness Entity

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/business-entities', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "entityCode": "text",
    "name": "text",
    "legalName": "text",
    "vatNumber": "text",
    "taxOffice": "text",
    "address": "text",
    "city": "text",
    "country": "text",
    "district": "text",
    "state": "text",
    "postalCode": "text",
    "email": "text",
    "phone": "text",
    "iban": "text",
    "isCustomer": false,
    "isSupplier": false
  }
}

UPDATE Scope

Update Customer or Supplier

Updates an existing customer or supplier

PUThttps://api.nuvio.io/v1/business-entities/{id}

Path parameters

id*string (uuid)

Body

application/jsontext/jsonapplication/*+json

entityCodestring

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

namestring

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

isCustomernullable boolean

Should be true if this business entity is a customer.

isSuppliernullable boolean

Should be true if this business entity is a supplier.

legalNamestring

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

vatNumberstring

TaxID or VAT number of the business entity.

taxOfficestring

Registered Tax office.

addressstring

Billing Address of the business entity.

citystring

City of the registered billing address.

countrystring

Country of the registered billing address. You can find the available countries here.

districtstring

District / region of the registered billing address.

statestring

State of the registered billing address.

postalCodestring

Postal code of the registered billing address.

emailstring

Contact person's email

phonestring

Company's or contact person's phone

ibanstring

IBAN number of the bank account of the business entity.

Response

200

OK

Body

application/json

successboolean

errorsnullable array of string

dataBusiness Entity

Request

JavaScriptCurlPython

const response = await fetch('https://api.nuvio.io/v1/business-entities/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "entityCode": "text",
    "name": "text",
    "legalName": "text",
    "vatNumber": "text",
    "taxOffice": "text",
    "address": "text",
    "city": "text",
    "country": "text",
    "district": "text",
    "state": "text",
    "postalCode": "text",
    "email": "text",
    "phone": "text",
    "iban": "text",
    "isCustomer": false,
    "isSupplier": false
  }
}