openapi-directory/api/avaza.com.json

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

{"openapi":"3.0.0","info":{"contact":{"x-twitter":"AvazaHq"},"description":"Welcome to the autogenerated documentation & test tool for Avaza's API. <br/><br/><strong>API Security & Authentication</strong><br/>Authentication options include OAuth2 Implicit and Authorization Code flows, and Personal Access Token. All connections should be encrypted over SSL/TLS <br/><br/>You can set up and manage your api authentication credentials from within your Avaza account. (requires Administrator permissions on your Avaza account).<br/><br/> OAuth2 Authorization endpoint: https://any.avaza.com/oauth2/authorize  <br/>OAuth2 Token endpoint: https://any.avaza.com/oauth2/token<br/>Base URL for subsequent API Requests: https://api.avaza.com/ <br/><br/>Blogpost about authenticating with Avaza's API:  https://www.avaza.com/avaza-api-oauth2-authentication/ <br/>Blogpost on using Avaza's webhooks: https://www.avaza.com/avaza-api-webhook-notifications/<br/>The OAuth flow currently issues Access Tokens that last 1 day, and Refresh tokens that last 180 days<br/>The Api respects the security Roles assigned to the authenticating Avaza user and filters the data return appropriately. <br/><br><strong>Support</strong><br/>For API Support, and to request access please contact Avaza Support Team via our support chat. <br/><br/><strong>User Contributed Libraries:</strong><br/>Graciously contributed by 3rd party users like you. <br/>Note these are not tested or endorsesd by Avaza. We encourage you to review before use, and use at own risk.<br/> <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 API Documentation","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":{"/ScheduleSeries/AddBooking":{"post":{"operationId":"ScheduleSeries_AddBooking","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBooking"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateBooking"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreateBooking"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CreateBooking"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CreateBooking"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}}}}},"security":[{"oauth2":["write_schedule"]}],"summary":"Create new Schedule Booking","tags":["ScheduleSeries"]}},"/ScheduleSeries/AddLeave":{"post":{"operationId":"ScheduleSeries_AddLeave","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLeave"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateLeave"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreateLeave"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CreateLeave"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CreateLeave"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}}}}},"security":[{"oauth2":["write_schedule"]}],"summary":"Create new Leave Booking","tags":["ScheduleSeries"]}},"/ScheduleSeries/EditBooking":{"put":{"operationId":"ScheduleSeries_EditBooking","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditBooking"}},"text/json":{"schema":{"$ref":"#/components/schemas/EditBooking"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EditBooking"}},"text/xml":{"schema":{"$ref":"#/components/schemas/EditBooking"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/EditBooking"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}}}}},"security":[{"oauth2":["write_schedule"]}],"summary":"Edit Booking","tags":["ScheduleSeries"]}},"/ScheduleSeries/EditLeave":{"put":{"operationId":"ScheduleSeries_EditLeave","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditLeave"}},"text/json":{"schema":{"$ref":"#/components/schemas/EditLeave"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EditLeave"}},"text/xml":{"schema":{"$ref":"#/components/schemas/EditLeave"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/EditLeave"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ScheduleSeriesDetails"}}}}},"security":[{"oauth2":["write_schedule"]}],"summary":"Edit Leave Booking","tags":["ScheduleSeries"]}},"/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_account"]}],"summary":"Account Details","tags":["Account"]}},"/api/Bill":{"get":{"description":"TransactionStatusCode values are: \"Draft\", \"Verified\", \"Late\", \"Paid\", \"Partial\", \"Void\"","operationId":"Bill_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page (max 1000)","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/BillList"}},"text/json":{"schema":{"$ref":"#/components/schemas/BillList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BillList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read_financials"]}],"summary":"Gets list of Bills","tags":["Bill"]},"post":{"operationId":"Bill_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewBill"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewBill"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewBill"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewBill"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewBill"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bill"}},"text/json":{"schema":{"$ref":"#/components/schemas/Bill"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bill"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Bill"}}}}},"security":[{"oauth2":["write_financials"]}],"summary":"Create a new draft Bill","tags":["Bill"]}},"/api/Bill/{id}":{"get":{"operationId":"Bill_GetByID","parameters":[{"description":"Bill 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_financials"]}],"summary":"Gets a Bill by Bill ID","tags":["Bill"]}},"/api/BillPayment":{"get":{"operationId":"BillPayment_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page (max 1000)","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/BillPaymentList"}},"text/json":{"schema":{"$ref":"#/components/schemas/BillPaymentList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillPaymentList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BillPaymentList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read_financials"]}],"summary":"Gets list of Bill Payments","tags":["BillPayment"]},"post":{"operationId":"BillPayment_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewBillPayment"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewBillPayment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewBillPayment"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewBillPayment"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewBillPayment"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPayment"}},"text/json":{"schema":{"$ref":"#/components/schemas/BillPayment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillPayment"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BillPayment"}}}}},"security":[{"oauth2":["write_financials"]}],"summary":"Create new Bill Payment and optionally assign payment allocations to Bills","tags":["BillPayment"]}},"/api/BillPayment/{id}":{"get":{"operationId":"BillPayment_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/BillPayment"}},"text/json":{"schema":{"$ref":"#/components/schemas/BillPayment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillPayment"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BillPayment"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"oauth2":["read_financials"]}],"summary":"Gets a Bill Payment by Payment Transaction ID","tags":["BillPayment"]}},"/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"}},{"description":"(optional) Supply one of: \"DateUpdated\", \"DateCreated\", \"CompanyName\",\"DateUpdated desc\",\"DateCreated desc\", \"CompanyName desc\"","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_contacts"]}],"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_contacts"]}],"summary":"Create a Company","tags":["Company"]},"put":{"description":"Requires CompanyID 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_contacts"]}],"summary":"Update a Company record.","tags":["Company"]}},"/api/Company/Lookup":{"get":{"description":"Certain roles see a restricted set of companies based on their project memberships","operationId":"CompanyLookup","parameters":[{"description":"Number of items per page (max 1000)","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":"Search string to match against Company title","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDropdownList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyDropdownList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CompanyDropdownList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CompanyDropdownList"}}}}},"security":[{"oauth2":["read_contacts"]}],"summary":"Gets minimal list of Companies.","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_contacts"]}],"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 (max 1000)","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_contacts"]}],"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_contacts"]}],"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_contacts"]}],"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 (max 1000)","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_financials"]}],"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_financials"]}],"summary":"Gets Credit Note by CreditNoteID","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"}}}}},"summary":"Gets list of Currencies","tags":["Currency"]}},"/api/Estimate":{"get":{"description":"EstimateStatusCode values are: \"Draft\", \"Sent\", \"Accepted\", \"Converted\", \"Expired\", \"Rejected\"","operationId":"Estimate_Get","parameters":[{"in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page (max 1000)","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_financials"]}],"summary":"Gets list of Estimates","tags":["Estimate"]},"post":{"operationId":"Estimate_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewEstimate"}},"text/json":{"schema":{"$ref":"#/components/schemas/NewEstimate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewEstimate"}},"text/xml":{"schema":{"$ref":"#/components/schemas/NewEstimate"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewEstimate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimateDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/EstimateDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EstimateDetails"}},"text/xml":{"schema":{"$ref":"#/components/schemas/EstimateDetails"}}}}},"security":[{"oauth2":["write_financials"]}],"summary":"Create a new draft Estimate","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_financials"]}],"summary":"Gets Estimate by Estimate ID","tags":["Estimate"]}},"/api/Expense":{"delete":{"operationId":"Expense_Delete","requestBody":{"content":{"application/json":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"text/json":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"application/xml":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"text/xml":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"application/x-www-form-urlencoded":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}}},"description":"A collection of ExpenseIDs to delete","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseDeleteResultSet"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseDeleteResultSet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseDeleteResultSet"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseDeleteResultSet"}}}}},"security":[{"oauth2":["write_expenses"]}],"summary":"Delete a Timesheet Entry","tags":["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":"UserID","required":false,"schema":{"type":"integer","format":"int32"}},{"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"}},{"in":"query","name":"ExpenseReimbursementIDFK","required":false,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"ExpensePaymentMethodIDFK","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"ExpenseApprovalStatusCode","required":false,"schema":{"type":"string"}},{"in":"query","name":"Search","required":false,"schema":{"type":"string"}},{"description":"Number of items per page (max 1000)","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_expenses"]}],"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_expenses"]}],"summary":"Create an Expense","tags":["Expense"]},"put":{"description":"Update an Expense","operationId":"Expense_Put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExpense"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateExpense"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateExpense"}},"text/xml":{"schema":{"$ref":"#/components/schemas/UpdateExpense"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UpdateExpense"}}},"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_expenses"]}],"summary":"Update an Expense","tags":["Expense"]}},"/api/Expense/Attachment":{"post":{"operationId":"ExpenseAttachment","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"File":{"description":"Upload software package","type":"string","format":"binary"}},"required":["File"]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseAttachmentUploadResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseAttachmentUploadResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseAttachmentUploadResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseAttachmentUploadResult"}}}}},"security":[{"oauth2":["write_expenses"]}],"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_expenses"]}],"summary":"Gets an Expense Entry by Expense ID","tags":["Expense"]}},"/api/ExpenseApproval/Submit":{"post":{"operationId":"ExpenseApproval","parameters":[{"description":"The user to submit the Expenses for. Defaults to current user. Only allowed to be different from the current user when the current user has rights to Impersonate other users.","in":"query","name":"UserID","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Send email alerts to expense approvers. Defaults to true","in":"query","name":"SendNotifications","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"text/json":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"application/xml":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"text/xml":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},"application/x-www-form-urlencoded":{"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}}},"description":"A collection of ExpenseID's that should be submitted for approval. If not provided, submits all verified expenses for approval.","required":true},"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_expenses"]}],"summary":"Submit Expenses for Approval.","tags":["Expense"]}},"/api/ExpenseCategory":{"get":{"description":"The default sort order is by Name asc","operationId":"ExpenseCategory_Get","parameters":[{"description":"Optional filter on for enabled/disabled categories. Defaults to true.","in":"query","name":"isEnabled","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseCategoryList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseCategoryList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseCategoryList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseCategoryList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read_expenses"]}],"summary":"Gets list of Expense Categories","tags":["ExpenseCategory"]}},"/api/ExpenseGroup/Lookup":{"get":{"description":"Expense Groups are for adhoc grouping of reported expenses. e.g. for expenses incurred on a Trip","operationId":"ExpenseGroupLookup","parameters":[{"description":"Number of items per page (max 1000)","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":"Search string to match against Expense Group Name","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseGroupDropdownList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseGroupDropdownList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseGroupDropdownList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseGroupDropdownList"}}}}},"security":[{"oauth2":["read_expenses"]}],"summary":"Gets minimal list of Expense Groups.","tags":["ExpenseGroup"]}},"/api/ExpenseMerchant/Lookup":{"get":{"operationId":"ExpenseMerchangeLookup","parameters":[{"description":"Number of items per page (max 1000)","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":"Search string to match against Expense Group Name","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseMerchantDropdownList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseMerchantDropdownList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseMerchantDropdownList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseMerchantDropdownList"}}}}},"security":[{"oauth2":["read_expenses"]}],"summary":"Gets minimal list of Expense Merchants.","tags":["ExpenseMerchant"]}},"/api/ExpensePaymentMethod/Lookup":{"get":{"operationId":"ExpensePaymentMethodLookup","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpensePaymentMethodDropdownList"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpensePaymentMethodDropdownList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpensePaymentMethodDropdownList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpensePaymentMethodDropdownList"}}}}},"security":[{"oauth2":["read_expenses"]}],"summary":"Gets minimal list of Expense Payment Methods.","tags":["ExpensePaymentMethod"]}},"/api/ExpenseSummary":{"get":{"operationId":"ExpenseSummary_Get","parameters":[{"description":"(Optional) Combine one, two or three levels of Grouping. Combine these possible grouping values: \"Category\", \"ChargeableStatus\", \"Merchant\", \"ApprovalStatus\", \"ReimbursementStatus\", \"Customer\", \"Project\", \"User\", \"Task\", \"Year\", \"Month\", \"Day\", \"Week\".","in":"query","name":"model.groupBy","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"(Required) Filter for expenses with expense dates greater or equal to the specified date. e.g. 2019-01-25.","in":"query","name":"model.expenseDateFrom","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"(Required) Filter for expenses with an expense date smaller or equal to the specified  date. e.g. 2019-01-25.","in":"query","name":"model.expenseDateTo","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"(Optional) Defaults to the current user. Provide one or more UserIDs of Users whose expenses should be retrieved. If the current user doesn't have impersonation rights, then they will only see their own data.","in":"query","name":"model.userID","required":false,"explode":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"description":"(Optional) Filter by Project","in":"query","name":"model.projectID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseSummaryResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExpenseSummaryResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ExpenseSummaryResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ExpenseSummaryResult"}}}}},"security":[{"oauth2":["read_expenses"]}],"summary":"Gets Basic Summary of Expense Statistics","tags":["ExpenseSummary"]}},"/api/FixedAmount":{"get":{"operationId":"FixedAmount_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":"(Optional) The ProjectID of a Project to filter Fixed Amounts for","in":"query","name":"ProjectID","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"(Optional) The TaskID of a Task to filter Fixed Amounts for","in":"query","name":"TaskID","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"isInvoiced","required":false,"schema":{"type":"boolean"}},{"description":"Number of items per page (max 1000)","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\",\"EntryDate\", \"EntryDate desc\", \"StartTimeLocal\",\"StartTimeLocal desc\", \"TimeSheetEntryID\", \"TimeSheetEntryID desc\"","in":"query","name":"Sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixedAmountList"}},"text/json":{"schema":{"$ref":"#/components/schemas/FixedAmountList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FixedAmountList"}},"text/xml":{"schema":{"$ref":"#/components/schemas/FixedAmountList"}}}},"401":{"description":"Unauthorized"}},"security":[{"oauth2":["read_financials"]}],"summary":"Gets list of Fixed Amounts","tags":["FixedAmount"]}},"/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 (max 1000)","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_financials"]}],"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_financials"]}],"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 (max 1000)","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_financials"]}],"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_financials"]}],"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_financials"]}],"summary":"Gets Invoice by Invoice ID","tags":["Invoice"]}},"/api/Payment":{"get":{"operationId":"Payment_Get","parameters":[{"description":"Filter for Payments that have at least one allocation against a given Invoice Transaction ID","in":"query","name":"InvoiceTransactionID","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"Filter for Payments updated after a given date","in":"query","name":"UpdatedAfter","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Number of items per page (max 1000)","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_financials"]}],"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_financials"]}],"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_financials"]}],"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 (max 1000)","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_projects"]}],"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_projects"]}],"summary":"Create a Project","tags":["Project"]},"put":{"description":"Update a Project","operationId":"Project_Put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectModel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateProjectModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/UpdateProjectModel"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UpdateProjectModel"}}},"required":true},"responses":{"200":{"description":"OK","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"}}}}},"security":[{"oauth2":["write_projects"]}],"summary":"Update an Project","tags":["Project"]}},"/api/Project/Lookup":{"get":{"operationId":"ProjectLookup","parameters":[{"description":"Number of items per page (max 1000)","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"