├── README.MD ├── client.md ├── general.md ├── invoice.md ├── payment.md ├── tax.md └── work-type.md /README.MD: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EmitKnowledge/Envoice/81eeb0089750fa1f23704b8cad5bb7a11581728b/README.MD -------------------------------------------------------------------------------- /client.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EmitKnowledge/Envoice/81eeb0089750fa1f23704b8cad5bb7a11581728b/client.md -------------------------------------------------------------------------------- /general.md: -------------------------------------------------------------------------------- 1 | ## General 2 | 3 | *For more details please read the [official Envoice documentation](https://www.envoice.in/reference/api/docs/v1) or [postman documentation.](https://documenter.getpostman.com/collection/view/1150943-7298a928-f509-01a3-5e4c-08592855085c#f935d027-1bb5-7a13-395d-99603d481fc9)* 4 | 5 | In this section we have pretty straightforward API calls that don't have any dependencies. This data is used when interacting with [invoices](./invoice.md) and [clients](./client.md). 6 | 7 | --- 8 | 9 | ### Countries 10 | 11 | api/general/countries 12 | ``` 13 | curl --request GET \ 14 | --url 'https://www.envoice.in/api/general/countries' \ 15 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 16 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' 17 | ``` 18 | 19 | Response (shortened for readability purposes, ~249 items in real output): 20 | ``` 21 | [ 22 | { 23 | "Id": 235, 24 | "Name": "United Kingdom (UK)", 25 | "Value": "GB" 26 | }, 27 | { 28 | "Id": 237, 29 | "Name": "United States of America (USA)", 30 | "Value": "US" 31 | } 32 | ] 33 | ``` 34 | 35 | --- 36 | 37 | ### Currencies 38 | 39 | api/general/currencies 40 | ``` 41 | curl --request GET \ 42 | --url 'https://www.envoice.in/api/general/currencies' \ 43 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 44 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' 45 | ``` 46 | 47 | Response (shortened for readability purposes, ~32 items in real output): 48 | ``` 49 | [ 50 | { 51 | "Id": 163, 52 | "Name": "Euro Member Countries", 53 | "Value": "EUR", 54 | "Code": "978", 55 | "Symbol": "€" 56 | }, 57 | { 58 | "Name": "United Kingdom Pound", 59 | "Value": "GBP", 60 | "Code": "826", 61 | "Symbol": "£", 62 | "Id": 170 63 | } 64 | ] 65 | ``` 66 | 67 | --- 68 | 69 | ### UI Languages 70 | 71 | api/general/uilanguages 72 | ``` 73 | curl --request GET \ 74 | --url 'https://www.envoice.in/api/general/uilanguages' \ 75 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 76 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' 77 | ``` 78 | 79 | Response (shortened for readability purposes, ~12 items in real output): 80 | ``` 81 | [ 82 | { 83 | "Id": 9, 84 | "Name": "Bulgarian", 85 | "UiCulture": "bg-BG" 86 | }, 87 | { 88 | "Id": 11, 89 | "Name": "Croatian", 90 | "UiCulture": "hr-HR" 91 | } 92 | ] 93 | ``` -------------------------------------------------------------------------------- /invoice.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EmitKnowledge/Envoice/81eeb0089750fa1f23704b8cad5bb7a11581728b/invoice.md -------------------------------------------------------------------------------- /payment.md: -------------------------------------------------------------------------------- 1 | ## Payment 2 | 3 | *For more details please read the [official Envoice documentation](https://www.envoice.in/reference/api/docs/v1) or [postman documentation.](https://documenter.getpostman.com/collection/view/1150943-7298a928-f509-01a3-5e4c-08592855085c#94bd4cf4-d3dc-ee29-7861-24eda482142e)* 4 | 5 | In this section we have pretty straightforward API calls that don't have any dependencies. This data is used when interacting with [invoices](./invoice.md). 6 | 7 | --- 8 | 9 | ### Supported payment providers 10 | 11 | api/payment/supported 12 | ``` 13 | curl --request GET \ 14 | --url 'https://www.envoice.in/api/general/countries' \ 15 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 16 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' 17 | ``` 18 | 19 | Response: 20 | ``` 21 | [ 22 | { 23 | "Name": "paypal", 24 | "SupportedCurrencies": [] 25 | }, 26 | { 27 | "Name": "stripe", 28 | "SupportedCurrencies": [] 29 | }, 30 | { 31 | "Name": "payoneer", 32 | "SupportedCurrencies": [ 33 | { 34 | "Name": "Euro Member Countries", 35 | "Value": "EUR" 36 | }, 37 | { 38 | "Name": "Pound sterling", 39 | "Value": "GBP" 40 | }, 41 | { 42 | "Name": "United States Dollar", 43 | "Value": "USD" 44 | }, 45 | { 46 | "Name": "Australian Dollar", 47 | "Value": "AUD" 48 | } 49 | ] 50 | }, 51 | { 52 | "Name": "square", 53 | "SupportedCurrencies": [] 54 | }, 55 | { 56 | "Name": "klikandpay", 57 | "SupportedCurrencies": [ 58 | { 59 | "Name": "Euro Member Countries", 60 | "Value": "EUR" 61 | } 62 | ] 63 | } 64 | ] 65 | ``` -------------------------------------------------------------------------------- /tax.md: -------------------------------------------------------------------------------- 1 | ## Tax 2 | 3 | *For more details please read the [official Envoice documentation](https://www.envoice.in/reference/api/docs/v1) or [postman documentation.](https://documenter.getpostman.com/collection/view/1150943-7298a928-f509-01a3-5e4c-08592855085c#5e656527-d1e1-0ac1-22bd-944b292f9406)* 4 | 5 | In this section we have pretty straightforward API calls that don't have any dependencies. This data is used when interacting with [invoices](./invoice.md) and [clients](./client.md). 6 | 7 | --- 8 | 9 | ### New tax 10 | 11 | api/tax/new 12 | ``` 13 | curl --request POST \ 14 | --url 'https://www.envoice.in/api/tax/new' \ 15 | --header 'Content-Type: application/json' \ 16 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 17 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 18 | --data '{ 19 | "Name": "Personal tax", 20 | "Percentage": 10 21 | }' 22 | ``` 23 | 24 | 25 | Response: Id of created tax 26 | 27 | ``` 28 | 311 29 | ``` 30 | 31 | --- 32 | 33 | ### Update tax 34 | 35 | api/tax/update 36 | ``` 37 | curl --request POST \ 38 | --url 'https://www.envoice.in/api/tax/update' \ 39 | --header 'Content-Type: application/json' \ 40 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 41 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 42 | --data '{ 43 | "Name": "Other tax", 44 | "Percentage": 12, 45 | "Id: 311 46 | }' 47 | ``` 48 | 49 | --- 50 | 51 | ### Get all taxes 52 | 53 | api/tax/all 54 | ``` 55 | curl --request GET \ 56 | --url 'https://www.envoice.in/api/tax/all' \ 57 | --header 'Content-Type: application/json' \ 58 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 59 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 60 | ``` 61 | 62 | Response: List of all your taxes 63 | 64 | ``` 65 | [ 66 | { 67 | "Name": "Other tax", 68 | "Percentage": 12, 69 | "Id": 311, 70 | "CreatedOn": "2018-01-17T08:42:41+00:00" 71 | } 72 | ] 73 | ``` 74 | 75 | --- 76 | 77 | ### Delete tax 78 | 79 | api/tax/delete 80 | ``` 81 | curl --request POST \ 82 | --url 'https://www.envoice.in/api/tax/delete' \ 83 | --header 'Content-Type: application/json' \ 84 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 85 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 86 | --data '{ 87 | "Id: 311 88 | }' 89 | ``` 90 | 91 | Response: Id of deleted tax 92 | 93 | ``` 94 | 311 95 | ``` -------------------------------------------------------------------------------- /work-type.md: -------------------------------------------------------------------------------- 1 | ## Work type 2 | 3 | *For more details please read the [official Envoice documentation](https://www.envoice.in/reference/api/docs/v1) or [postman documentation.](https://documenter.getpostman.com/collection/view/1150943-7298a928-f509-01a3-5e4c-08592855085c#655ef83a-a1be-5212-78be-490f69f3e7c2)* 4 | 5 | In this section we have pretty straightforward API calls that don't have any dependencies. This data is used when interacting with [invoices](./invoice.md) and [clients](./client.md). 6 | 7 | --- 8 | 9 | ### New work type 10 | 11 | api/worktype/new 12 | ``` 13 | curl --request POST \ 14 | --url 'https://www.envoice.in/api/worktype/new' \ 15 | --header 'Content-Type: application/json' \ 16 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 17 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 18 | --data '{ 19 | "Title": "API Integration" 20 | }' 21 | ``` 22 | 23 | 24 | Response: Id of created work type 25 | 26 | ``` 27 | 3764 28 | ``` 29 | 30 | --- 31 | 32 | ### Update work type 33 | 34 | api/worktype/update 35 | ``` 36 | curl --request POST \ 37 | --url 'https://www.envoice.in/api/worktype/update' \ 38 | --header 'Content-Type: application/json' \ 39 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 40 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 41 | --data '{ 42 | "Title": "Software development", 43 | "Id: 3764 44 | }' 45 | ``` 46 | 47 | --- 48 | 49 | ### Get all work types 50 | 51 | api/worktype/all 52 | ``` 53 | curl --request GET \ 54 | --url 'https://www.envoice.in/api/worktype/all' \ 55 | --header 'Content-Type: application/json' \ 56 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 57 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 58 | ``` 59 | 60 | Response: List of all your work types 61 | 62 | ``` 63 | [ 64 | { 65 | "Title": "Software development", 66 | "Id": 3764, 67 | "CreatedOn": "2018-01-17T08:42:41+00:00" 68 | } 69 | ] 70 | ``` 71 | 72 | --- 73 | 74 | ### Delete work type 75 | 76 | api/worktype/delete 77 | ``` 78 | curl --request POST \ 79 | --url 'https://www.envoice.in/api/worktype/delete' \ 80 | --header 'Content-Type: application/json' \ 81 | --header 'x-auth-key: {YOUR_AUTH_KEY}' \ 82 | --header 'x-auth-secret: {YOUR_AUTH_SECRET}' \ 83 | --data '{ 84 | "Id: 3764 85 | }' 86 | ``` 87 | 88 | Response: Id of deleted work type 89 | 90 | ``` 91 | 3764 92 | ``` --------------------------------------------------------------------------------