openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 86 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"AvazaHq"},"description":"Welcome to the autogenerated documentation & test tool for Avaza's API. API Security & Authentication Authentication options include OAuth2 Implicit and Authorization flows. All connections should be encrypted over SSL/TLS To use the Api from your own app you will need us to issue you an App Client ID and Secret. You can get in touch to request one, and provide us with a redirect URI. OAuth2 Authorization endpoint: https://any.avaza.com/oauth2/authorize OAuth2 Token endpoint: https://any.avaza.com/oauth2/token Base URL for subsequent API Requests: https://api.avaza.com/ Blogpost about authenticating with Avaza's API: https://www.avaza.com/avaza-api-oauth2-authentication/ Blogpost on using Avaza's webhooks: https://www.avaza.com/avaza-api-webhook-notifications/ We currently issue Access Tokens that last 1 day, and Refresh tokens that last 180 days The Api currently assumes initial authentication by an Admin role user. In the future we will add support for access by other roles. Support For API Support, and to request access please contact Avaza Support Team via our support chat. User Contributed Libraries: Graciously contributed by 3rd party users like you. Note these are not tested or endorsesd by Avaza. We encourage you to review before use, and use at own risk. <ul><li> - <a target='blank' href='https://packagist.org/packages/debiprasad/oauth2-avaza'>PHP OAuth Client Package for Azava API (by Debiprasad Sahoo)</a></li></ul>","title":"Avaza","version":"v1","x-apisguru-categories":["collaboration"],"x-logo":{"url":"https://twitter.com/AvazaHq/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://api.avaza.com/swagger/docs/v1","version":"2.0"}],"x-providerName":"avaza.com"},"paths":{"/api/Account":{"get":{"operationId":"Account_Get","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/AccountDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AccountDetails"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Account Details","tags":["Account"]}},"/api/Company":{"get":{"operationId":"Company_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of results per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"1 based page number to retrieve","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"Sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CompanyList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Companies","tags":["Company"]},"post":{"operationId":"Company_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCompany"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewCompany"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewCompany"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewCompany"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewCompany"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}},"text/json":{"schema":{"$ref":"#/components/schemas/Company"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Company"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["write"]}],"summary":"Create a Company","tags":["Company"]},"put":{"description":"Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.","operationId":"Company_Put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompany"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateCompany"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateCompany"}},"text/xml":{"schema":{"$ref":"#/components/schemas/UpdateCompany"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UpdateCompany"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}},"text/json":{"schema":{"$ref":"#/components/schemas/Company"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Company"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Company"}}}}},"security":[{"oauth2":["write"]}],"summary":"Update a Task.","tags":["Company"]}},"/api/Company/{id}":{"get":{"operationId":"Company_GetByID","parameters":[{"description":"Company ID Number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}},"text/json":{"schema":{"$ref":"#/components/schemas/Company"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Company"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Company"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Company by Company ID","tags":["Company"]}},"/api/Contact":{"get":{"operationId":"Contact_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"Sort","required":false,"schema":{"type":"string"}},{"in":"query","name":"CompanyIDFK","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ContactList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ContactList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ContactList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Contacts","tags":["Contact"]},"post":{"operationId":"Contact_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCompanyContact"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewCompanyContact"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewCompanyContact"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewCompanyContact"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewCompanyContact"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyContact"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyContact"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyContact"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CompanyContact"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["write"]}],"summary":"Create a Contact","tags":["Contact"]}},"/api/Contact/{id}":{"get":{"operationId":"Contact_GetByID","parameters":[{"description":"Contact ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyContact"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyContact"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyContact"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CompanyContact"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Contact by Contact ID","tags":["Contact"]}},"/api/CreditNote":{"get":{"operationId":"CreditNote_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreditNoteList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreditNoteList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CreditNoteList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of CreditNotes","tags":["CreditNote"]}},"/api/CreditNote/{id}":{"get":{"operationId":"CreditNote_GetByID","parameters":[{"description":"Credit Note ID Number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNote"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreditNote"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreditNote"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CreditNote"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Invoice by CreditNote ID","tags":["CreditNote"]}},"/api/Currency":{"get":{"operationId":"Currency_Get","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CurrencyList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CurrencyList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CurrencyList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Currencies","tags":["Currency"]}},"/api/Estimate":{"get":{"description":"EstimateStatusCode values are: \"Draft\", \"Sent\", \"Late\", \"Paid\", \"Partial\", \"Void\"","operationId":"Estimate_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"Sort","required":false,"schema":{"type":"string"}},{"in":"query","name":"CompanyIDFK","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimateList"}},"text/json":{"schema":{"$ref":"#/components/schemas/EstimateList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EstimateList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/EstimateList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Estimates","tags":["Estimate"]}},"/api/Estimate/{id}":{"get":{"operationId":"Estimate_GetByID","parameters":[{"description":"Estimate Estimate ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Estimate by Estimate ID","tags":["Estimate"]}},"/api/Expense":{"get":{"operationId":"Expense_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"ExpenseDateFrom","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"ExpenseDateTo","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"UserEmail","required":false,"schema":{"type":"string"}},{"in":"query","name":"CategoryName","required":false,"schema":{"type":"string"}},{"in":"query","name":"CustomerID","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"ProjectID","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"isChargeable","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"isInvoiced","required":false,"schema":{"type":"boolean"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"Sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Expenses","tags":["Expense"]},"post":{"description":"Create an Expense","operationId":"Expense_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewExpense"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewExpense"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewExpense"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewExpense"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewExpense"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}}}}},"security":[{"oauth2":["write"]}],"summary":"Create an Expense","tags":["Expense"]}},"/api/Expense/{id}":{"get":{"operationId":"Expense_GetByID","parameters":[{"description":"Expense ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets an Expense Entry by Expense ID","tags":["Expense"]}},"/api/Inventory":{"get":{"description":"","operationId":"Inventory_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryList"}},"text/json":{"schema":{"$ref":"#/components/schemas/InventoryList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InventoryList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InventoryList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Inventory","tags":["Inventory"]}},"/api/Inventory/{id}":{"get":{"operationId":"Inventory_GetByID","parameters":[{"description":"InventoryItem ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets InventoryItem by InventoryItem ID","tags":["Inventory"]}},"/api/Invoice":{"get":{"description":"TransactionStatusCode values are: \"Draft\", \"Sent\", \"Late\", \"Paid\", \"Partial\", \"Void\"","operationId":"Invoice_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"Sort","required":false,"schema":{"type":"string"}},{"in":"query","name":"CompanyIDFK","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceList"}},"text/json":{"schema":{"$ref":"#/components/schemas/InvoiceList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/InvoiceList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/InvoiceList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Invoices","tags":["Invoice"]},"post":{"operationId":"Invoice_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewInvoice"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewInvoice"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewInvoice"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewInvoice"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewInvoice"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}},"text/json":{"schema":{"$ref":"#/components/schemas/Invoice"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Invoice"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}},"security":[{"oauth2":["write"]}],"summary":"Create a new draft invoice","tags":["Invoice"]}},"/api/Invoice/{id}":{"get":{"operationId":"Invoice_GetByID","parameters":[{"description":"Invoice Transaction ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Invoice by Invoice ID","tags":["Invoice"]}},"/api/Payment":{"get":{"operationId":"Payment_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentList"}},"text/json":{"schema":{"$ref":"#/components/schemas/PaymentList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PaymentList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Payments","tags":["Payment"]},"post":{"operationId":"Payment_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPayment"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewPayment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewPayment"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewPayment"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewPayment"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}},"text/json":{"schema":{"$ref":"#/components/schemas/Payment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Payment"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Payment"}}}}},"security":[{"oauth2":["write"]}],"summary":"Create new Payment and optionally assign payment allocations to Invoices","tags":["Payment"]}},"/api/Payment/{id}":{"get":{"operationId":"Payment_GetByID","parameters":[{"description":"Invoice Transaction ID Number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}},"text/json":{"schema":{"$ref":"#/components/schemas/Payment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Payment"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Payment by Payment Transaction ID","tags":["Payment"]}},"/api/Project":{"get":{"operationId":"Project_Get","parameters":[{"description":"Only show project records updated after a certain date (UTC)","in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"A column to sort on. Current possible values: \"DateUpdated\", \"DateCreated\", \"DateUpdated desc\", \"DateCreated desc\"","in":"query","name":"Sort","required":false,"schema":{"type":"string"}},{"description":"Filter to the projects that the supplied UserID can add timesheets to","in":"query","name":"TimesheetUserID","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Include Archived Projects in the results","in":"query","name":"includeArchived","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProjectList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Projects","tags":["Project"]},"post":{"operationId":"Project_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewProjectModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewProjectModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewProjectModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewProjectModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewProjectModel"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["write"]}],"summary":"Create a Project","tags":["Project"]}},"/api/Project/{id}":{"get":{"operationId":"Project_GetByID","parameters":[{"description":"Project ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProjectDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Project by Project ID","tags":["Project"]}},"/api/ProjectTimesheetCategory":{"get":{"operationId":"ProjectTimesheetCategory_Get","parameters":[{"description":"Get categories filtered by ProjectID","in":"query","name":"ProjectID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTimesheetCategoryList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProjectTimesheetCategoryList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ProjectTimesheetCategoryList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ProjectTimesheetCategoryList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Project Timesheet Categories","tags":["ProjectTimesheetCategory"]}},"/api/Section":{"get":{"operationId":"Section_Get","parameters":[{"description":"Get sections for Project with ProjectID","in":"query","name":"ProjectID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectionList"}},"text/json":{"schema":{"$ref":"#/components/schemas/SectionList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SectionList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SectionList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Sections","tags":["Section"]},"post":{"operationId":"Section_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSection"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewSection"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewSection"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewSection"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewSection"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectionDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/SectionDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SectionDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SectionDetails"}}}}},"security":[{"oauth2":["write"]}],"summary":"Create a Section","tags":["Section"]}},"/api/Task":{"get":{"operationId":"Task_Get","parameters":[{"description":"Optional filter to records updated after a specific date.","in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page. Defaults to 20.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1. Defaults to 1","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Optional sorting instruction. Currently possible values: \"DateUpdated\", \"DateCreated\", \"DateUpdated desc\", \"DateCreated desc\"","in":"query","name":"Sort","required":false,"schema":{"type":"string"}},{"description":"Optional filter to only display tasks belonging to a specific ProjectID","in":"query","name":"ProjectID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskList"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaskList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaskList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaskList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Tasks","tags":["Task"]},"post":{"operationId":"Task_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTask"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewTask"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewTask"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewTask"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewTask"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaskDetails"}}}}},"security":[{"oauth2":["write"]}],"summary":"Create a Task","tags":["Task"]},"put":{"description":"Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.","operationId":"Task_Put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTask"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateTask"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateTask"}},"text/xml":{"schema":{"$ref":"#/components/schemas/UpdateTask"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UpdateTask"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaskDetails"}}}}},"security":[{"oauth2":["write"]}],"summary":"Update a Task.","tags":["Task"]}},"/api/Task/{id}":{"get":{"operationId":"Task_GetByID","parameters":[{"description":"Task ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaskDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaskDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets Task by Task ID","tags":["Task"]}},"/api/Tax":{"get":{"operationId":"Tax_Get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxList"}},"text/json":{"schema":{"$ref":"#/components/schemas/TaxList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TaxList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TaxList"}}}}},"security":[{"oauth2":["read"]}],"summary":"Get List of Taxes configured in the Avaza account.","tags":["Tax"]}},"/api/Timesheet":{"get":{"operationId":"Timesheet_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"EntryDateFrom","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"EntryDateTo","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The UserID of a timesheet user to filter timesheets for. Only api users with certain higher roles can see timesheets across multiple users.","in":"query","name":"UserID","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"UserEmail","required":false,"schema":{"type":"string"}},{"in":"query","name":"CategoryName","required":false,"schema":{"type":"string"}},{"in":"query","name":"ProjectID","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"isBillable","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"isInvoiced","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"isTimerRunning","required":false,"schema":{"type":"boolean"}},{"description":"Number of items per page","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page to display. Starts from 1.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Optional sorting instruction. Currently possible values: \"DateUpdated\", \"DateCreated\", \"DateUpdated desc\", \"DateCreated desc\"","in":"query","name":"Sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimesheetList"}},"text/json":{"schema":{"$ref":"#/components/schemas/TimesheetList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimesheetList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TimesheetList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Gets list of Timsheets","tags":["Timesheet"]},"post":{"operationId":"Timesheet_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTimesheet"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewTimesheet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewTimesheet"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewTimesheet"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewTimesheet"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}}}}},"security":[{"oauth2":["write"]}],"summary":"Create a new Timesheet Entry","tags":["Timesheet"]},"put":{"description":"The FieldsToUpdate field expects a string array collection of the field names you would like updated.","operationId":"Timesheet_Put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTimesheetModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateTimesheetModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateTimesheetModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/UpdateTimesheetModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UpdateTimesheetModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}}}}},"security":[{"oauth2":["write"]}],"summary":"Update a Timesheet","tags":["Timesheet"]}},"/api/Timesheet/{id}":{"delete":{"operationId":"Timesheet_Delete","parameters":[{"description":"The TimesheetEntryID of the Timesheet Entry","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}}},"security":[{"oauth2":["write"]}],"summary":"Delete a Timesheet Entry","tags":["Timesheet"]},"get":{"operationId":"Timesheet_GetByID","parameters":[{"description":"Timesheet ID number","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/TimesheetDetails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets a Timesheet Entry by Timesheet ID","tags":["Timesheet"]}},"/api/TimesheetTimer":{"get":{"operationId":"TimesheetTimer_GetRunningTimer","parameters":[{"description":"Optional - User ID number if impersonating a different user. Otherwise assumes the current user. Only users with certain security roles have permission to impersonate other users","in":"query","name":"UserID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read"]}],"summary":"Gets the Running Timer if there is one for a user.","tags":["TimesheetTimer"]}},"/api/TimesheetTimer/{id}":{"delete":{"operationId":"TimesheetTimer_StopTimer","parameters":[{"description":"The ID of the existing timesheet entry that needs its timer stopped","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Optional - User ID number if impersonating a different user. Otherwise assumes the current user. Only users with certain security roles have permission to impersonate other users","in":"query","name":"UserID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["write"]}],"summary":"Stop the timer running on an existing Timesheet Entry","tags":["TimesheetTimer"]},"post":{"operationId":"TimesheetTimer_StartTimer","parameters":[{"description":"The ID of the existing timesheet entry on which to start a timer","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Optional - User ID number if impersonating a different user. Otherwise assumes the current user. Only users with certain security roles have permission to impersonate other users","in":"query","name":"UserID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["write"]}],"summary":"Starts a Timer running on an existing Timesheet Entry","tags":["TimesheetTimer"]}},"/api/UserProfile":{"get":{"description":"Admin and Invoice Managers can see all. Other users are limited to seeing their own profile.","operationId":"UserProfile_Get","parameters":[{"description":"Optional list of comma sepaprated roele codes to filter users by (e.g. \"TimesheetUser,Admin\")","in":"query","name":"Roles","required":false,"schema":{"type":"string"}},{"description":"Optional boolean (true/false) to filter to only show current authenticated user (always true for non Admin/InvoiceManager users)","in":"query","name":"CurrentUserOnly","required":false,"schema":{"type":"boolean"}},{"description":"Optionally filter by Company ID","in":"query","name":"CompanyIDFK","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}},"text/json":{"schema":{"$ref":"#/components/schemas/UserList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UserList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/UserList"}}}}},"security":[{"oauth2":["read"]}],"summary":"Get Collection of Users who have roles in the current Avaza account.","tags":["UserProfile"]}},"/api/Webhook":{"delete":{"operationId":"Webhook_DeleteByUrl","parameters":[{"description":"Target URL that should be used to delete subscriptions","in":"query","name":"target_url","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Subscription Deleted OK","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Delete webhook subscription by URL","tags":["Webhook"]},"get":{"operationId":"Webhook_Get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookList"}},"text/json":{"schema":{"$ref":"#/components/schemas/WebhookList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WebhookList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/WebhookList"}}}}},"security":[{"oauth2":["read"]}],"summary":"Get list of Webhook Subscriptions","tags":["Webhook"]},"post":{"description":"When you receive a webhook, you should respond with Http 200 OK Status Code, otherwise we will retry. Event values are: \"company_created\", \"company_deleted\", \"company_updated\", \"contact_created\", \"contact_deleted\", \"contact_updated\", \"invoice_created\", \"invoice_sent\", \"project_created\", \"project_deleted\", \"project_updated\", \"task_created\", \"timesheet_created\", \"timesheet_deleted\", \"timesheet_updated\". You can subscribe to any webhook, but you will only receive notifications for data appropriate to the roles of your user account. There is an optional Secret parameter (string 255 char max). This allows for webhook authentication. If provided, the Secret will be BASE 64 encoded and passed with notications as a basic authentication http header. i.e. Authorization Basic [BASE64 of Secret]\"","operationId":"Webhook_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}}},"required":true},"responses":{"201":{"description":"Subscription created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/SubscribeResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SubscribeResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/SubscribeResult"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Duplicate subscription already exists"}},"security":[{"oauth2":["read"]}],"summary":"Subscribe to Webhook. On success, returns ID of webhook subscription.","tags":["Webhook"]}},"/api/Webhook/{id}":{"delete":{"operationId":"Webhook_Delete","parameters":[{"description":"Subscription id to be deleted","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Subscription deleted ok","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read"]}],"summary":"Delete Webhook Subscription by ID","tags":["Webhook"]}}},"servers":[{"url":"https://api.avaza.com"}],"components":{"securitySchemes":{"oauth2":{"description":"OAuth2 Implicit Grant","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://any.avaza.com/oauth2/authorize","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}},"schemas":{"AccountDetails":{"properties":{"AccountID":{"format":"int32","type":"integer"},"CompanyName":{"type":"string"},"LockApprovedTimesheets":{"type":"boolean"},"Subdomain":{"type":"string"},"TimesheetDayOfWeek":{"format":"int32","type":"integer"},"TimesheetDisplayFormatCode":{"type":"string"},"WeeklyTimesheetReminder":{"type":"boolean"},"has24HourTimesheetFormat":{"type":"boolean"},"hasStartEndTimesheets":{"type":"boolean"}},"type":"object"},"Company":{"properties":{"BillingAddress":{"type":"string"},"BillingAddressCity":{"type":"string"},"BillingAddressLine":{"type":"string"},"BillingAddressPostCode":{"type":"string"},"BillingAddressState":{"type":"string"},"BillingCountryCode":{"type":"string"},"Comments":{"type":"string"},"CompanyID":{"format":"int32","type":"integer"},"CompanyName":{"type":"string"},"Contacts":{"items":{"$ref":"#/components/schemas/CompanyContact"},"type":"array"},"CurrencyCode":{"type":"string"},"DateCreated":{"format":"date-time","type":"string"},"DateUpdated":{"format":"date-time","type":"string"},"DefaultTradingTermIDFK":{"format":"int32","type":"integer"},"Fax":{"type":"string"},"Phone":{"type":"string"},"TaxNumber":{"type":"string"},"website":{"type":"string"}},"type":"object"},"CompanyContact":{"properties":{"CompanyIDFK":{"format":"int32","type":"integer"},"CompanyName":{"type":"string"},"ContactID":{"format":"int32","type":"integer"},"DateCreated":{"format":"date-time","type":"string"},"DateUpdated":{"format":"date-time","type":"string"},"Email":{"type":"string"},"Firstname":{"type":"string"},"Lastname":{"type":"string"},"Mobile":{"type":"string"},"Phone":{"type":"string"},"PositionTitle":{"type":"string"},"TimeZone":{"type":"string"}},"type":"object"},"CompanyList":{"properties":{"Companies":{"items":{"$ref":"#/components/schemas/Company"},"type":"array"},"PageNumber":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalCount":{"format":"int32","type":"integer"}},"type":"object"},"ContactList":{"properties":{"Contacts":{"items":{"$ref":"#/components/schemas/CompanyContact"},"type":"array"},"PageNumber":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalCount":{"format":"int32","type":"integer"}},"type":"object"},"CreateSubscription":{"description":"New Subscription to be Created","properties":{"event":{"description":"The event code to be notified about. Possible values: company_created, contact_created, invoice_created, invoice_sent, project_created, task_created","type":"string"},"secret":{"description":"Optional Secret string (255 char max). If provided, the secret will be BASE 64 encoded and used as a basic authentication http header with webhook notifications. i.e. Authorization Basic [BASE64 of Secret]\"","type":"string"},"target_url":{"description":"The URL that should be notified of the event.","type":"string"}},"required":["target_url","event"],"type":"object"},"CreditNote":{"properties":{"Balance":{"format":"double","type":"number"},"CreditNoteAllocations":{"items":{"$ref":"#/components/schemas/CreditNoteAllocation"},"type":"array"},"CreditNoteLineItems":{"items":{"$ref":"#/components/schemas/CreditNoteLineItem"},"type":"array"},"CreditNoteNumber":{"type":"string"},"CurrencyCode":{"type":"string"},"CustomerIDFK":{"format":"int32","type":"integer"},"DateCreated":{"format":"date-time","type":"string"},"DateIssued":{"format":"date-time","type":"string"},"DateUpdated":{"format":"date-time","type":"string"},"Notes":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"TransactionID":{"format":"int64","type":"integer"},"TransactionPrefix":{"type":"string"},"TransactionStatusCode":{"type":"string"}},"type":"object"},"CreditNoteAllocation":{"properties":{"AllocationAmount":{"format":"double","type":"number"},"AllocationDate":{"format":"date-time","type":"string"},"CreditNoteTransactionIDFK":{"format":"int64","type":"integer"},"InvoiceTransactionIDFK":{"format":"int64","type":"integer"},"TransactionAllocationID":{"format":"int64","type":"integer"}},"type":"object"},"CreditNoteLineItem":{"properties":{"Amount":{"format":"double","type":"number"},"Description":{"type":"string"},"Discount":{"format":"double","type":"number"},"Quantity":{"format":"double","type":"number"},"TaxAmount":{"format":"double","type":"number"},"TaxIDFK":{"format":"int32","type":"integer"},"TransactionLineItemID":{"format":"int64","type":"integer"},"UnitPrice":{"format":"double","type":"number"}},"type":"object"},"CreditNoteList":{"properties":{"CreditNotes":{"items":{"$ref":"#/components/sche