Status
Loading...
v1.4.0
OAS 3.1.0

Panier API

Support

An API for managing your Panier company.

API Credentials

You can get the API credentials i.e APP-ID and API-KEY, from the Developer API section of your Panier company account.

Only users with the Developer API user permission can access to API credentials. If you don't have the permission, ask your company account owner or admin to grant you the permission.

Rate Limit

This API has a Rate Limit of 500 API calls every 5 minutes for each unique IP Address.

To avoid exceeding the maximum number of API calls we recommend making as much use of Webhooks as possible and to avoid Polling. However if your app's architecture requires Polling, we recommend putting a long interval of at least 15 seconds between each API call.
To avoid exceeding the Rate Limit you can also do bulk operations e.g doing a single API call with all the products that you want to create in a single list instead of looping through the list and doing an individual API call for each product.

Template Design

You can customize the design of your Sales Receipts, Quotations, Invoices, Credit Notes, Debit Notes and Delivery Notes with 30 templates, 7 color palettes and 3 table layouts.

Template List
Template # Template Image
1 No Template
2 Template #1
3 Template #2
4 Template #3
5 Template #4
6 Template #5
7 Template #6
8 Template #7
9 Template #8
10 Template #9
11 Template #10
12 Template #11
13 Template #12
14 Template #13
15 Template #14
16 Template #15
17 Template #16
18 Template #17
19 Template #18
20 Template #19
21 Template #20
22 Template #21
23 Template #22
24 Template #23
25 Template #24
26 Template #25
27 Template #26
28 Template #27
29 Template #28
30 Template #29
Color Palettes
Code Color
no_color Color (no_color)
primary Color (blue)
secondary Color (grey)
success Color (green)
warning Color (orange)
danger Color (red)
dark Color (black)
Table Layout

Plain

Plain Table Layout

Color

The background color of the table is taken from the color palette of your template design.

Color Table Layout

Stripe

Plain Table Layout

Currency Support

We support 119 currencies allowing your company to record transactions in multiple currencies.

Currency List
# Name Symbol Code
1 Afghan Afghani Af AFN
2 Albanian Lek ALL ALL
3 Algerian Dinar DA DZD
4 Argentine Peso AR$ ARS
5 Armenian Dram AMD AMD
6 Australian Dollar AU$ AUD
7 Azerbaijani Manat man. AZN
8 Bahraini Dinar BD BHD
9 Bangladeshi Taka Tk BDT
10 Belarusian Ruble Br BYN
11 Belize Dollar BZ$ BZD
12 Bolivian Boliviano Bs BOB
13 Bosnia-Herzegovina Convertible Mark KM BAM
14 Botswanan Pula BWP BWP
15 Brazilian Real R$ BRL
16 British Pound Sterling £ GBP
17 Brunei Dollar BN$ BND
18 Bulgarian Lev BGN BGN
19 Burundian Franc FBu BIF
20 CFA Franc BCEAO CFA XOF
21 CFA Franc BEAC FCFA XAF
22 Cambodian Riel KHR KHR
23 Canadian Dollar CA$ CAD
24 Cape Verdean Escudo CV$ CVE
25 Chilean Peso CL$ CLP
26 Chinese Yuan CN¥ CNY
27 Colombian Peso CO$ COP
28 Comorian Franc CF KMF
29 Congolese Franc CDF CDF
30 Costa Rican Colón ₡ CRC
31 Croatian Kuna kn HRK
32 Czech Republic Koruna Kč CZK
33 Danish Krone Dkr DKK
34 Djiboutian Franc Fdj DJF
35 Dominican Peso RD$ DOP
36 Egyptian Pound EGP EGP
37 Eritrean Nakfa Nfk ERN
38 Estonian Kroon Ekr EEK
39 Ethiopian Birr Br ETB
40 Euro € EUR
41 Georgian Lari GEL GEL
42 Ghanaian Cedi GH₵ GHS
43 Guatemalan Quetzal GTQ GTQ
44 Guinean Franc FG GNF
45 Honduran Lempira HNL HNL
46 Hong Kong Dollar HK$ HKD
47 Hungarian Forint Ft HUF
48 Icelandic Króna Ikr ISK
49 Indian Rupee Rs INR
50 Indonesian Rupiah Rp IDR
51 Iranian Rial IRR IRR
52 Iraqi Dinar IQD IQD
53 Israeli New Sheqel ₪ ILS
54 Jamaican Dollar J$ JMD
55 Japanese Yen ¥ JPY
56 Jordanian Dinar JD JOD
57 Kazakhstani Tenge KZT KZT
58 Kenyan Shilling Ksh KES
59 Kuwaiti Dinar KD KWD
60 Latvian Lats Ls LVL
61 Lebanese Pound L.L. LBP
62 Libyan Dinar LD LYD
63 Lithuanian Litas Lt LTL
64 Macanese Pataca MOP$ MOP
65 Macedonian Denar MKD MKD
66 Malagasy Ariary MGA MGA
67 Malaysian Ringgit RM MYR
68 Mauritian Rupee MURs MUR
69 Mexican Peso MX$ MXN
70 Moldovan Leu MDL MDL
71 Moroccan Dirham MAD MAD
72 Mozambican Metical MTn MZN
73 Myanma Kyat MMK MMK
74 Namibian Dollar N$ NAD
75 Nepalese Rupee NPRs NPR
76 New Taiwan Dollar NT$ TWD
77 New Zealand Dollar NZ$ NZD
78 Nicaraguan Córdoba C$ NIO
79 Nigerian Naira ₦ NGN
80 Norwegian Krone Nkr NOK
81 Omani Rial OMR OMR
82 Pakistani Rupee PKRs PKR
83 Panamanian Balboa B/. PAB
84 Paraguayan Guarani ₲ PYG
85 Peruvian Nuevo Sol S/. PEN
86 Philippine Peso ₱ PHP
87 Polish Zloty zł PLN
88 Qatari Rial QR QAR
89 Romanian Leu RON RON
90 Russian Ruble RUB RUB
91 Rwandan Franc RWF RWF
92 Saudi Riyal SR SAR
93 Serbian Dinar din. RSD
94 Singapore Dollar S$ SGD
95 Somali Shilling Ssh SOS
96 South African Rand R ZAR
97 South Korean Won ₩ KRW
98 Sri Lankan Rupee SLRs LKR
99 Sudanese Pound SDG SDG
100 Swedish Krona Skr SEK
101 Swiss Franc CHF CHF
102 Syrian Pound SY£ SYP
103 Tanzanian Shilling TSh TZS
104 Thai Baht ฿ THB
105 Tongan Paʻanga T$ TOP
106 Trinidad and Tobago Dollar TT$ TTD
107 Tunisian Dinar DT TND
108 Turkish Lira TL TRY
109 US Dollar $ USD
110 Ugandan Shilling USh UGX
111 Ukrainian Hryvnia ₴ UAH
112 United Arab Emirates Dirham AED AED
113 Uruguayan Peso $U UYU
114 Uzbekistan Som UZS UZS
115 Venezuelan Bolívar Bs.F. VEF
116 Vietnamese Dong ₫ VND
117 Yemeni Rial YR YER
118 Zambian Kwacha ZK ZMK
119 Zimbabwe Gold ZWG ZWG

