{"note":"OpenAPI conversion -- returning structured metadata","name":"envoice-in","description":"API v1.0.0","version":"v1","base_url":"https://www.envoice.in","endpoints":61,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api API v1.0.0\n@base https://www.envoice.in\n@version v1\n@auth ApiKey x-auth-key in header | ApiKey x-auth-secret in header\n@common_fields {x-auth-key: any, x-auth-secret: any}\n@endpoints 61\n@hint download_for_search\n@toc api(61)\n\n@endpoint GET /api/client/all\n@desc Return all clients for the account\n@returns(200) OK\n\n@endpoint POST /api/client/new\n@desc Create a client\n@required {client: map}\n@returns(200) OK\n\n@endpoint POST /api/client/update\n@desc Update an existing client\n@required {client: map}\n@returns(204) No Content\n\n@endpoint GET /api/client/candelete\n@desc Check if the provided client can be deleted\n@required {id: any}\n@returns(200) OK\n\n@endpoint POST /api/client/delete\n@desc Delete an existing client\n@required {deleteModel: map}\n@returns(200) OK\n\n@endpoint GET /api/client/details\n@desc Return client details. Activities and invoices included.\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/estimation/all\n@desc Return all estimation for the account\n@optional {queryOptions.page: any, queryOptions.pageSize: any}\n@returns(200) OK\n\n@endpoint POST /api/estimation/new\n@desc Create an estimation\n@required {estimation: map}\n@returns(200) OK\n\n@endpoint POST /api/estimation/update\n@desc Update an existing estimation\n@required {estimation: map}\n@returns(200) OK\n\n@endpoint POST /api/estimation/delete\n@desc Delete an existing estimation\n@required {deleteModel: map}\n@returns(200) OK\n\n@endpoint POST /api/estimation/changestatus\n@desc Change estimation status\n@required {statusModel: map}\n@returns(200) OK\n\n@endpoint GET /api/estimation/status\n@desc Retrieve the status of the estimation\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/estimation/details\n@desc Return estimation data\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/estimation/uri\n@desc Return the unique url to the client's invoice\n@required {id: any}\n@returns(200) OK\n\n@endpoint POST /api/estimation/convert\n@desc Convert the estimation to an invoice\n@required {id: int(int32)}\n@returns(200) OK\n\n@endpoint POST /api/estimation/sendtoclient\n@desc Send the provided estimation to the client\n@required {deliveryOptions: map}\n@returns(200) OK\n\n@endpoint GET /api/general/countries\n@desc Return all of the platform supported countries\n@returns(200) OK\n\n@endpoint GET /api/general/currencies\n@desc Return all of the platform supported currencies\n@returns(200) OK\n\n@endpoint GET /api/general/uilanguages\n@desc Return all of the platform supported UI languages\n@returns(200) OK\n\n@endpoint GET /api/general/dateformats\n@desc Return all of the platform supported Date Formats\n@returns(200) OK\n\n@endpoint GET /api/invoice/all\n@desc Return all invoices for the account\n@optional {queryOptions.page: any, queryOptions.pageSize: any}\n@returns(200) OK\n\n@endpoint GET /api/invoice/allcategories\n@desc Return all invoice categories for the account\n@optional {query: any}\n@returns(200) OK\n\n@endpoint POST /api/invoice/new\n@desc Create an invoice\n@required {invoice: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/newcategory\n@desc Create an invoice category\n@required {invoiceCategory: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/update\n@desc Update an existing invoice\n@required {invoice: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/updatecategory\n@desc Update an existing invoice category\n@required {invoiceCateogry: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/delete\n@desc Delete an existing invoice\n@required {deleteModel: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/deletecategory\n@desc Delete an existing invoice category\n@required {deleteModel: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/sendtoclient\n@desc Send the provided invoice to the client\n@required {deliveryOptions: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/sendtoaccountant\n@desc Send the provided invoice to the accountant\n@required {invoice: map}\n@returns(200) OK\n\n@endpoint POST /api/invoice/changestatus\n@desc Change invoice status\n@required {statusModel: map}\n@returns(200) OK\n\n@endpoint GET /api/invoice/status\n@desc Retrieve the status of the invoice\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/invoice/details\n@desc Return invoice data\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/invoice/uri\n@desc Return the unique url to the client's invoice\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/invoice/pdf\n@desc Return the PDF for the invoice\n@required {id: any}\n@optional {signedVersion: any}\n@returns(200) OK\n\n@endpoint GET /api/order/all\n@desc Return all orders for the account\n@optional {queryOptions.page: any, queryOptions.pageSize: any}\n@returns(200) OK\n\n@endpoint POST /api/order/new\n@desc Create an order\n@required {order: map}\n@returns(200) OK\n\n@endpoint POST /api/order/delete\n@desc Delete an existing order\n@required {order: map}\n@returns(200) OK\n\n@endpoint POST /api/order/changeshippingdetails\n@desc Change order shipping details\n@required {orderId: any, shippingDetails: map}\n@returns(204) No Content\n\n@endpoint POST /api/order/changestatus\n@desc Change order status\n@required {status: map}\n@returns(204) No Content\n\n@endpoint GET /api/order/details\n@desc Return order details\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/payment/supported\n@desc Return all supported payment gateways (no currencies means all are supported)\n@returns(200) OK\n\n@endpoint GET /api/paymentlink/uri\n@desc Return the unique url to the client's payment link\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/paymentlink/all\n@desc Create a payment link\n@optional {queryOptions.page: any, queryOptions.pageSize: any}\n@returns(200) OK\n\n@endpoint POST /api/paymentlink/new\n@desc Create a payment link\n@required {paymentLink: map}\n@returns(200) OK\n\n@endpoint POST /api/paymentlink/delete\n@desc Delete an existing payment link\n@required {paymentLink: map}\n@returns(200) OK\n\n@endpoint GET /api/product/all\n@desc Return all products for the account\n@optional {queryOptions.page: any, queryOptions.pageSize: any}\n@returns(200) OK\n\n@endpoint POST /api/product/new\n@desc Create a product\n@required {product: map}\n@returns(200) OK\n\n@endpoint POST /api/product/update\n@desc Update an existing product\n@required {product: map}\n@returns(204) No Content\n\n@endpoint POST /api/product/delete\n@desc Delete an existing product\n@required {product: map}\n@returns(200) OK\n\n@endpoint GET /api/product/details\n@desc Return product details\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/tax/all\n@desc Return all taxes for the account\n@returns(200) OK\n\n@endpoint POST /api/tax/new\n@desc Create a tax\n@required {tax: map}\n@returns(200) OK\n\n@endpoint POST /api/tax/update\n@desc Update an existing tax\n@required {tax: map}\n@returns(204) No Content\n\n@endpoint POST /api/tax/delete\n@desc Delete an existing tax\n@required {deleteModel: map}\n@returns(200) OK\n\n@endpoint GET /api/worktype/all\n@desc Return all work types for the account\n@returns(200) OK\n\n@endpoint GET /api/worktype/search\n@desc Return all work types for the account that match the query param\n@optional {queryOptions.query: any, queryOptions.orderBy: any, queryOptions.order: any, queryOptions.page: any, queryOptions.pageSize: any}\n@returns(200) OK\n\n@endpoint POST /api/worktype/new\n@desc Create a work type\n@required {workType: map}\n@returns(200) OK\n\n@endpoint POST /api/worktype/update\n@desc Update an existing work type\n@required {workType: map}\n@returns(204) No Content\n\n@endpoint POST /api/worktype/delete\n@desc Delete an existing work type\n@required {deleteModel: map}\n@returns(200) OK\n\n@endpoint GET /api/worktype/details\n@desc Return work type details\n@required {workTypeId: any}\n@returns(200) OK\n\n@end\n"}