Customers & Suppliers

All API Operations related with Customers & Suppliers

READ Scope

List all Customers or Suppliers

get

Retrieves all the customers or suppliers that match with provided filters

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Query parameters

isSupplierbooleanOptional

Send this as true if you would like to list suppliers.

isCustomerbooleanOptional

Send this as true if you would like to list customers.

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/business-entities

HTTPcURLJavaScriptPython

GET /v1/business-entities HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "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": true,
      "isSupplier": true
    }
  ]
}

Get a Customer or Supplier by ID

get

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

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstringRequired

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

get

/v1/business-entities/{id}

HTTPcURLJavaScriptPython

GET /v1/business-entities/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "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": true,
    "isSupplier": true
  }
}

WRITE Scope

Create a new Customer or Supplier

post

Creates a new Customer or Supplier from scratch

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

post

/v1/business-entities

HTTPcURLJavaScriptPython

POST /v1/business-entities HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "entityCode": "text",
  "name": "text",
  "isCustomer": true,
  "isSupplier": true,
  "legalName": "text",
  "vatNumber": "text",
  "taxOffice": "text",
  "address": "text",
  "city": "text",
  "country": "text",
  "district": "text",
  "state": "text",
  "postalCode": "text",
  "email": "text",
  "phone": "text",
  "iban": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "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": true,
    "isSupplier": true
  }
}

UPDATE Scope

Update Customer or Supplier

put

Updates an existing customer or supplier

Authorizations

Bearer

AuthorizationstringRequired

API Key Authentication

Path parameters

idstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

application/json

successbooleanOptional

errorsstring[] · nullableOptional

put

/v1/business-entities/{id}

HTTPcURLJavaScriptPython

PUT /v1/business-entities/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "entityCode": "text",
  "name": "text",
  "isCustomer": true,
  "isSupplier": true,
  "legalName": "text",
  "vatNumber": "text",
  "taxOffice": "text",
  "address": "text",
  "city": "text",
  "country": "text",
  "district": "text",
  "state": "text",
  "postalCode": "text",
  "email": "text",
  "phone": "text",
  "iban": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "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": true,
    "isSupplier": true
  }
}