openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 94.7 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"x-twitter":"envoicein"},"description":"[](https://app.getpostman.com/run-collection/1d39bbcddaf694d81100)\r\n<span style='margin-left: 0.5em;'>or</span>\r\n<a href='https://documenter.getpostman.com/view/3559821/envoice-api/RW1XL1mf' class='openapi-button' _ngcontent-c6>View Postman docs</a>\r\n\r\n# Quickstart\r\n\r\nVisit [github](https://github.com/EmitKnowledge/Envoice) to view the quickstart tutorial.\r\n\r\n<div class='postman-tutorial'>\r\n\r\n# Tutorial for running the API in postman\r\n\r\nClick on \"\"Run in Postman\"\" button\r\n<br /><br />\r\n\r\n\r\n --- \r\n\r\nA new page will open.\r\nClick the \"\"Postman for windows\"\" to run postman as a desktop app.\r\nMake sure you have already [installed](https://www.getpostman.com/docs/postman/launching_postman/installation_and_updates) Postman.\r\n<br /><br />\r\n\r\n\r\n --- \r\n\r\nIn chrome an alert might show up to set a default app for opening postman links. Click on \"\"Open Postman\"\".\r\n<br /><br />\r\n\r\n\r\n --- \r\n\r\nThe OpenAPI specification will be imported in Postman as a new collection named \"\"Envoice api\"\"\r\n<br /><br />\r\n\r\n\r\n --- \r\n\r\nWhen 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. \r\n<sub>\\*Eye button in top right corner </sub>\r\n<br /><br /> \r\n\r\n<br /><br /> \r\n\r\n\r\n --- \r\n\r\nYou 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.\r\n<br /><br />\r\n\r\n\r\n --- \r\n\r\nModify the example data to suit your needs and send a request.\r\n<br /><br />\r\n\r\n</div>\r\n\r\n# Webhooks\r\n\r\nWebhooks allow you to build or set up Envoice Apps which subscribe to invoice activities. \r\nWhen one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. \r\nWebhooks can be used to update an external invoice data storage.\r\n\r\nIn 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.\r\nAll nonworking webhooks will be ignored after a certain period of time and several retry attempts.\r\nIf after several attempts the webhook starts to work, we will send you all activities, both past and present, in chronological order.\r\n\r\nThe payload of the webhook is in format:\r\n```\r\n{\r\n Signature: \"\"sha256 string\"\",\r\n Timestamp: \"\"YYYY-MM-DDTHH:mm:ss.FFFFFFFZ\"\",\r\n Activity: {\r\n Message: \"string\",\r\n Link: \"share url\",\r\n Type: int, \r\n InvoiceNumber: \"string\",\r\n InvoiceId: int, \r\n OrderNumber: \"string\",\r\n OrderId: int,\r\n Id: int,\r\n CreatedOn: \"YYYY-MM-DDTHH:mm:ss.FFFFFFFZ\"\r\n }\r\n}\r\n``` ","title":"API v1.0.0","version":"v1","x-apisguru-categories":["financial"],"x-logo":{"url":"https://twitter.com/envoicein/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://www.envoice.in/docs/api/v1/specification","version":"2.0"}],"x-providerName":"envoice.in"},"paths":{"/api/client/all":{"get":{"operationId":"ClientApi_All","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/ClientDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/ClientDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/ClientDetailsApiModel"},"type":"array"}}}}},"summary":"Return all clients for the account","tags":["Client"]}},"/api/client/candelete":{"get":{"operationId":"ClientApi_CanDelete","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}},"text/html":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}},"text/xml":{"schema":{"type":"boolean"}}}}},"summary":"Check if the provided client can be deleted","tags":["Client"]}},"/api/client/delete":{"post":{"operationId":"ClientApi_Delete","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDeleteApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ClientDeleteApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ClientDeleteApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ClientDeleteApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ClientDeleteApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ClientDeleteApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Delete an existing client","tags":["Client"]}},"/api/client/details":{"get":{"operationId":"ClientApi_Details","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ClientDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ClientDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ClientDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ClientDetailsApiModel"}}}}},"summary":"Return client details. Activities and invoices included.","tags":["Client"]}},"/api/client/new":{"post":{"operationId":"ClientApi_New","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ClientCreateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ClientCreateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ClientCreateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ClientCreateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ClientCreateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Create a client","tags":["Client"]}},"/api/client/update":{"post":{"operationId":"ClientApi_Update","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ClientUpdateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ClientUpdateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ClientUpdateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ClientUpdateApiModel"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Update an existing client","tags":["Client"]}},"/api/general/countries":{"get":{"operationId":"GeneralApi_Countries","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CountryDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/CountryDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/CountryDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/CountryDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/CountryDetailsApiModel"},"type":"array"}}}}},"summary":"Return all of the platform supported countries","tags":["General"]}},"/api/general/currencies":{"get":{"operationId":"GeneralApi_Currencies","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CurrencyDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/CurrencyDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/CurrencyDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/CurrencyDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/CurrencyDetailsApiModel"},"type":"array"}}}}},"summary":"Return all of the platform supported currencies","tags":["General"]}},"/api/general/dateformats":{"get":{"operationId":"GeneralApi_DateFormats","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}},"text/json":{"schema":{"items":{"type":"string"},"type":"array"}},"text/html":{"schema":{"items":{"type":"string"},"type":"array"}},"application/xml":{"schema":{"items":{"type":"string"},"type":"array"}},"text/xml":{"schema":{"items":{"type":"string"},"type":"array"}}}}},"summary":"Return all of the platform supported Date Formats","tags":["General"]}},"/api/general/uilanguages":{"get":{"operationId":"GeneralApi_UiLanguages","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UILanguageDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/UILanguageDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/UILanguageDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/UILanguageDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/UILanguageDetailsApiModel"},"type":"array"}}}}},"summary":"Return all of the platform supported UI languages","tags":["General"]}},"/api/invoice/all":{"get":{"operationId":"InvoiceApi_All","parameters":[{"in":"query","name":"queryOptions.page","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"queryOptions.pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResult_InvoiceDetailsApiModel_"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListResult_InvoiceDetailsApiModel_"}},"text/html":{"schema":{"$ref":"#/components/schemas/ListResult_InvoiceDetailsApiModel_"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ListResult_InvoiceDetailsApiModel_"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ListResult_InvoiceDetailsApiModel_"}}}}},"summary":"Return all invoices for the account","tags":["Invoice"]}},"/api/invoice/changestatus":{"post":{"operationId":"InvoiceApi_ChangeStatus","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeStatusApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeStatusApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ChangeStatusApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ChangeStatusApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeStatusApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ChangeStatusApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}},"text/html":{"schema":{"type":"boolean"}},"application/xml":{"schema":{"type":"boolean"}},"text/xml":{"schema":{"type":"boolean"}}}}},"summary":"Change invoice status","tags":["Invoice"]}},"/api/invoice/delete":{"post":{"operationId":"InvoiceApi_Delete","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDeleteApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceDeleteApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceDeleteApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceDeleteApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceDeleteApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/InvoiceDeleteApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Delete an existing invoice","tags":["Invoice"]}},"/api/invoice/details":{"get":{"operationId":"InvoiceApi_Details","parameters":[{"description":"","in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}}}}},"summary":"Return invoice data","tags":["Invoice"]}},"/api/invoice/new":{"post":{"operationId":"InvoiceApi_New","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceCreateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceCreateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceCreateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/InvoiceCreateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}}}}},"summary":"Create an invoice","tags":["Invoice"]}},"/api/invoice/sendtoaccountant":{"post":{"operationId":"InvoiceApi_SendToAccountant","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendInvoiceToAccountantApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SendInvoiceToAccountantApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/SendInvoiceToAccountantApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SendInvoiceToAccountantApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SendInvoiceToAccountantApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SendInvoiceToAccountantApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Send the provided invoice to the accountant","tags":["Invoice"]}},"/api/invoice/sendtoclient":{"post":{"operationId":"InvoiceApi_SendToClient","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendInvoiceToClientApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/SendInvoiceToClientApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/SendInvoiceToClientApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SendInvoiceToClientApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SendInvoiceToClientApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SendInvoiceToClientApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Send the provided invoice to the client","tags":["Invoice"]}},"/api/invoice/status":{"get":{"operationId":"InvoiceApi_Status","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"enum":["Draft","Paid","Unpaid","Overdue","Void"],"type":"string"}},"text/json":{"schema":{"enum":["Draft","Paid","Unpaid","Overdue","Void"],"type":"string"}},"text/html":{"schema":{"enum":["Draft","Paid","Unpaid","Overdue","Void"],"type":"string"}},"application/xml":{"schema":{"enum":["Draft","Paid","Unpaid","Overdue","Void"],"type":"string"}},"text/xml":{"schema":{"enum":["Draft","Paid","Unpaid","Overdue","Void"],"type":"string"}}}}},"summary":"Retrieve the status of the invoice","tags":["Invoice"]}},"/api/invoice/update":{"post":{"operationId":"InvoiceApi_Update","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/InvoiceUpdateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceFullDetailsApiModel"}}}}},"summary":"Update an existing invoice","tags":["Invoice"]}},"/api/invoice/uri":{"get":{"operationId":"InvoiceApi_Uri","parameters":[{"description":"","in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUriApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceUriApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceUriApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceUriApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceUriApiModel"}}}}},"summary":"Return the unique url to the client's invoice","tags":["Invoice"]}},"/api/order/all":{"get":{"operationId":"OrderApi_All","parameters":[{"in":"query","name":"queryOptions.page","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"queryOptions.pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResult_OrderDetailsApiModel_"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListResult_OrderDetailsApiModel_"}},"text/html":{"schema":{"$ref":"#/components/schemas/ListResult_OrderDetailsApiModel_"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ListResult_OrderDetailsApiModel_"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ListResult_OrderDetailsApiModel_"}}}}},"summary":"Return all orders for the account","tags":["Order"]}},"/api/order/changeshippingdetails":{"post":{"operationId":"OrderApi_ChangeShippingDetails","parameters":[{"in":"query","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderShippingDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderShippingDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/OrderShippingDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrderShippingDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrderShippingDetailsApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OrderShippingDetailsApiModel"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Change order shipping details","tags":["Order"]}},"/api/order/changestatus":{"post":{"operationId":"OrderApi_ChangeStatus","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeOrderStatusApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeOrderStatusApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ChangeOrderStatusApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ChangeOrderStatusApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeOrderStatusApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ChangeOrderStatusApiModel"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Change order status","tags":["Order"]}},"/api/order/delete":{"post":{"operationId":"OrderApi_Delete","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDeleteApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderDeleteApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/OrderDeleteApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrderDeleteApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrderDeleteApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OrderDeleteApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Delete an existing order","tags":["Order"]}},"/api/order/details":{"get":{"operationId":"OrderApi_Details","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderFullDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderFullDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/OrderFullDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrderFullDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrderFullDetailsApiModel"}}}}},"summary":"Return order details","tags":["Order"]}},"/api/order/new":{"post":{"operationId":"OrderApi_New","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCreateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderCreateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/OrderCreateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrderCreateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrderCreateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OrderCreateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Create an order","tags":["Order"]}},"/api/payment/supported":{"get":{"operationId":"PaymentApi_Supported","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentGatewayDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentGatewayDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/PaymentGatewayDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/PaymentGatewayDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/PaymentGatewayDetailsApiModel"},"type":"array"}}}}},"summary":"Return all supported payment gateways (no currencies means all are supported)","tags":["Payment"]}},"/api/product/all":{"get":{"operationId":"ProductApi_All","parameters":[{"in":"query","name":"queryOptions.page","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"queryOptions.pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResult_ProductDetailsApiModel_"}},"text/json":{"schema":{"$ref":"#/components/schemas/ListResult_ProductDetailsApiModel_"}},"text/html":{"schema":{"$ref":"#/components/schemas/ListResult_ProductDetailsApiModel_"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ListResult_ProductDetailsApiModel_"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ListResult_ProductDetailsApiModel_"}}}}},"summary":"Return all products for the account","tags":["Product"]}},"/api/product/delete":{"post":{"operationId":"ProductApi_Delete","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDeleteApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProductDeleteApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ProductDeleteApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductDeleteApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProductDeleteApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ProductDeleteApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Delete an existing product","tags":["Product"]}},"/api/product/details":{"get":{"operationId":"ProductApi_Details","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFullDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProductFullDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ProductFullDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductFullDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProductFullDetailsApiModel"}}}}},"summary":"Return product details","tags":["Product"]}},"/api/product/new":{"post":{"operationId":"ProductApi_New","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCreateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProductCreateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ProductCreateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductCreateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProductCreateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ProductCreateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Create a product","tags":["Product"]}},"/api/product/update":{"post":{"operationId":"ProductApi_Update","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductUpdateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProductUpdateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/ProductUpdateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProductUpdateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProductUpdateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ProductUpdateApiModel"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Update an existing product","tags":["Product"]}},"/api/tax/all":{"get":{"operationId":"TaxApi_All","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaxDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/TaxDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/TaxDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/TaxDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/TaxDetailsApiModel"},"type":"array"}}}}},"summary":"Return all taxes for the account","tags":["Tax"]}},"/api/tax/delete":{"post":{"operationId":"TaxApi_Delete","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDeleteApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaxDeleteApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/TaxDeleteApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxDeleteApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaxDeleteApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TaxDeleteApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Delete an existing tax","tags":["Tax"]}},"/api/tax/new":{"post":{"operationId":"TaxApi_New","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCreateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaxCreateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/TaxCreateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxCreateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaxCreateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TaxCreateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Create a tax","tags":["Tax"]}},"/api/tax/update":{"post":{"operationId":"TaxApi_Update","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxUpdateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaxUpdateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/TaxUpdateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxUpdateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaxUpdateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TaxUpdateApiModel"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Update an existing tax","tags":["Tax"]}},"/api/worktype/all":{"get":{"operationId":"WorkTypeApi_All","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"},"type":"array"}}}}},"summary":"Return all work types for the account","tags":["WorkType"]}},"/api/worktype/delete":{"post":{"operationId":"WorkTypeApi_Delete","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkTypeDeleteApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/WorkTypeDeleteApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/WorkTypeDeleteApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WorkTypeDeleteApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/WorkTypeDeleteApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/WorkTypeDeleteApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Delete an existing work type","tags":["WorkType"]}},"/api/worktype/details":{"get":{"operationId":"WorkTypeApi_Details","parameters":[{"in":"query","name":"workTypeId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/WorkTypeDetailsApiModel"}}}}},"summary":"Return work type details","tags":["WorkType"]}},"/api/worktype/new":{"post":{"operationId":"WorkTypeApi_New","parameters":[{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkTypeCreateApiModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/WorkTypeCreateApiModel"}},"text/html":{"schema":{"$ref":"#/components/schemas/WorkTypeCreateApiModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WorkTypeCreateApiModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/WorkTypeCreateApiModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/WorkTypeCreateApiModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"format":"int32","type":"integer"}},"text/json":{"schema":{"format":"int32","type":"integer"}},"text/html":{"schema":{"format":"int32","type":"integer"}},"application/xml":{"schema":{"format":"int32","type":"integer"}},"text/xml":{"schema":{"format":"int32","type":"integer"}}}}},"summary":"Create a work type","tags":["WorkType"]}},"/api/worktype/search":{"get":{"operationId":"WorkTypeApi_Search","parameters":[{"in":"query","name":"queryOptions.query","required":false,"schema":{"type":"string"}},{"in":"query","name":"queryOptions.orderBy","required":false,"schema":{"type":"string"}},{"in":"query","name":"queryOptions.order","required":false,"schema":{"type":"string","enum":["None","Asc","Desc"]}},{"in":"query","name":"queryOptions.page","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"queryOptions.pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"","in":"header","name":"x-auth-key","required":true,"schema":{"type":"string","default":"[authentication key]"}},{"description":"","in":"header","name":"x-auth-secret","required":true,"schema":{"type":"string","default":"[authentication secret]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WorkTypeDetailsApi