Envoice

API v1.0.0

[](https://app.getpostman.com/run-collection/80638214aa04722c9203) or View Postman docs Quickstart Visit [github](https://github.com/EmitKnowledge/Envoice) to…

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview


or
View Postman docs

Quickstart

Visit github to view the quickstart tutorial.

Tutorial for running the API in postman

Click on ""Run in Postman"" button


A new page will open.
Click the ""Postman for windows"" to run postman as a desktop app.
Make sure you have already installed Postman.


In chrome an alert might show up to set a default app for opening postman links. Click on ""Open Postman"".


The OpenAPI specification will be imported in Postman as a new collection named ""Envoice api""


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


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.


Modify the example data to suit your needs and send a request.

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 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"
    }
}

Endpoints 61

Client

  • GETReturn all clients for the account/api/client/all
  • GETCheck if the provided client can be deleted/api/client/candelete?id=0
  • POSTDelete an existing client/api/client/delete
  • GETReturn client details. Activities and invoices included./api/client/details?id=0
  • POSTCreate a client/api/client/new
  • POSTUpdate an existing client/api/client/update

Estimation

  • GETReturn all estimation for the account/api/estimation/all?queryOptions.page=0&queryOptions.pageSize=0
  • POSTChange estimation status/api/estimation/changestatus
  • POSTConvert the estimation to an invoice/api/estimation/convert
  • POSTDelete an existing estimation/api/estimation/delete
  • GETReturn estimation data/api/estimation/details?id=0
  • POSTCreate an estimation/api/estimation/new
  • POSTSend the provided estimation to the client/api/estimation/sendtoclient
  • GETRetrieve the status of the estimation/api/estimation/status?id=0
  • POSTUpdate an existing estimation/api/estimation/update
  • GETReturn the unique url to the client's invoice/api/estimation/uri?id=0

General

  • GETReturn all of the platform supported countries/api/general/countries
  • GETReturn all of the platform supported currencies/api/general/currencies
  • GETReturn all of the platform supported Date Formats/api/general/dateformats
  • GETReturn all of the platform supported UI languages/api/general/uilanguages

Invoice

  • GETReturn all invoices for the account/api/invoice/all?queryOptions.page=0&queryOptions.pageSize=0
  • GETReturn all invoice categories for the account/api/invoice/allcategories?query=string
  • POSTChange invoice status/api/invoice/changestatus
  • POSTDelete an existing invoice/api/invoice/delete
  • POSTDelete an existing invoice category/api/invoice/deletecategory
  • GETReturn invoice data/api/invoice/details?id=0
  • POSTCreate an invoice/api/invoice/new
  • POSTCreate an invoice category/api/invoice/newcategory
  • GETReturn the PDF for the invoice/api/invoice/pdf?id=0&signedVersion=true
  • POSTSend the provided invoice to the accountant/api/invoice/sendtoaccountant
  • POSTSend the provided invoice to the client/api/invoice/sendtoclient
  • GETRetrieve the status of the invoice/api/invoice/status?id=0
  • POSTUpdate an existing invoice/api/invoice/update
  • POSTUpdate an existing invoice category/api/invoice/updatecategory
  • GETReturn the unique url to the client's invoice/api/invoice/uri?id=0

Order

  • GETReturn all orders for the account/api/order/all?queryOptions.page=0&queryOptions.pageSize=0
  • POSTChange order shipping details/api/order/changeshippingdetails?orderId=0
  • POSTChange order status/api/order/changestatus
  • POSTDelete an existing order/api/order/delete
  • GETReturn order details/api/order/details?id=0
  • POSTCreate an order/api/order/new

Payment

  • GETReturn all supported payment gateways (no currencies means all are supported)/api/payment/supported

PaymentLink

  • GETCreate a payment link/api/paymentlink/all?queryOptions.page=0&queryOptions.pageSize=0
  • POSTDelete an existing payment link/api/paymentlink/delete
  • POSTCreate a payment link/api/paymentlink/new
  • GETReturn the unique url to the client's payment link/api/paymentlink/uri?id=0

Product

  • GETReturn all products for the account/api/product/all?queryOptions.page=0&queryOptions.pageSize=0
  • POSTDelete an existing product/api/product/delete
  • GETReturn product details/api/product/details?id=0
  • POSTCreate a product/api/product/new
  • POSTUpdate an existing product/api/product/update

Tax

  • GETReturn all taxes for the account/api/tax/all
  • POSTDelete an existing tax/api/tax/delete
  • POSTCreate a tax/api/tax/new
  • POSTUpdate an existing tax/api/tax/update

WorkType

  • GETReturn all work types for the account/api/worktype/all
  • POSTDelete an existing work type/api/worktype/delete
  • GETReturn work type details/api/worktype/details?workTypeId=0
  • POSTCreate a work type/api/worktype/new
  • GETReturn all work types for the account that match the query param/api/worktype/search?queryOptions.query=string&queryOptions.orderBy=string&queryOptions.order=None&queryOptions.page=0&queryOptions.pageSize=0
  • POSTUpdate an existing work type/api/worktype/update

API details

Base URL
https://www.envoice.in
Authentication
An API key in the x-auth-key header
An API key in the x-auth-secret header
Operations
61 operations on 61 pathsPOST 33GET 28
Main resources
Invoice 15Estimation 10Client 6Order 6WorkType 6Product 5General 4PaymentLink 4Tax 4Payment 1
Response formats
application/json application/xml text/html
Description format
OpenAPI 3.0.0, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the API v1.0.0 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the API v1.0.0 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the x-auth-key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Return all clients for the account” (GET /api/client/all), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the API v1.0.0?

[](https://app.getpostman.com/run-collection/80638214aa04722c9203) or View Postman docs Quickstart Visit [github](https://github.com/EmitKnowledge/Envoice) to… It is listed under Finance & banking and has 61 endpoints.

Who publishes the API v1.0.0?

It is listed from Envoice's public API description (an OpenAPI document), not published by Envoice on Swastik Codes. Anyone who controls envoice.in can claim the profile by adding a DNS TXT record.

What is the base URL of the API v1.0.0?

Requests go to https://www.envoice.in. Endpoint paths are added to this base URL.

How do I authenticate with the API v1.0.0?

It accepts 2 methods: an API key in the x-auth-key header; an API key in the x-auth-secret header.

How many endpoints does the API v1.0.0 have?

61 operations on 61 paths (33 POST, 28 GET). The largest groups are Invoice, Estimation, Client, Order.

Is forking the API v1.0.0 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.