ZIMRA Fiscalisation

This API extends Panier's ability to create ZIMRA Fiscal Tax Invoices, Credit Notes and Debit Notes. Coupled with Panier's automated fiscal device registration feature, makes this the best tool to integrate ZIMRA fiscalisation into your project. This API's ZIMRA Fiscalisation functionality is based on the official ZIMRA Fiscal Device Gateway API Specs v7.2 and so we recommend that you get acquainted with it in order to get the most out of this API.

You can use this API to do operations in the ZIMRA test environment while you wait for ZIMRA to approve your virtual fiscal device. After being approved, your ZIMRA integration will be automatically put into production.
This API's ZIMRA Fiscalisation functionality is subject to change if the ZIMRA Fiscal Device Gateway API Specs v7.2 also changes and so we cannot guarantee that there will be backward compatibility with future versions.
Server:
Client Libraries
Shell Curl

Products

​

A collection of all the endpoints needed to manage products

Products Operations

Create products

​

Create products in your company

Body
application/json

The products you want to create

Request body for creating products

  • data
    Type: array object[] 1…1000
    required

    Product list that is to be created

    A product

  • find_hs_codes
    Type: boolean
    default: 
    false

    Automatically find the relevent HS Codes for your products.

    This will deduct 1 credit for each product whose HS Code we search
  • overwrite_duplicates
    Type: boolean
    default: 
    true

    Overwrite products with the same name

Responses
Request Example for post/product/create
curl /product/create \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "data": [
    {
      "name": "Eggs",
      "description": "One dozen large eggs",
      "buying_price": 2.51,
      "selling_price": 5.81,
      "initial_quantity": 100,
      "hs_code": "0808.01.01",
      "sku": "",
      "is_inventory_item": true,
      "applicable_tax_id": null,
      "suppliers": null
    }
  ],
  "find_hs_codes": false,
  "overwrite_duplicates": true
}'

