Get invoices list

get

https://api.getkonvex.com/core/api/invoices

Available for: Siigo Alegra Quickbooks Contifico NetSuite SAP Microsoft Dynamics 365 Business Central Odoo
For Siigo and Alegra returns the details of the invoices in a date range paginated by 25 elements.
Each query params and headers field, has a label indicating the ERP in which is required or can be used.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

ID corresponding to each invoice.
Netsuite

start

date

required

Initial date of interval (YYYY-MM-DD)
Siigo Alegra Quickbooks Business Central Netsuite

end

date

required

Final date of interval (YYYY-MM-DD)
Siigo Alegra Quickbooks Business Central Netsuite

page

int32

required

Number of page starts at 1
Use it only with detail parameter in false
Required for Siigo Netsuite

payment_status

string

Defaults to paid

The payment_status key is used to indicate the status of the payment for an invoice. This can be used to track the progress of payments and to ensure that invoices are paid on time. (open, paid)
Alegra Siigo Quickbooks

payment_method

string

The payment_method key is used to filter invoices by the ID of the payment method used to pay for them. This can be useful for tracking the use of different payment methods and for identifying any issues with specific payment methods
Alegra Siigo Quickbooks

client_identification

string

Client national identification
Alegra Siigo Quickbooks

tipo_registro

string

Defaults to CLI

Contifico

fecha_emision

string

Defaults to 24/01/2024

Contifico

detail

boolean

Defaults to true

Detail query param is exclusive to Siigo ERP.
When detail = true , the customer's information is complete. However, the response time is slower and the endpoint's performance may be worse in some cases.
When detail = false, the customer's information is not complete, but the endpoint's response time is shorter and the performance is better.
Siigo Netsuite

tranid

string

The tranid field represents the Transaction ID — it's the user-visible document number for a transaction. Only support for Netsuite

Headers

x-software

string

enum

required

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

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 Netsuite

x-user

string

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

x-apikey

string

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

x-testing

boolean

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

Consumer Key generated for Netsuite

x-consumer-secret

string

required

Consumer Secret generated forNetsuite

x-access-token

string

Access Token credential generated for Netsuite

x-token-secret

string

Token Secret generated for Netsuite

x-realm

string

Unique identifier assigned to each NetSuite account.Netsuite

x-url

string

url of the ERP server to consult and connection port
Netsuite SAP Odoo

x-db

string

ERP database name
SAP Odoo

x-tenant-id

string

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

x-environment-id

string

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

x-company-id

string

Unique identifier (id) assigned to each company
Business Central

x-language

string

Defaults to en

Language defined by ERP client account only support for Netsuite

Responses

200200

5XX5XX