API v1.0.0 API

Overview

[](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 />  --- 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 />  --- In chrome an alert might show up to set a default app for opening postman links. Click on ""Open Postman"". <br /><br />  --- The OpenAPI specification will be imported in Postman as a new collection named ""Envoice api"" <br /><br />  --- 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. _{\*Eye button in top right corner} <br /><br />  <br /><br />  --- 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 />  --- Modify the example data to suit your needs and send a request. <br /><br />  </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" } } ```

API v1.0.0 is a finance API from envoice.in. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 61 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Finance

Base URL

https://www.envoice.in

Version

v1

Endpoints

61

OpenAPI

Specification ↗

Spec updated

2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://www.envoice.in/api/client/all" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://www.envoice.in/api/client/all", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://www.envoice.in/api/client/all",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions