Avaza

Avaza API Documentation

Welcome to the autogenerated documentation & test tool for Avaza's API. API Security & Authentication Authentication options include OAuth2 Implicit and…

Developer tools#openapi#collaboration

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the autogenerated documentation & test tool for Avaza's API. API Security & Authentication Authentication options include OAuth2 Implicit and Authorization Code flows, and Personal Access Token. All connections should be encrypted over SSL/TLS You can set up and manage your api authentication credentials from within your Avaza account. (requires Administrator permissions on your Avaza account). 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/ The OAuth flow currently issues Access Tokens that last 1 day, and Refresh tokens that last 180 days The Api respects the security Roles assigned to the authenticating Avaza user and filters the data return appropriately. 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. - PHP OAuth Client Package for Azava API (by Debiprasad Sahoo)

Endpoints 86

ScheduleSeries

  • POSTCreate new Schedule Booking/ScheduleSeries/AddBooking
  • POSTCreate new Leave Booking/ScheduleSeries/AddLeave
  • PUTEdit Booking/ScheduleSeries/EditBooking
  • PUTEdit Leave Booking/ScheduleSeries/EditLeave
  • GETGets list of Schedule Series/api/ScheduleSeries?UpdatedAfter=2024-01-01T00:00:00Z&ScheduleStartDateFrom=2024-01-01T00:00:00Z&ScheduleStartDateTo=2024-01-01T00:00:00Z&ScheduleEndDateFrom=2024-01-01T00:00:00Z&ScheduleEndDateTo=2024-01-01T00:00:00Z&UserID=0&UserEmail=string&TimeSheetCategoryID=0&TimeSheetCategoryName=string&LeaveTypeID=0&ProjectID=0&CompanyID=0&pageSize=0&pageNumber=0&Sort=stringSchedule Series represents a strip of time assigned to a user over a date range, for a certain number of hours per day. They can be for Leave or for project…

Account

  • GETAccount Details/api/Account

Bill

  • GETGets list of Bills/api/Bill?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string&CompanyIDFK=0TransactionStatusCode values are: "Draft", "Verified", "Late", "Paid", "Partial", "Void"
  • POSTCreate a new draft Bill/api/Bill
  • GETGets a Bill by Bill ID/api/Bill/:id

BillPayment

  • GETGets list of Bill Payments/api/BillPayment?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0
  • POSTCreate new Bill Payment and optionally assign payment allocations to Bills/api/BillPayment
  • GETGets a Bill Payment by Payment Transaction ID/api/BillPayment/:id

Company

  • GETGets list of Companies/api/Company?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string
  • PUTUpdate a Company record./api/CompanyRequires CompanyID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.
  • POSTCreate a Company/api/Company
  • GETGets minimal list of Companies./api/Company/Lookup?pageSize=0&pageNumber=0&search=stringCertain roles see a restricted set of companies based on their project memberships
  • GETGets Company by Company ID/api/Company/:id

Contact

  • GETGets list of Contacts/api/Contact?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string&CompanyIDFK=0
  • POSTCreate a Contact/api/Contact
  • GETGets Contact by Contact ID/api/Contact/:id

CreditNote

  • GETGets list of CreditNotes/api/CreditNote?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0
  • GETGets Credit Note by CreditNoteID/api/CreditNote/:id

Currency

  • GETGets list of Currencies/api/Currency

Estimate

  • GETGets list of Estimates/api/Estimate?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string&CompanyIDFK=0EstimateStatusCode values are: "Draft", "Sent", "Accepted", "Converted", "Expired", "Rejected"
  • POSTCreate a new draft Estimate/api/Estimate
  • GETGets Estimate by Estimate ID/api/Estimate/:id

Expense

  • GETGets list of Expenses/api/Expense?UpdatedAfter=2024-01-01T00:00:00Z&ExpenseDateFrom=2024-01-01T00:00:00Z&ExpenseDateTo=2024-01-01T00:00:00Z&UserEmail=string&UserID=0&CategoryName=string&CustomerID=0&ProjectID=0&isChargeable=true&isInvoiced=true&ExpenseReimbursementIDFK=0&ExpensePaymentMethodIDFK=0&ExpenseApprovalStatusCode=string&Search=string&pageSize=0&pageNumber=0&Sort=string
  • PUTUpdate an Expense/api/ExpenseUpdate an Expense
  • POSTCreate an Expense/api/ExpenseCreate an Expense
  • DELETEDelete a Timesheet Entry/api/Expense
  • POSTExpenseAttachment/api/Expense/Attachment
  • GETGets an Expense Entry by Expense ID/api/Expense/:id
  • POSTSubmit Expenses for Approval./api/ExpenseApproval/Submit?UserID=0&SendNotifications=true

