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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/business-entities' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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
    }
  ]
}

OK

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

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/business-entities/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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
  }
}

OK

WRITE Scope

Create a new Customer or Supplier

post

Creates a new Customer or Supplier from scratch

Authorizations

Body

application/jsontext/jsonapplication/*+json

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/business-entities' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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

200

{
  "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
  }
}

OK

UPDATE Scope

Update Customer or Supplier

put

Updates an existing customer or supplier

Authorizations

Path parameters

idstring · uuidrequired

Body

application/jsontext/jsonapplication/*+json

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.nuvio.io/v1/business-entities/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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

200

{
  "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
  }
}

OK