API Reference
GuidesAPI ReferenceSign In
  • Introduction
  • Authentication
  • Scopes
  • Errors
  • Endpoints
    • Accounts & Transactions
    • Customers & Suppliers
    • Expenses
    • Income
    • Payments
    • Products & Services
    • Projects
    • Tags
    • Taxes
  • Common Models
    • Countries
    • Currencies
Powered by GitBook
On this page
  1. Endpoints

Customers & Suppliers

All API Operations related with Customers & Suppliers

PreviousAccounts & TransactionsNextExpenses

Last updated 9 months ago

READ Scope

WRITE Scope

UPDATE 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
200
OK
application/json
get
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
Path parameters
idstringRequired
Responses
200
OK
application/json
get
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
  }
}
  • READ Scope
  • GETList all Customers or Suppliers
  • GETGet a Customer or Supplier by ID
  • WRITE Scope
  • POSTCreate a new Customer or Supplier
  • UPDATE Scope
  • PUTUpdate Customer or Supplier

Create a new Customer or Supplier

post

Creates a new Customer or Supplier from scratch

Authorizations
Body
all ofOptional
Responses
200
OK
application/json
post
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"
}
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 Customer or Supplier

put

Updates an existing customer or supplier

Authorizations
Path parameters
idstring ยท uuidRequired
Body
all ofOptional
Responses
200
OK
application/json
put
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"
}
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
  }
}