ExpenseCategory

  • GETGets list of Expense Categories/api/ExpenseCategory?isEnabled=trueThe default sort order is by Name asc

ExpenseGroup

  • GETGets minimal list of Expense Groups./api/ExpenseGroup/Lookup?pageSize=0&pageNumber=0&search=stringExpense Groups are for adhoc grouping of reported expenses. e.g. for expenses incurred on a Trip

ExpenseMerchant

  • GETGets minimal list of Expense Merchants./api/ExpenseMerchant/Lookup?pageSize=0&pageNumber=0&search=string

ExpensePaymentMethod

  • GETGets minimal list of Expense Payment Methods./api/ExpensePaymentMethod/Lookup

ExpenseSummary

  • GETGets Basic Summary of Expense Statistics/api/ExpenseSummary?model.groupBy=string&model.expenseDateFrom=2024-01-01T00:00:00Z&model.expenseDateTo=2024-01-01T00:00:00Z&model.userID=0&model.projectID=0

FixedAmount

  • GETGets list of Fixed Amounts/api/FixedAmount?UpdatedAfter=2024-01-01T00:00:00Z&EntryDateFrom=2024-01-01T00:00:00Z&EntryDateTo=2024-01-01T00:00:00Z&ProjectID=0&TaskID=0&isInvoiced=true&pageSize=0&pageNumber=0&Sort=string

Inventory

  • GETGets list of Inventory/api/Inventory?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0
  • GETGets InventoryItem by InventoryItem ID/api/Inventory/:id

Invoice

  • GETGets list of Invoices/api/Invoice?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string&CompanyIDFK=0TransactionStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"
  • POSTCreate a new draft invoice/api/Invoice
  • GETGets Invoice by Invoice ID/api/Invoice/:id

Payment

  • GETGets list of Payments/api/Payment?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0
  • POSTCreate new Payment and optionally assign payment allocations to Invoices/api/Payment
  • GETGets Payment by Payment Transaction ID/api/Payment/:id

Project

  • GETGets list of Projects/api/Project?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string&TimesheetUserID=0&includeArchived=true
  • PUTUpdate an Project/api/ProjectUpdate a Project
  • POSTCreate a Project/api/Project
  • GETGets minimal list of active Projects for the current user/api/Project/Lookup?pageSize=0&pageNumber=0&TimesheetUserID=0&CompanyIDFK=0&search=string
  • GETGets Project by Project ID/api/Project/:id

ProjectMember

  • GETGets list of Project Members/api/ProjectMember?ProjectID=0&UserID=0Include at least one of ProjectID or UserID parameters.
  • PUTUpdate a Member of a Project/api/ProjectMemberFields are only updated if their field name is in the FieldsToUpdate string collection. The Amount columns for Cost, Budget, Rates if specified should be a…
  • POSTAssign a user as a Member of a Project/api/ProjectMemberthe Amount columns for Cost, Budget, Rates should be specified as a decimal. Financial amounts assume the currency of the Customer company. Budget units…

ProjectTimesheetCategory

  • GETGets list of Project Timesheet Categories/api/ProjectTimesheetCategory?ProjectID=0The default sort order is by isBillable desc, Name asc
  • POSTAssign a TimeSheetCategory to a Project./api/ProjectTimesheetCategory

ScheduleAssignment

  • GETGets list of Schedule Assignments./api/ScheduleAssignment?UpdatedAfter=2024-01-01T00:00:00Z&ScheduleDateFrom=2024-01-01T00:00:00Z&ScheduleDateTo=2024-01-01T00:00:00Z&ScheduleSeriesID=0&UserID=0&UserEmail=string&pageSize=0&pageNumber=0&Sort=stringSchedule assignments are per-day, and link to a parent Schedule Series.

Section

  • GETGets list of Sections/api/Section?ProjectID=0
  • POSTCreate a Section/api/Section
  • DELETEDelete a Section/api/Section?SectionID=0

Task

  • GETGets list of Tasks/api/Task?UpdatedAfter=2024-01-01T00:00:00Z&pageSize=0&pageNumber=0&Sort=string&isComplete=true&ProjectID=0
  • PUTUpdate a Task./api/TaskRequires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.
  • POSTCreate a Task/api/Task
  • DELETEDelete a Task/api/Task?TaskID=0
  • GETGets minimal list of Tasks for the current user/api/Task/Lookup?projectID=0&pageSize=0&pageNumber=0&hideCompleted=true&search=stringGroups Tasks by Section. Default sort is by Section Title followed by Task Title
  • GETGets Task by Task ID/api/Task/:id

