integrations.sh
← all integrations

API v1.0.0

OpenAPI apis-guru financial

or

Quickstart

Visit to view the quickstart tutorial.

Tutorial for running the API in postman

Click on ""Run in Postman"" button

postman - tutorial - 1

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

postman - tutorial - 2

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

postman - tutorial - 3

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

postman - tutorial - 4

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

postman - tutorial - 5


postman - tutorial - 6

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.

postman - tutorial - 7

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

postman - tutorial - 8

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 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"    }}
Homepage
https://api.apis.guru/v2/specs/envoice.in/v1.json
Provider
envoice.in
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/envoice.in/v1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/envoice.in/v1/openapi.yaml

Tools (63)

Extracted live via the executor SDK.

  • client.clientApiAll

    Return all clients for the account

  • client.clientApiCanDelete

    Check if the provided client can be deleted

  • client.clientApiDelete

    Delete an existing client

  • client.clientApiDetails

    Return client details. Activities and invoices included.

  • client.clientApiNew

    Create a client

  • client.clientApiUpdate

    Update an existing client

  • estimation.estimationApiAll

    Return all estimation for the account

  • estimation.estimationApiChangeStatus

    Change estimation status

  • estimation.estimationApiConvert

    Convert the estimation to an invoice

  • estimation.estimationApiDelete

    Delete an existing estimation

  • estimation.estimationApiDetails

    Return estimation data

  • estimation.estimationApiNew

    Create an estimation

  • estimation.estimationApiSendToClient

    Send the provided estimation to the client

  • estimation.estimationApiStatus

    Retrieve the status of the estimation

  • estimation.estimationApiUpdate

    Update an existing estimation

  • estimation.estimationApiUri

    Return the unique url to the client's invoice

  • general.generalApiCountries

    Return all of the platform supported countries

  • general.generalApiCurrencies

    Return all of the platform supported currencies

  • general.generalApiDateFormats

    Return all of the platform supported Date Formats

  • general.generalApiUiLanguages

    Return all of the platform supported UI languages

  • invoice.getApiInvoiceAllcategories

    Return all invoice categories for the account

  • invoice.invoiceApiAll

    Return all invoices for the account

  • invoice.invoiceApiChangeStatus

    Change invoice status

  • invoice.invoiceApiDelete

    Delete an existing invoice

  • invoice.invoiceApiDetails

    Return invoice data

  • invoice.invoiceApiNew

    Create an invoice

  • invoice.invoiceApiPdf

    Return the PDF for the invoice

  • invoice.invoiceApiSendToAccountant

    Send the provided invoice to the accountant

  • invoice.invoiceApiSendToClient

    Send the provided invoice to the client

  • invoice.invoiceApiStatus

    Retrieve the status of the invoice

  • invoice.invoiceApiUpdate

    Update an existing invoice

  • invoice.invoiceApiUri

    Return the unique url to the client's invoice

  • invoice.postApiInvoiceDeletecategory

    Delete an existing invoice category

  • invoice.postApiInvoiceNewcategory

    Create an invoice category

  • invoice.postApiInvoiceUpdatecategory

    Update an existing invoice category

  • order.orderApiAll

    Return all orders for the account

  • order.orderApiChangeShippingDetails

    Change order shipping details

  • order.orderApiChangeStatus

    Change order status

  • order.orderApiDelete

    Delete an existing order

  • order.orderApiDetails

    Return order details

  • order.orderApiNew

    Create an order

  • payment.paymentApiSupported

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

  • paymentLink.paymentLinkApiAll

    Create a payment link

  • paymentLink.paymentLinkApiDelete

    Delete an existing payment link

  • paymentLink.paymentLinkApiNew

    Create a payment link

  • paymentLink.paymentLinkApiUri

    Return the unique url to the client's payment link

  • product.productApiAll

    Return all products for the account

  • product.productApiDelete

    Delete an existing product

  • product.productApiDetails

    Return product details

  • product.productApiNew

    Create a product

  • product.productApiUpdate

    Update an existing product

  • tax.taxApiAll

    Return all taxes for the account

  • tax.taxApiDelete

    Delete an existing tax

  • tax.taxApiNew

    Create a tax

  • tax.taxApiUpdate

    Update an existing tax

  • workType.workTypeApiAll

    Return all work types for the account

  • workType.workTypeApiDelete

    Delete an existing work type

  • workType.workTypeApiDetails

    Return work type details

  • workType.workTypeApiNew

    Create a work type

  • workType.workTypeApiSearch

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

  • workType.workTypeApiUpdate

    Update an existing work type

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools