API List
- API Introduction
- Authentication Key API
- Server Date and Time
- Register Quotation API
- Register Delivery Order
- Embed Image API
- List of companies with basic details
- Complete details of a company
- List of customers of a branch with basic details
- Register company
- Register address
- Login ID availability check
- Customer Login API
- Common lookups
- Delivery Order Tracking API
- List of Commercial Invoices
- Number of Commercial Invoices
Shopping Cart Integration API
API # : 8022 | API Name : cicount
Gets number of commercial invoices / tax invoices matching the filters in the payload.
URL : <domain>/apic/cicount
Methods Allowed : POST
Request Body : JSON Payload
Payload Structure :
| Name | Description | Type |
|---|---|---|
| search | Search text. | String |
| sdate | Starting date in DD/MM/YYYY format. For example 01/04/2020 would get all records starting from April 1, 2020 | String |
| fdate | Ending date in DD/MM/YYYY format. For example 31/03/2021 would get all records till from March 31, 2021 | String |
| itemid | Company ID of the customer. | String |
| show | Status of the invoice | String |
| ep1 | Accounting Status of the invoice
|
String |
| show3 | Record type ID. | String |
| show4 | Currency. Three letter currency code to get records for a specific currency or "NOT-" and three letter
currency code to exclude a particular currency. Examples :
|
String |
| show2 | Agent ID. ID of the agent for the sale through agents and sub-dealers. ANY : Value to send for getting sales through all agents. This excludes direct sales. NONE : Value to send for getting direct sales. This excludes all sales through agents and sub-dealers. |
String |
| show8 | Zone ID. ID of the marketing zone.
none : Value to send for getting sales to customers where marketing zone has not been specified. |
String |
| show6 | Group ID. ID of the customer group.
none : Value to send for getting sales to customers that are not part of any specific group. |
String |
| ep2 | ID of the sales person who has made the sale. | String |
| show7 | Type code of the associated record.
If required, please check type code for the deployment being integrated with. Type codes are dynamically generated, but can be edited manually. Therefore, it can differ from deployment to deployment. |
String |
Request Headers :
| Name | Description |
|---|---|
| device | A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted. |
| Authentication | Authentication code generated for API call. |