{
  "created": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "buying_price": 1,
      "sku": "string",
      "hs_code": "string",
      "selling_price": 1,
      "quantity": -9007199254740991,
      "is_inventory_item": true,
      "applicable_tax": {
        "id": "string",
        "name": "string",
        "percentage": 1,
        "code": "string",
        "zimra_tax_id": 1
      },
      "supplier": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "updated_at": "string",
      "created_at": "string"
    }
  ],
  "excluded_duplicates": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "buying_price": 1,
      "sku": "string",
      "hs_code": "string",
      "selling_price": 1,
      "quantity": -9007199254740991,
      "is_inventory_item": true,
      "applicable_tax": {
        "id": "string",
        "name": "string",
        "percentage": 1,
        "code": "string",
        "zimra_tax_id": 1
      },
      "supplier": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "updated_at": "string",
      "created_at": "string"
    }
  ]
}

Created Successfully created the products

Update products

​

Update products in your company

You cannot update product quantities directly. You must instead use Stock Endpoints to Add or Subtract the stock quantities. This is done so that you can have an audit trail of all the stock movements of a product.
Body
application/json

The products you want to update

Request body for updating products

  • data
    Type: array object[] 1…1000
    required

    Product list that is to be updated

    A product

  • find_hs_codes
    Type: boolean
    default: 
    false

    Automatically find the relevent HS Codes for your products.

    This will deduct 1 credit for each product whose HS Code we search
Responses
Request Example for put/product/update
curl /product/update \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "data": [
    {
      "id": "",
      "name": "Eggs",
      "description": "One dozen large eggs",
      "buying_price": 2.51,
      "selling_price": 5.81,
      "hs_code": "0808.01.01",
      "sku": "",
      "is_inventory_item": true,
      "applicable_tax_id": null,
      "suppliers": null
    }
  ],
  "find_hs_codes": false
}'

{
  "updated": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "buying_price": 1,
      "sku": "string",
      "hs_code": "string",
      "selling_price": 1,
      "quantity": -9007199254740991,
      "is_inventory_item": true,
      "applicable_tax": {
        "id": "string",
        "name": "string",
        "percentage": 1,
        "code": "string",
        "zimra_tax_id": 1
      },
      "supplier": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "updated_at": "string",
      "created_at": "string"
    }
  ]
}

OK Successfully updated the products

Search products

​

Search products in your company

All searched products are returned in descending order of created_at.
Body
application/json

The product search query

Request body for searching products

  • data
    Type: object
    required

    Search product query

Responses
Request Example for post/product/search
curl /product/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "query": "*",
    "limit": 10,
    "skip": 0
  }
}'

{
  "searched_record_count": 1,
  "total_record_count": 1,
  "searched": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "buying_price": 1,
      "sku": "string",
      "hs_code": "string",
      "selling_price": 1,
      "quantity": -9007199254740991,
      "is_inventory_item": true,
      "applicable_tax": {
        "id": "string",
        "name": "string",
        "percentage": 1,
        "code": "string",
        "zimra_tax_id": 1
      },
      "supplier": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "updated_at": "string",
      "created_at": "string"
    }
  ]
}

OK Successfully searched the products

Delete products

​

Delete products in your company.

Body
application/json

The products you want to delete

Request body for deleting products

  • data
    Type: array object[] 1…1000
    required

    Product list that is to be deleted

    A product

Responses
Request Example for post/product/delete
curl /product/delete \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "data": [
    {
      "id": ""
    }
  ]
}'

{
  "deleted_count": 1
}

OK Successfully deleted the products

Stocks (Collapsed)

​

A collection of all the endpoints needed to manage stocks

Stocks Operations

Customers (Collapsed)

​

A collection of all the endpoints needed to manage customers

Customers Operations

Suppliers (Collapsed)

​

A collection of all the endpoints needed to manage suppliers

Suppliers Operations

Taxes (Collapsed)

​

A collection of all the endpoints needed to manage taxes

Taxes Operations

Currencies (Collapsed)

​

A collection of all the endpoints needed to manage currencies

Currencies Operations

Sales (Collapsed)

​

A collection of all the endpoints needed to manage sales

Sales Operations

Invoices (Collapsed)

​

A collection of all the endpoints needed to manage invoices

Invoices Operations

Debit Notes (Collapsed)

​

A collection of all the endpoints needed to manage debit notes

Debit Notes Operations

Credit Notes (Collapsed)

​

A collection of all the endpoints needed to manage credit notes

Credit Notes Operations

Delivery Notes (Collapsed)

​

A collection of all the endpoints needed to manage delivery notes

Delivery Notes Operations

Quotations (Collapsed)

​

A collection of all the endpoints needed to manage quotations

Quotations Operations

ZIMRA Fiscalisation (Collapsed)

​

A collection of all endpoints needed to fiscalize with ZIMRA

ZIMRA Fiscalisation Operations

Models