APIHub
Back to Explore

API v1.0.0

The API offers a comprehensive set of endpoints for managing business operations, including creating, retrieving, updating, and deleting invoices, estimates, clients, products, orders, payment links, taxes, and work types, as well as accessing supporting data such as supported countries, currencies, date formats, and UI languages.

Finance
apiKeyHeader
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

1235ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/api/invoice/newcategory

Create an invoice category

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/product/details

Return product details

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/estimation/sendtoclient

Send the provided estimation to the client

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/estimation/status

Retrieve the status of the estimation

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/estimation/update

Update an existing estimation

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/estimation/uri

Return the unique url to the client's invoice

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/general/countries

Return all of the platform supported countries

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/general/currencies

Return all of the platform supported currencies

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/general/dateformats

Return all of the platform supported Date Formats

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/general/uilanguages

Return all of the platform supported UI languages

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/product/new

Create a product

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/invoice/all

Return all invoices for the account

  • queryOptions.page (query)
  • queryOptions.pageSize (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/invoice/allcategories

Return all invoice categories for the account

  • query (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/changestatus

Change invoice status

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/delete

Delete an existing invoice

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/deletecategory

Delete an existing invoice category

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/invoice/details

Return invoice data

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/new

Create an invoice

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/client/all

Return all clients for the account

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/client/candelete

Check if the provided client can be deleted

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/client/delete

Delete an existing client

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/client/details

Return client details. Activities and invoices included.

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/client/new

Create a client

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/client/update

Update an existing client

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/estimation/all

Return all estimation for the account

  • queryOptions.page (query)
  • queryOptions.pageSize (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/estimation/changestatus

Change estimation status

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/estimation/convert

Convert the estimation to an invoice

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/estimation/delete

Delete an existing estimation

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/estimation/details

Return estimation data

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/estimation/new

Create an estimation

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/invoice/pdf

Return the PDF for the invoice

  • id (query, required)
  • signedVersion (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/sendtoaccountant

Send the provided invoice to the accountant

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/sendtoclient

Send the provided invoice to the client

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/invoice/status

Retrieve the status of the invoice

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/update

Update an existing invoice

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/invoice/updatecategory

Update an existing invoice category

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/invoice/uri

Return the unique url to the client's invoice

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/order/all

Return all orders for the account

  • queryOptions.page (query)
  • queryOptions.pageSize (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/order/changeshippingdetails

Change order shipping details

  • orderId (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/order/changestatus

Change order status

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/order/delete

Delete an existing order

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/order/details

Return order details

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/order/new

Create an order

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/payment/supported

Return all supported payment gateways (no currencies means all are supported)

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/paymentlink/all

Create a payment link

  • queryOptions.page (query)
  • queryOptions.pageSize (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/paymentlink/delete

Delete an existing payment link

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/paymentlink/new

Create a payment link

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/paymentlink/uri

Return the unique url to the client's payment link

  • id (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/product/all

Return all products for the account

  • queryOptions.page (query)
  • queryOptions.pageSize (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/product/delete

Delete an existing product

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/product/update

Update an existing product

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/tax/all

Return all taxes for the account

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/tax/delete

Delete an existing tax

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/tax/new

Create a tax

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/tax/update

Update an existing tax

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/worktype/all

Return all work types for the account

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/worktype/delete

Delete an existing work type

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/worktype/details

Return work type details

  • workTypeId (query, required)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/worktype/new

Create a work type

  • x-auth-key (header, required)
  • x-auth-secret (header, required)
GET

/api/worktype/search

Return all work types for the account that match the query param

  • queryOptions.query (query)
  • queryOptions.orderBy (query)
  • queryOptions.order (query)
  • queryOptions.page (query)
  • queryOptions.pageSize (query)
  • x-auth-key (header, required)
  • x-auth-secret (header, required)
POST

/api/worktype/update

Update an existing work type

  • x-auth-key (header, required)
  • x-auth-secret (header, required)

61 endpoints auto-detected

Authentication

This API uses an API key, passed in the "x-auth-key" header. No OAuth required.

curl -X POST \
  "https://www.envoice.in/api/invoice/newcategory" \
  -H "x-auth-key: YOUR_API_KEY"

www.envoice.in · HTTPS only