Skip to content

Avaza API Documentation API

by avaza.com

Open documentation ↗

Overview

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>

Avaza API Documentation is a documents & productivity API from avaza.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 86 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Base URL
https://api.avaza.com
Version
v1
Endpoints
86
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.avaza.com/api/Account" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://api.avaza.com/api/Account", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.avaza.com/api/Account",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/ScheduleSeries/AddBookingCreate new Schedule Booking
POST/ScheduleSeries/AddLeaveCreate new Leave Booking
PUT/ScheduleSeries/EditBookingEdit Booking
PUT/ScheduleSeries/EditLeaveEdit Leave Booking
GET/api/AccountAccount Details
GET/api/BillGets list of Bills
POST/api/BillCreate a new draft Bill
GET/api/Bill/{id}Gets a Bill by Bill ID
GET/api/BillPaymentGets list of Bill Payments
POST/api/BillPaymentCreate new Bill Payment and optionally assign payment allocations to Bills
GET/api/BillPayment/{id}Gets a Bill Payment by Payment Transaction ID
GET/api/CompanyGets list of Companies
POST/api/CompanyCreate a Company
PUT/api/CompanyUpdate a Company record.
GET/api/Company/LookupGets minimal list of Companies.
GET/api/Company/{id}Gets Company by Company ID
GET/api/ContactGets list of Contacts
POST/api/ContactCreate a Contact
GET/api/Contact/{id}Gets Contact by Contact ID
GET/api/CreditNoteGets list of CreditNotes
GET/api/CreditNote/{id}Gets Credit Note by CreditNoteID
GET/api/CurrencyGets list of Currencies
GET/api/EstimateGets list of Estimates
POST/api/EstimateCreate a new draft Estimate
GET/api/Estimate/{id}Gets Estimate by Estimate ID
GET/api/ExpenseGets list of Expenses
POST/api/ExpenseCreate an Expense
PUT/api/ExpenseUpdate an Expense
DELETE/api/ExpenseDelete a Timesheet Entry
POST/api/Expense/AttachmentExpenseAttachment
GET/api/Expense/{id}Gets an Expense Entry by Expense ID
POST/api/ExpenseApproval/SubmitSubmit Expenses for Approval.
GET/api/ExpenseCategoryGets list of Expense Categories
GET/api/ExpenseGroup/LookupGets minimal list of Expense Groups.
GET/api/ExpenseMerchant/LookupGets minimal list of Expense Merchants.
GET/api/ExpensePaymentMethod/LookupGets minimal list of Expense Payment Methods.
GET/api/ExpenseSummaryGets Basic Summary of Expense Statistics
GET/api/FixedAmountGets list of Fixed Amounts
GET/api/InventoryGets list of Inventory
GET/api/Inventory/{id}Gets InventoryItem by InventoryItem ID
GET/api/InvoiceGets list of Invoices
POST/api/InvoiceCreate a new draft invoice
GET/api/Invoice/{id}Gets Invoice by Invoice ID
GET/api/PaymentGets list of Payments
POST/api/PaymentCreate new Payment and optionally assign payment allocations to Invoices
GET/api/Payment/{id}Gets Payment by Payment Transaction ID
GET/api/ProjectGets list of Projects
POST/api/ProjectCreate a Project
PUT/api/ProjectUpdate an Project
GET/api/Project/LookupGets minimal list of active Projects for the current user
GET/api/Project/{id}Gets Project by Project ID
GET/api/ProjectMemberGets list of Project Members
POST/api/ProjectMemberAssign a user as a Member of a Project
PUT/api/ProjectMemberUpdate a Member of a Project
GET/api/ProjectTimesheetCategoryGets list of Project Timesheet Categories
POST/api/ProjectTimesheetCategoryAssign a TimeSheetCategory to a Project.
GET/api/ScheduleAssignmentGets list of Schedule Assignments.
GET/api/ScheduleSeriesGets list of Schedule Series
GET/api/SectionGets list of Sections
POST/api/SectionCreate a Section
DELETE/api/SectionDelete a Section
GET/api/TaskGets list of Tasks
POST/api/TaskCreate a Task
PUT/api/TaskUpdate a Task.
DELETE/api/TaskDelete a Task
GET/api/Task/LookupGets minimal list of Tasks for the current user
GET/api/Task/{id}Gets Task by Task ID
GET/api/TaskStatusGets list of Task Statuses
GET/api/TaskTypeGets list of Task Types
GET/api/TaxGet List of Taxes configured in the Avaza account.
GET/api/TimesheetGets list of Timsheets
POST/api/TimesheetCreate a new Timesheet Entry
PUT/api/TimesheetUpdate a Timesheet
GET/api/Timesheet/{id}Gets a Timesheet Entry by Timesheet ID
DELETE/api/Timesheet/{id}Delete a Timesheet Entry
POST/api/TimesheetSubmissionSubmit Timesheets for Approval.
GET/api/TimesheetSummaryGets Basic Summary of Timesheet Statistics
GET/api/TimesheetTimerGets the Running Timer if there is one for a user.
POST/api/TimesheetTimer/{id}Starts a Timer running on an existing Timesheet Entry
DELETE/api/TimesheetTimer/{id}Stop the timer running on an existing Timesheet Entry
GET/api/UserProfileGet Collection of Users who have roles in the current Avaza account.
GET/api/WebhookGet list of Webhook Subscriptions
POST/api/WebhookSubscribe to Webhook. On success, returns ID of webhook subscription.
DELETE/api/WebhookDelete webhook subscription by URL
GET/api/Webhook/{id}Get Webhook Subscription by SubscriptionID
DELETE/api/Webhook/{id}Delete Webhook Subscription by ID

Questions

Does the Avaza API Documentation API need an API key?

Yes. The Avaza API Documentation API uses OAuth authentication; the documentation explains how to get credentials.

Does the Avaza API Documentation API support HTTPS?

Yes, the Avaza API Documentation API is served over HTTPS.

How many endpoints does the Avaza API Documentation API have?

Its OpenAPI description lists 86 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Avaza API Documentation API?

Other Documents & Productivity APIs include JIRA, Notion, DocStruct, Asana, ClickUp.

Compare alternatives →

Listed from APIs.guru (CC0).