TaskStatus

  • GETGets list of Task Statuses/api/TaskStatus

TaskType

  • GETGets list of Task Types/api/TaskType

Tax

  • GETGet List of Taxes configured in the Avaza account./api/Tax

Timesheet

  • GETGets list of Timsheets/api/Timesheet?UpdatedAfter=2024-01-01T00:00:00Z&EntryDateFrom=2024-01-01T00:00:00Z&EntryDateTo=2024-01-01T00:00:00Z&UserID=0&UserEmail=string&CategoryName=string&ProjectID=0&isBillable=true&isInvoiced=true&isTimerRunning=true&pageSize=0&pageNumber=0&includeInvoiceDetails=true&Sort=string
  • PUTUpdate a Timesheet/api/TimesheetThe FieldsToUpdate field expects a string array collection of the field names you would like updated. Valid fields to update inlcude "ProjectIDFK",…
  • POSTCreate a new Timesheet Entry/api/Timesheet
  • GETGets a Timesheet Entry by Timesheet ID/api/Timesheet/:id
  • DELETEDelete a Timesheet Entry/api/Timesheet/:id

TimesheetSubmission

  • POSTSubmit Timesheets for Approval./api/TimesheetSubmission?SendNotifications=true&WholeWeekOf=2024-01-01T00:00:00Z&WholeDayOf=2024-01-01T00:00:00Z&UserID=0Either provide a a specific Day (WholeDayOf) or any day in a Week (WholeWeekOf) to submit all draft timesheets in that day or week

TimesheetSummary

  • GETGets Basic Summary of Timesheet Statistics/api/TimesheetSummary?model.groupBy=string&model.entryDateFrom=2024-01-01T00:00:00Z&model.entryDateTo=2024-01-01T00:00:00Z&model.userID=0&model.projectID=0&model.isBillable=true&model.isInvoiced=true

TimesheetTimer

  • GETGets the Running Timer if there is one for a user./api/TimesheetTimer?UserID=0
  • POSTStarts a Timer running on an existing Timesheet Entry/api/TimesheetTimer/:id?UserID=0
  • DELETEStop the timer running on an existing Timesheet Entry/api/TimesheetTimer/:id?UserID=0

UserProfile

  • GETGet Collection of Users who have roles in the current Avaza account./api/UserProfile?Roles=string&Tags=string&CurrentUserOnly=true&CompanyIDFK=0Admin and Invoice Managers can see all. Other users are limited to seeing their own profile.

Webhook

  • GETGet list of Webhook Subscriptions/api/Webhook
  • POSTSubscribe to Webhook. On success, returns ID of webhook subscription./api/WebhookWhen you receive a webhook, you should respond with Http 200 OK Status Code, otherwise we will retry. To create a webhook, you need both the…
  • DELETEDelete webhook subscription by URL/api/Webhook?target_url=string
  • GETGet Webhook Subscription by SubscriptionID/api/Webhook/:id
  • DELETEDelete Webhook Subscription by ID/api/Webhook/:id

API details

Base URL
https://api.avaza.com
Authentication
OAuth 2.0 (implicit flow) with 17 scopes
Operations
86 operations on 58 pathsGET 50POST 21PUT 8DELETE 7
Main resources
Expense 7Task 6Company 5Project 5ScheduleSeries 5Timesheet 5Webhook 5Bill 3BillPayment 3Contact 3
Description format
Swagger 2.0, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Avaza API Documentation in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Avaza API Documentation collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 17 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create new Schedule Booking” (POST /ScheduleSeries/AddBooking), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Avaza API Documentation?

Welcome to the autogenerated documentation & test tool for Avaza's API. API Security & Authentication Authentication options include OAuth2 Implicit and… It is listed under Developer tools and has 86 endpoints.

Who publishes the Avaza API Documentation?

It is listed from Avaza's public API description (an OpenAPI document), not published by Avaza on Swastik Codes. Anyone who controls avaza.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Avaza API Documentation?

Requests go to https://api.avaza.com. Endpoint paths are added to this base URL.

How do I authenticate with the Avaza API Documentation?

With OAuth 2.0 (implicit flow) with 17 scopes.

How many endpoints does the Avaza API Documentation have?

86 operations on 58 paths (50 GET, 21 POST, 8 PUT, 7 DELETE). The largest groups are Expense, Task, Company, Project.

Is forking the Avaza API Documentation free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.