API: Invoice
Table of Contents
The ERP API Invoice endpoints provide a list of invoices and their associated information from the Enapps ERP system. As standard, this method returns 100 records per page. It is recommended that this API method is called in real-time for logged in customers when they access their Invoices page. This, should be used in conjunction with Invoice Lines API below.
| Base URL |
| https://<server>:<port>/api/v1 |
| Endpoint | /invoices |
| Method | GET |
Retrieve Invoices
Request parameters | |||
| Name | Type |
Required |
Description |
| _id | integer |
No |
ID of a specific Invoice to obtain only 1 Invoice record. |
| partner_id | integer |
Yes |
ID of a partner obtained from Partners API response. |
| invoice_date | date_time |
No |
Filter records invoiced at the specified date and later (%Y-%m-%d) |
| page | integer |
No |
Optional pagination parameter. |
| additional_fields | array/list |
No |
Provide field names of additional fields not part of the standard Endpoint. For more information please refer to Additional Fields |
Response parameters | ||
| Name | Type |
Description |
| id | integer |
Invoice unique ID |
| number | string |
Invoice unique name generated by the ERP system |
| partner_id | integer |
Unique ID of associated Customer |
| address_invoice_id | integer |
ID of the invoice address |
| payment_term | string |
Payment terms agreed with partner |
| reference | string |
Invoice reference |
| currency | string |
Currency of Invoice |
| invoice_date | date_time |
The date the invoice was created (%Y-%M-%D) |
| due_date | date_time |
The date the payment is due on the invoice (%Y-%M-%D) |
| state | string |
Determines if invoice is paid or unpaid |
| total_net | numeric |
Net total of invoice |
| total_gross | numeric |
Grand total of invoice |
| amount_tax | numeric |
Tax amount |
Examples | |
| HTTP |
GET /api/v1/invoices/ HTTP/1.1 Host: company.erp.zone:4095 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTg5OTc5NTYsInQiOiJhY2Nlc3MiLCJsIjoid29vY29tbWVyY2VhcGkiLCJkYiI6InByb2R1Y3Rpb25fZGV2In0.kLQG7QIIxBdXCp9H9wiEf5YeQxwwecq55hoiJ64KIFM Cookie: sessionid=9412fbdf30a858b69a990bffba84c1640ebf2a16 |
Retrieve Invoice Lines data
The ERP API's Invoice Lines endpoint provides a list of invoice lines and their associated information from the Enapps ERP system. By default, this method returns 100 records per page. It is recommended to call this API method in real-time for logged-in customers when they access their invoice page and intend to view detailed Invoice information. This should be used in conjunction with the Invoice API.
| Endpoint | /invoice_lines |
| Method | GET |
Request parameters | |||
| Name | Type |
Required |
Description |
| invoice_id | integer |
Yes |
ID of a specific invoice to obtain all invoice lines |
| page | integer |
No |
Optional pagination parameter. |
| additional_fields | array/list |
No |
Provide field names of additional fields not part of the standard Endpoint. For more information please refer to Additional Fields |
Response parameters | ||
| Name | Type |
Description |
| id | integer |
Invoice line unique ID |
| invoice_id | integer |
Invoice id (header) |
| product_id | array |
Product unique ID and it's Name |
| parameters | array |
An array representing product parameters. Structure: - Option Type Name Example: "parameters": [ [ Material, "Bronze" ], [ Colour, "DarkSlateBlue" ] ] |
| quantity | integer |
Product quantity |
| description | string |
Line description |
| price_unit | numeric |
Unit price of product |
| line_total | numeric |
Unit price multiplied by quantity and any applied discounts |
| tax_name | string |
Type of tax paid |
Examples | |
| HTTP | GET /api/v1/invoice_lines/ HTTP/1.1 Host: company.erp.zone:4095 invoice_id: 636634 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyiOjE2OTg5OTc5NTYsInQiOiJhY2Nlc3MiLCJsIjoid29vY29tbWVyY2VhcGkiLCJkYiI6InByb2R1Y3Rpb25fZGV2In0.kLQG7QIIxBdXCp9H9wiEf5YeQxwwecq55hoiJ64KIFM |