API v1.0.0

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/80638214aa04722c9203) <span style='margin-left: 0.5em;'>or</span> <a href='https://documenter.getpostman.com/view/3559821/TVeqcn2L' class='openapi-button' _ngcontent-c6>View Postman docs</a> # Quickstart Visit [github](https://github.com/EmitKnowledge/Envoice) to view the quickstart tutorial. <div class='postman-tutorial'> # Tutorial for running the API in postman Click on ""Run in Postman"" button <br /><br /> ![postman - tutorial - 1](/Assets/images/api/postman-tutorial/postman-tutorial-1.png) --- A new page will open. Click the ""Postman for windows"" to run postman as a desktop app. Make sure you have already [installed](https://www.getpostman.com/docs/postman/launching_postman/installation_and_updates) Postman. <br /><br /> ![postman - tutorial - 2](/Assets/images/api/postman-tutorial/postman-tutorial-2.png) --- In chrome an alert might show up to set a default app for opening postman links. Click on ""Open Postman"". <br /><br /> ![postman - tutorial - 3](/Assets/images/api/postman-tutorial/postman-tutorial-3.png) --- The OpenAPI specification will be imported in Postman as a new collection named ""Envoice api"" <br /><br /> ![postman - tutorial - 4](/Assets/images/api/postman-tutorial/postman-tutorial-4.png) --- When testing be sure to check and modify the environment variables to suit your api key and secret. The domain is set to envoice's endpoint so you don't really need to change that. <sub>\*Eye button in top right corner </sub> <br /><br /> ![postman - tutorial - 5](/Assets/images/api/postman-tutorial/postman-tutorial-5.png) <br /><br /> ![postman - tutorial - 6](/Assets/images/api/postman-tutorial/postman-tutorial-6.png) --- You don't need to change the values of the header parameters, because they will be replaced automatically when you send a request with real values from the environment configured in the previous step. <br /><br /> ![postman - tutorial - 7](/Assets/images/api/postman-tutorial/postman-tutorial-7.png) --- Modify the example data to suit your needs and send a request. <br /><br /> ![postman - tutorial - 8](/Assets/images/api/postman-tutorial/postman-tutorial-8.png) </div> # Webhooks Webhooks allow you to build or set up Envoice Apps which subscribe to invoice activities. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external invoice data storage. In order to use webhooks visit [this link](/account/settings#api-tab) and add upto 10 webhook urls that will return status `200` in order to signal that the webhook is working. All nonworking webhooks will be ignored after a certain period of time and several retry attempts. If after several attempts the webhook starts to work, we will send you all activities, both past and present, in chronological order. The payload of the webhook is in format: ``` { Signature: ""sha256 string"", Timestamp: ""YYYY-MM-DDTHH:mm:ss.FFFFFFFZ"", Activity: { Message: "string", Link: "share url", Type: int, InvoiceNumber: "string", InvoiceId: int, OrderNumber: "string", OrderId: int, Id: int, CreatedOn: "YYYY-MM-DDTHH:mm:ss.FFFFFFFZ" } } ```

Claim this API

Are you the operator of API v1.0.0? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with API v1.0.0? Let us know about broken links, changed auth, deprecated endpoints, or other issues.

Base URL: https://www.envoice.in
Auth: unknown
Endpoints: 28
Reachable: unknown
CORS: unknown

Endpoints

Method Path Summary Auth Last Status Latency
GET /api/client/all Return all clients for the account
GET /api/client/candelete Check if the provided client can be deleted
GET /api/client/details Return client details. Activities and invoices included.
GET /api/estimation/all Return all estimation for the account
GET /api/estimation/details Return estimation data
GET /api/estimation/status Retrieve the status of the estimation
GET /api/estimation/uri Return the unique url to the client's invoice
GET /api/general/countries Return all of the platform supported countries
GET /api/general/currencies Return all of the platform supported currencies
GET /api/general/dateformats Return all of the platform supported Date Formats
GET /api/general/uilanguages Return all of the platform supported UI languages
GET /api/invoice/all Return all invoices for the account
GET /api/invoice/allcategories Return all invoice categories for the account
GET /api/invoice/details Return invoice data
GET /api/invoice/pdf Return the PDF for the invoice
GET /api/invoice/status Retrieve the status of the invoice
GET /api/invoice/uri Return the unique url to the client's invoice
GET /api/order/all Return all orders for the account
GET /api/order/details Return order details
GET /api/payment/supported Return all supported payment gateways (no currencies means all are supported)
GET /api/paymentlink/all Create a payment link
GET /api/paymentlink/uri Return the unique url to the client's payment link
GET /api/product/all Return all products for the account
GET /api/product/details Return product details
GET /api/tax/all Return all taxes for the account
GET /api/worktype/all Return all work types for the account
GET /api/worktype/details Return work type details
GET /api/worktype/search Return all work types for the account that match the query param