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
- Category
- Documents & Productivity
- Base URL
https://api.avaza.com- Version
- v1
- Endpoints
- 86
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.avaza.com/api/Account" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"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);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
| Method | Path | What it does |
|---|---|---|
| POST | /ScheduleSeries/AddBooking | Create new Schedule Booking |
| POST | /ScheduleSeries/AddLeave | Create new Leave Booking |
| PUT | /ScheduleSeries/EditBooking | Edit Booking |
| PUT | /ScheduleSeries/EditLeave | Edit Leave Booking |
| GET | /api/Account | Account Details |
| GET | /api/Bill | Gets list of Bills |
| POST | /api/Bill | Create a new draft Bill |
| GET | /api/Bill/{id} | Gets a Bill by Bill ID |
| GET | /api/BillPayment | Gets list of Bill Payments |
| POST | /api/BillPayment | Create new Bill Payment and optionally assign payment allocations to Bills |
| GET | /api/BillPayment/{id} | Gets a Bill Payment by Payment Transaction ID |
| GET | /api/Company | Gets list of Companies |
| POST | /api/Company | Create a Company |
| PUT | /api/Company | Update a Company record. |
| GET | /api/Company/Lookup | Gets minimal list of Companies. |
| GET | /api/Company/{id} | Gets Company by Company ID |
| GET | /api/Contact | Gets list of Contacts |
| POST | /api/Contact | Create a Contact |
| GET | /api/Contact/{id} | Gets Contact by Contact ID |
| GET | /api/CreditNote | Gets list of CreditNotes |
| GET | /api/CreditNote/{id} | Gets Credit Note by CreditNoteID |
| GET | /api/Currency | Gets list of Currencies |
| GET | /api/Estimate | Gets list of Estimates |
| POST | /api/Estimate | Create a new draft Estimate |
| GET | /api/Estimate/{id} | Gets Estimate by Estimate ID |
| GET | /api/Expense | Gets list of Expenses |
| POST | /api/Expense | Create an Expense |
| PUT | /api/Expense | Update an Expense |
| DELETE | /api/Expense | Delete a Timesheet Entry |
| POST | /api/Expense/Attachment | ExpenseAttachment |
| GET | /api/Expense/{id} | Gets an Expense Entry by Expense ID |
| POST | /api/ExpenseApproval/Submit | Submit Expenses for Approval. |
| GET | /api/ExpenseCategory | Gets list of Expense Categories |
| GET | /api/ExpenseGroup/Lookup | Gets minimal list of Expense Groups. |
| GET | /api/ExpenseMerchant/Lookup | Gets minimal list of Expense Merchants. |
| GET | /api/ExpensePaymentMethod/Lookup | Gets minimal list of Expense Payment Methods. |
| GET | /api/ExpenseSummary | Gets Basic Summary of Expense Statistics |
| GET | /api/FixedAmount | Gets list of Fixed Amounts |
| GET | /api/Inventory | Gets list of Inventory |
| GET | /api/Inventory/{id} | Gets InventoryItem by InventoryItem ID |
| GET | /api/Invoice | Gets list of Invoices |
| POST | /api/Invoice | Create a new draft invoice |
| GET | /api/Invoice/{id} | Gets Invoice by Invoice ID |
| GET | /api/Payment | Gets list of Payments |
| POST | /api/Payment | Create new Payment and optionally assign payment allocations to Invoices |
| GET | /api/Payment/{id} | Gets Payment by Payment Transaction ID |
| GET | /api/Project | Gets list of Projects |
| POST | /api/Project | Create a Project |
| PUT | /api/Project | Update an Project |
| GET | /api/Project/Lookup | Gets minimal list of active Projects for the current user |
| GET | /api/Project/{id} | Gets Project by Project ID |
| GET | /api/ProjectMember | Gets list of Project Members |
| POST | /api/ProjectMember | Assign a user as a Member of a Project |
| PUT | /api/ProjectMember | Update a Member of a Project |
| GET | /api/ProjectTimesheetCategory | Gets list of Project Timesheet Categories |
| POST | /api/ProjectTimesheetCategory | Assign a TimeSheetCategory to a Project. |
| GET | /api/ScheduleAssignment | Gets list of Schedule Assignments. |
| GET | /api/ScheduleSeries | Gets list of Schedule Series |
| GET | /api/Section | Gets list of Sections |
| POST | /api/Section | Create a Section |
| DELETE | /api/Section | Delete a Section |
| GET | /api/Task | Gets list of Tasks |
| POST | /api/Task | Create a Task |
| PUT | /api/Task | Update a Task. |
| DELETE | /api/Task | Delete a Task |
| GET | /api/Task/Lookup | Gets minimal list of Tasks for the current user |
| GET | /api/Task/{id} | Gets Task by Task ID |
| GET | /api/TaskStatus | Gets list of Task Statuses |
| GET | /api/TaskType | Gets list of Task Types |
| GET | /api/Tax | Get List of Taxes configured in the Avaza account. |
| GET | /api/Timesheet | Gets list of Timsheets |
| POST | /api/Timesheet | Create a new Timesheet Entry |
| PUT | /api/Timesheet | Update a Timesheet |
| GET | /api/Timesheet/{id} | Gets a Timesheet Entry by Timesheet ID |
| DELETE | /api/Timesheet/{id} | Delete a Timesheet Entry |
| POST | /api/TimesheetSubmission | Submit Timesheets for Approval. |
| GET | /api/TimesheetSummary | Gets Basic Summary of Timesheet Statistics |
| GET | /api/TimesheetTimer | Gets 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/UserProfile | Get Collection of Users who have roles in the current Avaza account. |
| GET | /api/Webhook | Get list of Webhook Subscriptions |
| POST | /api/Webhook | Subscribe to Webhook. On success, returns ID of webhook subscription. |
| DELETE | /api/Webhook | Delete 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.
Similar documents & productivity APIs
Compare alternatives →JIRA
Documents & ProductivityJIRA is a proprietary issue tracking product that allows bug tracking and agile project management
Notion
Documents & ProductivityIntegrate with Notion
DocStruct
Documents & ProductivityAI extraction of invoices, receipts, bank statements & contracts into structured JSON/CSV
Asana
Documents & ProductivityProgrammatic access to all data in your asana system
ClickUp
Documents & ProductivityClickUp is a robust, cloud-based project management tool for boosting productivity
iLovePDF
Documents & ProductivityConvert, merge, split, extract text and add page numbers for PDFs. Free for 250 documents/month
Listed from APIs.guru (CC0).