Get List customers

get https://api.getkonvex.com/core/api/customers

Available for: Siigo Alegra Quickbooks Contifico NetSuite SAP Microsoft Dynamics 365 Business Central Odoo

End point to get list customers from ERP System. We provide a standard response similar to ERP Alegra response. Non-standardizable fields are displayed in the response with the key-name corresponding to the name of each ERP

Each query params and headers field, has a label indicating the ERP in which is required or can be used.

Query Params

string

required

Unique identification for customer ERP system. Siigo Alegra SAP

identification

string

Customer's Identification
For Quickbooks use: customer id
Siigo Alegra Quickbooks Business Central

page

string

required

Defaults to 1

Pagination ERP
Siigo Alegra Quickbooks

active

boolean

If you send active: true, the API will return a list of active customers. If you send active: false, it will return a list of inactive customers. Siigo

Headers

x-software

string

required

Name of the ERP or accounting software from which you want to get the information
Siigo Alegra Quickbooks Contifico Netsuite SAP Business Central Odoo

x-connection

string

required

If you send the x-connection, the connection will already be secured, and there will be no need to send the connection headers for each software.
Optional for: Siigo Alegra Quickbooks Contifico Netsuite SAP Business Central Odoo

x-user

string

required

User of ERP API connection
For Netsuite and Business central use: null
Siigo Alegra Quickbooks Contifico NetSuite
client-id for Business Central Odoo

x-apiKey

string

required

Apikey or token of ERP API connection
For Netsuite and Business central use: null
Siigo Alegra Quickbooks Contifico NetSuite SAP client-secret forBusiness Central Odoo

x-testing

boolean

required

Defaults to true

x-testing is used for building the environment. could be sandbox or production (true: sandbox, false: production)
Siigo Alegra Quickbooks Contifico NetSuite SAP Business Central Odoo

x-quickbooks-token

string

required

Quickbooks session token
Quickbooks

x-consumer-key

string

required

Consumer Key generated for:
Netsuite

x-consumer-secret

string

required

Consumer Secret generated for:
Netsuite

x-access-token

string

required

Access Token credential generated for:
Netsuite

x-token-secret

string

required

Token Secret generated for:
Netsuite

x-realm

string

required

Unique identifier assigned to each NetSuite account
Netsuite

x-url

string

required

Url of the ERP server to consult
Netsuite SAP Odoo

x-db

string

required

ERP database name
SAP Odoo

x-tenant-id

string

required

Unique identifier (id) asigned to each tenant. Each tenant ID is globally unique
Business Central

x-environment-id

string

required

Unique identifier (id) of the work environment within the Business Central instance
Business Central

x-company-id

string

required

Unique identifier (id) assigned to each company
Business Central

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.getkonvex.com/core/api/customers?page=1' \
3
     --header 'accept: application/json' \
4
     --header 'x-software: siigo' \
5
     --header 'x-testing: true'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

4XX4XX

5XX5XX