avaza
Module avaza
API
Definitions
ballerinax/avaza Ballerina library
Overview
Avaza is a cloud-based platform that brings project management, timesheets, expenses, invoicing and team scheduling together in one workspace. This connector provides access to the Avaza REST API (version v1) from Ballerina, covering customers and contacts, projects, tasks, timesheets, expenses, invoices, payments, schedules, users and webhook subscriptions. It authenticates with an OAuth 2.0 access token or an Avaza personal access token.
Key features
- Manage customer companies and their contacts
- Create and track projects, sections, tasks and project members
- Log, review and approve timesheet entries and running timers
- Capture expenses, estimates, invoices and payments
- Schedule bookings and leave for team members
- Subscribe to Avaza events through webhooks
Setup guide
To use the connector you need an Avaza account and an access token.
-
Sign in to your Avaza account. Creating API credentials requires Administrator permissions.
-
Open the API settings of your account and either create a personal access token, or register an OAuth 2.0 application to obtain a client ID and client secret.
-
For an OAuth 2.0 application, authorize it against
https://any.avaza.com/oauth2/authorizewith the scopes your integration needs (for exampleread_projectsandwrite_projects), then exchange the authorization code athttps://any.avaza.com/oauth2/tokenfor an access token and a refresh token. -
Keep the token (or the client ID, client secret and refresh token) safe. You supply it to the connector through
Config.toml.
Quickstart
To use the avaza connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the connector.
import ballerinax/avaza;
Step 2: Create a Config.toml file with your access token.
accessToken = "<Your Avaza access token>"
Step 3: Create a client using the token.
configurable string accessToken = ?; final avaza:Client avazaClient = check new ({auth: {token: accessToken}});
Step 4: List the projects in your account.
public function main() returns error? { avaza:ProjectList _ = check avazaClient->listProjects(pageSize = 10); }
Examples
The Avaza connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Project kickoff setup - Create a project for an existing customer, add a kickoff section and task, and confirm the result.
- Weekly timesheet summary - Page through the timesheet entries of a date range and total the hours logged per project.
Clients
avaza: Client
Avaza is a work management platform for project management, resource scheduling, timesheets, expenses and invoicing. This API manages the projects, tasks, timesheets, expenses, invoices, bills and contacts of an Avaza account, authenticated with OAuth 2.0 or a Personal Access Token.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.avaza.com/api" - URL of the target service
getAccount
function getAccount(map<string|string[]> headers) returns AccountDetails|errorRetrieves configuration details for the authenticated Avaza account, including timesheet settings, currency, branding, and feature flags.
Return Type
- AccountDetails|error - Unauthorized
listBills
Retrieves a paginated list of supplier bills with line items, status, and address details. Supports filtering by company, status, date ranges, and updated date.
Parameters
- queries *ListBillsQueries - Queries to be sent with the request
createBill
Creates a new draft supplier bill (purchase invoice). Optionally creates a new supplier company and contact if no matching company is found.
Parameters
- payload NewBill - The request body containing the new bill details including supplier, line items, and dates
getBill
Retrieves a single supplier bill by its Transaction ID, including line items, issuer/recipient address details, and web links.
Parameters
- id int - Bill Transaction ID number
listBillPayments
function listBillPayments(map<string|string[]> headers, *ListBillPaymentsQueries queries) returns BillPaymentList|errorRetrieves a paginated list of supplier bill payments, including payment allocations to specific bills.
Parameters
- queries *ListBillPaymentsQueries - Queries to be sent with the request
Return Type
- BillPaymentList|error - Unauthorized
createBillPayment
function createBillPayment(NewBillPayment payload, map<string|string[]> headers) returns BillPayment|errorRecords a new supplier bill payment. Optionally include allocations to apply the payment against specific bills.
Parameters
- payload NewBillPayment - The request body containing the new bill payment details including amount, supplier, and optional allocations
Return Type
- BillPayment|error - Unauthorized
getBillPayment
Retrieves a single supplier bill payment by its Transaction ID, including allocations to bills.
Parameters
- id int - The Bill Payment Transaction ID to retrieve
Return Type
- BillPayment|error - Unauthorized
lookupCompanies
function lookupCompanies(map<string|string[]> headers, *LookupCompaniesQueries queries) returns CompanyDropdownList|errorRetrieves a paginated dropdown list of companies. Admins see all companies; non-admins see only companies from projects they are a member of.
Parameters
- queries *LookupCompaniesQueries - Queries to be sent with the request
Return Type
- CompanyDropdownList|error - Returns a paginated list of minimal company records (ID and name)
listCompanies
function listCompanies(map<string|string[]> headers, *ListCompaniesQueries queries) returns CompanyList|errorRetrieves a paginated list of customer companies with full details including contacts, billing address, and financial settings.
Parameters
- queries *ListCompaniesQueries - Queries to be sent with the request
Return Type
- CompanyList|error - Unauthorized
updateCompany
Updates an existing company record. Only fields listed in the FieldsToUpdate array will be modified.
Parameters
- payload UpdateCompany - The request body containing the CompanyID, the list of field names to update, and the new field values
createCompany
Creates a new customer company record in Avaza.
Parameters
- payload NewCompany - The request body containing the new company details. CompanyName is required
getCompany
Retrieves a single customer company by its Company ID, including contacts and billing address details.
Parameters
- id int - The Company ID to retrieve
listContacts
function listContacts(map<string|string[]> headers, *ListContactsQueries queries) returns ContactList|errorRetrieves a paginated list of external contacts (customer contacts) with company association details.
Parameters
- queries *ListContactsQueries - Queries to be sent with the request
Return Type
- ContactList|error - Unauthorized
createContact
function createContact(NewCompanyContact payload, map<string|string[]> headers) returns CompanyContact|errorCreates a new external contact, optionally linked to an existing company. If CompanyName is provided and not matched, a new company is created.
Parameters
- payload NewCompanyContact - The request body containing the new contact details. Firstname, Lastname, and ContactEmail are required
Return Type
- CompanyContact|error - Unauthorized
getContact
Retrieves a single external contact by their Contact ID.
Parameters
- id int - The Contact ID to retrieve
Return Type
- CompanyContact|error - Unauthorized
listCreditNotes
function listCreditNotes(map<string|string[]> headers, *ListCreditNotesQueries queries) returns CreditNoteList|errorRetrieves a paginated list of customer credit notes, including line items and allocations against invoices.
Parameters
- queries *ListCreditNotesQueries - Queries to be sent with the request
Return Type
- CreditNoteList|error - Unauthorized
getCreditNote
Retrieves a single credit note by its Transaction ID, including line items and invoice allocations.
Parameters
- id int - Credit Note ID Number
Return Type
- CreditNote|error - Unauthorized
listCurrencies
function listCurrencies(map<string|string[]> headers) returns CurrencyList|errorRetrieves the list of currencies configured in the Avaza account, including currency codes, names, symbols, and decimal places.
Return Type
- CurrencyList|error - Returns the list of configured currencies
listCustomFieldDefinitions
function listCustomFieldDefinitions(map<string|string[]> headers, *ListCustomFieldDefinitionsQueries queries) returns CustomFieldDefinitionList|errorRetrieves the active custom field definitions mapped to an entity type, in display order, including data type, multi-select flag, required flag, visibility, and the active options for Dropdown fields. Use the returned CustomFieldDefinitionID (or Name) to set values via the CustomFields collection on the Task, Project, UserProfile, Contact and Company endpoints. Returns an empty list when the account's Custom Fields feature is disabled.
Parameters
- queries *ListCustomFieldDefinitionsQueries - Queries to be sent with the request
Return Type
- CustomFieldDefinitionList|error - The EntityTypeCode is missing or not a valid entity type
listEstimates
function listEstimates(map<string|string[]> headers, *ListEstimatesQueries queries) returns EstimateList|errorGets list of Estimates
Parameters
- queries *ListEstimatesQueries - Queries to be sent with the request
Return Type
- EstimateList|error - Unauthorized
updateEstimate
function updateEstimate(UpdatedEstimate payload, map<string|string[]> headers) returns EstimateDetails|errorUpdates an existing estimate. Only fields listed in the FieldsToUpdate array will be modified. When LineItems is included in FieldsToUpdate, all existing line items not present in the array are deleted.
Parameters
- payload UpdatedEstimate - The request body containing the fields to update and their new values
Return Type
- EstimateDetails|error - Unauthorized
createEstimate
function createEstimate(NewEstimate payload, map<string|string[]> headers) returns EstimateDetails|errorCreates a new draft estimate (quote). Optionally creates a new customer company and contact if no matching company is found.
Parameters
- payload NewEstimate - The request body containing the new estimate details, line items, and optional company/contact information
Return Type
- EstimateDetails|error - Unauthorized
deleteEstimate
function deleteEstimate(map<string|string[]> headers, *DeleteEstimateQueries queries) returns record {}|errorDeletes an estimate by its Estimate ID.
Parameters
- queries *DeleteEstimateQueries - Queries to be sent with the request
Return Type
- record {}|error - The estimate was deleted successfully
getEstimate
Retrieves a single estimate by its Estimate ID, including line items, issuer/recipient details, and web links.
Parameters
- id int - Estimate Estimate ID number
Return Type
- EstimateDetails|error - Unauthorized
uploadExpenseAttachment
function uploadExpenseAttachment(ExpenseAttachmentBody payload, map<string|string[]> headers) returns ExpenseAttachmentUploadResult|errorUploads a file attachment for an expense. Accepts multipart/form-data with the file content. Returns the uploaded file details including ID and URL.
Parameters
- payload ExpenseAttachmentBody - Multipart form with the expense attachment file to upload
Return Type
- ExpenseAttachmentUploadResult|error - Unauthorized
submitExpensesForApproval
function submitExpensesForApproval(int[] payload, map<string|string[]> headers, *SubmitExpensesForApprovalQueries queries) returns record {}|errorSubmit Expenses for Approval.
Parameters
- payload int[] - A collection of ExpenseID's that should be submitted for approval. If not provided, submits all verified expenses for approval
- queries *SubmitExpensesForApprovalQueries - Queries to be sent with the request
Return Type
- record {}|error - OK
deleteExpenseAttachment
Discards a receipt uploaded with POST api/Expense/Attachment that has not been linked to an expense (for example when the user cancels before saving). The file is removed by the storage clean-up shortly afterwards. Only the uploader can delete it.
Parameters
- id int - File Attachment ID returned by the upload
Return Type
- record {}|error - The attachment was discarded (or had already been)
getExpenseHistory
Retrieves the history of an expense, newest first: who created, updated, submitted, approved or rejected it, and the AI receipt reads. Access follows GET api/Expense/{id}: users with the "get expense" right see any expense's history, others only their own expenses.
Parameters
- id int - Expense ID number
Return Type
- ExpenseHistoryResult|error - Unauthorized
listExpenses
function listExpenses(map<string|string[]> headers, *ListExpensesQueries queries) returns ExpenseList|errorRetrieves a paginated list of expense entries with rich filtering by date range, user, project, category, chargeable/invoiced status, approval status, and merchant.
Parameters
- queries *ListExpensesQueries - Queries to be sent with the request
Return Type
- ExpenseList|error - Unauthorized
updateExpense
function updateExpense(UpdateExpense payload, map<string|string[]> headers) returns ExpenseDetails|errorUpdates an existing expense entry. Only fields listed in the FieldsToUpdate array will be modified. Requires the ExpenseID and FieldsToUpdate properties.
Parameters
- payload UpdateExpense - The update request containing the ExpenseID, FieldsToUpdate list, and new field values
Return Type
- ExpenseDetails|error - Bad Request
createExpense
function createExpense(NewExpense payload, map<string|string[]> headers) returns ExpenseDetails|errorCreates a new expense entry. Requires at minimum an expense date, amount, and expense category (by ID or name).
Parameters
- payload NewExpense - The new expense details
Return Type
- ExpenseDetails|error - Bad Request
deleteExpense
function deleteExpense(int[] payload, map<string|string[]> headers, *DeleteExpenseQueries queries) returns ExpenseDeleteResultSet|errorDeletes one or more expense entries by their Expense IDs. Returns a result set indicating success or failure for each expense.
Parameters
- payload int[] - A collection of Expense IDs to delete
- queries *DeleteExpenseQueries - Queries to be sent with the request
Return Type
- ExpenseDeleteResultSet|error - Unauthorized
getExpense
Retrieves a single expense entry by its Expense ID, including category, project, tax, attachment, and approval details.
Parameters
- id int - Expense ID number
Return Type
- ExpenseDetails|error - Unauthorized
listExpenseCategories
function listExpenseCategories(map<string|string[]> headers, *ListExpenseCategoriesQueries queries) returns ExpenseCategoryList|errorRetrieves the list of expense categories configured in the account, including unit price settings for per-unit expense tracking.
Parameters
- queries *ListExpenseCategoriesQueries - Queries to be sent with the request
Return Type
- ExpenseCategoryList|error - Unauthorized
lookupExpenseGroups
function lookupExpenseGroups(map<string|string[]> headers, *LookupExpenseGroupsQueries queries) returns ExpenseGroupDropdownList|errorRetrieves a paginated list of expense group/trip names for categorising expenses, with optional search filtering.
Parameters
- queries *LookupExpenseGroupsQueries - Queries to be sent with the request
Return Type
- ExpenseGroupDropdownList|error - Unauthorized
lookupExpenseMerchants
function lookupExpenseMerchants(map<string|string[]> headers, *LookupExpenseMerchantsQueries queries) returns ExpenseMerchantDropdownList|errorRetrieves a minimal dropdown list of expense merchant names for search/autocomplete.
Parameters
- queries *LookupExpenseMerchantsQueries - Queries to be sent with the request
Return Type
- ExpenseMerchantDropdownList|error - Unauthorized
lookupExpensePaymentMethods
function lookupExpensePaymentMethods(map<string|string[]> headers) returns ExpensePaymentMethodDropdownList|errorRetrieves the list of expense payment methods configured in the Avaza account.
Return Type
- ExpensePaymentMethodDropdownList|error - Unauthorized
getExpenseSummary
function getExpenseSummary(map<string|string[]> headers, *GetExpenseSummaryQueries queries) returns ExpenseSummaryResult|errorRetrieves aggregated expense statistics for a date range, with optional grouping by up to three dimensions (e.g. Category, Project, User, Month). Requires ExpenseDateFrom and ExpenseDateTo.
Parameters
- queries *GetExpenseSummaryQueries - Queries to be sent with the request
Return Type
- ExpenseSummaryResult|error - Unauthorized
uploadFileAttachment
function uploadFileAttachment(ApiFileAttachmentBody payload, map<string|string[]> headers, *UploadFileAttachmentQueries queries) returns FileAttachmentUploadResult|errorUploads a single file via multipart/form-data. Send the file in a "file" form field. Optional query parameters linkToEntityType + linkToEntityId inline-link the upload to a Task, Expense, Estimate, or Invoice in the same call. When no link is supplied, the row is inserted as AttachmentType="Draft" and reaped by the cleanup job after 24 hours if never linked.
Parameters
- payload ApiFileAttachmentBody - Multipart form with the file to upload as a file attachment
- queries *UploadFileAttachmentQueries - Queries to be sent with the request
Return Type
- FileAttachmentUploadResult|error - Returns the uploaded file attachment details
uploadFileAttachmentBase64
function uploadFileAttachmentBase64(FileAttachmentBase64Request payload, map<string|string[]> headers) returns FileAttachmentUploadResult|errorUploads a single file as a base64-encoded JSON body. Designed for MCP clients and other JSON-only callers that can't easily build multipart/form-data requests. When body.LinkTo is supplied (entityType in {Task, Expense, Estimate, Invoice}), the row is linked in the same transaction; otherwise it is inserted as AttachmentType="Draft" for later linking.
Parameters
- payload FileAttachmentBase64Request - Filename, Base64Data, optional ContentType, optional LinkTo
Return Type
- FileAttachmentUploadResult|error - Returns the uploaded file attachment details
uploadFileAttachmentFromUrl
function uploadFileAttachmentFromUrl(FileAttachmentSourceUrlRequest payload, map<string|string[]> headers) returns FileAttachmentUploadResult|errorUploads a single file by giving the server a public https URL to fetch from. The server downloads the file (capped at 50 MB, SSRF-protected: blocks RFC1918, loopback, link-local, AWS metadata IPs, and IPv6 ULA). When body.LinkTo is supplied (entityType in {Task, Expense, Estimate, Invoice}), the row is linked in the same transaction; otherwise it is inserted as AttachmentType="Draft" for later linking.
Parameters
- payload FileAttachmentSourceUrlRequest - SourceUrl, optional Filename, optional ContentType, optional LinkTo
Return Type
- FileAttachmentUploadResult|error - Returns the uploaded file attachment details
completeFileAttachmentUpload
function completeFileAttachmentUpload(byte[] payload, map<string|string[]> headers, *CompleteFileAttachmentUploadQueries queries) returns FileAttachmentUploadResult|errorStep 2 of the signed-URL upload flow: PUT the file bytes as the raw request body to the URL returned by POST api/FileAttachment/Upload. The signed token in the query string is the only credential (no Authorization header). It is bound to the issuing user, account, filename, content type and size limit, and rejected after it expires. Content-Length is required. The token is spent by the first PUT that passes the Content-Length check, whether or not that upload then succeeds, so any later PUT gets 409; a 401, 410, 411 or 413 rejection happens before the body is read and leaves the token usable until it expires. The response is identical to the other upload routes: a Draft attachment, or a linked one when LinkTo was supplied at authorise time.
Parameters
- payload byte[] - The raw file bytes as the request body. Content-Length is required
- queries *CompleteFileAttachmentUploadQueries - Queries to be sent with the request
Return Type
- FileAttachmentUploadResult|error - Returns the uploaded file attachment details
authorizeFileAttachmentUpload
function authorizeFileAttachmentUpload(FileAttachmentUploadAuthorizeRequest payload, map<string|string[]> headers) returns FileAttachmentUploadAuthorization|errorStep 1 of the signed-URL upload flow. Authorises one upload for the calling user and returns a single-use PUT URL that expires after FileUploadTokenTtlMinutes (default 15). Send the file bytes as the raw request body of a PUT to that URL (e.g. curl -T file "url"); the PUT response is the same FileAttachmentUploadResult the other upload routes return. Designed for MCP and agent clients that can run an HTTP request but must never pass file bytes through the model. Rights and the optional LinkTo target are checked here, at issue time, and again when the PUT arrives.
Parameters
- payload FileAttachmentUploadAuthorizeRequest - Filename, optional ContentType, optional SizeBytes (upper bound for the PUT), optional LinkTo
Return Type
- FileAttachmentUploadAuthorization|error - Returns the upload URL, its expiry and the file metadata that will be applied
listFixedAmounts
function listFixedAmounts(map<string|string[]> headers, *ListFixedAmountsQueries queries) returns FixedAmountList|errorRetrieves a paginated list of fixed-amount billing entries used for fixed-price project invoicing. Can filter by project, task, invoiced status, and updated date.
Parameters
- queries *ListFixedAmountsQueries - Queries to be sent with the request
Return Type
- FixedAmountList|error - Unauthorized
updateFixedAmount
function updateFixedAmount(UpdateFixedAmount payload, map<string|string[]> headers) returns FixedAmountDetails|errorUpdates an existing fixed-amount billing entry. Only fields listed in the FieldsToUpdate array will be modified. Valid field names: Amount, InventoryItemIDFK, Notes.
Parameters
- payload UpdateFixedAmount - The request body containing the FixedAmountID, the field names to update and their new values
Return Type
- FixedAmountDetails|error - Unauthorized
createFixedAmount
function createFixedAmount(NewFixedAmount payload, map<string|string[]> headers) returns FixedAmountDetails|errorCreates a new fixed-amount billing entry against a task.
Parameters
- payload NewFixedAmount - The request body containing the new fixed amount details
Return Type
- FixedAmountDetails|error - Unauthorized
listInventoryItems
function listInventoryItems(map<string|string[]> headers, *ListInventoryItemsQueries queries) returns InventoryList|errorRetrieves a paginated list of inventory/product items configured in the account, used as line items on invoices, bills, and estimates.
Parameters
- queries *ListInventoryItemsQueries - Queries to be sent with the request
Return Type
- InventoryList|error - Unauthorized
createInventoryItem
function createInventoryItem(NewInventoryItem payload, map<string|string[]> headers) returns InventoryItem|errorCreates a new inventory/product item.
Parameters
- payload NewInventoryItem - The request body containing the new inventory item details
Return Type
- InventoryItem|error - Unauthorized
getInventoryItem
Retrieves a single inventory/product item by its Inventory Item ID.
Parameters
- id int - InventoryItem ID number
Return Type
- InventoryItem|error - Unauthorized
markInvoiceAsSent
function markInvoiceAsSent(MarkInvoiceAsSentRequest payload, map<string|string[]> headers) returns MarkInvoiceAsSentResponse|errorFlags an existing Draft invoice as Sent ("Mark as Sent"). This is a status change only - the invoice is not emailed to the customer.
Parameters
- payload MarkInvoiceAsSentRequest - The request body containing the InvoiceID, an optional DateSent, and an optional SendWebhooks flag
Return Type
- MarkInvoiceAsSentResponse|error - Bad Request - missing InvoiceID, a DateSent in the future, or the invoice is not in Draft status
addInvoiceLineItems
function addInvoiceLineItems(AddInvoiceLineItemsRequest payload, map<string|string[]> headers) returns InvoiceLineItemsResult|errorAppends line items to an existing invoice WITHOUT modifying or deleting its other line items (unlike PUT /api/Invoice, which replaces the full line item collection). Each line item may optionally link uninvoiced timesheets, expenses or a fixed amount via TimesheetEntryIDs / ExpenseIDs / FixedAmountIDs; quantities, prices, descriptions and taxes are calculated from the linked records unless supplied, and the linked records are marked as invoiced. The request is atomic: if any line item or link is invalid, nothing is added. The invoice must not be Void; totals, balance and status are recalculated (e.g. a Paid invoice becomes Partial when its total grows).
Parameters
- payload AddInvoiceLineItemsRequest - The invoice ID, the line items to append (with optional source-record links), optional expense exchange-rate overrides, and the SendWebhooks flag
Return Type
- InvoiceLineItemsResult|error - Returns the updated invoice, the new TransactionLineItemIDs, and any warnings
removeInvoiceLineItems
function removeInvoiceLineItems(RemoveInvoiceLineItemsRequest payload, map<string|string[]> headers) returns RemoveInvoiceLineItemsResult|errorDeletes specific line items from an invoice and releases any timesheets, expenses or fixed amounts linked to them back to uninvoiced. Unlike PUT /api/Invoice (which replaces the whole line item collection), this endpoint only touches the line items you name. The invoice must not be Void and must retain at least one line item; totals, balance and status are recalculated.
Parameters
- payload RemoveInvoiceLineItemsRequest - The invoice ID, the TransactionLineItemIDs to delete, and the SendWebhooks flag
Return Type
- RemoveInvoiceLineItemsResult|error - Returns the updated invoice and the IDs of the released source records
previewUninvoicedItems
function previewUninvoicedItems(UninvoicedItemsRequest payload, map<string|string[]> headers) returns PreviewUninvoicedItemsResult|errorDRY RUN: computes the line items that AddUninvoicedItems would create for the given filters - quantities, blended rates, converted expense amounts with markup, generated descriptions, taxes, and the source record IDs each line covers - WITHOUT saving anything or marking any record as invoiced. Use it to answer "what is ready to bill onto this invoice?" and to confirm with a person before calling AddUninvoicedItems.
Parameters
- payload UninvoicedItemsRequest - The invoice ID and the Time / Expenses / FixedAmounts filter sections (at least one required). SendWebhooks is ignored
Return Type
- PreviewUninvoicedItemsResult|error - Returns the computed line items and totals. An empty LineItems list means nothing is currently ready to bill for the filters
addUninvoicedItemsToInvoice
function addUninvoicedItemsToInvoice(UninvoicedItemsRequest payload, map<string|string[]> headers) returns AddUninvoicedItemsResult|errorFinds ALL currently-eligible uninvoiced records for the invoice's customer matching the filters (timesheets, expenses and/or fixed amounts), groups them per the requested grouping, appends the generated line items to the invoice and marks the source records as invoiced - one call instead of list + construct + add. Selection only ever picks eligible records, so a repeat call finds nothing and returns zero counts (safe to retry). Use PreviewUninvoicedItems first for a dry run. The invoice must not be Void.
Parameters
- payload UninvoicedItemsRequest - The invoice ID, the Time / Expenses / FixedAmounts filter sections (at least one required), optional expense exchange-rate overrides, and the SendWebhooks flag
Return Type
- AddUninvoicedItemsResult|error - Returns the updated invoice, new line item IDs and per-type linked counts. Zero counts mean nothing matched - not an error
getUninvoicedSummary
function getUninvoicedSummary(map<string|string[]> headers, *GetUninvoicedSummaryQueries queries) returns UninvoicedSummaryResult|errorAggregated "what is ready to bill?" view: uninvoiced billable hours and indicative time value, uninvoiced chargeable expense value, and uninvoiced fixed amount totals, grouped per customer (default) or per project. Only billable, Approved/AutoApproved, not-yet-invoiced records are counted. Time and fixed amounts are in each customer's currency; expense values are in the account's base currency (before markup). Use PreviewUninvoicedItems for exact invoice-ready amounts for one customer.
Parameters
- queries *GetUninvoicedSummaryQueries - Queries to be sent with the request
Return Type
- UninvoicedSummaryResult|error - Returns one row per customer (or project) with uninvoiced value. Customers with nothing uninvoiced are omitted
listInvoices
function listInvoices(map<string|string[]> headers, *ListInvoicesQueries queries) returns InvoiceList|errorGets list of Invoices
Parameters
- queries *ListInvoicesQueries - Queries to be sent with the request
Return Type
- InvoiceList|error - Unauthorized
updateInvoice
Updates an existing draft invoice. Only fields listed in the FieldsToUpdate array will be modified. When LineItems is included in FieldsToUpdate, all existing line items not present in the array are deleted.
Parameters
- payload UpdatedInvoice - The request body containing the fields to update and their new values
createInvoice
Creates a new draft invoice. Optionally creates a new customer company and contact if no matching company is found.
Parameters
- payload NewInvoice - The request body containing the new invoice details, line items, and optional company/contact information
getInvoice
Retrieves a single invoice by its Transaction ID, including line items, issuer/recipient address details, and web links.
Parameters
- id int - Invoice Transaction ID number
listInvoiceTemplates
function listInvoiceTemplates(map<string|string[]> headers, *ListInvoiceTemplatesQueries queries) returns InvoiceTemplateList|errorRetrieves the invoice templates in the account with their IDs, names, type and configuration, ordered by Name. INV and EST templates are used interchangeably on invoices and estimates; BILL templates are for bills only.
Parameters
- queries *ListInvoiceTemplatesQueries - Queries to be sent with the request
Return Type
- InvoiceTemplateList|error - Returns a paginated list of invoice templates. An empty list (TotalCount 0) is returned when nothing matches the filters
getInvoiceTemplate
function getInvoiceTemplate(Signed32 id, map<string|string[]> headers) returns InvoiceTemplateDetails|errorRetrieves a single invoice template by its Invoice Template ID.
Parameters
- id Signed32 - Invoice Template ID number
Return Type
- InvoiceTemplateDetails|error - Returns the invoice template details
listPayments
function listPayments(map<string|string[]> headers, *ListPaymentsQueries queries) returns PaymentList|errorRetrieves a paginated list of customer payments, including allocations to specific invoices. Can filter by invoice or updated date.
Parameters
- queries *ListPaymentsQueries - Queries to be sent with the request
Return Type
- PaymentList|error - Unauthorized
createPayment
Records a new customer payment. Optionally include allocations to apply the payment against specific invoices.
Parameters
- payload NewPayment - The request body containing the new payment details and optional invoice allocations
getPayment
Retrieves a single customer payment by its Transaction ID, including allocations to invoices.
Parameters
- id int - Invoice Transaction ID Number
lookupProjects
function lookupProjects(map<string|string[]> headers, *LookupProjectsQueries queries) returns ProjectDropdownList|errorRetrieves a minimal dropdown list of active projects grouped by customer company, for search/autocomplete. Supports filtering by user timesheet access, company, project code, and search term.
Parameters
- queries *LookupProjectsQueries - Queries to be sent with the request
Return Type
- ProjectDropdownList|error - Returns a paginated list of projects grouped by customer company
listProjects
function listProjects(map<string|string[]> headers, *ListProjectsQueries queries) returns ProjectList|errorRetrieves a paginated list of projects with details including status, billing type, budget, category, and date range. Supports filtering by company, category, owner, status, billable type, budget type, and creation date.
Parameters
- queries *ListProjectsQueries - Queries to be sent with the request
Return Type
- ProjectList|error - Returns a paginated list of projects with details
updateProject
function updateProject(UpdateProjectModel payload, map<string|string[]> headers) returns ProjectDetails|errorUpdates an existing project. Only fields listed in the FieldsToUpdate array will be modified. When ProjectBillableTypeCode is updated, use ScheduleRateUpdateOption and TimesheetRateUpdateOption to control whether rate changes cascade to existing schedule bookings and timesheet entries respectively.
Parameters
- payload UpdateProjectModel - The request body containing the fields to update and their new values
Return Type
- ProjectDetails|error - Returns the updated project details
createProject
function createProject(NewProjectModel payload, map<string|string[]> headers) returns ProjectDetails|errorCreates a new project in Avaza, linked to a customer company. Optionally creates a new company if CompanyName is provided and not matched.
Parameters
- payload NewProjectModel - The request body containing the data for the new project
Return Type
- ProjectDetails|error - Unauthorized
getProject
Retrieves full project details by Project ID, including sections, team members with rates and permissions, and project tags.
Parameters
- id int - Project ID number
Return Type
- ProjectDetails|error - Unauthorized
listProjectMembers
function listProjectMembers(map<string|string[]> headers, *ListProjectMembersQueries queries) returns ProjectMemberList|errorRetrieves a list of project members with rates and permissions. Include at least one of ProjectID or UserID parameters.
Parameters
- queries *ListProjectMembersQueries - Queries to be sent with the request
Return Type
- ProjectMemberList|error - Unauthorized
updateProjectMember
function updateProjectMember(UpdateProjectMember payload, map<string|string[]> headers) returns ProjectMemberDetails|errorUpdates a project member's rates, budget, or permissions. Only fields listed in the FieldsToUpdate array will be modified.
Parameters
- payload UpdateProjectMember - The request body containing the fields to update and their new values
Return Type
- ProjectMemberDetails|error - Returns the updated project member details
createProjectMember
function createProjectMember(NewProjectMember payload, map<string|string[]> headers) returns ProjectMemberDetails|errorAdds a user as a member of a project, setting their rates, budget, and permissions.
Parameters
- payload NewProjectMember - The request body containing the project ID, user ID, and optional rates and permissions
Return Type
- ProjectMemberDetails|error - Returns the new project member assignment details
listProjectTags
function listProjectTags(map<string|string[]> headers) returns ProjectTagList|errorRetrieves all project tags in the account, sorted alphabetically by name (case-insensitive). Tags are returned independently of whether they are currently assigned to any project, so this can populate tag pickers and filters. Requires the same permission as creating or updating a project; read-only users are denied.
Return Type
- ProjectTagList|error - Unauthorized
listTimesheetCategories
function listTimesheetCategories(map<string|string[]> headers, *ListTimesheetCategoriesQueries queries) returns ProjectTimesheetCategoryList|errorRetrieves the list of timesheet/billing categories assigned to projects.
Parameters
- queries *ListTimesheetCategoriesQueries - Queries to be sent with the request
Return Type
- ProjectTimesheetCategoryList|error - Unauthorized
updateTimesheetCategory
function updateTimesheetCategory(AssignProjectTimesheetCategory payload, map<string|string[]> headers) returns ProjectTimesheetCategoryDetails|errorUpdates an existing project timesheet category assignment, including billable status, rate, and budget hours. Optionally cascades rate changes to existing schedule bookings via ScheduleRateUpdateOption and to existing timesheet entries via TimesheetRateUpdateOption.
Parameters
- payload AssignProjectTimesheetCategory - The request body containing the project ID, category ID, and fields to update. Use ScheduleRateUpdateOption to control schedule booking cascade and TimesheetRateUpdateOption to control timesheet entry cascade
Return Type
- ProjectTimesheetCategoryDetails|error - Returns the updated timesheet category assignment
createTimesheetCategory
function createTimesheetCategory(AssignProjectTimesheetCategory payload, map<string|string[]> headers) returns ProjectTimesheetCategoryDetails|errorAssigns a timesheet/billing category to a project, specifying billable status, rate, and budget hours.
Parameters
- payload AssignProjectTimesheetCategory - The request body containing the project ID, category ID, and optional rate and budget settings
Return Type
- ProjectTimesheetCategoryDetails|error - Returns the new timesheet category assignment
listRecurringInvoices
function listRecurringInvoices(map<string|string[]> headers, *ListRecurringInvoicesQueries queries) returns RecurringInvoiceList|errorGets list of Recurring Invoices
Parameters
- queries *ListRecurringInvoicesQueries - Queries to be sent with the request
Return Type
- RecurringInvoiceList|error - Unauthorized
getRecurringInvoice
Retrieves a single recurring invoice profile by its ID, including line items, schedule configuration, and next invoice date.
Parameters
- id int - Recurring Invoice Profile ID number
Return Type
- RecurringInvoice|error - Unauthorized
listScheduleAssignments
function listScheduleAssignments(map<string|string[]> headers, *ListScheduleAssignmentsQueries queries) returns ScheduleAssignmentList|errorGets list of Schedule Assignments.
Parameters
- queries *ListScheduleAssignmentsQueries - Queries to be sent with the request
Return Type
- ScheduleAssignmentList|error - Unauthorized
addScheduleBooking
function addScheduleBooking(CreateBooking payload, map<string|string[]> headers) returns ScheduleSeriesDetails|errorCreates a new project work schedule booking for a user over a date range with specified hours per day or total duration.
Parameters
- payload CreateBooking - The booking details including user, project, category, date range, and hours
Return Type
- ScheduleSeriesDetails|error - Unauthorized
addScheduleLeave
function addScheduleLeave(CreateLeave payload, map<string|string[]> headers) returns ScheduleSeriesDetails|errorCreates a new leave/time-off schedule booking for a user over a date range.
Parameters
- payload CreateLeave - The leave details including user, leave type, date range, and hours per day
Return Type
- ScheduleSeriesDetails|error - Unauthorized
updateScheduleLeave
function updateScheduleLeave(EditLeave payload, map<string|string[]> headers) returns ScheduleSeriesDetails|errorUpdates an existing leave schedule booking.
Parameters
- payload EditLeave - The updated leave details. ScheduleSeriesID is required
Return Type
- ScheduleSeriesDetails|error - Unauthorized
updateScheduleBooking
function updateScheduleBooking(EditBooking payload, map<string|string[]> headers) returns ScheduleSeriesDetails|errorUpdates an existing project work schedule booking.
Parameters
- payload EditBooking - The updated booking details. ScheduleSeriesID is required
Return Type
- ScheduleSeriesDetails|error - Unauthorized
listScheduleSeries
function listScheduleSeries(map<string|string[]> headers, *ListScheduleSeriesQueries queries) returns ScheduleSeriesList|errorGets list of Schedule Series
Parameters
- queries *ListScheduleSeriesQueries - Queries to be sent with the request
Return Type
- ScheduleSeriesList|error - Unauthorized
searchScheduleSeries
function searchScheduleSeries(ScheduleSeriesFilterRequest payload, map<string|string[]> headers) returns ScheduleSeriesList|errorRetrieves a paginated list of schedule series matching the provided filter criteria. POST body contains filter parameters.
Parameters
- payload ScheduleSeriesFilterRequest - A filter object containing criteria for retrieving schedule series records, including date ranges, user, project, and category filters
Return Type
- ScheduleSeriesList|error - Unauthorized
deleteScheduleSeries
function deleteScheduleSeries(int id, map<string|string[]> headers, *DeleteScheduleSeriesQueries queries) returns record {}|errorDeletes a schedule series (booking or leave) by its Schedule Series ID. Also removes all associated daily schedule assignments.
Parameters
- id int - The ID of the Schedule Series to delete
- queries *DeleteScheduleSeriesQueries - Queries to be sent with the request
Return Type
- record {}|error - Unauthorized
listSections
function listSections(map<string|string[]> headers, *ListSectionsQueries queries) returns SectionList|errorRetrieves a list of sections (task groups) within a project. Requires a ProjectID query parameter.
Parameters
- queries *ListSectionsQueries - Queries to be sent with the request
Return Type
- SectionList|error - Unauthorized
createSection
function createSection(NewSection payload, map<string|string[]> headers) returns SectionDetails|errorCreates a new section (task group) within a project.
Parameters
- payload NewSection - The request body containing the project ID and section title
Return Type
- SectionDetails|error - Returns the created section with assigned Section ID
deleteSection
function deleteSection(map<string|string[]> headers, *DeleteSectionQueries queries) returns record {}|errorDeletes a section by its Section ID. Cannot delete a Section that contains Tasks.
Parameters
- queries *DeleteSectionQueries - Queries to be sent with the request
Return Type
- record {}|error - Returns confirmation of the section deletion
lookupTasks
function lookupTasks(map<string|string[]> headers, *LookupTasksQueries queries) returns TaskDropdownList|errorRetrieves tasks grouped by section within a project for dropdown/autocomplete use. Requires a projectID parameter.
Parameters
- queries *LookupTasksQueries - Queries to be sent with the request
Return Type
- TaskDropdownList|error - Returns tasks grouped by section for the specified project
listTasks
Retrieves a paginated list of tasks with details including assignees, dates, status, priority, tags, and time tracking. Supports filtering by project, section, status, priority, due date range, assigned user, completion state, and parent task / hierarchy.
Parameters
- queries *ListTasksQueries - Queries to be sent with the request
updateTask
function updateTask(UpdateTask payload, map<string|string[]> headers) returns TaskDetails|errorUpdate a Task.
Parameters
- payload UpdateTask - The request body containing the task ID, fields to update, and updated values
Return Type
- TaskDetails|error - Returns the updated task details
createTask
Creates a new task in a project section. Requires ProjectIDFK, SectionIDFK, and Title. Optionally assign users, set dates, priority, estimated effort, and tags.
Parameters
- payload NewTask - The request body containing the data for the new task
Return Type
- TaskDetails|error - Returns the created task with assigned Task ID
getTask
Retrieves full task details by Task ID, including project context, section, assignees, dates, status, priority, tags, and time tracking information.
Parameters
- id int - Task ID number
Return Type
- TaskDetails|error - Unauthorized
deleteTask
function deleteTask(int id, map<string|string[]> headers, *DeleteTaskQueries queries) returns record {}|errorDeletes a task by its Task ID.
Parameters
- id int - The ID of the task to delete. Supplied in the URL path, e.g. DELETE /api/Task/123
- queries *DeleteTaskQueries - Queries to be sent with the request
Return Type
- record {}|error - The task was deleted successfully
listTaskDiscussions
function listTaskDiscussions(map<string|string[]> headers, *ListTaskDiscussionsQueries queries) returns TaskDiscussion|errorRetrieves discussion/comment messages for a specific task, including replies, attachments, and system messages. Supports pagination via startItem.
Parameters
- queries *ListTaskDiscussionsQueries - Queries to be sent with the request
Return Type
- TaskDiscussion|error - Returns discussion messages with replies and attachments for the task
updateTaskDiscussion
function updateTaskDiscussion(EditTaskDiscussion payload, map<string|string[]> headers) returns TaskDiscussionResponse|errorEdit an existing task comment (body + attachments). Author-only. Internal-note flag, reply-to context, identity, and DateCreated are locked. Edits are silent (no new comment notification re-fires); only NEWLY-added @mentions trigger their mention notification.
Parameters
- payload EditTaskDiscussion - Edited task comment body and final set of attachment IDs
Return Type
createTaskDiscussion
function createTaskDiscussion(NewTaskDiscussion payload, map<string|string[]> headers) returns TaskDiscussionResponse|errorPost a new comment / discussion message to a task. Supports plain comments, internal notes, replies to existing messages, and file attachments.
Parameters
- payload NewTaskDiscussion - Discussion message payload
Return Type
- TaskDiscussionResponse|error - The newly created discussion message in the same shape used inside the Get TaskDiscussion responses[] array
listTaskPriorities
function listTaskPriorities(map<string|string[]> headers) returns TaskPriorityList|errorRetrieves all task priority definitions configured in the account. Includes priority code, display name, color, and sort order. Results are ordered by DisplayOrder ascending.
Return Type
- TaskPriorityList|error - Returns all task priority definitions
listTaskStatuses
function listTaskStatuses(map<string|string[]> headers) returns TaskStatusList|errorRetrieves all task status definitions configured in the account, grouped by task type. Includes status codes, display names, colors, sort order, and whether the status represents a completed state.
Return Type
- TaskStatusList|error - Returns all task status definitions grouped by task type
listTaskTypes
function listTaskTypes(map<string|string[]> headers) returns TaskTypeList|errorRetrieves all task type definitions (workflow types) configured in the account, including name, icon, and whether it is the default type.
Return Type
- TaskTypeList|error - Returns all task type definitions
listTaxes
Retrieves all tax rates configured in the Avaza account, including tax components for compound taxes.
listDeletedTimesheets
function listDeletedTimesheets(map<string|string[]> headers, *ListDeletedTimesheetsQueries queries) returns DeletedTimesheetList|errorRetrieves deleted (tombstone) timesheet entries for synchronisation purposes. Admin access only. Supports filtering by deletion date, entry date range, and user.
Parameters
- queries *ListDeletedTimesheetsQueries - Queries to be sent with the request
Return Type
- DeletedTimesheetList|error - Unauthorized
listTimesheets
function listTimesheets(map<string|string[]> headers, *ListTimesheetsQueries queries) returns TimesheetList|errorRetrieves a paginated list of timesheet entries with rich filtering by date range, user, project, task, category, billable/invoiced status, approval status, and running timer state.
Parameters
- queries *ListTimesheetsQueries - Queries to be sent with the request
Return Type
- TimesheetList|error - Unauthorized
updateTimesheet
function updateTimesheet(UpdateTimesheetModel payload, map<string|string[]> headers) returns TimesheetDetails|errorUpdates an existing timesheet entry. Only fields listed in FieldsToUpdate will be modified. ProjectIDFK is always required.
Parameters
- payload UpdateTimesheetModel - The request body containing the updated timesheet fields. Must include TimeSheetEntryID, ProjectIDFK, and FieldsToUpdate
Return Type
- TimesheetDetails|error - Bad Request
createTimesheet
function createTimesheet(NewTimesheet payload, map<string|string[]> headers) returns TimesheetDetails|errorCreates a new timesheet entry. If Duration is null or 0, a timer will be started automatically. Requires ProjectIDFK and TimesheetCategoryIDFK.
Parameters
- payload NewTimesheet - The request body containing the data for the new timesheet entry
Return Type
- TimesheetDetails|error - Bad Request
getTimesheet
Retrieves a single timesheet entry by its Timesheet Entry ID, including user, project, category, approval, and timer details.
Parameters
- id int - Timesheet Entry ID number
Return Type
- TimesheetDetails|error - Unauthorized
deleteTimesheet
function deleteTimesheet(int id, map<string|string[]> headers, *DeleteTimesheetQueries queries) returns record {}|errorDeletes a timesheet entry by its Timesheet Entry ID.
Parameters
- id int - The Timesheet Entry ID of the entry to be deleted
- queries *DeleteTimesheetQueries - Queries to be sent with the request
Return Type
- record {}|error - Unauthorized
approveTimesheets
function approveTimesheets(TimesheetApprovalRequest payload, map<string|string[]> headers) returns TimesheetApprovalBatchResponse|errorApproves a batch of pending timesheet entries by their TimeSheetEntryIDs. Caller must have the Timesheet Approver role and permission to approve each specific entry. Mixed-eligibility batches return per-entry results.
Parameters
- payload TimesheetApprovalRequest - The request body containing the list of TimeSheetEntryIDs to approve and an optional approval note
Return Type
- TimesheetApprovalBatchResponse|error - Bad Request - missing/invalid TimeSheetEntryIDs or note too long
rejectTimesheets
function rejectTimesheets(TimesheetRejectionRequest payload, map<string|string[]> headers) returns TimesheetApprovalBatchResponse|errorRejects a batch of pending or approved timesheet entries by their TimeSheetEntryIDs. Invoiced or paid entries cannot be rejected. Caller must have the Timesheet Approver role and permission to reject each specific entry. By default sends a rejection notification email per affected timesheet user; set SendNotifications=false to suppress.
Parameters
- payload TimesheetRejectionRequest - The request body containing the list of TimeSheetEntryIDs to reject, an optional rejection reason, and an optional SendNotifications flag (default true)
Return Type
- TimesheetApprovalBatchResponse|error - Bad Request - missing/invalid TimeSheetEntryIDs or reason too long
submitTimesheets
function submitTimesheets(map<string|string[]> headers, *SubmitTimesheetsQueries queries) returns record {}|errorSubmits timesheet entries for approval. Either provide a specific day (WholeDayOf) or any day within a week (WholeWeekOf) to submit all draft timesheets in that day or week.
Parameters
- queries *SubmitTimesheetsQueries - Queries to be sent with the request
Return Type
- record {}|error - Bad Request - WholeDayOf or WholeWeekOf must be provided
getTimesheetSummary
function getTimesheetSummary(map<string|string[]> headers, *GetTimesheetSummaryQueries queries) returns TimesheetSummaryResult|errorRetrieves aggregated timesheet statistics for a date range, with optional grouping by up to three dimensions (e.g. Project, User, Category, Task, Month). Requires EntryDateFrom and EntryDateTo.
Parameters
- queries *GetTimesheetSummaryQueries - Queries to be sent with the request
Return Type
- TimesheetSummaryResult|error - Bad Request - EntryDateFrom and EntryDateTo are required
getRunningTimer
function getRunningTimer(map<string|string[]> headers, *GetRunningTimerQueries queries) returns record {}|errorChecks if there is a currently running timer for the authenticated user (or an impersonated user). Returns timer start time, timesheet entry ID, and server time for clock synchronisation.
Parameters
- queries *GetRunningTimerQueries - Queries to be sent with the request
Return Type
- record {}|error - Unauthorized
startTimer
function startTimer(int id, map<string|string[]> headers, *StartTimerQueries queries) returns record {}|errorStarts a timer on an existing timesheet entry. If the entry is not on the current day or start/end times are enabled, a new timesheet entry is created for the timer.
Parameters
- id int - ID of the timesheet entry that should be used as the basis for running a timer. If the existing timesheet is not on the current day, or start/end times are enabled, a new timesheet will be created for the timer
- queries *StartTimerQueries - Queries to be sent with the request
Return Type
- record {}|error - Bad Request
stopTimer
function stopTimer(int id, map<string|string[]> headers, *StopTimerQueries queries) returns record {}|errorStops the running timer on a timesheet entry. The elapsed time is added to the entry's duration.
Parameters
- id int - The ID of the existing timesheet entry that needs its timer stopped
- queries *StopTimerQueries - Queries to be sent with the request
Return Type
- record {}|error - Bad Request
archiveUserProfile
function archiveUserProfile(UserProfileIDRequest payload, map<string|string[]> headers) returns UserDetails|errorArchive an existing user. Sets isArchived=true, deletes all role assignments, and disables all ProjectMember rows (freeing any consumed paid-role seats).
Parameters
- payload UserProfileIDRequest - { UserID }
Return Type
- UserDetails|error - Validation error or attempt to archive self
unarchiveUserProfile
function unarchiveUserProfile(UserProfileIDRequest payload, map<string|string[]> headers) returns UserDetails|errorUnarchive a previously archived user. Does NOT restore roles or ProjectMember records — those must be re-added explicitly.
Parameters
- payload UserProfileIDRequest - { UserID }
Return Type
- UserDetails|error - Validation error
listUserProfiles
function listUserProfiles(map<string|string[]> headers, *ListUserProfilesQueries queries) returns UserList|errorGet Collection of Users who have roles in the current Avaza account.
Parameters
- queries *ListUserProfilesQueries - Queries to be sent with the request
updateUserProfile
function updateUserProfile(UpdateUserProfile payload, map<string|string[]> headers) returns UserDetails|errorUpdate one or more fields on an existing user. Only fields named in FieldsToUpdate are written; fields listed but null in the payload are ignored.
Parameters
- payload UpdateUserProfile - UserID, FieldsToUpdate allowlist, and the fields to change
Return Type
- UserDetails|error - Validation error
createUserProfile
function createUserProfile(NewUserProfile payload, map<string|string[]> headers) returns UserDetails|errorCreate a new user (team member or customer contact) in the current Avaza account.
Parameters
- payload NewUserProfile - The new user details
Return Type
- UserDetails|error - Validation error (missing/invalid field, email already exists, invalid RoleCode for user type)
listWebhooks
function listWebhooks(map<string|string[]> headers) returns WebhookList|errorRetrieves all active webhook subscriptions for the authenticated account.
Return Type
- WebhookList|error - Unauthorized
createWebhook
function createWebhook(CreateSubscription payload, map<string|string[]> headers) returns SubscribeResult|errorCreates a new webhook subscription. On success, returns the ID of the new webhook subscription.
Parameters
- payload CreateSubscription - Webhook subscription details including target URL and events
Return Type
- SubscribeResult|error - Unauthorized
deleteWebhookByUrl
function deleteWebhookByUrl(map<string|string[]> headers, *DeleteWebhookByUrlQueries queries) returns record {}|errorDeletes a webhook subscription by its callback URL.
Parameters
- queries *DeleteWebhookByUrlQueries - Queries to be sent with the request
Return Type
- record {}|error - Unauthorized
getWebhook
Retrieves a single webhook subscription by its Subscription ID.
Parameters
- id Signed32 - The numeric Subscription ID of the webhook to retrieve
Return Type
- WebhookList|error - Unauthorized
deleteWebhook
Deletes a webhook subscription by its Subscription ID.
Parameters
- id Signed32 - The numeric Subscription ID of the webhook to delete
Return Type
- record {}|error - Unauthorized
Records
avaza: AccountDetails
Account-level configuration details including timesheet settings, currency, and branding options
Fields
- accountID? Signed32 - Unique identifier for the Avaza account
- timesheetDayOfWeek? Signed32 - The day of the week that starts the timesheet week (0=Sunday, 1=Monday, etc.)
- currentServerTimeISO? string - Format: ISO "YYYY-MM-DD HH:mm:ss.SSS"
- accountEmail? string - The primary email address associated with the account
- allowHidingCompletedTasksOnTimesheet? boolean - Whether users can hide completed tasks when selecting tasks on timesheets
- sC? string -
- companyName? string - The registered company/organisation name for the account
- receiptAIEnabled? boolean - AI receipt scanning is available to this account (POST api/Expense/ScanReceipt): enabled in Expense Settings on a paid plan
- has24HourTimesheetFormat? boolean - Whether the account displays times in 24-hour format (true) or 12-hour format (false)
- subdomain? string - The unique subdomain for the account (e.g. 'mycompany' in mycompany.avaza.com)
- hasStartEndTimesheets? boolean - Whether the account is configured to track start and end times on timesheet entries
- expenseApprovalRequired? boolean - Whether the account requires expenses be approved
- lockApprovedTimesheets? boolean - Whether approved timesheets are locked from further editing by standard users
- defaultCurrencyCode? string - ISO 3 letter base Currency Code for the account
- brandPrimaryColorLuminance? string - A determination of the luminance of the Brand Primary Color (possible values: 'Dark', 'Medium', 'Light'). This can be used to determine appropriate font colors to sit on top of the brand color
- timesheetDisplayFormatCode? string - The display format for timesheets (e.g. decimal hours vs hours:minutes)
- brandPrimaryColor? string - A custom branding color for the account. Available on paid accounts
- lockApprovedExpenses? boolean - Approved expenses get locked from subsequent editing by standard expense users
- weeklyTimesheetReminder? boolean - Whether weekly timesheet reminder emails are enabled for the account
avaza: AccountTaskTypeDetails
A task type definition (workflow type) with name, icon, and default flag
Fields
- isDefault? boolean - Whether this is the default task type for new tasks
- accountTaskTypeID? Signed32 - Unique identifier for the task type
- icon? string - Icon identifier for the task type
- iconType? string - Type/category of the icon
- name? string - Display name of the task type
avaza: AddInvoiceLineItemsRequest
Request model for appending line items to an existing invoice without modifying its other line items
Fields
- lineItems NewInvoiceLineItem[] - The line items to append (1-100). Each may optionally link uninvoiced timesheets, expenses or a fixed amount via TimesheetEntryIDs / ExpenseIDs / FixedAmountIDs; amounts and descriptions are calculated from the linked records unless supplied. Existing line items on the invoice are never modified or deleted by this endpoint
- expenseExchangeRates? ExpenseExchangeRate[] - Optional exchange-rate overrides applied when linked Expenses are in a currency different from the invoice currency
- sendWebhooks? boolean - If true, fires invoice_updated (plus timesheet_updated / expense_updated for linked records) webhook events. Defaults to false
- invoiceID int - The Transaction ID of the invoice to append line items to. The invoice must not be Void
avaza: AddUninvoicedItemsResult
Result of adding all matching uninvoiced records to an invoice
Fields
- invoice? Invoice -
- addedTransactionLineItemIDs? int[] - The TransactionLineItemIDs of the newly created line items
- expensesLinked? Signed32 - Number of expenses linked (marked invoiced)
- timesheetEntriesLinked? Signed32 - Number of timesheet entries linked (marked invoiced)
- skippedTimesheetEntryIDs? int[] - Timesheet entries that matched the filters but were skipped because they have a running timer
- warnings? string[] - Non-fatal notices (e.g. an invoice status change caused by the new total)
- fixedAmountsLinked? Signed32 - Number of fixed amounts linked (marked invoiced)
avaza: ApiFileAttachmentBody
Fields
- file record { fileContent byte[], fileName string } - The file to upload (multipart/form-data)
avaza: AssignedToUser
A user assigned to a task, with their user ID, email, first name, and last name
Fields
- assignedToFirstname? string - First name of the assigned user
- assignedToLastname? string - Last name of the assigned user
- assignedToUserIDFK? Signed32 - User ID of the assigned user
- assignedToEmail? string - Email of the assigned user
avaza: AssignProjectTimesheetCategory
Request model for assigning or updating a timesheet category on a project
Fields
- scheduleRateUpdateOption? string - Controls whether updated rates are applied to existing schedule bookings for this category. Possible values: "new" (default, only new bookings), "all" (all existing bookings), "active" (bookings with end date in the future)
- timesheetRateUpdateOption? string - Controls whether updated rates are applied to existing timesheet entries for this category. Possible values: "new" (default, do not update existing timesheets), "uninvoiced" (update all existing uninvoiced timesheets)
- projectIDFK? Signed32 - The project ID to assign the category to
- budgetHours? decimal - Hours budget for this category on this project
- costAmount? decimal - The cost rate per hour for this category on this project
- rateAmount? decimal - The billing rate per hour for this category on this project
- timesheetCategoryIDFK? Signed32 - The timesheet category ID to assign to the project
- isBillable? boolean - Whether time logged under this category is billable
- isPayable? boolean - Whether time logged under this category is payable
avaza: Bill
A supplier bill (purchase invoice) including line items, status, amounts, and issuer/recipient details
Fields
- exchangeRate? decimal - Exchange rate to the account's base currency. 1.0 if same currency
- issuer? BillIssuerDetails -
- dateCreated? string - Date and time the record was created
- billNumber? string - The full bill/invoice number including prefix
- transactionID? int - Unique identifier for the bill transaction
- transactionPrefix? string - The prefix used in the bill number (e.g. 'BILL')
- currencyCode? string - ISO 3-character currency code for the bill
- companyName? string - The name of the supplier company
- taxAmount? decimal - Total tax amount across all line items
- supplierPONumber? string - Supplier purchase order number reference
- transactionStatusCode? string - Current status of the bill. Values: Draft, Verified, Late, Paid, Partial, Void
- dueDate? string - The payment due date for the bill
- notes? string - Additional notes or comments on the bill
- lineItems? BillLineItem[] - Line items on this bill
- dateUpdated? string - Date and time the record was last updated
- accountIDFK? Signed32 - The Avaza account this bill belongs to
- recipient? BillRecipientDetails -
- companyIDFK? Signed32 - The supplier company ID this bill is from
- totalAmount? decimal - Total amount of the bill including tax
- subject? string - Subject line or description for the bill
- dateVerified? string - The date the bill was verified/approved
- dateIssued? string - The date the bill was issued
- links? BillLinks -
- balance? decimal - Outstanding balance remaining on the bill
- transactionTaxConfigCode? string - Tax configuration: 'EX' (tax exclusive) or 'INC' (tax inclusive)
avaza: BillIssuerDetails
Billing address details for the supplier who issued the bill
Fields
- billingAddress? string - Formatted multi-line billing address
- companyName? string - The name of the supplier company
- taxNumberLabel? string - Label printed next to the supplier's tax number: the company's own Tax Number Label, else the bill template's default supplier label, else "Tax Number"
- billingAddressLine? string - Street address line of the billing address
- billingAddressState? string - State/province of the billing address
- billingCountryCode? string - ISO 3166-1 alpha-2 country code of the billing address
- billingAddressPostCode? string - Postal/ZIP code of the billing address
- companyIDFK? Signed32 - The supplier company ID this bill is from
- taxNumber? string - The supplier company's tax registration number (Company.TaxNumber). Null when not set
- billingAddressCity? string - City/suburb of the billing address
avaza: BillLineItem
A line item on a supplier bill, specifying the inventory item, quantity, unit price, tax, and amount
Fields
- description? string - Text description for the line item
- discount? decimal - Discount percentage applied to this line item
- taxIDFK? Signed32 - The tax rate ID applied to this line item
- taxName? string - Name of the applied tax rate
- projectIDFK? Signed32 - Optional project ID this line item is attributed to for reporting
- amount? decimal - Calculated line total (Quantity x UnitPrice less Discount)
- inventoryItemIDFK? int - The inventory/product item ID for this line item
- quantity? decimal - Quantity of items on this line
- transactionLineItemID? int - Unique identifier for the line item
- inventoryItemName? string - Name of the inventory/product item
- unitPrice? decimal - Price per unit for this line item
- taxAmount? decimal - Total tax amount for this line item
- inventoryItemSKU? string - Stock Keeping Unit code for the inventory item
- projectTitle? string - Title of the associated project
- taxCode? string - Short code for the applied tax rate
avaza: BillLinks
URLs for viewing and editing a bill in the Avaza web application
Fields
- edit? string - URL for editing the bill in the Avaza application
- webView? string - URL for viewing the bill in a web browser
- view? string - URL for viewing the bill in the Avaza application
avaza: BillList
Paginated collection of supplier bills
Fields
- totalCount? Signed32 - Total number of bills matching the filter criteria
- pageSize? Signed32 - Number of results per page
- pageNumber? Signed32 - Current page number (1-based)
- bills? Bill[] - The list of bills for this page
avaza: BillPayment
A payment made to a supplier, including allocations to specific bills
Fields
- exchangeRate? decimal - Exchange rate to the account's base currency
- paymentAllocations? BillPaymentAllocation[] - List of allocations applying this payment to specific bills
- transactionReference? string - External reference number (e.g. cheque number or bank reference)
- dateUpdated? string - Date and time the record was last updated
- accountIDFK? Signed32 - The Avaza account this payment belongs to
- dateCreated? string - Date and time the record was created
- totalAmount? decimal - Total payment amount
- transactionID? int - Unique identifier for the payment transaction
- transactionPrefix? string - The prefix used in the payment number
- currencyCode? string - ISO 3-character currency code for the payment
- supplierIDFK? Signed32 - The supplier company ID this payment is made to
- dateIssued? string - The date the payment was made
- viewBillPaymentURL? string - URL to view this bill payment in the Avaza web application
- transactionStatusCode? string - Current status of the payment
- paymentProviderCode? string - Code identifying the payment provider/method used
- balance? decimal - Unallocated balance remaining on the payment
- paymentNumber? string - The full payment number including prefix
- notes? string - Additional notes on the payment
avaza: BillPaymentAllocation
An allocation record linking a bill payment to a specific supplier bill
Fields
- allocationAmount? decimal - The amount allocated from the payment to the bill
- transactionAllocationID? int - Unique identifier for this payment allocation
- allocationDate? string - The date this allocation was applied
- paymentTransactionIDFK? int - The payment Transaction ID this allocation belongs to
- billTransactionIDFK? int - The bill Transaction ID this payment is allocated against
avaza: BillPaymentList
Paginated collection of supplier bill payments
Fields
- totalCount? Signed32 - Total number of payments matching the filter criteria
- pageSize? Signed32 - Number of results per page
- pageNumber? Signed32 - Current page number (1-based)
- payments? BillPayment[] - The list of bill payments for this page
avaza: BillRecipientDetails
Billing address details for the Avaza account (the recipient of the bill)
Fields
- recipientFormattedBillingAddress? string - Pre-formatted multi-line billing address for the recipient
- recipientBillingAddressState? string - State/province for the recipient
- taxNumberLabel? string - Label printed next to your company's tax number: the template's override, else the account's Company Default Tax Number Label, else "Tax Number"
- recipientBillingAddressPostCode? string - Postal/ZIP code for the recipient
- recipientBillingAddressCountryCode? string - ISO country code for the recipient
- recipientBillingAddressCity? string - City/suburb for the recipient
- taxNumber? string - Your company's tax registration number as printed on the bill: the bill template's Company Tax Number override, else the account's Company Default Tax Number. Null when neither is set
- recipientBillingAddressLine? string - Street address line for the recipient
avaza: Company
A customer or supplier company record with billing address, contacts, and financial settings
Fields
- taxNumberLabel? string - Label printed next to the tax number on invoices, e.g. "VAT No.", "USt-IdNr.", "ABN" (max 100 chars). Null uses the invoice template's default label or "Tax Number"
- billingAddressLine? string - The first line of the company's billing address (street address)
- website? string - The company's website URL
- billingAddressState? string - The state or province of the company's billing address
- companyID? Signed32 - The unique identifier of the company
- comments? string - Internal notes or comments about the company
- dateUpdated? string - The UTC date and time when the company record was last updated
- defaultTradingTermIDFK? Signed32 - The ID of the default trading terms applied to invoices for this company
- billingCountryCode? string - The ISO 2-letter country code for the company's billing address
- dateCreated? string - The UTC date and time when the company record was created
- billingAddressPostCode? string - The postcode or ZIP code of the company's billing address
- billingAddressCity? string - The city of the company's billing address
- billingAddress? string - The full formatted billing address string. If set, overrides the individual address fields
- currencyCode? string - The default currency code used for invoices and transactions with this company
- companyName? string - The display name of the company
- customFields? CustomFieldValueItem[] - Custom field values set on this company, in display order. Fields with no value are not included. Omitted entirely when the account's Custom Fields feature is disabled (external contact tokens only see fields with "Everyone" visibility). See GET /api/CustomFieldDefinition for the account's field definitions
- contacts? CompanyContact[] - The list of external contacts associated with this company
- phone? string - The company's primary phone number
- viewCompanyURL? string - URL to view this company in the Avaza web application
- taxNumber? string - The company's tax registration number
- fax? string - The company's fax number
avaza: CompanyContact
An external contact associated with a customer company
Fields
- email? string - The contact's email address
- positionTitle? string - The contact's job title or position
- dateUpdated? string - The UTC date and time when the contact record was last updated
- lastname? string - The contact's last name
- dateCreated? string - The UTC date and time when the contact record was created
- roles? RoleDetails[] - The roles assigned to this contact (RoleCode/RoleName), mirroring the Get UserProfile response
- contactID? Signed32 - The unique identifier of the contact
- companyIDFK? Signed32 - The ID of the company this contact belongs to
- mobile? string - The contact's mobile phone number
- firstname? string - The contact's first name
- companyName? string - The name of the company this contact belongs to
- timeZone? string - The contact's time zone identifier
- customFields? CustomFieldValueItem[] - Custom field values set on this contact, in display order. Fields with no value are not included. Omitted entirely when the account's Custom Fields feature is disabled (external contact tokens only see fields with "Everyone" visibility), and not populated on the nested Contacts of a Company response. See GET /api/CustomFieldDefinition for the account's field definitions
- phone? string - The contact's phone number
avaza: CompanyDropdownList
Paginated list of minimal company records for dropdown/autocomplete use
Fields
- totalCount? Signed32 - Total number of companies matching the query
- pageSize? Signed32 - The number of results per page
- pageNumber? Signed32 - The current page number (1-based)
- companies? CompanyMinimal[] - The list of minimal company records for the current page
avaza: CompanyList
Paginated collection of customer companies with full details
Fields
- totalCount? Signed32 - Total number of companies matching the query
- pageSize? Signed32 - The number of results per page
- pageNumber? Signed32 - The current page number (1-based)
- companies? Company[] - The list of companies for the current page
avaza: CompanyMinimal
A minimal company record containing only the Company ID and name
Fields
- companyName? string - The display name of the company
- companyID? int - The unique identifier of the company
avaza: CompleteFileAttachmentUploadQueries
Represents the Queries record for the operation: completeFileAttachmentUpload
Fields
- token? string - The signed upload token from the authorised URL
avaza: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
avaza: ContactList
Paginated collection of external contacts
Fields
- totalCount? Signed32 - Total number of contacts matching the query
- contacts? CompanyContact[] - The list of contacts for the current page
- pageSize? Signed32 - The number of results per page
- pageNumber? Signed32 - The current page number (1-based)
avaza: CreateBooking
Request model for creating a new project work schedule booking over a date range
Fields
- durationType? string - Possible values are "HoursPerDay" or "TotalDuration"
- hoursPerDay? decimal - Hours to allocate per working day
- sendWebhooks? boolean - If true, fires the scheduleseries_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK? Signed32 - The project to book time against
- taskIDFK? Signed32 - Optional task to link the booking to
- startTime? string - Optional start time of day for the booking
- endDate? string - End date of the booking period
- totalDuration? decimal - Total hours across the booking (alternative to HoursPerDay)
- startDate? string - Start date of the booking period
- categoryIDFK? Signed32 - The timesheet category for the booking
- userIDFK? Signed32 - The user ID to schedule the booking for
- scheduleOnDaysOff? boolean - Whether to include weekends and holidays
- notes? string - Additional notes for the booking
avaza: CreateLeave
Request model for creating a new leave/time-off schedule entry for a user
Fields
- leaveUserIDFK? Signed32 - The user ID to create leave for
- leaveTypeIDFK? Signed32 - The leave type ID (e.g. Annual Leave, Sick Leave)
- leaveEndDate? string - End date of the leave period
- leaveStartDate? string - Start date of the leave period
- sendWebhooks? boolean - If true, fires the scheduleseries_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- leaveNotify? boolean - Whether to send an email notification about the leave
- leaveHoursPerDay? decimal - Hours of leave per day
- leaveStartTime? string - Optional start time for partial-day leave
- leaveNotes? string - Additional notes for the leave entry
avaza: CreateSubscription
New Subscription to be Created
Fields
- targetUrl string - The URL that should be notified of the event
- secret? string - 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]"
- event string - The event code to be notified about. Possible values: company_created, company_deleted, company_updated, contact_created, contact_deleted, contact_updated, invoice_created, invoice_sent, invoice_updated, invoice_deleted, project_created, project_deleted, project_updated, task_created, task_updated, task_deleted, timesheet_created, timesheet_deleted, timesheet_updated, bill_created, bill_updated, estimate_created, estimate_updated, estimate_deleted, team_member_created, team_member_updated, team_member_deleted
avaza: CreditNote
A customer credit note with line items and allocations to invoices
Fields
- creditNoteNumber? string - The full credit note number including prefix
- viewCreditNoteURL? string - URL to view this credit note in the Avaza web application
- dateUpdated? string - Date and time the record was last updated
- creditNoteLineItems? CreditNoteLineItem[] - Line items on this credit note
- dateCreated? string - Date and time the record was created
- totalAmount? decimal - Total credit note amount
- transactionID? int - Unique identifier for the credit note transaction
- transactionPrefix? string - Prefix used in the credit note number
- currencyCode? string - ISO 3-character currency code for the credit note
- customerIDFK? Signed32 - The customer company ID this credit note is issued to
- dateIssued? string - The date the credit note was issued
- transactionStatusCode? string - Current status of the credit note
- creditNoteAllocations? CreditNoteAllocation[] - List of allocations applying this credit note against invoices
- balance? decimal - Unallocated balance remaining on the credit note
- notes? string - Additional notes on the credit note
avaza: CreditNoteAllocation
An allocation record linking a credit note to a specific invoice
Fields
- allocationAmount? decimal - The amount allocated from the credit note to the invoice
- transactionAllocationID? int - Unique identifier for this allocation
- creditNoteTransactionIDFK? int - The credit note Transaction ID this allocation belongs to
- allocationDate? string - The date this allocation was applied
- invoiceTransactionIDFK? int - The invoice Transaction ID this credit note is allocated against
avaza: CreditNoteLineItem
A line item on a credit note
Fields
- transactionLineItemID? int - Unique identifier for the line item
- unitPrice? decimal - Price per unit for this line item
- taxAmount? decimal - Calculated tax amount on this line item
- description? string - Text description for the line item
- discount? decimal - Discount percentage applied to this line item
- taxIDFK? Signed32 - The tax rate ID applied to this line item
- amount? decimal - Calculated line total (Quantity x UnitPrice less Discount)
- quantity? decimal - Quantity of items on this line
avaza: CreditNoteList
Paginated collection of customer credit notes
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- creditNotes? CreditNote[] - The list of credit notes on this page
avaza: Currency
Fields
- currencyCode? string -
- decimalPlaces? Signed32 -
- symbol? string -
- symbol2? string -
- name? string -
avaza: CurrencyList
Collection of currencies configured in the account
Fields
- currencies? Currency[] - The list of currencies configured in the Avaza account
avaza: CustomFieldDefinitionDetails
An active custom field definition mapped to an entity type. Definitions are managed by account admins in Avaza settings and are read-only via the API
Fields
- decimalPlaces? Signed32 - Number of decimal places displayed for numeric types
- customFieldDefinitionID? Signed32 - Unique identifier for the custom field definition
- isRequired? boolean - Whether a value is required when creating records of this entity type
- options? CustomFieldOptionDetails[] - Active options for Dropdown fields, in display order. Empty for other data types
- description? string - Optional description / help text for the field
- isMultiSelect? boolean - Whether the field allows multiple selections (Dropdown and User types only)
- unitLabel? string - Unit suffix displayed after Number values (e.g. "km"), when configured
- dataTypeCode? string - Data type of the field. Values: ShortText, LongText, Number, Percentage, Currency, Duration, Date, Checkbox, Dropdown, User, Location
- visibilityCode? string - Field visibility. "Internal" = team members only; "Everyone" = also visible to external contacts
- name? string - Display name of the custom field
avaza: CustomFieldDefinitionList
Collection of custom field definitions mapped to an entity type
Fields
- customFieldDefinitions? CustomFieldDefinitionDetails[] - Active custom field definitions mapped to the requested entity type, in display order
avaza: CustomFieldOptionDetails
An active option of a Dropdown custom field
Fields
- color? string - Hex colour assigned to the option (e.g. "#F0AD4E"), or null
- customFieldOptionID? Signed32 - Unique identifier for the option
- name? string - Option display name
avaza: CustomFieldValueInput
One custom field value to set on a Task, Project, Team Member (UserProfile), Contact or Company. Identify the field by CustomFieldDefinitionID (preferred) or by Name (case-insensitive). Custom field definitions and options can never be created or modified via the API — values only (see GET /api/CustomFieldDefinition for the account's definitions)
Fields
- customFieldDefinitionID? Signed32 - The custom field definition ID to set (preferred identifier; see GET /api/CustomFieldDefinition)
- value? record {} - The value to set. Accepted formats by data type: text = string; Number/Percentage/Currency = JSON number or numeric string; Duration = number (decimal hours) or "h:mm" string; Date = "yyyy-MM-dd" string; Checkbox = boolean; Dropdown (single) = option name string or option id number; User (single) = UserID number or email string; Location = "lat,lng" string. Pass null (with no Values) to clear the field
- values? record {}[] - Multi-select fields only (Dropdown/User with isMultiSelect): the complete new selection as an array of option names/ids or user ids/emails. REPLACES the existing selection. An empty array clears the field
- name? string - The custom field name (case-insensitive) — an alternative to CustomFieldDefinitionID
avaza: CustomFieldValueItem
One custom field value on a Task, Project, Team Member, Contact or Company record. Fields with no value are omitted from the CustomFields collection entirely. Value carries the typed raw value (string / number / boolean / "yyyy-MM-dd" date string / option name(s) / user name(s) / "lat, lng" string); DisplayValue is the formatted, human-readable text
Fields
- customFieldDefinitionID? Signed32 - Unique identifier of the custom field definition this value belongs to
- optionIDs? Signed32[] - Selected option IDs. Dropdown fields only
- isMultiSelect? boolean - Whether the field allows multiple selections (Dropdown and User types only)
- displayValue? string - Formatted display text for the value (numbers formatted per the definition, Duration as h:mm, Checkbox as Yes/No, multi-select values comma-separated)
- unitLabel? string - Unit suffix configured on the definition (Number fields only, when set)
- value? record {} - The typed raw value: string for text, number for numeric types (Duration is decimal hours), boolean for Checkbox, "yyyy-MM-dd" string for Date, option name(s) for Dropdown, user name(s) for User (array of strings when multi-select), "lat, lng" string for Location
- latitude? decimal - Latitude. Location fields only
- longitude? decimal - Longitude. Location fields only
- dataTypeCode? string - Data type of the field. Values: ShortText, LongText, Number, Percentage, Currency, Duration, Date, Checkbox, Dropdown, User, Location
- userIDs? Signed32[] - Selected user IDs. User fields only
- name? string - Display name of the custom field
avaza: DeletedTimeSheetEntryDetails
A deleted timesheet entry record including all original field values, useful for external system synchronisation
Fields
- billLineItemIDFK? int - The bill line item ID if the entry had been included on a supplier bill
- startTimeUTC? string - The UTC start time of the entry, if start/end time tracking was enabled
- projectIDFK? Signed32 - The project ID this entry was associated with
- dateCreated? string - Date and time the record was originally created (UTC)
- endTimeLocal? string - The local end time of the entry, if start/end time tracking was enabled
- rateAmount? decimal - The billing rate amount. Only visible to Admin role users
- endTimeUTC? string - The UTC end time of the entry, if start/end time tracking was enabled
- timesheetUserTimeZone? string - The IANA time zone ID of the user who owned the timesheet
- invoiceLineItemIDFK? int - The invoice line item ID if the entry had been invoiced
- costAmount? decimal - The cost rate amount. Only visible to Admin role users
- timerStartedAtUTC? string - The UTC time the timer was started, if a timer was running
- notes? string - Notes attached to the timesheet entry
- timeSheetEntryID? int - Unique identifier of the deleted timesheet entry
- dateUpdated? string - Date and time the record was last updated before deletion (UTC)
- taskIDFK? Signed32 - The task ID the entry was linked to, if any
- accountIDFK? Signed32 - The Avaza account this entry belonged to
- duration? decimal - Duration of the entry in decimal hours
- timeSheetCategoryIDFK? Signed32 - The timesheet category ID applied to this entry
- isBillable? boolean - Whether the entry was billable
- isPaid? boolean - Whether the entry had been paid
- hasTimer? boolean - Whether a timer was running on this entry at the time of deletion
- startTimeLocal? string - The local start time of the entry, if start/end time tracking was enabled
- approvedBy? string - Name or email of the user who approved this entry
- entryDate? string - The original date of the timesheet entry
- userIDFK? Signed32 - The user ID who owned this timesheet entry
- timesheetEntryApprovalStatusCode? string - Approval status at the time of deletion
- deletedByUserIDFK? Signed32 - The user ID of the user who deleted this entry
- isInvoiced? boolean - Whether the entry had been invoiced
- dateApproved? string - Date and time the entry was approved, if applicable
- deletedDate? string - The date and time the entry was deleted (UTC)
- customMetadata? string - Custom metadata stored on the entry
- isPayable? boolean - Whether the entry was payable
avaza: DeletedTimesheetList
Paginated collection of deleted timesheet entries for sync purposes
Fields
- totalCount? Signed32 - Total number of deleted timesheet entries matching the filter criteria
- deletedTimesheets? DeletedTimeSheetEntryDetails[] - The list of deleted timesheet entries for the current page
- pageSize? Signed32 - Number of results per page
- pageNumber? Signed32 - The current page number (1-based)
avaza: DeleteEstimateQueries
Represents the Queries record for the operation: deleteEstimate
Fields
- SendWebhooks? boolean - If true, fires the estimate_deleted webhook to subscribed endpoints. Defaults to false
- EstimateID? int - The ID of the estimate to delete, supplied in the query string
avaza: DeleteExpenseQueries
Represents the Queries record for the operation: deleteExpense
Fields
- SendWebhooks? boolean -
avaza: DeleteScheduleSeriesQueries
Represents the Queries record for the operation: deleteScheduleSeries
Fields
- sendWebhooks? boolean -
avaza: DeleteSectionQueries
Represents the Queries record for the operation: deleteSection
Fields
- SectionID int - The ID of the section to delete
avaza: DeleteTaskQueries
Represents the Queries record for the operation: deleteTask
Fields
- sendWebhooks? boolean - If true, fires the task_deleted webhook to subscribed endpoints. Defaults to false
avaza: DeleteTimesheetQueries
Represents the Queries record for the operation: deleteTimesheet
Fields
- sendWebhooks? boolean -
avaza: DeleteWebhookByUrlQueries
Represents the Queries record for the operation: deleteWebhookByUrl
Fields
- target_url string - The callback URL of the webhook subscription to delete
avaza: EditBooking
Request model for updating an existing project work schedule booking
Fields
- durationType? string - Possible values are "HoursPerDay" or "TotalDuration"
- scheduleSeriesID? int - The Schedule Series ID to update
- hoursPerDay? decimal - Hours to allocate per working day
- sendWebhooks? boolean - If true, fires the scheduleseries_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK? Signed32 - The project to book time against
- taskIDFK? Signed32 - Optional task to link the booking to
- startTime? string - Optional start time of day for the booking
- endDate? string - End date of the booking period
- totalDuration? decimal - Total hours across the booking (alternative to HoursPerDay)
- startDate? string - Start date of the booking period
- categoryIDFK? Signed32 - The timesheet category for the booking
- userIDFK? Signed32 - The user ID to schedule the booking for
- scheduleOnDaysOff? boolean - Whether to include weekends and holidays
- notes? string - Additional notes for the booking
avaza: EditLeave
Request model for updating an existing leave schedule booking
Fields
- startDate? string - Start date of the leave period
- leaveTypeIDFK? Signed32 - The leave type ID (e.g. Annual Leave, Sick Leave)
- scheduleSeriesID? int - The Schedule Series ID to update
- hoursPerDay? decimal - Hours of leave per day
- sendWebhooks? boolean - If true, fires the scheduleseries_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- startTime? string - Optional start time for partial-day leave
- userIDFK? Signed32 - The user ID this leave is for
- endDate? string - End date of the leave period
- notes? string - Additional notes for the leave entry
avaza: EditTaskDiscussion
Fields
- expectedDateUpdated? string - Optional optimistic-concurrency guard. If supplied and differs from the row's current DateUpdated, the edit is rejected with 409
- taskResponseID? int - The TaskResponseID of the comment to edit. Must be authored by the current user
- responseBody? string - The new message body. Required (non-empty after sanitisation) if FileAttachmentIDs is empty. @mention markup is the same as on POST: <span class="mention" data-mentionid="12345">@Firstname Lastname</span> (the class attribute is required). On edit, only NEWLY-added mentions are notified/followed; mentions already present before the edit are not re-notified
- fileAttachmentIDs? int[] - Final canonical attachment set after edit: existing IDs to KEEP plus new draft IDs to ADD. Existing IDs omitted from this list are hard-deleted. Maximum 8
avaza: EstimateDetails
An estimate (quote) including line items, status, amounts, and issuer/recipient details
Fields
- estimatePrefix? string - Prefix used in the estimate number
- exchangeRate? decimal - Exchange rate to the account's base currency
- lineItems? EstimateLineItemDetails[] - Line items on this estimate
- issuer? IssuerDetails -
- dateUpdated? string - Date and time the record was last updated
- accountIDFK? Signed32 - The Avaza account this estimate belongs to
- dateCreated? string - Date and time the record was created
- estimateTaxConfigCode? string - Tax configuration: 'EX' (exclusive) or 'INC' (inclusive)
- recipient? RecipientDetails -
- companyIDFK? Signed32 - The customer company ID this estimate is for
- totalAmount? decimal - Total estimate amount including tax
- estimateID? int - Unique identifier for the estimate
- subject? string - Subject line for the estimate
- estimateItemNumber? string - The estimate number (without prefix)
- currencyCode? string - ISO 3-character currency code for the estimate
- companyName? string - Name of the customer company
- taxAmount? decimal - Total tax amount across all line items
- dateIssued? string - Date the estimate was created/issued
- dateSent? string - Date the estimate was sent to the customer
- links? EstimateLinks -
- dueDate? string - Expiry date for the estimate
- balance? decimal - Remaining balance on the estimate
- notes? string - Additional notes on the estimate
- estimateStatusCode? string - Current status. Values: Draft, Sent, Accepted, Converted, Expired, Rejected
avaza: EstimateLineItemDetails
A line item on an estimate, specifying the inventory item, quantity, unit price, tax, and amount
Fields
- description? string - Text description for the line item
- discount? decimal - Discount percentage applied to this line item
- taxIDFK? Signed32 - The tax rate ID applied to this line item
- taxName? string - Name of the applied tax rate
- amount? decimal - Calculated line total (Quantity x UnitPrice less Discount)
- inventoryItemIDFK? int - The inventory/product item ID for this line item
- quantity? decimal - Quantity of items on this line
- inventoryItemName? string - Name of the inventory/product item
- unitPrice? decimal - Price per unit for this line item
- taxAmount? decimal - Calculated tax amount on this line item
- inventoryItemSKU? string - Stock Keeping Unit code for the inventory item
- taxCode? string - Short code for the applied tax rate
- estimateLineItemID? int - Unique identifier for the estimate line item
avaza: EstimateLinks
URLs for client-facing view, internal view, and editing an estimate in Avaza
Fields
- clientView? string - URL for the customer to view the estimate online
- edit? string - URL for editing the estimate in the Avaza application
- view? string - URL for viewing the estimate in the Avaza application
avaza: EstimateList
Paginated collection of estimates/quotes
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- estimates? EstimateDetails[] - The list of estimates on this page
avaza: ExpenseAiExtraction
The state and result of the AI receipt read behind an expense created by receipt scanning
Fields
- status? string - Processing (the receipt is being read), Completed, NotReceipt (the file was not a receipt), Failed, Refused (the AI provider declined the image) or QuotaExceeded
- filledFields? string[] - The expense fields that were filled from the receipt, e.g. Merchant, Date, Amount, Currency, Tax, Category, Payment Method, Merchant Tax Number, Notes
- message? string - The same sentence the expense history shows, e.g. "AI extracted 6 fields ..."
- startedUtc? string - When the read was started (UTC)
- fieldsExtracted? Signed32 - How many expense fields the AI could read from the receipt
- completedUtc? string - When the read finished (UTC). Null while Processing
- notes? string[] - Caveats worth showing the user, e.g. why the Amount was left blank
avaza: ExpenseAttachmentBody
Fields
- file record { fileContent byte[], fileName string } - Upload software package
avaza: ExpenseAttachmentUploadResult
Result of uploading an expense file attachment, containing the file details
Fields
- fileAttachments? FileAttachmentDetails[] - List of uploaded file attachment details
avaza: ExpenseCategoryDetails
An expense category with unit price configuration for per-unit expense tracking (e.g. mileage)
Fields
- unitPrice? decimal - The predefined price per unit, if hasUnitPrice is true
- hasUnitPrice? boolean - Whether this category uses unit pricing (e.g. mileage rate per km/mile)
- expenseCategoryID? Signed32 - Unique identifier for the expense category
- enabled? boolean - Whether this category is currently active and available for use
- unitName? string - The unit label (e.g. 'mile', 'km'), if hasUnitPrice is true
- name? string - Name of the expense category
avaza: ExpenseCategoryList
Collection of expense categories configured in the account
Fields
- categories? ExpenseCategoryDetails[] - List of expense categories
avaza: ExpenseDeleteResult
Result of deleting a single expense, indicating success or the error encountered
Fields
- expenseID? int - The Expense ID for this deletion result
- errorMessage? string - Error message if the deletion failed, otherwise null
- success? boolean - Whether the deletion was successful
avaza: ExpenseDeleteResultSet
Collection of deletion results for a batch expense delete operation
Fields
- results? ExpenseDeleteResult[] - List of individual deletion results, one per requested Expense ID
avaza: ExpenseDetails
A detailed expense entry including user, project, category, amount, tax, approval status, and attachment
Fields
- expenseCategoryIDFK? Signed32 - The expense category ID
- exchangeRate? decimal - Exchange rate from expense currency to account base currency
- email? string - Email address of the expense user
- expenseID? int - Unique identifier for the expense entry
- projectIDFK? Signed32 - The project ID the expense is linked to
- expenseCategoryUnitName? string - The unit label (e.g. 'miles', 'km') for unit-priced categories
- dateCreated? string - Date and time the expense record was created
- aiExtraction? ExpenseAiExtraction -
- viewExpenseURL? string - Url to view the Expense in Avaza
- expenseReportIDFK? int - ID of the expense report/group this expense belongs to
- expenseReimbursementStatusCode? string - Reimbursement processing status
- expensePaymentMethodIDFK? Signed32 - The payment method ID used for this expense
- currencyCode? string - ISO 3-character currency code for the expense
- isOfficialExchangeRate? boolean - Whether the exchange rate is from an official/market source
- taxAmount? decimal - Calculated tax amount on the expense
- expenseApprovalStatusCode? string - Approval status. Values: Draft, Pending, Approved, AutoApproved, Rejected, Verified
- merchant? string - Name of the merchant/vendor
- attachmentPreviewURL? string - URL for a preview/thumbnail of the expense attachment
- projectCode? string - Short code of the associated project
- customerName? string - Name of the associated customer/company
- fileAttachmentIDFK? int - ID of the receipt/file attachment, if any
- transactionTaxConfigName? string - Display name for the tax configuration
- notes? string - Additional notes on the expense
- expenseReportName? string - Name of the expense report/group
- expensePaymentMethodName? string - Name of the payment method
- isReimbursable? boolean - Whether the expense is reimbursable to the employee
- attachmentURL? string - Public URL of the expense receipt attachment
- taxIDFK? Signed32 - The tax rate ID applied to this expense
- dateUpdated? string - Date and time the expense record was last updated
- taskIDFK? Signed32 - The task ID the expense is linked to
- amount? decimal - The expense amount in the expense currency
- taxName? string - Name of the applied tax rate
- lastname? string - Last name of the expense user
- expenseReimbursementIDFK? int - The reimbursement batch ID this expense belongs to, if reimbursed
- merchantTaxNumber? string - Tax registration number of the merchant
- taskTitle? string - Title of the associated task
- quantity? decimal - Quantity for unit-priced expenses (e.g. number of miles)
- isChargeable? boolean - Whether the expense is billable to the customer
- firstname? string - First name of the expense user
- customerIDFK? Signed32 - The customer/company ID the expense is associated with
- projectTitle? string - Title of the associated project
- expenseDate? string - The date the expense was incurred
- expenseCategoryHasUnitPrice? boolean - Whether the expense category has a predefined unit price (e.g. mileage rate)
- expenseCategoryName? string - Name of the expense category
- userIDFK? Signed32 - The user ID who created/owns this expense
- expenseCategoryUnitPrice? decimal - The unit price for the expense category, if applicable
- chargeableStatusCode? string - Detailed chargeable status code
- transactionTaxConfigCode? string - Tax configuration: 'EX' (exclusive) or 'INC' (inclusive)
avaza: ExpenseExchangeRate
An exchange-rate override for linking expenses whose currency differs from the invoice currency
Fields
- currencyCode string - ISO standard 3 character currency code of the expense currency
- rate decimal - The rate that converts 1 unit of the expense currency into the invoice currency. Must be greater than zero
avaza: ExpenseGroupDropdownList
Paginated list of expense group/trip names for dropdown/autocomplete use
Fields
- totalCount? Signed32 - Total number of expense groups matching the filter
- pageSize? Signed32 - The number of results per page
- pageNumber? Signed32 - The current page number (1-based)
- expenseGroups? ExpenseGroupMinimal[] - List of expense group records
avaza: ExpenseGroupMinimal
A minimal expense group record containing only the Group ID and name
Fields
- expenseGroupID? int - Unique identifier for the expense group
- name? string - Name of the expense group/trip
avaza: ExpenseHistoryItem
One expense history entry: who did what, when
Fields
- actionName? string - Display name of the action, e.g. "Created", "Receipt read by AI"
- actionType? string - Action code, e.g. ExpenseCreated, ExpenseUpdated, ExpenseSubmitted, ExpenseApproved, ExpenseRejected, ExpenseAIScanned, ExpenseAIScanFailed
- comments? string - Extra detail, e.g. the rejection reason or the AI read summary. Null for most entries
- activityID? int -
- dateCreated? string - When it happened, in UTC
- actionByInitials? string - Initials for an avatar: the user's initials when the entry is attributed to a user, otherwise derived from ActionBy
- actionByProfilePicURL? string - Public URL of the user's profile picture, or null when they have none
- actionByUserIDFK? Signed32 - The user the action is attributed to. For AI receipt reads this is the user who requested the read
- actionBy? string - Name shown for the entry as recorded at the time; "Avaza AI" for AI receipt reads
avaza: ExpenseHistoryResult
Response of GET api/Expense/History/{id}: the expense's history, newest first
Fields
- expenseID? int - The expense the history belongs to
- history? ExpenseHistoryItem[] - History entries, newest first. The same entries the expense's History panel shows in the web app
avaza: ExpenseList
Paginated collection of expense entries
Fields
- totalCount? Signed32 - Total number of expenses matching the filter criteria
- pageSize? Signed32 - The number of results per page
- expenses? ExpenseDetails[] - The list of expense entries for the current page
- pageNumber? Signed32 - The current page number (1-based)
avaza: ExpenseMerchantDropdownList
Paginated list of expense merchant names for dropdown/autocomplete use
Fields
- totalCount? Signed32 - Total number of distinct merchants matching the filter
- pageSize? Signed32 - The number of results per page
- pageNumber? Signed32 - The current page number (1-based)
- expenseMerchants? ExpenseMerchantMinimal[] - List of expense merchant records
avaza: ExpenseMerchantMinimal
A minimal expense merchant record containing only the merchant name
Fields
- merchantName? string - The merchant/vendor name
avaza: ExpensePaymentMethodDropdownList
Collection of expense payment methods configured in the account
Fields
- expensePaymentMethods? ExpensePaymentMethodMinimal[] - List of expense payment methods
avaza: ExpensePaymentMethodMinimal
A minimal expense payment method record with ID and name
Fields
- expensePaymentMethodID? int - Unique identifier for the expense payment method
- name? string - Name of the expense payment method
avaza: ExpenseSummaryGroup
A group within aggregated expense data, representing totals for one grouping dimension (e.g. a specific category or project)
Fields
- groupName? string - Display name for this group (e.g. project name, user name, month name)
- totalAmount? decimal - Total expense amount for this group
- groupID? string - Identifier for this group (e.g. project ID, user ID, month number)
- groupData? ExpenseSummaryGroup[] - Nested group data for the next grouping level, if applicable
avaza: ExpenseSummaryResult
Aggregated expense statistics for a date range, including total amounts and grouped sub-totals
Fields
- expenseDateFrom? string - Start date for the summary period
- userID? Signed32[] - Optional user ID(s) the summary is filtered by
- groupingLevels? string[] - The grouping dimensions applied to the summary data
- expenseDateTo? string - End date for the summary period
- totalAmount? decimal - Total expense amount for the period
- groupData? ExpenseSummaryGroup[] - Grouped summary data, nested by grouping levels
avaza: FileAttachmentBase64Request
JSON body for POST /api/FileAttachment/Base64. Provide the file as base64-encoded bytes plus its filename
Fields
- contentType? string - Optional MIME type. Inferred from extension if omitted
- base64Data? string - Base64-encoded file content. Required
- filename? string - Original filename including extension. Required
- linkTo? FileAttachmentLinkTarget -
avaza: FileAttachmentDetails
Details of an uploaded file attachment including ID, size, filename, and public URL
Fields
- originalFilename? string - Original filename as uploaded
- publicFileURL? string - Public URL to access the uploaded file
- sizeBytes? int - File size in bytes
- fileAttachmentID? int - Unique identifier for the file attachment
- previewBaseURL? string - URL for a preview/thumbnail of the file
avaza: FileAttachmentLinkTarget
Identifies an entity to inline-link an uploaded attachment to. Supported entityType values: "Task", "Expense", "Estimate", "Invoice"
Fields
- entityType? string - Entity kind. One of: "Task", "Expense", "Estimate", "Invoice"
- entityId? int - The target entity's primary key
avaza: FileAttachmentSourceUrlRequest
JSON body for POST /api/FileAttachment/FromUrl. Server fetches the file from the supplied https URL
Fields
- sourceUrl? string - Public https URL the server will fetch to obtain the file. Required
- contentType? string - Optional MIME type. Falls back to the response Content-Type header
- filename? string - Optional original filename. If omitted, derived from Content-Disposition or the URL path
- linkTo? FileAttachmentLinkTarget -
avaza: FileAttachmentUploadAuthorization
Response from POST /api/FileAttachment/Upload: a single-use, time-limited upload URL plus the file metadata the server will apply. Shaped after the MCP file-transfer descriptor (SEP-2631) so MCP clients can map it directly
Fields
- upload? FileAttachmentUploadTransfer -
- linkedTo? FileAttachmentLinkTarget -
- file? FileAttachmentUploadFileInfo -
- maxSizeBytes? int - Largest body the PUT will accept, in bytes
avaza: FileAttachmentUploadAuthorizeRequest
JSON body for POST /api/FileAttachment/Upload (step 1 of the signed-URL upload flow). Describes the file the caller is about to send
Fields
- contentType? string - Optional MIME type. Inferred from the extension if omitted. The stored ContentType comes from here, never from the PUT request headers
- filename? string - Original filename including extension. Required
- sizeBytes? int - Optional exact size in bytes (1 .. 52428800). When supplied, the PUT is rejected if its Content-Length is larger. Omit to allow any size up to 50 MB
- linkTo? FileAttachmentLinkTarget -
avaza: FileAttachmentUploadFileInfo
File metadata bound into a signed upload URL
Fields
- size? int - Declared size in bytes, when the caller supplied one
- mimeType? string - MIME type that will be stored
- name? string - Filename that will be stored (sanitised)
avaza: FileAttachmentUploadResult
Response from the /api/FileAttachment* endpoints. Mirrors the shape of /api/Expense/Attachment with an optional LinkedTo echo when an inline link was requested
Fields
- fileAttachments? FileAttachmentDetails[] - List of uploaded file attachment details
- linkedTo? FileAttachmentLinkTarget -
avaza: FileAttachmentUploadTransfer
Transfer descriptor for a signed upload URL
Fields
- headers? record { string... } - Headers to send with the PUT (currently Content-Type). Optional: the server applies the authorised type regardless
- method? string - Always "PUT". The file bytes are the raw request body (no multipart wrapper)
- transport? string - Always "https"
- expiresAt? string - UTC instant after which the URL is rejected with 410
- url? string - Single-use signed URL. Treat it as a bearer credential; it expires at ExpiresAt
avaza: FixedAmountDetails
A fixed-amount billing entry for fixed-price project invoicing, linked to a project, task, and inventory item
Fields
- dateUpdated? string - Date the record was last updated
- updatedByUserIDFK? Signed32 - User ID of the last person to update this record
- projectIDFK? Signed32 - The project this fixed amount is linked to
- taskIDFK? Signed32 - The task this fixed amount is linked to, if any
- amount? decimal - The fixed billing amount
- inventoryItemIDFK? int - The inventory item used for this fixed amount
- isInvoiced? boolean - Whether this fixed amount has been included on an invoice
- taskTitle? string - Title of the associated task
- dateCreated? string - Date the record was created
- invoiceIDFK? int - The invoice (Transaction) the linked line item belongs to. Only populated when includeInvoiceDetails=true
- inventoryItemName? string - Name of the inventory item
- customerIDFK? Signed32 - ID of the customer company the fixed amount's project belongs to
- projectTitle? string - Title of the associated project
- invoiceLineItemIDFK? int - The invoice line item this fixed amount is linked to, if it has been invoiced
- projectCode? string - Short code of the associated project
- fixedAmountID? Signed32 - Unique identifier for the fixed amount entry
- notes? string - Additional notes on the fixed amount
avaza: FixedAmountList
Paginated collection of fixed-amount billing entries
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- fixedAmounts? FixedAmountDetails[] - The list of fixed-amount entries for this page
avaza: GetExpenseSummaryQueries
Represents the Queries record for the operation: getExpenseSummary
Fields
- modelExpenseDateFrom? string - (Required) Filter for expenses with expense dates greater or equal to the specified date. e.g. 2019-01-25
- modelGroupBy? string[] - (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"
- modelExpenseDateTo? string - (Required) Filter for expenses with an expense date smaller or equal to the specified date. e.g. 2019-01-25
- modelProjectID? Signed32 - (Optional) Filter by Project
- modelUserID? Signed32[] - (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
avaza: GetRunningTimerQueries
Represents the Queries record for the operation: getRunningTimer
Fields
- userID? Signed32 - 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
avaza: GetTimesheetSummaryQueries
Represents the Queries record for the operation: getTimesheetSummary
Fields
- modelIsBillable? boolean - (Optional) Filter by the billable status of Timesheets
- modelIsInvoiced? boolean - (Optional) Filter for timesheets by whether they have been Invoiced or not
- modelTimesheetEntryApprovalStatusCode? string[] - (Optional) Filter for timesheets that belong to one of the specified statuses (Draft, Pending, Approved, AutoApproved, Rejected)
- modelGroupBy? string[] - (Optional) Combine one, two or three levels of Grouping. Combine these possible grouping values: "Customer", "Project", "Category", "User", "Task", "Year", "Month", "Day", "Week"
- modelEntryDateTo? string - (Required) Filter for timesheets with an entry date smaller or equal to the specified date. e.g. 2019-01-25. You can optionally include a time component, otherwise it assumes 00:00
- modelEntryDateFrom? string - (Required) Filter for timesheets greater or equal to the specified date. e.g. 2019-01-25. You can optionally include a time component, otherwise it assumes 00:00
- modelProjectID? Signed32 - (Optional) Filter by Project
- modelUserID? Signed32[] - (Optional) Defaults to the current user. Provide one or more UserIDs of Users whose timesheets should be retrieved. If the current user doesn't have impersonation rights, then they will only see their own data
avaza: GetUninvoicedSummaryQueries
Represents the Queries record for the operation: getUninvoicedSummary
Fields
- groupBy? string - Group rows by "Customer" (default) or "Project"
- companyID? Signed32 - Optional. Limit the summary to this customer company
- projectID? Signed32 - Optional. Limit the summary to this project
avaza: InventoryItem
An inventory/product item used on invoices, bills, and estimates, with cost price, sale price, and tax defaults
Fields
- purchaseTaxIDFK? Signed32 - The default tax rate ID applied when purchasing this item (used on bills)
- description? string - Detailed description of the item
- dateUpdated? string - Date the item was last updated
- inventoryItemID? int - Unique identifier for the inventory/product item
- isHiddenOnBill? boolean - Whether this item is hidden from the item pickers on bills ("Hide from Bills")
- dateCreated? string - Date the item was created
- saleTaxIDFK? Signed32 - The default tax rate ID applied when selling this item
- costPrice? decimal - The cost/purchase price of the item
- salePrice? decimal - The default sale price of the item
- sKU? string - Stock Keeping Unit code
- name? string - Name of the inventory item
- isHidden? boolean - Whether this item is hidden from the item pickers on invoices and estimates ("Hide from Invoicing")
avaza: InventoryList
Paginated collection of inventory/product items
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- inventory? InventoryItem[] - The list of inventory items for this page
avaza: Invoice
A customer invoice including line items, status, amounts, issuer/recipient details, and web links
Fields
- exchangeRate? decimal - Exchange rate to the account's base currency. 1.0 if same currency
- issuer? IssuerDetails -
- dateCreated? string - Date and time the record was created
- transactionID? int - Unique identifier for the invoice transaction
- transactionPrefix? string - Prefix used in the invoice number (e.g. 'INV')
- currencyCode? string - ISO 3-character currency code for the invoice
- companyName? string - Name of the customer company
- customerPONumber? string - Customer's purchase order number for reference
- externalContactUserIDFK? Signed32 - The external contact user ID associated with this invoice
- taxAmount? decimal - Total tax amount across all line items
- transactionStatusCode? string - Current status. Values: Draft, Sent, Late, Paid, Partial, Void
- invoiceNumber? string - The full invoice number including prefix
- dueDate? string - Payment due date
- notes? string - Additional notes or comments on the invoice
- lineItems? InvoiceLineItem[] - Line items on this invoice
- dateUpdated? string - Date and time the record was last updated
- accountIDFK? Signed32 - The Avaza account this invoice belongs to
- recipient? RecipientDetails -
- companyIDFK? Signed32 - The customer company ID this invoice is for
- totalAmount? decimal - Total amount of the invoice including tax
- subject? string - Subject line for the invoice
- dateIssued? string - Date the invoice was issued
- dateSent? string - Date the invoice was sent to the customer
- links? InvoiceLinks -
- balance? decimal - Outstanding balance remaining on the invoice
- transactionTaxConfigCode? string - Tax configuration: 'EX' (exclusive) or 'INC' (inclusive)
avaza: InvoiceLineItem
A line item on an invoice, specifying the inventory item, quantity, unit price, tax, project, and calculated amount
Fields
- description? string - Text description for the line item
- discount? decimal - Discount percentage applied to this line item
- taxIDFK? Signed32 - The tax rate ID applied to this line item
- taxName? string - Name of the applied tax rate
- projectIDFK? Signed32 - Optional project ID this line item is attributed to for reporting
- amount? decimal - Calculated line total (Quantity x UnitPrice less Discount)
- inventoryItemIDFK? int - The inventory/product item ID for this line item
- quantity? decimal - Quantity of items on this line
- transactionLineItemID? int - Unique identifier for the line item
- inventoryItemName? string - Name of the inventory/product item
- expenseIDs? int[] - IDs of the Expenses linked to (invoiced by) this line item. Empty when the line item has no linked expenses
- unitPrice? decimal - Price per unit for this line item
- taxAmount? decimal - Calculated tax amount on this line item
- timesheetEntryIDs? int[] - IDs of the Timesheet entries linked to (invoiced by) this line item. Empty when the line item has no linked timesheets
- inventoryItemSKU? string - Stock Keeping Unit code for the inventory item
- projectTitle? string - Title of the associated project
- taxCode? string - Short code for the applied tax rate
- fixedAmountIDs? int[] - IDs of the Fixed Amounts linked to (invoiced by) this line item. Empty when the line item has no linked fixed amounts
avaza: InvoiceLineItemsResult
Result of appending line items to an invoice
Fields
- invoice? Invoice -
- addedTransactionLineItemIDs? int[] - The TransactionLineItemIDs of the newly created line items, in request order
- warnings? string[] - Non-fatal notices about the operation (e.g. an invoice status change caused by the new total)
avaza: InvoiceLinks
URLs for client-facing view, internal view, and editing an invoice in the Avaza web application
Fields
- clientView? string - URL for the customer to view and pay the invoice online
- edit? string - URL for editing the invoice in the Avaza application
- view? string - URL for viewing the invoice in the Avaza application
avaza: InvoiceList
Paginated collection of customer invoices
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- invoices? Invoice[] - The list of invoices on this page
avaza: InvoiceTemplateDetails
An invoice template: the layout, labels, logo and payment options applied when an invoice, estimate or bill is rendered. TemplateTypeCode says which document type the template is for: INV and EST templates are used interchangeably on invoices and estimates, BILL templates are for bills only
Fields
- labelOverrides? InvoiceTemplateLabelOverrides -
- showCurrency? boolean - Show the currency on the document
- billingAddressLine? string - Street address line of the billing address override
- companyTaxNumberOverride? string - Overrides your company's tax number printed when ShowCompanyTaxNumber is on; null uses the account's Company Default Tax Number
- addressOverride? string - Overrides the sender address block printed on the document; null uses the account address
- billingAddressPostCode? string - Postal or ZIP code of the billing address override
- defaultInvoiceTemplate? boolean - True when this is the account's default template for new invoices
- reportPageSize? string - Paper size used when rendering: A4 or USLetter
- showInventoryItem? boolean - Show the inventory item column
- showTaxColumn? boolean - Show the per-line tax column
- name? string - Template name as shown in the Avaza web application. Names are not unique within an account
- billingAddressCity? string - City of the billing address override
- invoiceLogoURL? string - Public URL of the template logo, or null when no logo is set
- templateTypeCode? string - Document type the template is for: INV (invoices), EST (estimates) or BILL (bills). INV and EST templates are interchangeable on invoices and estimates
- showPONumber? boolean - Show the purchase order number
- defaultEstimateTemplate? boolean - True when this is the account's default template for new estimates
- paymentProviders? InvoiceTemplatePaymentProviderSummary[] - Online payment providers enabled on this template. Only providers that are also enabled on the account are listed. Empty when none are enabled
- showDescription? boolean - Show the line item description column
- showCompanyTaxNumber? boolean - Print your company's tax number as the last line of the From block (the To block on bills). The number is CompanyTaxNumberOverride, falling back to the account's Company Default Tax Number; nothing prints when both are blank
- showTaxes? boolean - Show tax amounts on the document
- invoiceTemplateID? Signed32 - Unique identifier for the template. Use this value for InvoiceTemplateIDFK on invoices and estimates, or BillTemplateIDFK on bills
- defaultRetainerTemplate? boolean - True when this is the account's default template for new retainer invoices
- showUnitPriceandQty? boolean - Show the unit price and quantity columns
- billingAddressState? string - State or province of the billing address override
- isInvoiceGrouped? boolean - True when line items are grouped by type (time, expense, general) on the rendered document
- defaultBillTemplate? boolean - True when this is the account's default template for new bills
- billingAddressOverride? boolean - True when the BillingAddress* fields below replace the account billing address on the document
- billingAddressCountryCode? string - ISO country code of the billing address override
- companyNameOverride? string - Overrides the sender company name printed on the document; null uses the account name
- featuredBackgroundColor1? string - Hex colour of the featured header band, e.g. #2f9aea
- showCustomerTaxNumber? boolean - Print the customer's TaxNumber as the last line of the To block (the supplier's, in the From block, on bills). Nothing prints when the customer has no tax number
- invoiceLogoResolution? Signed32 - Logo resolution in dpi (120 or 300), or null when not set
- invoiceTaxDisclosureCode? string - How tax totals are disclosed at the bottom of the document: SingleTaxSubTotal, AllTaxRates, AllTaxComponentRate, NoTax, TaxComponentsNon0 or TaxRateNon0
- invoiceFileAttachmentIDFK? int - File attachment ID of the logo, or null when no logo is set
- headerTitle? string - Title printed at the top of the document, e.g. "Tax Invoice"
- showDiscount? boolean - Show the discount column
- showSubject? boolean - Show the subject line
- showCustomerContact? boolean - Show the customer contact on the document
- paymentInstructions? InvoiceTemplatePaymentInstructionSummary[] - Payment instructions (bank transfer, BPAY, etc.) enabled on this template. Empty when none are enabled
- defaultInvoiceNotes? string - Default notes text pre-filled on new documents that use this template
- featuredFontColor1? string - Hex colour of the text on the featured header band, e.g. #fff
avaza: InvoiceTemplateLabelOverrides
Custom label text overrides for the template. The object is always present; each member is null when the default label is used
Fields
- overrideSubjectLabel? string - Custom text for the "Subject" label. Null when the default text is used
- overrideEstimateTitleLabel? string - Custom text for the "Estimate Title" label. Null when the default text is used
- overridePlusTaxAmountLabel? string - Custom text for the "Plus Tax Amount" label. Null when the default text is used
- overrideBillVerifiedStatusLabel? string - Custom text for the "Bill Verified Status" label. Null when the default text is used
- overrideCurrencyLabel? string - Custom text for the "Currency" label. Null when the default text is used
- overrideEstimateExpiryDateLabel? string - Custom text for the "Estimate Expiry Date" label. Null when the default text is used
- overrideNotesLabel? string - Custom text for the "Notes" label. Null when the default text is used
- overrideInvoiceLateStatusLabel? string - Custom text for the "Invoice Late Status" label. Null when the default text is used
- overrideInvoiceNumberLabel? string - Custom text for the "Invoice Number" label. Null when the default text is used
- overridePaymentInstructionLabel? string - Custom text for the "Payment Instruction" label. Null when the default text is used
- overrideCompanyTaxNumberLabel? string - Custom label for your company's tax number line (e.g. "ABN", "VAT No."). Null falls back to the account's Company Default Tax Number Label, then "Tax Number"
- overrideCustomerTaxNumberLabel? string - Default label for the customer's tax number line (e.g. "VAT No."). A customer's own TaxNumberLabel takes precedence; null falls back to "Tax Number"
- overrideQuantityLabel? string - Custom text for the "Quantity" label. Null when the default text is used
- overrideAmountLabel? string - Custom text for the "Amount" label. Null when the default text is used
- overrideInvoicePartialPaidStatusLabel? string - Custom text for the "Invoice Partial Paid Status" label. Null when the default text is used
- overrideEstimateRejectedStatusLabel? string - Custom text for the "Estimate Rejected Status" label. Null when the default text is used
- overrideInvoicePaidStatusLabel? string - Custom text for the "Invoice Paid Status" label. Null when the default text is used
- overrideTypeLabel? string - Custom text for the "Type" label. Null when the default text is used
- overrideDateIssuedLabel? string - Custom text for the "Date Issued" label. Null when the default text is used
- overrideViewRespondOnlineButton? string - Custom text for the "View Respond Online" button text. Null when the default text is used
- overrideInvoiceVoidStatusLabel? string - Custom text for the "Invoice Void Status" label. Null when the default text is used
- overrideGroupingTimeLabel? string - Custom text for the "Grouping Time" label. Null when the default text is used
- overrideEstimateNumberLabel? string - Custom text for the "Estimate Number" label. Null when the default text is used
- overridePayOnlineButton? string - Custom text for the "Pay Online" button text. Null when the default text is used
- overrideEstimateDraftStatusLabel? string - Custom text for the "Estimate Draft Status" label. Null when the default text is used
- overridePaymentAmountLabel? string - Custom text for the "Payment Amount" label. Null when the default text is used
- overrideCloseButtonLabel? string - Custom text for the "Close Button" label. Null when the default text is used
- overrideEstimateConvertedStatusLabel? string - Custom text for the "Estimate Converted Status" label. Null when the default text is used
- overrideAppliedPaymentLabel? string - Custom text for the "Applied Payment" label. Null when the default text is used
- overrideEmailInvoiceLink? string - Custom text for the "Email Invoice" link text. Null when the default text is used
- overrideToLabel? string - Custom text for the "To" label. Null when the default text is used
- overrideCreditNoteTitleLabel? string - Custom text for the "Credit Note Title" label. Null when the default text is used
- overrideInvoiceDraftStatusLabel? string - Custom text for the "Invoice Draft Status" label. Null when the default text is used
- overrideCreditNoteClosedStatusLabel? string - Custom text for the "Credit Note Closed Status" label. Null when the default text is used
- overrideCreditNoteOpenStatusLabel? string - Custom text for the "Credit Note Open Status" label. Null when the default text is used
- overrideEstimateExpiredStatusLabel? string - Custom text for the "Estimate Expired Status" label. Null when the default text is used
- overrideAmountDueLabel? string - Custom text for the "Amount Due" label. Null when the default text is used
- overrideEstimateSentStatusLabel? string - Custom text for the "Estimate Sent Status" label. Null when the default text is used
- overrideIncludesTaxAmountLabel? string - Custom text for the "Includes Tax Amount" label. Null when the default text is used
- overrideAppliedCreditNoteLabel? string - Custom text for the "Applied Credit Note" label. Null when the default text is used
- overrideTotalAmountLabel? string - Custom text for the "Total Amount" label. Null when the default text is used
- overrideEstimateApproveButton? string - Custom text for the "Estimate Approve" button text. Null when the default text is used
- overrideEstimateRejectButton? string - Custom text for the "Estimate Reject" button text. Null when the default text is used
- overrideEstimateAcceptedStatusLabel? string - Custom text for the "Estimate Accepted Status" label. Null when the default text is used
- overrideTotalDiscountLabel? string - Custom text for the "Total Discount" label. Null when the default text is used
- overrideInvoicePONumberLabel? string - Custom text for the "Invoice PO Number" label. Null when the default text is used
- overrideDiscountLabel? string - Custom text for the "Discount" label. Null when the default text is used
- overridePayNowTitle? string - Custom text for the "Pay Now" title. Null when the default text is used
- overrideTaxColumnLabel? string - Custom text for the "Tax Column" label. Null when the default text is used
- overrideFromLabel? string - Custom text for the "From" label. Null when the default text is used
- overrideSubTotalLabel? string - Custom text for the "Sub Total" label. Null when the default text is used
- overrideDescriptionLabel? string - Custom text for the "Description" label. Null when the default text is used
- overrideDueDateLabel? string - Custom text for the "Due Date" label. Null when the default text is used
- overridePayNowButton? string - Custom text for the "Pay Now" button text. Null when the default text is used
- overrideGroupingGeneralLabel? string - Custom text for the "Grouping General" label. Null when the default text is used
- overrideInvoiceSentStatusLabel? string - Custom text for the "Invoice Sent Status" label. Null when the default text is used
- overrideGroupingDurationColumnLabel? string - Custom text for the "Grouping Duration Column" label. Null when the default text is used
- overrideGroupingExpenseLabel? string - Custom text for the "Grouping Expense" label. Null when the default text is used
- overrideUnitPriceLabel? string - Custom text for the "Unit Price" label. Null when the default text is used
- overrideAppliedInvoiceLabel? string - Custom text for the "Applied Invoice" label. Null when the default text is used
- overrideCreditNoteNumberLabel? string - Custom text for the "Credit Note Number" label. Null when the default text is used
avaza: InvoiceTemplateList
A paginated list of invoice templates
Fields
- totalCount? Signed32 - Total number of templates matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- invoiceTemplates? InvoiceTemplateDetails[] - The invoice templates for this page, ordered by Name
avaza: InvoiceTemplatePaymentInstructionSummary
A payment instruction method enabled on a template
Fields
- isHiddenOnInvoice? boolean - True when the method is enabled on the template but is not rendered on the document
- paymentInstructionCode? string - Payment instruction method code, e.g. bank_transfer_generic, bpay, payid
- accountPaymentInstructionID? Signed32 - ID of the account's payment instruction record
- name? string - Display name of the method, e.g. "Bank Transfer (SEPA)"
avaza: InvoiceTemplatePaymentProviderSummary
An online payment provider enabled on a template
Fields
- accountPaymentProviderID? Signed32 - ID of the account's payment provider record
- paymentProviderCode? string - Provider code, e.g. PaypalExpress, Stripe, PayoneerV4
- paymentProviderName? string - Display name of the provider, e.g. "Paypal Express"
- name? string - The account's own label for this provider connection
avaza: IssuerDetails
Billing address and tax details for the Avaza account (the party issuing an invoice or estimate)
Fields
- billingAddress? string - Formatted multi-line billing address
- taxNumberLabel? string - Label printed next to the issuer's tax number: the template's override, else the account's Company Default Tax Number Label, else "Tax Number"
- billingAddressLine? string - Street address line of the billing address
- billingAddressState? string - State/province of the billing address
- billingCountryCode? string - ISO 3166-1 alpha-2 country code of the billing address
- billingAddressPostCode? string - Postal/ZIP code of the billing address
- taxNumber? string - Tax registration number (e.g. VAT number, ABN, EIN) as printed on the document: the template's Company Tax Number override, else the account's Company Default Tax Number. Null when neither is set
- billingAddressCity? string - City/suburb of the billing address
avaza: ListBillPaymentsQueries
Represents the Queries record for the operation: listBillPayments
Fields
- pageNumber? Signed32 - 1-based page number to retrieve. Default 1
- pageSize? Signed32 - Number of results per page. Maximum 1000, default 20
- updatedAfter? string - Only return records updated after this UTC date-time (ISO 8601 format). Useful for incremental sync
avaza: ListBillsQueries
Represents the Queries record for the operation: listBills
Fields
- pageNumber? Signed32 - 1-based page number to retrieve. Default 1
- dueDateFrom? string - Filter by due date start range
- transactionStatusCode? string - Filter by bill status code
- issueDateFrom? string - Filter by issue date start range
- pageSize? Signed32 - Number of results per page. Maximum 1000, default 20
- sort? string - Sort results by: DateUpdated, DateCreated (append ' desc' for descending)
- issueDateTo? string - Filter by issue date end range
- companyIDFK? Signed32 - Filter bills to a specific supplier company by Company ID
- dueDateTo? string - Filter by due date end range
- updatedAfter? string - Only return bills updated after this date-time (ISO 8601). Useful for incremental sync
avaza: ListCompaniesQueries
Represents the Queries record for the operation: listCompanies
Fields
- includeCustomFields? boolean - Set false to omit the CustomFields collection from each company. Defaults to true
- pageNumber? Signed32 - 1-based page number to retrieve. Default 1
- pageSize? Signed32 - Number of results per page. Maximum 1000, default 20
- sort? string - Sort results by: DateUpdated, DateCreated (append ' desc' for descending)
- updatedAfter? string - Only return companies updated after this date-time (ISO 8601). Useful for incremental sync
avaza: ListContactsQueries
Represents the Queries record for the operation: listContacts
Fields
- includeCustomFields? boolean - Set false to omit the CustomFields collection from each contact. Defaults to true
- pageNumber? Signed32 - 1-based page number to retrieve. Default 1
- pageSize? Signed32 - Number of results per page. Maximum 1000, default 20
- sort? string - Sort results by: DateUpdated, DateCreated (append ' desc' for descending)
- companyIDFK? Signed32 - Filter contacts to a specific company by Company ID
- updatedAfter? string - Only return contacts updated after this date-time
avaza: ListCreditNotesQueries
Represents the Queries record for the operation: listCreditNotes
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
- updatedAfter? string - Only return records updated after this UTC date-time (ISO 8601 format). Useful for incremental sync
avaza: ListCustomFieldDefinitionsQueries
Represents the Queries record for the operation: listCustomFieldDefinitions
Fields
- entityTypeCode? string - The entity type the fields are mapped to. Values: Project, Task, TeamMember, Contact, Company, Timesheet, Expense, Invoice, InvoiceLineItem, Estimate, EstimateLineItem, Schedule, Bill, BillLineItem. Required
avaza: ListDeletedTimesheetsQueries
Represents the Queries record for the operation: listDeletedTimesheets
Fields
- pageSize? Signed32 - Number of items per page
- pageNumber? Signed32 - Page number (starts from 1)
- userID? Signed32 - Filter by user ID
- entryDateFrom? string - Filter by original timesheet entry date (start)
- entryDateTo? string - Filter by original timesheet entry date (end)
- sort? string - Sort expression (e.g. 'DeletedDate desc', 'EntryDate')
- deletedAfter? string - Filter entries deleted after this UTC date
avaza: ListEstimatesQueries
Represents the Queries record for the operation: listEstimates
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- issueDateFrom? string - Filter by issue date start range
- pageSize? Signed32 - Number of items per page (max 1000)
- sort? string - Sort results by: DateUpdated, DateCreated (append ' desc' for descending)
- issueDateTo? string - Filter by issue date end range
- companyIDFK? Signed32 - Filter estimates to a specific customer company by Company ID
- expiryDateTo? string - Filter by expiry date end range
- updatedAfter? string - Only return estimates updated after this date-time
- estimateStatusCode? string - Filter by estimate status code
- expiryDateFrom? string - Filter by expiry date start range
avaza: ListExpenseCategoriesQueries
Represents the Queries record for the operation: listExpenseCategories
Fields
- isEnabled? boolean - Optional filter on for enabled/disabled categories. Defaults to true
avaza: ListExpensesQueries
Represents the Queries record for the operation: listExpenses
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- expenseDateFrom? string - Filter expenses with an ExpenseDate on or after this date. Format: MM/dd/yyyy hh:mm:ss tt
- projectID? Signed32 - Filter expenses by Project ID
- isInvoiced? boolean - Filter by invoiced status: true for invoiced expenses, false for uninvoiced
- expenseReimbursementIDFK? int - Filter expenses by a specific reimbursement batch ID
- pageSize? Signed32 - Number of items per page (max 1000)
- customerID? Signed32 - Filter expenses by Customer/Company ID
- userEmail? string - Filter expenses by the email address of the expense user
- expensePaymentMethodIDFK? Signed32 - Filter expenses by payment method ID
- updatedAfter? string - Only return expenses updated after this date-time. Format: MM/dd/yyyy hh:mm:ss tt
- isChargeable? boolean - Filter by chargeable (billable) status: true for chargeable, false for non-chargeable
- expenseApprovalStatusCode? string - Filter by approval status. Values: Draft, Rejected, Approved, AutoApproved, Pending, Verified
- userID? Signed32 - Filter expenses by the UserID of the expense user
- search? string - Search expenses by matching against Merchant name and Expense Category Name
- expenseDateTo? string - Filter expenses with an ExpenseDate on or before this date. Format: MM/dd/yyyy hh:mm:ss tt
- categoryName? string - Filter expenses by expense category name (exact match)
- sort? string - Sort by: DateUpdated, DateCreated, ExpenseDate (append ' desc' for descending)
avaza: ListFixedAmountsQueries
Represents the Queries record for the operation: listFixedAmounts
Fields
- taskID? Signed32 - (Optional) The TaskID of a Task to filter Fixed Amounts for
- pageNumber? Signed32 - Page to display. Starts from 1
- includeInvoiceDetails? boolean - When true, each linked fixed amount also returns the InvoiceIDFK of the invoice its line item belongs to
- projectID? Signed32 - (Optional) The ProjectID of a Project to filter Fixed Amounts for
- isInvoiced? boolean - Filter by invoiced status: true for invoiced, false for uninvoiced
- pageSize? Signed32 - Number of items per page (max 1000)
- sort? string - Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
- customerID? Signed32 - (Optional) Only return fixed amounts whose project belongs to this customer company
- updatedAfter? string - Only return fixed amounts updated after this date-time
avaza: ListInventoryItemsQueries
Represents the Queries record for the operation: listInventoryItems
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
- updatedAfter? string - Only return inventory items updated after this date-time
avaza: ListInvoicesQueries
Represents the Queries record for the operation: listInvoices
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- dueDateFrom? string - Filter invoices due on or after this date (ISO 8601)
- transactionStatusCode? string - Filter by invoice status. Values: Draft, Sent, Late, Paid, Partial, Void
- issueDateFrom? string - Filter invoices issued on or after this date (ISO 8601)
- pageSize? Signed32 - Number of items per page (max 1000)
- sort? string - Sort results by: DateUpdated, DateCreated (append ' desc' for descending)
- includeSourceLinks? boolean - When true, each line item also lists the IDs of the timesheets, expenses and fixed amounts linked to it (TimesheetEntryIDs / ExpenseIDs / FixedAmountIDs). Defaults to false to keep large list responses small
- issueDateTo? string - Filter invoices issued before this date (ISO 8601)
- companyIDFK? Signed32 - Filter invoices to a specific customer company by Company ID
- dueDateTo? string - Filter invoices due before this date (ISO 8601)
- updatedAfter? string - Only return invoices updated after this date-time
avaza: ListInvoiceTemplatesQueries
Represents the Queries record for the operation: listInvoiceTemplates
Fields
- templateTypeCode? string - Only return templates of this type: INV, EST or BILL. Omit for all types
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000, default 100)
- name? string - Only return templates whose name matches exactly (case-insensitive, surrounding whitespace ignored). Names are not unique within an account, so more than one template can match; use TemplateTypeCode to tell them apart. Partial matching is not supported
avaza: ListPaymentsQueries
Represents the Queries record for the operation: listPayments
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
- invoiceTransactionID? int - Filter for Payments that have at least one allocation against a given Invoice Transaction ID
- updatedAfter? string - Only return records updated after this UTC date-time (ISO 8601 format). Useful for incremental sync
avaza: ListProjectMembersQueries
Represents the Queries record for the operation: listProjectMembers
Fields
- userID? Signed32 - Get Project members filtered by UserID
- projectID? Signed32 - Get Project members filtered by ProjectID
avaza: ListProjectsQueries
Represents the Queries record for the operation: listProjects
Fields
- dateCreatedTo? string - Filter projects created on or before this date (ISO 8601)
- includeArchived? boolean - Include Archived Projects in the results
- includeCustomFields? boolean - Set false to omit the CustomFields collection from each project. Defaults to true
- projectStatusCode? string - Filter by project status code. Per-account configurable; default codes are NotStarted, InProgress, Complete, OnHold (seeded for every account); admins may add custom codes
- pageNumber? Signed32 - Page to display. Starts from 1
- companyID? Signed32 - Filter projects belonging to a specific customer company by Company ID
- projectBillableTypeCode? string - Filter by billing type. Values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly
- tagMatchMode? string - How multiple Tags combine. "any" (default) returns projects with at least one of the supplied tags; "all" returns only projects that have every supplied tag
- pageSize? Signed32 - Number of items per page (max 1000)
- projectOwnerUserID? Signed32 - Filter projects owned by a specific user by User ID
- updatedAfter? string - Only return projects updated after this UTC date-time (ISO 8601)
- projectBudgetTypeCode? string - Filter by budget type. Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours
- dateCreatedFrom? string - Filter projects created on or after this date (ISO 8601)
- projectCategoryID? Signed32 - Filter projects by project category ID
- sort? string - A column to sort on. Current possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
- timesheetUserID? Signed32 - Filter to the projects that the supplied UserID can add timesheets to
- includeBudget? boolean - Set true to include the computed budget fields on each project (EffectiveBudgetHours, SpentHours, SpentAmount - the same Budget and Spent the All Projects page shows). The page size is capped at 100 when set, because the values are computed per request. Defaults to false. The stored settings BudgetAmount / BudgetHours are always returned
- tags? string[] - Filter to projects assigned the supplied tag name(s). Repeat the parameter for multiple tags (e.g. ?Tags=Urgent&Tags=Retainer). Names are matched case-insensitively; a name not in the account simply matches nothing. By default a project matches if it has ANY of the supplied tags (see TagMatchMode)
avaza: ListRecurringInvoicesQueries
Represents the Queries record for the operation: listRecurringInvoices
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
- sort? string - Sort results by: DateUpdated, DateCreated (append ' desc' for descending)
- companyIDFK? Signed32 - Filter recurring invoices to a specific customer company by Company ID
- updatedAfter? string - Only return recurring invoice profiles updated after this date-time
avaza: ListScheduleAssignmentsQueries
Represents the Queries record for the operation: listScheduleAssignments
Fields
- pageNumber? Signed32 - Page to display. Starts from 1
- scheduleSeriesID? int - Filter to records for a particular Schedule Series
- userID? Signed32 - The UserID of a schedule user to filter assignments for. Only api users with Admin role can see all schedules across all users. Users with ScheduleUser role can access their own ScheduleSeries
- pageSize? Signed32 - Number of items per page (max 1000)
- sort? string - Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
- scheduleDateFrom? string - Filter for schedule assignement that are on or after a specific date
- scheduleDateTo? string - Filter for schedules that are on or before a specific date
- userEmail? string - The email of the user who has been scheduled
- updatedAfter? string - Limit results to records updated after the specified date
avaza: ListScheduleSeriesQueries
Represents the Queries record for the operation: listScheduleSeries
Fields
- scheduleEndDateTo? string - Filter for schedules that end on or before a specific date
- pageNumber? Signed32 - Page to display. Starts from 1
- companyID? Signed32 - Filter to only include records linked to projects, where that project belongs to a specific customer company
- scheduleStartDateTo? string - Filter for schedules that start on or before a specific date
- projectID? Signed32 - Filter to only include books linked to a specific project
- pageSize? Signed32 - Number of items per page (max 1000)
- userEmail? string - The email of the user who has been scheduled
- leaveTypeID? Signed32 - Filter to records of a particular leave type
- updatedAfter? string - Limit results to records updated after the specified date
- scheduleStartDateFrom? string - Filter for schedules that start on or after a specific date
- userID? Signed32 - The UserID of a schedule user to filter assignments for. Only api users with Admin role can see all schedules across all users. Users with ScheduleUser role can access their own ScheduleSeries
- timeSheetCategoryID? Signed32 - Filter for schedule records linked to a specific timesheeet category
- sort? string - Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
- timeSheetCategoryName? string - Filter for schedule records with a specific timesheeet category name (exact string match)
- scheduleEndDateFrom? string - Filter for schedules that end on or after a specific date
avaza: ListSectionsQueries
Represents the Queries record for the operation: listSections
Fields
- projectID Signed32 - Get sections for Project with ProjectID
avaza: ListTaskDiscussionsQueries
Represents the Queries record for the operation: listTaskDiscussions
Fields
- taskID int - The TaskID of the Task to retrieve messages for
- startItem? int - the ReponseID of the comment from which the page of results should start
- pageSize? Signed32 - The max number of responses to return in this page
avaza: ListTasksQueries
Represents the Queries record for the operation: listTasks
Fields
- includeCustomFields? boolean - Set false to omit the CustomFields collection from each task. Defaults to true
- pageNumber? Signed32 - Page to display. Starts from 1. Defaults to 1
- isRootLevel? boolean - Optional filter on task hierarchy. true = only root-level tasks (ParentTaskIDFK IS NULL); false = only subtasks (ParentTaskIDFK IS NOT NULL); omitted = no filter
- taskStatusCode? string - Optional filter to only display tasks with a specific status
- projectID? Signed32 - Optional filter to only display tasks belonging to a specific ProjectID
- pageSize? Signed32 - Number of items per page. Defaults to 20
- taskPriorityCode? string - Optional filter to only display tasks with a specific priority
- updatedAfter? string - Optional filter to records updated after a specific date
- parentTaskIDFK? Signed32 - Optional filter to only display subtasks of the given parent task ID (i.e. tasks where ParentTaskIDFK = value)
- dueDateFrom? string - Optional filter to only display tasks with a Due Date after DueDateFrom
- assignedToUserIDs? Signed32[] - Optional filter to only display tasks with at least one of the provided UserIDs set as the Assigned User
- sort? string - Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc", "SectionTitle", "Title"
- dueDateTo? string - Optional filter to only display tasks with a Due Date before DueDateTo
- isComplete? boolean - Optional filter to only display tasks linked to a Task Status where isComplete=false, or where isComplete=true
avaza: ListTimesheetCategoriesQueries
Represents the Queries record for the operation: listTimesheetCategories
Fields
- projectID? Signed32 - Get categories filtered by ProjectID
avaza: ListTimesheetsQueries
Represents the Queries record for the operation: listTimesheets
Fields
- taskID? Signed32 - Filter timesheets by Task ID
- pageNumber? Signed32 - Page to display. Starts from 1
- includeInvoiceDetails? boolean - When true, includes invoice Transaction ID and line item ID for invoiced entries
- entryDateFrom? string - Filter timesheets with an entry date on or after this date (ISO 8601)
- projectID? Signed32 - Filter timesheets by Project ID
- isInvoiced? boolean - Filter by invoiced status: true or false
- pageSize? Signed32 - Number of items per page (max 1000)
- customerID? Signed32 - Only return timesheets whose project belongs to this customer company
- userEmail? string - Filter timesheets by the email address of the timesheet user
- updatedAfter? string - Only return timesheets updated after this date-time
- isBillable? boolean - Filter by billable status: true or false
- userID? Signed32 - The UserID of a timesheet user to filter timesheets for. Only api users with certain higher roles can see timesheets across multiple users
- entryDateTo? string - Filter timesheets with an entry date on or before this date (ISO 8601)
- categoryName? string - Filter timesheets by category name
- timesheetEntryApprovalStatusCode? string - Filter by approval status. Values: Draft, Pending, AutoApproved, Approved, Rejected
- isTimerRunning? boolean - Filter to only entries that currently have a running timer (true) or not (false)
- sort? string - Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc","EntryDate", "EntryDate desc", "StartTimeLocal","StartTimeLocal desc", "TimeSheetEntryID", "TimeSheetEntryID desc"
avaza: ListUserProfilesQueries
Represents the Queries record for the operation: listUserProfiles
Fields
- includeCustomFields? boolean - Set false to omit the CustomFields collection from each user. Defaults to true
- email? string - Optionally filter by user email address
- roles? string - Optional list of comma separated role codes to filter users by (e.g. "TimesheetUser,Admin")
- companyIDFK? Signed32 - Optionally filter by Company ID
- tags? string - Comma-separated list of user tag names to filter users by
- currentUserOnly? boolean - Optional boolean (true/false) to filter to only show current authenticated user (always true for non Admin/Finance Manager users)
avaza: LookupCompaniesQueries
Represents the Queries record for the operation: lookupCompanies
Fields
- search? string - Search string to match against Company name
- pageNumber? Signed32 - 1-based page number to retrieve. Default 1
- pageSize? Signed32 - Number of results per page. Maximum 1000, default 20
avaza: LookupExpenseGroupsQueries
Represents the Queries record for the operation: lookupExpenseGroups
Fields
- search? string - Search string to match against Expense Group Name
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
avaza: LookupExpenseMerchantsQueries
Represents the Queries record for the operation: lookupExpenseMerchants
Fields
- search? string - Search string to match against Expense Merchant Name
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
avaza: LookupProjectsQueries
Represents the Queries record for the operation: lookupProjects
Fields
- search? string - Search term to filter projects by title
- pageNumber? Signed32 - Page to display. Starts from 1
- pageSize? Signed32 - Number of items per page (max 1000)
- timesheetUserID? Signed32 - Filter to the projects that the supplied UserID can add timesheets to
- projectCode? string - Filter by project code
- companyIDFK? Signed32 - Filter projects by customer company ID
avaza: LookupTasksQueries
Represents the Queries record for the operation: lookupTasks
Fields
- search? string - (optional) Search string to match against Task title. Performs begins-with match
- pageNumber? Signed32 - Page to display. Starts from 1
- hideCompleted? boolean - (optional) true/false to hide completed tasks. Defaults false
- pageSize? Signed32 - Number of items per page (max 1000)
- projectID Signed32 - The Project ID to retrieve tasks for. Required
- hideSubtasks? boolean -
avaza: MarkInvoiceAsSentRequest
Request to flag an existing draft invoice as Sent, without emailing it to the customer
Fields
- dateSent? string - Optional Date Sent to record against the invoice (ISO 8601, e.g. 2026-08-17). Defaults to today in your user profile's timezone. Cannot be more than one day in the future
- sendWebhooks? boolean - If true, fires the invoice_sent webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- invoiceID int - The ID of the invoice to mark as Sent. Must be a Draft invoice belonging to your account
avaza: MarkInvoiceAsSentResponse
The outcome of marking an invoice as Sent
Fields
- dateSent? string - The Date Sent recorded against the invoice
- transactionStatusCode? string - The resulting invoice status. Normally "Sent", but zero-amount invoices are set to "Paid"
- message? string - Human readable confirmation of what happened
- invoiceNumber? string - The full invoice number including prefix
- invoiceID? int - The invoice that was updated
avaza: NewBill
Request model for creating a new supplier bill. Supports automatic company/contact creation
Fields
- exchangeRate? decimal - Exchange rate is only valid for invoices in currency other than default account currency. If not specified it will get the market rate based on the Date Issued
- lineItems? NewBillLineItem[] - Line items to include on the bill. At least one line item is required
- email? string - Specified value will be used to create a new customer contact only if a new customer is being created
- sendWebhooks? boolean - If true, fires the bill_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- lastname? string - Specified value will be used to create a new customer contact only if a new customer is being created
- billTemplateIDFK? Signed32 - The bill template to render the bill with (a BILL type template). Use GET /api/InvoiceTemplate?TemplateTypeCode=BILL to look up template IDs by name. If left blank the account default bill template will be used
- companyIDFK? Signed32 - If left blank then you must specify Company Name
- paymentTerms? Signed32 - "If left blank we will set it to customer default. If specified then it must match one of your existing pre configured payment term periods. Your account starts with: (-1 --- Custom, 0 --- Upon Receipt, 7 --- 7 Days, 15 --- 15 Days, 30 --- 30 Days, 45 --- 45 Days, 60 --- 60 Days)
- billNumber? string - Pass any string. If left blank it will use the next number in the auto incrementing sequence. If an integer is passed then the largest integer will be use as the seed to auto generate the next invoice number in the sequence
- subject? string - Plain UTF8 text. (no HTML). 255 characters max
- transactionPrefix? string - A prefix for the Invoice number. e.g. 'INV'. If left blank it will be set to the account default. Max length 20 characters
- firstname? string - Specified value will be used to create a new customer contact only if a new customer is being created
- currencyCode? string - Expects ISO Standard 3 character currency code. If left blank the currency will default to account's currency in general setting. For existing companies this field will be ignored and the invoice will use the currency of the customer. For new customers if the currency is not specified then account currency will be used otherwise the specified currency will be used
- companyName? string - If left blank then you must specify Company ID. Specified Name will be used to match existing customer record. If not matched then it will be used to create a new customer. First Name, Last Name and Email will only be used if it is a new company. If the Company name appears multiple times we will check the email address to find a matching company. If email address doesn't identify a matching company then the invoice creation will be rejected
- supplierPONumber? string - Plain UTF8 text. 100 characters max
- dateIssued? string - If not specified it will use today's date. The date should be specified as local date
- dueDate? string - It will be auto calculated based on the payment term and issue date. Due Date must be greater than or equal to Issue Date. If the Due Date is specified then Payment Terms will be set to -1 (Custom)
- notes? string - Plain UTF8 text. (no HTML). Max 2000 characters
- transactionTaxConfigCode? string - Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left empty it will use the account default
avaza: NewBillLineItem
A line item to be added to a new supplier bill
Fields
- inventoryItemName? string - If not specified then Inventory item ID must be specified. If specified and not matched to any existing inventory items then a new inventory item will be created. Max 200 characters
- unitPrice decimal - The unit price for the lineitem
- description? string - Plain UTF8 text. (no HTML)
- discount? decimal - Enter 10.5 to give a 10.5% discount
- taxIDFK? Signed32 - If specified then it must match an existing Tax ID. If not specified then Tax Name and Tax Percent must be specified
- taxName? string - Must be specified if the Tax ID is blank. If the Tax Name is specified it will be matched to an existing Tax Name or else a new Tax will be created
- projectIDFK? Signed32 - Optional. Project ID of an Avaza Project that belongs to this customer, so line item is attributed to that Project for reporting
- inventoryItemIDFK? Signed32 - If not specified then Inventory Item Name must be specified
- quantity decimal - The quantity for the line item
- taxPercent? decimal - The Tax Percent will only be used if a new tax is being created
avaza: NewBillPayment
Request model for creating a new supplier bill payment
Fields
- transactionPrefix? string - Optional to override the default prefix added to Payment Numbers
- currencyCode? string - Optional for specifying the Bill Payment's Currency (3 letter ISO Currency Code)
- exchangeRate? decimal - Optional. Only used when the Company's currency is different from the Avaza account's base currency. Specifies the exchange rate that should apply between the Company currency and base currency. If not provided we will obtain an up to date exchange rate for the Payment Issue Date
- paymentAllocations? NewBillPaymentAllocation[] - List of amounts within this payment that are allocated to invoices. The sum of these be less than or equal to the payment amount
- dateIssued? string - Date of Payment. If not specified, assumes today
- transactionReference? string - Optional for storing the reference # of the payment method
- paymentProviderCode? string - Optional for storing the payment provider who was the source of funds
- sendWebhooks? boolean - If true, fires the bill_updated webhook event to any subscribed endpoints for each bill that was allocated against. Defaults to false to preserve existing integration behaviour
- amount? decimal - The total amount of the payment
- companyIDFK? Signed32 - Only required if no invoice allocations specified
- paymentNumber? string - Optional. If not specified will be automatically generated
- notes? string - Additional notes on the payment
avaza: NewBillPaymentAllocation
An allocation entry for applying a bill payment to a specific bill
Fields
- allocationAmount? decimal - The Amount being allocated to the bill. Expects same currency as bill currency
- allocationDate? string - Optional. Defaults to the current time in the Avaza account's timezone. The date the allocation is applied to the bill. Can be different from the Payment Date when doing prepayments etc
- billTransactionIDFK? int - The Avaza Bill TransactionID that is having a payment amount allocated to it
avaza: NewCompany
Request model for creating a new customer company
Fields
- taxNumberLabel? string - Label printed next to the tax number on invoices, e.g. "VAT No.", "USt-IdNr.", "ABN" (max 100 chars). Null uses the invoice template's default label or "Tax Number"
- billingAddressLine? string - The street address line for the company's billing address
- website? string - The company's website URL
- billingAddressState? string - The state or province for the company's billing address
- sendWebhooks? boolean - If true, fires the company_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- comments? string - Internal notes or comments about the company
- billingCountryCode? string - The ISO 2-letter country code for the company's billing address
- billingAddressPostCode? string - The postcode or ZIP code for the company's billing address
- billingAddressCity? string - The city for the company's billing address
- currencyCode? string - The default currency code for this company. Defaults to the account's default currency if not provided
- billingAddress? string - The full formatted billing address string. If set, overrides the individual address fields
- companyName string - The name of the company. Required
- customFields? CustomFieldValueInput[] - Custom field values to set on the new company. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Fields not supplied receive their configured default values; required fields without a default must be supplied. Custom field definitions/options cannot be created or modified via the API
- phone? string - The company's primary phone number
- taxNumber? string - The company's tax registration number
- fax? string - The company's fax number
avaza: NewCompanyContact
Request model for creating a new external contact. Optionally creates a new company if one doesn't exist
Fields
- companyBillingAddressCity? string - The city for the billing address of a newly created company
- positionTitle? string - The contact's job title or position
- sendWebhooks? boolean - If true, fires the contact_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- companyBillingAddressCountryCode? string - The ISO 2-letter country code for the billing address of a newly created company
- lastname string - The contact's last name. Required
- updateExisting? boolean - If true, updates an existing contact with the same email address instead of creating a duplicate. Defaults to true
- companyIDFK? Signed32 - The ID of an existing company to associate the contact with. If omitted, CompanyName is used to find or create a company
- companyBillingAddress? string - The full formatted billing address string for a newly created company
- companyBillingAddressLine? string - The street address line for the billing address of a newly created company
- mobile? string - The contact's mobile phone number
- currencyCode? string - The currency code for a newly created company. Defaults to the account's default currency if not provided
- firstname string - The contact's first name. Required
- companyName? string - The name of the company to associate the contact with. Used to find an existing company or create a new one if not found
- customFields? CustomFieldValueInput[] - Custom field values to set on the contact. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). When a new contact is created, fields not supplied receive their configured default values and required fields without a default must be supplied; when an existing contact is updated (UpdateExisting), only the supplied fields change. Custom field definitions/options cannot be created or modified via the API
- companyBillingAddressState? string - The state or province for the billing address of a newly created company
- phone? string - The contact's phone number
- companyBillingAddressPostCode? string - The postcode or ZIP code for the billing address of a newly created company
- contactEmail string - The contact's email address. Required
avaza: NewEstimate
Request model for creating a new estimate/quote. Supports automatic company/contact creation
Fields
- estimatePrefix? string - A prefix for the Estimate number. e.g. 'INV'. If left blank it will be set to the account default. Max length 20 characters
- exchangeRate? decimal - Exchange rate is only valid for Estimates in currency other than default account currency. If not specified it will get the market rate based on the Date Issued
- lineItems? NewEstimateLineItem[] -
- email? string - Specified value will be used to create a new customer contact only if a new customer is being created
- sendWebhooks? boolean - If true, fires the estimate_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- lastname? string - Specified value will be used to create a new customer contact only if a new customer is being created
- estimateTaxConfigCode? string - Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left empty it will use the account default
- companyIDFK? Signed32 - If left blank then you must specify Company Name
- subject? string - Plain UTF8 text. (no HTML). 255 characters max
- estimateNumber? string - Pass any string. If left blank it will use the next number in the auto incrementing sequence. If an integer is passed then the largest integer will be use as the seed to auto generate the next Estimate number in the sequence
- firstname? string - Specified value will be used to create a new customer contact only if a new customer is being created
- currencyCode? string - Expects ISO Standard 3 character currency code. If left blank the currency will default to account's currency in general setting. For existing companies this field will be ignored and the Estimate will use the currency of the customer. For new customers if the currency is not specified then account currency will be used otherwise the specified currency will be used
- companyName? string - If left blank then you must specify Company ID. Specified Name will be used to match existing customer record. If not matched then it will be used to create a new customer. First Name, Last Name and Email will only be used if it is a new company. If the Company name appears multiple times we will check the email address to find a matching company. If email address doesn't identify a matching company then the Estimate creation will be rejected
- customerPONumber? string - Plain UTF8 text. 100 characters max
- dateIssued? string - If not specified it will use today's date. The date should be specified as local date
- invoiceTemplateIDFK? Signed32 - The template to render the estimate with (an INV or EST type template). Use GET /api/InvoiceTemplate to look up template IDs by name. If left blank the account default estimate template will be used
- dueDate? string - It will be auto calculated based on the payment term and issue date. Due Date must be greater than or equal to Issue Date. If the Due Date is specified then Payment Terms will be set to -1 (Custom)
- notes? string - Plain UTF8 text. (no HTML). Max 2000 characters
avaza: NewEstimateLineItem
A line item to be included on a new estimate
Fields
- inventoryItemName? string - If not specified then Inventory item ID must be specified. If specified and not matched to any existing inventory items then a new inventory item will be created. Max 200 characters
- unitPrice decimal - The unit price for the lineitem
- description? string - Plain UTF8 text. (no HTML)
- discount? decimal - Enter 10.5 to give a 10.5% discount
- taxIDFK? Signed32 - If specified then it must match an existing Tax ID. If not specified then Tax Name and Tax Percent must be specified
- taxName? string - Must be specified if the Tax ID is blank. If the Tax Name is specified it will be matched to an existing Tax Name or else a new Tax will be created
- inventoryItemIDFK? Signed32 - If not specified then Inventory Item Name must be specified
- quantity decimal - The quantity for the line item
- taxPercent? decimal - The Tax Percent will only be used if a new tax is being created
avaza: NewExpense
Request model for creating a new expense entry. Requires expense date, amount, and category
Fields
- expenseCategoryIDFK? Signed32 - The expense category to link the Expense to. If not provided, ExpenseCategoryName must be provided
- exchangeRate? decimal - Optional (Only relevant if the expense currency is different to your account currency. If not provided we will look up the market exchange rate for you based on the expense date.) Exchange Rate = Expense Currency Amount / Base Currency Amount (e.g. if Expense currency is in AUD, and Base Currency is in USD, Exchange Rate = AUD $140 / USD $100 = 1.4)
- projectName? string - Can work for matching an expense to a project, but only if it's an exact match for a single project under the customer
- sendWebhooks? boolean - If true, fires the expense_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK? Signed32 - The Avaza project ID to associate the Expense with
- userEmail? string - The email address of a Timesheet/Expense user in Avaza. If not provided, UserIDFK field must be provided
- groupTripName? string - Links the expense to a Grouping/Trip report. If no matching name found, creates a new Group/Trip Report name
- expensePaymentMethodIDFK? Signed32 - (Optional) ID of Expense Payment Method
- verifyAndSave? boolean - Pass false if creating a draft expense. True otherwise
- currencyCode? string - A 3-letter ISO CurrencyCode for the expense currency. (e.g. USD). If not provided, defaults to the Account base currency
- merchant? string - The name of the merchant
- customerName? string - The name of an existing customer in Avaza. Must be an exact (case insensitive) match
- notes? string - Expense Notes
- fileAttachmentIDs? int[] - Array of File Attachment IDs to associate with this expense. The files need to have already been uploaded. Currently only accepts a single file
- isReimbursable? boolean - Defaults to false if not provided
- taxIDFK? Signed32 - Avaza Tax ID the expense belongs to. If left blank then Tax Name must be provided
- taskIDFK? Signed32 - (optional) TaskID of a Task to link the new Expense to. A Customer and Project must be provided also
- amount? decimal - Expense Amount (Required). Can be negative, e.g. to record a refund that reduces project cost and credits the client's next invoice
- taxName? string - Must exactly match an existing Tax Name that you have configured in Avaza Tax settings. If left blank then Tax ID must be provided
- merchantTaxNumber? string - A Tax number identifier for the merchant
- quantity? decimal - Conditional - available for expenses that are assigned a unit priced based expense category. e.g Mileage. A negative Quantity gives a negative Amount
- isChargeable? boolean - aka Billable. Defaults to false if not provided. If set to true, a CustomerIDFK or CustomerName must be provided
- customerIDFK? Signed32 - The Avaza Customer ID to associate the Expense with. Either this field or CustomerName can be provided
- expenseDate? string - The date of the expense entry (Required)
- expenseCategoryName? string - Must match an existing expense category name otherwise a new category will be created. If left blank Expense Category ID must be provided
- userIDFK? Signed32 - UserID for a Timesheet/Expense user in Avaza. If not provided, UserEmail field must be provided
- transactionTaxConfigCode? string - Optional - Enter "INC" if the tax amount is included in the expense amount otherwise enter "EX" when the amount exlcudes the tax. Defaults to "Ex". The tax amount on the expense will be autocalculated
avaza: NewFixedAmount
Payload for creating a new fixed-amount billing entry against a task
Fields
- taskIDFK? Signed32 - The task the fixed amount is added to. Required. Must exist in the authenticated account; the project is always derived from the task. Multiple fixed amounts per task are allowed
- amount? decimal - The fixed billing amount, in the currency of the customer the task's project belongs to. Required. Rounded to that currency's decimal places
- inventoryItemIDFK? int - The inventory item used when this fixed amount is invoiced. Required; there is no default
- notes? string - Plain text notes, maximum 255 characters
avaza: NewInventoryItem
Request model for creating a new inventory/product item
Fields
- purchaseTaxIDFK? Signed32 - The default tax rate ID applied when purchasing this item. Must be the TaxID of a tax belonging to the account
- description? string - Detailed description of the item. Plain UTF8 text. Max 1000 characters
- isHiddenOnBill? boolean - Set to true to hide this item from the item pickers on bills ("Hide from Bills"). Defaults to false
- saleTaxIDFK? Signed32 - The default tax rate ID applied when selling this item. Must be the TaxID of a tax belonging to the account
- salePrice? decimal - The default sale price of the item, in the account currency. Must be zero or greater
- costPrice? decimal - The default cost/purchase price of the item, in the account currency. Must be zero or greater
- sKU? string - Stock Keeping Unit code. Max 100 characters. When provided, must be unique within the account
- name? string - Name of the inventory item. Required. Max 200 characters. Must be unique within the account
- isHidden? boolean - Set to true to hide this item from the item pickers on invoices and estimates ("Hide from Invoicing"). Defaults to false
avaza: NewInvoice
Request model for creating a new customer invoice. Supports automatic company/contact creation
Fields
- exchangeRate? decimal - Exchange rate is only valid for invoices in currency other than default account currency. If not specified it will get the market rate based on the Date Issued
- lineItems? NewInvoiceLineItem[] -
- email? string - Specified value will be used to create a new customer contact only if a new customer is being created
- sendWebhooks? boolean - If true, fires the invoice_created webhook event to any subscribed endpoints (and timesheet_updated / expense_updated for any timesheets or expenses pulled into the invoice). Defaults to false to preserve existing integration behaviour
- lastname? string - Specified value will be used to create a new customer contact only if a new customer is being created
- companyIDFK? Signed32 - If left blank then you must specify Company Name
- paymentTerms? Signed32 - "If left blank we will set it to customer default. If specified then it must match one of your existing pre configured payment term periods. Your account starts with: (-1 --- Custom, 0 --- Upon Receipt, 7 --- 7 Days, 15 --- 15 Days, 30 --- 30 Days, 45 --- 45 Days, 60 --- 60 Days)
- subject? string - Plain UTF8 text. (no HTML). 255 characters max
- transactionPrefix? string - A prefix for the Invoice number. e.g. 'INV'. If left blank it will be set to the account default. Max length 20 characters
- firstname? string - Specified value will be used to create a new customer contact only if a new customer is being created
- currencyCode? string - Expects ISO Standard 3 character currency code. If left blank the currency will default to account's currency in general setting. For existing companies this field will be ignored and the invoice will use the currency of the customer. For new customers if the currency is not specified then account currency will be used otherwise the specified currency will be used
- companyName? string - If left blank then you must specify Company ID. Specified Name will be used to match existing customer record. If not matched then it will be used to create a new customer. First Name, Last Name and Email will only be used if it is a new company. If the Company name appears multiple times we will check the email address to find a matching company. If email address doesn't identify a matching company then the invoice creation will be rejected
- customerPONumber? string - Plain UTF8 text. 100 characters max
- dateIssued? string - If not specified it will use today's date. The date should be specified as local date
- expenseExchangeRates? ExpenseExchangeRate[] - Optional exchange-rate overrides applied when line items link Expenses in a currency different from the invoice currency. Expenses in currencies without an override use the stored/market rate. Ignored when no expenses are linked. Note: line item links cannot be used when creating a new customer company
- invoiceTemplateIDFK? Signed32 - The invoice template to render the invoice with (an INV or EST type template). Use GET /api/InvoiceTemplate to look up template IDs by name. If left blank the account default invoice template will be used
- invoiceNumber? string - Pass any string. If left blank it will use the next number in the auto incrementing sequence. If an integer is passed then the largest integer will be use as the seed to auto generate the next invoice number in the sequence
- dueDate? string - It will be auto calculated based on the payment term and issue date. Due Date must be greater than or equal to Issue Date. If the Due Date is specified then Payment Terms will be set to -1 (Custom)
- notes? string - Plain UTF8 text. (no HTML). Max 2000 characters
- transactionTaxConfigCode? string - Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left empty it will use the account default
avaza: NewInvoiceLineItem
A line item to be included on a new invoice
Fields
- description? string - Plain UTF8 text. (no HTML). When the line item links source records and this is omitted, a description is generated from the linked records
- discount? decimal - Enter 10.5 to give a 10.5% discount
- taxIDFK? Signed32 - If specified then it must match an existing Tax ID. If not specified then Tax Name and Tax Percent must be specified - except on a line item linking source records, where the tax is derived from the linked records when omitted
- taxName? string - Must be specified if the Tax ID is blank. If the Tax Name is specified it will be matched to an existing Tax Name or else a new Tax will be created
- projectIDFK? Signed32 - Optional. Project ID of an Avaza Project that belongs to this customer, so line item is attributed to that Project for reporting. Must be omitted when the line item links source records (it is derived from them)
- inventoryItemIDFK? Signed32 - If not specified then Inventory Item Name must be specified
- quantity? decimal - The quantity for the line item. Required unless the line item links source records (TimesheetEntryIDs / ExpenseIDs / FixedAmountIDs), in which case it is calculated from the linked records when omitted (e.g. total timesheet duration with account rounding applied)
- taxPercent? decimal - The Tax Percent will only be used if a new tax is being created
- inventoryItemName? string - If not specified then Inventory item ID must be specified. If specified and not matched to any existing inventory items then a new inventory item will be created. Max 200 characters
- expenseIDs? int[] - Optional. IDs of uninvoiced chargeable Expenses (Approved or AutoApproved, belonging to the invoice's customer) to link to this line item. Multiple expenses grouped onto one line must share the same tax. Quantity is 1 and UnitPrice is calculated from the expense amounts (including category markup and currency conversion) unless overridden. A line item may link only ONE source type, and InventoryItemIDFK/InventoryItemName/ProjectIDFK must be omitted on linked lines
- unitPrice? decimal - The unit price for the lineitem. Required unless the line item links source records, in which case it is calculated from the linked records when omitted (timesheets: the billable rate, blended when rates differ; expenses: converted amount including category markup; fixed amounts: the amount)
- timesheetEntryIDs? int[] - Optional. IDs of uninvoiced Timesheet entries to link to (invoice with) this line item. All entries must be billable, Approved or AutoApproved, not already invoiced, have no running timer, belong to the invoice's customer, and share a single project. Put one ID per line item for a dedicated line per entry, or several IDs to group them into one line. A line item may link only ONE source type, and InventoryItemIDFK/InventoryItemName/ProjectIDFK must be omitted on linked lines (they are derived from the source records)
- fixedAmountIDs? int[] - Optional. ID of an uninvoiced Fixed Amount to link to this line item - maximum ONE per line item (fixed amounts are always invoiced on their own line). Quantity is 1 and UnitPrice/Tax/InventoryItem come from the fixed amount unless overridden. A line item may link only ONE source type, and InventoryItemIDFK/InventoryItemName/ProjectIDFK must be omitted on linked lines
avaza: NewPayment
Request model for creating a new customer payment. Optionally include allocations to invoices
Fields
- transactionPrefix? string - Optional to override the default prefix added to Payment Numbers
- customerIDFK? Signed32 - Only required if no invoice allocations specified
- exchangeRate? decimal - Optional. Only used when the Customer's currecy is different from the Avaza account's base currency. Specifies the exchange rate that should apply between the customer currency and base currency. If not provided we will obtain an up to date exchange rate for the Payment Issue Date
- paymentAllocations? NewPaymentAllocation[] - List of amounts within this payment that are allocated to invoices. The sum of these be less than or equal to the payment amount
- dateIssued? string - Date of Payment. If not specified, assumes today
- transactionReference? string - Optional for storing the reference # of the payment method
- paymentProviderCode? string - Optional for storing the payment provider who was the source of funds
- sendWebhooks? boolean - If true, fires the invoice_updated webhook event for each invoice that was allocated against. Defaults to false to preserve existing integration behaviour
- amount? decimal - Total amount of the payment
- paymentNumber? string - Optional. If not specified will be automatically generated
- notes? string -
avaza: NewPaymentAllocation
An allocation entry for applying a customer payment to a specific invoice
Fields
- allocationAmount? decimal - The Amount being allocated to the invoice. Expects same currency as invoice currency
- allocationDate? string - Optional. Defaults to the current time in the Avaza account's timezone. The date the allocation is applied to the invoice. Can be difference from the Payment Date when doing prepayments etc
- invoiceTransactionIDFK? int - The Avaza Invoice TransactionID that is having a payment amount allocated to it
avaza: NewProjectMember
Request model for adding a user as a member of a project, with rate, budget, and permission settings
Fields
- isTimesheetApprovalRequired? boolean -
- canUpdateTasks? boolean -
- projectIDFK? Signed32 - Required. The ProjectID
- isTimesheetApprover? boolean -
- rateAmount? decimal - Optional. If not provided, defaults to the User's default Rate Amount
- isExpenseApprover? boolean -
- budgetAmount? decimal - Optional
- canDeleteTasks? boolean -
- canCommentOnTasks? boolean -
- canCreateTasks? boolean -
- costAmount? decimal - Optional. If not provided, defaults to the User's default Cost Amount
- userIDFK? Signed32 - Required. The UserID to assign
- isTimesheetAllowed? boolean -
avaza: NewProjectModel
Request model for creating a new project. Requires a project title and company association
Fields
- populateDefaultProjectMembers? boolean - Defaults to true
- projectStatusCode? string - Project status code. Per-account configurable; default codes are NotStarted, InProgress, Complete, OnHold (seeded for every account); admins may add custom codes. If omitted, the account's default-for-new-projects status is used
- isTaskRequiredOnTimesheet? boolean - Whether users must select a task when logging time to this project
- timesheetApprovalRequiredbyDefault? boolean - Whether timesheet approval should be required by default for newly added project members
- sendWebhooks? boolean - If true, fires the project_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- budgetHours? decimal - Hours budget allocated to the project
- projectBillableTypeCode? string - The billing method for the new project. (string, optional) Possible values: CategoryHourly (bill timesheets at per-category hourly rates), NoRate (billable, but no hourly rate is applied), NotBillable (project is not billable), PersonHourly (bill timesheets at per-person hourly rates), ProjectHourly (bill all timesheets at a single project hourly rate). Values are matched case-insensitively; the canonical casing is stored. If omitted, the account's default billing method for new projects is applied (current behaviour). Supplying it requires the Edit Project Configuration permission. When set to ProjectHourly the project is created with its Project Hourly Rate unset — set the rate afterwards via Project Settings or PUT /api/Project; per-person and per-category rates are managed via Project Members and Project Timesheet Categories. Must be NotBillable (or omitted) when the project is created under the account's internal company
- companyIDFK? Signed32 - An ID of a company in Avaza to create the Project under. You must provide either a CompanyID, or a CompanyName
- endDate? string - Planned end date for the project
- budgetAmount? decimal - Monetary budget allocated to the project
- currencyCode? string - The ISO 3 letter currency code to use when creating a new Company. If not provided, the account's default currency will be used
- startDate? string - Planned start date for the project
- companyName? string - The name for a Company to create the project under. Will create company unless it matches an existing company name
- projectNotes? string - Any descriptive notes about the project. (2000 characters max)
- projectBudgetTypeCode? string - The budget method for the new project. (string, optional) Possible values: CategoryHours (hours budget per timesheet category), NoBudget (no budget), PersonHours (hours budget per person), ProjectFees (total project fee budget, paired with BudgetAmount), ProjectHours (total project hours budget, paired with BudgetHours). Values are matched case-insensitively; the canonical casing is stored. If omitted, the account's default budget method for new projects is applied and BudgetAmount / BudgetHours are stored as provided (current behaviour). Supplying it requires the Edit Project Configuration permission. When supplied, the budget fields are cross-validated: NoBudget rejects a non-zero BudgetAmount or BudgetHours; ProjectFees rejects a non-zero BudgetHours; ProjectHours, PersonHours and CategoryHours reject a non-zero BudgetAmount. Per-person and per-category hour budgets are managed via Project Members and Project Timesheet Categories
- customFields? CustomFieldValueInput[] - Custom field values to set on the new project. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Fields not supplied receive their configured default values; required fields without a default must be supplied. Custom field definitions/options cannot be created or modified via the API
- projectTitle string - The title of the new project. (255 characters max)
- projectCategoryIDFK? Signed32 - The project category ID, if categorised
- projectTags? ProjectTagInput[] - Tags to assign to the new project. Object array; each item has a Name. Names are matched case-insensitively against the account tag pool and created on first use. Omit or null to create the project with no tags. (255 characters max per name)
- projectCode? string - Used when Manual Project Codes are enabled
avaza: NewSection
Request model for creating a new section within a project
Fields
- endDateUTC? string - Optional end date for the section (UTC)
- projectIDFK? Signed32 - The project this section should be created in
- title? string - Section title/name
- startDateUTC? string - Optional start date for the section (UTC)
avaza: NewTag
A tag to apply to a task, specifying name and hex color code
Fields
- color? string - Hex color code in format #000000
- name? string - Tag name
avaza: NewTask
Request model for creating a new task in a project section. Requires ProjectIDFK, SectionIDFK, and Title
Fields
- estimatedEffort? decimal - Decimal hours
- sectionIDFK Signed32 - The section (task group) this task belongs to
- assignedToUserIDFKs? Signed32[] - List of user IDs to assign to this task
- description? string - Task description (may contain HTML)
- sendWebhooks? boolean - If true, fires the task_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK Signed32 - The project this task belongs to
- dateStart? string - Task start date
- title string - Task title/name
- taskPriorityCode? string - Task priority. Values: None, Low, Medium, High, Urgent
- parentTaskIDFK? Signed32 - Parent task ID to create this as a subtask. NULL creates a root-level task
- customFields? CustomFieldValueInput[] - Custom field values to set on the new task. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Fields not supplied receive their configured default values; required fields without a default must be supplied. Custom field definitions/options cannot be created or modified via the API
- accountTaskTypeIDFK? Signed32 - The task type (workflow) ID for this task
- dateDue? string - Task due date
- tags? NewTag[] - Collection of tags specifying Name and Color (Hex)
- fileAttachmentIDs? int[] - FileAttachmentIDs (returned from prior /api/FileAttachment uploads) to link to the new task. Each ID must have been created by the current user and not yet linked to any entity
avaza: NewTaskDiscussion
Request payload for posting a new comment / discussion message to a task. Use POST /api/FileAttachment first to upload any attachments and pass the resulting FileAttachmentIDs here
Fields
- isInternalNote? boolean - True to post as an internal note (not visible to external/customer users). Only team members may post internal notes. Default: false
- taskID? Signed32 - The TaskID to post the discussion message to. Required
- replyToMessageID? int - Optional. The TaskResponseID of an existing message on the same task being replied to. Set null/0/omit for a top-level message
- responseBody? string - The message body. May contain a limited HTML subset (sanitised on save). Required unless FileAttachmentIDs is non-empty. To @mention a user (notifies them and adds them as a task follower), include a span that carries a class attribute immediately before data-mentionid, e.g. <span class="mention" data-mentionid="12345">@Firstname Lastname</span>. The class attribute is required — a span with data-mentionid but no class is stored as plain text and is NOT treated as a mention. Resolve the numeric user id via GET /api/User
- fileAttachmentIDs? int[] - Optional. List of FileAttachmentIDs returned from prior /api/FileAttachment uploads to attach to this message. Each must be owned by the current user and not already linked (AttachmentType='Draft'). Maximum 8 per message
avaza: NewTimesheet
Request model for creating a new timesheet entry. If Duration is null or 0, a timer is started automatically
Fields
- hasStartEndTime? boolean - If true, the start time will be take from the time component of the Entry Date field, and the end time will be calculated by adding the Duration to the StartDate
- sendWebhooks? boolean - If true, fires the timesheet_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK? Signed32 - The project to associate the timesheet with
- taskIDFK? Signed32 - Optional. Link the timesheet to a specific task
- isInvoiced? boolean - Optional. False by default. Allows you to mark the timesheet as invoiced in an external system
- entryDate? string - The date of the timesheet entry, with an optional start time component
- userIDFK? Signed32 - UserID for a Timesheet user in Avaza
- timesheetCategoryIDFK? Signed32 - The Project timesheet category to link the timesheet to
- duration? decimal - The duration of the timesheet, in decimal hours. If null or 0, a timer will be started
- notes? string - Timesheet Notes
- customMetadata? string - Optional. free nvarchar field available via Api to store any additional metadata against a timesheet. We suggest you use Json or your preferred serialisation format. 1000 characters max
avaza: NewUserProfile
Request body for POST /api/UserProfile. Creates a team member (CompanyIDFK = null) or a customer contact (CompanyIDFK set)
Fields
- email? string - Email address. Must be a valid format and unique within the current account
- positionTitle? string - User's job title. Max 100 characters
- sendInviteEmail? boolean - If true and at least one role is assigned, sends an invitation email and sets InvitationStatusCode = "InviteSent". See spec for the full matrix
- defaultBillableRate? decimal - Default billable rate per hour. Team members only. Must be non-negative
- lastname? string - Last name. Max 100 characters
- roles? string[] - Role codes to assign. Each entry must be a RoleCode from the Roles table that is assignable for the user type (UserAssignable=1 for team members, CustomerAssignable=1 for customer contacts). Empty/null = no roles (InvitationStatusCode = "NoRoles")
- companyIDFK? Signed32 - If set, creates a Customer Contact linked to this Company. If null, creates a Team Member
- mobile? string - Mobile phone number. Max 50 characters
- firstname? string - First name. Max 100 characters
- timeZone? string - Windows Time Zone ID (e.g. "Pakistan Standard Time"). If omitted, defaults to the account's timezone
- customFields? CustomFieldValueInput[] - Custom field values to set on the new user (Team Member fields when CompanyIDFK is null, Contact fields when it is set). Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Fields not supplied receive their configured default values; required fields without a default must be supplied. Custom field definitions/options cannot be created or modified via the API
- phone? string - Phone number. Max 50 characters
- defaultCostRate? decimal - Default cost rate per hour. Team members only. Must be non-negative
avaza: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://any.avaza.com/oauth2/token") - Refresh URL
avaza: Payment
A customer payment including allocations to specific invoices
Fields
- exchangeRate? decimal - Exchange rate to the account's base currency
- paymentAllocations? PaymentAllocation[] - List of allocations applying this payment against specific invoices
- transactionReference? string - External reference number (e.g. cheque number or bank reference)
- dateUpdated? string - Date and time the record was last updated
- accountIDFK? Signed32 - The Avaza account this payment belongs to
- dateCreated? string - Date and time the record was created
- totalAmount? decimal - Total payment amount
- transactionID? int - Unique identifier for the payment transaction
- transactionPrefix? string - The prefix used in the payment number
- currencyCode? string - ISO 3-character currency code for the payment
- customerIDFK? Signed32 - The customer company ID this payment is from
- dateIssued? string - The date the payment was made
- transactionStatusCode? string - Current status of the payment
- paymentProviderCode? string - Code identifying the payment provider/method used
- viewPaymentURL? string - URL to view this payment in the Avaza web application
- balance? decimal - Unallocated balance remaining on the payment
- paymentNumber? string - The full payment number including prefix
- notes? string - Additional notes on the payment
avaza: PaymentAllocation
An allocation record linking a customer payment to a specific invoice
Fields
- allocationAmount? decimal - The amount allocated from the payment to the invoice
- transactionAllocationID? int - Unique identifier for this payment allocation
- allocationDate? string - The date this allocation was applied
- paymentTransactionIDFK? int - The payment Transaction ID this allocation belongs to
- invoiceTransactionIDFK? int - The invoice Transaction ID this payment is allocated against
avaza: PaymentList
Paginated collection of customer payments
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- payments? Payment[] - The list of payments on this page
avaza: PreviewLineItem
A line item that would be (or was) generated from uninvoiced records, including the source record IDs it covers
Fields
- expenseIDs? int[] - Expenses covered by this line
- unitPrice? decimal - The calculated unit price (blended rate / converted amount including markup / fixed amount)
- taxAmount? decimal - The calculated tax amount
- timesheetEntryIDs? int[] - Timesheet entries covered by this line
- description? string - The generated line description
- taxIDFK? Signed32 - The derived tax for the line
- sourceType? string - The type of source records this line invoices: Timesheet, Expense or FixedAmount
- amount? decimal - The calculated line total
- projectIDFK? Signed32 - The project the line is attributed to, if any
- inventoryItemIDFK? int - The derived inventory item for the line
- quantity? decimal - The calculated quantity (e.g. total hours)
- fixedAmountIDs? int[] - Fixed amounts covered by this line
avaza: PreviewUninvoicedItemsResult
Result of previewing uninvoiced records for an invoice. Nothing is saved by a preview
Fields
- lineItems? PreviewLineItem[] - The line items that AddUninvoicedItems would create for the same request
- taxAmount? decimal - Sum of the previewed line tax amounts
- subtotalAmount? decimal - Sum of the previewed line amounts
- skippedTimesheetEntryIDs? int[] - Timesheet entries that matched the filters but were skipped because they have a running timer
- totalAmount? decimal - The total the previewed lines would add to the invoice
- warnings? string[] - Non-fatal notices about the preview
avaza: ProjectCompanyGroup
A customer company and its associated projects, used in the project dropdown list
Fields
- companyName? string - Name of the customer company
- projects? ProjectDropdownSelection[] - Projects belonging to this company
- companyID? int - The customer company ID
avaza: ProjectDetails
Full project details including sections, team members with rates/permissions, and project tags
Fields
- spentHours? decimal - Hours recorded to date for hour-based budget types: every timesheet entry except Rejected, billable entries only when the project deducts billable hours only. Null for ProjectFees / NoBudget
- projectStatusCode? string - Project status code. Per-account configurable. Default codes (NotStarted, InProgress, Complete, OnHold) are seeded for every account; admins may add custom codes via the Project Statuses settings panel. Codes are unique within an account and stable once created
- isArchived? boolean - Whether the project is archived. Archived projects are hidden from default views
- projectID? Signed32 - Unique identifier for the project
- dateCreated? string - Date the project was created
- budgetAmount? decimal - Monetary budget allocated to the project (the stored setting; ProjectFees only). Null when the token owner cannot see amounts on this project (Administrator, Finance Manager and Portfolio Manager always can; other users need "Can manage Project Member Cost and Billable Rates" on the project)
- currencyCode? string - ISO currency code of the project's customer company (the account's default currency for projects on the internal company). Every money value on this project is in this currency
- startDate? string - Planned start date for the project
- companyName? string - Name of the customer company this project belongs to
- projectCategoryIDFK? Signed32 - The project category ID, if categorised
- sections? ProjectSectionDetails[] - List of sections (task groups) within this project
- projectTags? ProjectTagItem[] - List of tags applied to this project
- projectOwnerUserIDFK? Signed32 - User ID of the project owner/manager
- projectCode? string - Short reference code for the project
- notes? string - Project description or notes
- isTaskRequiredOnTimesheet? boolean - Whether users must select a task when logging time to this project
- projectStatusColor? string - Hex colour assigned to the project status (e.g. "#F0AD4E")
- projectCategoryName? string - Name of the project category
- defaultAccountTaskTypeIDFK? Signed32 - The default task type ID used for new tasks in this project
- dateUpdated? string - Date the project was last updated
- budgetHours? decimal - Hours budget allocated to the project (the stored setting; ProjectHours only - see EffectiveBudgetHours for the CategoryHours / PersonHours sums)
- projectBillableTypeCode? string - Billing configuration. Values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly. Null for external customer-contact tokens, which never receive budget or billing details
- title? string - Project title/name
- projectStatusName? string - Display name of the project status (e.g. "In Progress", "At Risk")
- companyIDFK? Signed32 - The customer company ID this project is linked to
- projectHourlyRate? decimal - The project-level hourly rate (when billing type is ProjectHourly). Null when the token owner cannot see amounts on this project
- endDate? string - Planned end date for the project
- viewProjectURL? string - URL to view this project in the Avaza web application
- projectBudgetTypeCode? string - Budget configuration. Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours. Null for external customer-contact tokens, which never receive budget or billing details
- customFields? CustomFieldValueItem[] - Custom field values set on this project, in display order. Fields with no value are not included. Omitted entirely when the account's Custom Fields feature is disabled (external contact tokens only see fields with "Everyone" visibility). See GET /api/CustomFieldDefinition for the account's field definitions
- projectStatusIsComplete? boolean - True if this status marks the project as complete (one row per account)
- effectiveBudgetHours? decimal - Effective hours budget for hour-based budget types: BudgetHours for ProjectHours, the sum of the category budgets for CategoryHours, the sum of the member budgets for PersonHours. Null for ProjectFees / NoBudget and when no budget is entered
- projectCategoryColor? string - Html Hex Color Code starting with #
- defaultAccountTaskTypeName? string - Name of the default task type
- projectStatusIsNotStarted? boolean - True if this is the account's default-for-new-projects status (one row per account)
- spentAmount? decimal - Amount spent to date for ProjectFees / NoBudget projects, in CurrencyCode: timesheets at the project's cost or billable rate setting, plus expenses net of tax (no markup) when the project deducts expenses; task fixed amounts are never included; every entry except Rejected. Null for hour-based budget types and null when the token owner cannot see amounts on this project
- members? ProjectMemberDetails[] - List of team members assigned to this project
avaza: ProjectDropdownList
Paginated list of active projects grouped by customer company, for dropdown/autocomplete use
Fields
- companies? ProjectCompanyGroup[] - List of Projects grouped by Customer Name
- pageNumber? Signed32 - Current page number (1 based)
- pageSize? Signed32 - Current page size
- hasMore? boolean - More records probably exist
avaza: ProjectDropdownSelection
A minimal project record containing Project ID, project code, and title for dropdown selection
Fields
- isTaskRequiredOnTimesheet? boolean - Whether a task must be selected when logging a timesheet entry against this project
- projectID? int - Unique identifier for the project
- title? string - Project title/name
- projectCode? string - Short reference code for the project
avaza: ProjectList
Paginated collection of projects with summary details
Fields
- totalCount? Signed32 - Total number of projects matching the query
- pageSize? Signed32 - Number of results per page
- pageNumber? Signed32 - Current page number (1-based)
- projects? ProjectListDetails[] - List of projects in this page
avaza: ProjectListDetails
Summary details of a project including status, billing type, budget, category, and owner
Fields
- spentHours? decimal - Hours recorded to date for hour-based budget types: every timesheet entry except Rejected, billable entries only when the project deducts billable hours only. Null for ProjectFees / NoBudget. Returned only when IncludeBudget=true
- projectStatusCode? string - Project status code. Per-account configurable. Default codes (NotStarted, InProgress, Complete, OnHold) are seeded for every account; admins may add custom codes via the Project Statuses settings panel. Codes are unique within an account and stable once created
- isArchived? boolean - Whether the project is archived. Archived projects are hidden from default views
- projectID? Signed32 - Unique identifier for the project
- dateCreated? string - Date the project was created
- budgetAmount? decimal - Monetary budget allocated to the project
- currencyCode? string - ISO currency code of the project's customer company (the account's default currency for projects on the internal company). Every money value on this project is in this currency
- startDate? string - Planned start date for the project
- companyName? string - Name of the customer company this project belongs to
- projectCategoryIDFK? int - The project category ID, if categorised
- projectTags? ProjectTagItem[] - List of tags applied to this project, alphabetical by name
- projectOwnerUserIDFK? int - User ID of the project owner/manager
- projectCode? string - Short reference code for the project
- notes? string - Project description or notes
- isTaskRequiredOnTimesheet? boolean - Whether users must select a task when logging time to this project
- projectCategoryName? string - Name of the project category
- projectStatusColor? string - Hex colour assigned to the project status (e.g. "#F0AD4E")
- defaultAccountTaskTypeIDFK? Signed32 - The default task type ID used for new tasks in this project
- dateUpdated? string - Date the project was last updated
- budgetHours? decimal - Hours budget allocated to the project
- projectBillableTypeCode? string - Billing configuration. Values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly. Null for external customer-contact tokens, which never receive budget or billing details
- title? string - Project title/name
- projectStatusName? string - Display name of the project status (e.g. "In Progress", "At Risk")
- companyIDFK? Signed32 - The customer company ID this project is linked to
- projectHourlyRate? decimal - The project-level hourly rate (when billing type is ProjectHourly). Null when the token owner cannot see amounts on this project (Administrator, Finance Manager and Portfolio Manager always can; other users need "Can manage Project Member Cost and Billable Rates" on the project)
- endDate? string - Planned end date for the project
- viewProjectURL? string - URL to view this project in the Avaza web application
- projectBudgetTypeCode? string - Budget configuration. Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours. Null for external customer-contact tokens, which never receive budget or billing details
- customFields? CustomFieldValueItem[] - Custom field values set on this project, in display order. Fields with no value are not included. Omitted entirely when the account's Custom Fields feature is disabled (external contact tokens only see fields with "Everyone" visibility). See GET /api/CustomFieldDefinition for the account's field definitions
- projectStatusIsComplete? boolean - True if this status marks the project as complete (one row per account)
- effectiveBudgetHours? decimal - Effective hours budget for hour-based budget types: BudgetHours for ProjectHours, the sum of the category budgets for CategoryHours, the sum of the member budgets for PersonHours. Null for ProjectFees / NoBudget and when no budget is entered. Returned only when IncludeBudget=true
- defaultAccountTaskTypeName? string - Name of the default task type
- projectStatusIsNotStarted? boolean - True if this is the account's default-for-new-projects status (one row per account)
- spentAmount? decimal - Amount spent to date for ProjectFees / NoBudget projects, in CurrencyCode: timesheets at the project's cost or billable rate setting, plus expenses net of tax (no markup) when the project deducts expenses; task fixed amounts are never included; every entry except Rejected. Null for hour-based budget types and null when the token owner cannot see amounts on this project. Returned only when IncludeBudget=true
avaza: ProjectMemberDetails
A project team member with their role permissions, rates, budget, and timesheet settings
Fields
- isTimesheetApprovalRequired? boolean - Whether this member's timesheets require approval
- canUpdateTasks? boolean - Whether this member can update tasks in this project
- email? string - Member's email address
- fullname? string - Member's full display name
- projectIDFK? Signed32 - The project this membership belongs to
- lastname? string - Member's last name
- isTimesheetApprover? boolean - Whether this member can approve timesheets on this project
- rateAmount? decimal - Bill rate per hour for this member on this project
- budgetAmount? decimal - Budget amount allocated to this member on this project
- isMemberDisabled? boolean - Whether this member's access to the project is disabled
- firstname? string - Member's first name
- canDeleteTasks? boolean - Whether this member can delete tasks in this project
- canCommentOnTasks? boolean - Whether this member can comment on tasks in this project
- costAmount? decimal - Cost rate per hour for this member on this project
- canCreateTasks? boolean - Whether this member can create tasks in this project
- userIDFK? Signed32 - The user ID of the project member
- isTimesheetAllowed? boolean - Whether this member can log timesheets to this project
avaza: ProjectMemberList
Collection of project member records
Fields
- projectMembers? ProjectMemberDetails[] - List of project members
avaza: ProjectSectionDetails
A section (task group) within a project, with title, date range, and display order
Fields
- startDate? string - Planned start date for the section
- displayOrder? Signed32 - Sort order position for display
- title? string - Section title/name
- sectionID? Signed32 - Unique identifier for the section
- endDate? string - Planned end date for the section
avaza: ProjectTagInput
A project tag to assign, specified by name. Names are matched case-insensitively against the account tag pool and created on first use
Fields
- name? string - Tag name. (255 characters max)
avaza: ProjectTagItem
A tag applied to a project, with ID and name
Fields
- projectTagID? Signed32 - Unique identifier for the project tag
- name? string - Tag name
avaza: ProjectTagList
Collection of an account's project tags
Fields
- tags? ProjectTagItem[] - The account's project tags, sorted alphabetically by name (case-insensitive)
avaza: ProjectTimesheetCategoryDetails
A timesheet/billing category assigned to a project, with billable status, rate, and budget hours
Fields
- projectIDFK? Signed32 - The project this category is assigned to
- budgetHours? decimal - Hours budget for this category on this project
- costAmount? decimal - The cost rate per hour for this category on this project
- accountIDFK? Signed32 - The Avaza account this category belongs to
- rateAmount? decimal - The billing rate per hour for this category on this project
- isDisabled? boolean - Whether this category assignment is disabled
- timeSheetCategoryIDFK? Signed32 - The timesheet category ID
- name? string - Name of the timesheet category
- isBillable? boolean - Whether time logged under this category is billable
- isPayable? boolean - Whether time logged under this category is payable
avaza: ProjectTimesheetCategoryList
Collection of timesheet categories assigned to a project
Fields
- categories? ProjectTimesheetCategoryDetails[] - List of timesheet category assignments
avaza: RecipientDetails
Billing address details for the customer receiving an invoice or estimate
Fields
- recipientFormattedBillingAddress? string - Pre-formatted multi-line billing address for the recipient
- companyName? string - Name of the customer company
- recipientBillingAddressState? string - State/province for the recipient
- taxNumberLabel? string - Label printed next to the recipient's tax number: the company's own Tax Number Label, else the template's default customer label, else "Tax Number"
- recipientBillingAddressPostCode? string - Postal/ZIP code for the recipient
- recipientBillingAddressCountryCode? string - ISO country code for the recipient
- recipientBillingAddressCity? string - City/suburb for the recipient
- companyIDFK? Signed32 - The customer company ID
- taxNumber? string - The customer company's tax registration number (Company.TaxNumber). Null when not set
- recipientBillingAddressLine? string - Street address line for the recipient
avaza: RecurringInvoice
A recurring invoice profile defining automatic invoice generation on a schedule, with line items and configuration
Fields
- neverExpires? boolean - Whether the profile continues generating invoices indefinitely with no expiry
- exchangeRate? decimal - The exchange rate applied when the invoice currency differs from the account default currency
- numberOfCyclesRemaining? Signed32 - The number of invoice cycles remaining before the profile completes. Null if the profile never expires
- subtotalAmount? decimal - The subtotal amount before tax and discounts
- dateCreated? string - The date and time this recurring invoice profile was created
- profileName? string - A friendly name for the recurring invoice profile
- startDate? string - The date the recurring profile first generates an invoice
- currencyCode? string - The ISO 3-letter currency code for the generated invoices
- companyName? string - The name of the customer company this recurring invoice is billed to
- taxAmount? decimal - The total tax amount on the recurring invoice profile
- viewRecurringInvoiceURL? string - URL to view this recurring invoice in the Avaza web application
- notes? string - Additional notes or terms that appear on generated invoices
- recurringProfileStatusCode? string - Status of the recurring profile (e.g. Active, Paused, Completed)
- lineItems? RecurringInvoiceLineItem[] - The line items that will appear on each generated invoice
- dateUpdated? string - The date and time this recurring invoice profile was last updated
- accountIDFK? Signed32 - The account this recurring invoice profile belongs to
- companyIDFK? Signed32 - The ID of the customer company this recurring invoice is billed to
- totalAmount? decimal - The total amount including tax and after discounts
- lastInvoiceDate? string - The date the most recent invoice was generated from this profile
- nextInvoiceDate? string - The date the next invoice will be generated from this profile
- subject? string - The subject/title text that appears on generated invoices
- discountAmount? decimal - The total discount amount applied to the profile
- numberOfCycles? Signed32 - The total number of invoice cycles configured for this profile. Null if the profile never expires
- isAutoChargeEnabled? boolean - Whether automatic charging is enabled for this recurring profile
- recurringInvoiceID? int - Unique identifier for the recurring invoice profile
- recurringProfileFrequencyCode? string - The frequency at which invoices are generated (e.g. Weekly, Monthly, Yearly)
- customFrequencyNumber? Signed32 - For custom frequency profiles, the number of units between invoice generations
- transactionTaxConfigCode? string - Specifies whether generated invoices are tax exclusive or tax inclusive (e.g. EX, INC)
avaza: RecurringInvoiceLineItem
A line item on a recurring invoice profile
Fields
- recurringInvoiceLineItemID? int - Unique identifier for the recurring invoice line item
- description? string - A description for the line item as it appears on generated invoices
- discount? decimal - The discount percentage applied to this line item
- taxIDFK? Signed32 - The ID of the tax rate applied to this line item
- taxName? string - The display name of the tax rate applied to this line item
- projectIDFK? Signed32 - The ID of the project associated with this line item for reporting purposes
- amount? decimal - The total amount for the line item (quantity multiplied by unit price, after discount, before tax)
- inventoryItemIDFK? int - The ID of the inventory item associated with this line item
- quantity? decimal - The quantity for the line item
- inventoryItemName? string - The name of the inventory item for this line item
- unitPrice? decimal - The unit price for the line item
- taxAmount? decimal - The tax amount calculated for the line item
- inventoryItemSKU? string - The SKU code of the inventory item for this line item
- projectTitle? string - The title of the project associated with this line item
- taxCode? string - The tax code of the tax rate applied to this line item
avaza: RecurringInvoiceList
Paginated collection of recurring invoice profiles
Fields
- recurringInvoices? RecurringInvoice[] - The recurring invoice profiles for the current page
- totalCount? Signed32 - The total number of recurring invoice profiles matching the query
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number of the result set
avaza: RemoveInvoiceLineItemsRequest
Request model for deleting specific line items from an invoice and releasing their linked records
Fields
- sendWebhooks? boolean - If true, fires invoice_updated (plus timesheet_updated / expense_updated for released records) webhook events. Defaults to false
- transactionLineItemIDs int[] - The TransactionLineItemIDs to delete (1-100). Every ID must belong to this invoice. Any timesheets, expenses or fixed amounts linked to the deleted lines are released back to uninvoiced
- invoiceID int - The Transaction ID of the invoice to remove line items from. The invoice must not be Void
avaza: RemoveInvoiceLineItemsResult
Result of removing line items from an invoice
Fields
- unlinkedExpenseIDs? int[] - Expenses released back to uninvoiced by the removal
- invoice? Invoice -
- unlinkedFixedAmountIDs? int[] - Fixed amounts released back to uninvoiced by the removal
- warnings? string[] - Non-fatal notices about the operation
- unlinkedTimesheetEntryIDs? int[] - Timesheet entries released back to uninvoiced by the removal
avaza: RoleDetails
A security role assigned to a user, with role code and display name
Fields
- roleName? string - Display name of the role
- roleCode? string - Unique code for the role (e.g. Admin, PM, TimesheetUser)
avaza: ScheduleAssignmentDetails
A single-day schedule assignment representing hours allocated to a user on a specific date, derived from a schedule series
Fields
- scheduleAssignmentID? int - Unique identifier for the daily schedule assignment
- dateUpdated? string - Date and time the record was last updated
- accountIDFK? Signed32 - The Avaza account this schedule belongs to
- userIDFK? Signed32 - The user this schedule is assigned to
- dateCreated? string - Date and time the record was created
- duration? decimal - Hours allocated for this specific day
- scheduleSeriesIDFK? int - The parent schedule series this assignment belongs to
- scheduleDate? string - The specific date this assignment is for
avaza: ScheduleAssignmentList
Paginated collection of per-day schedule assignments
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- pageNumber? Signed32 - The current page number (1-based)
- scheduleAssignments? ScheduleAssignmentDetails[] - The list of schedule assignment records for this page
avaza: ScheduleSeriesDetails
A schedule series record representing a continuous booking or leave allocation for a user over a date range
Fields
- endTime? string - Optional end time of day for the scheduled work
- scheduleSeriesID? int - Unique identifier for the schedule series
- projectIDFK? Signed32 - The project this booking is for (null for leave)
- dateCreated? string - Date and time the record was created
- rateAmount? decimal - The applicable billing rate per hour for this booking
- startDate? string - Start date of the schedule series
- companyName? string - Name of the customer company
- leaveTypeIDFK? Signed32 - The leave type ID (for leave schedule entries)
- costAmount? decimal - The applicable cost rate per hour for this booking
- leaveTypeName? string - Name of the leave type
- timeSheetCategoryName? string - Name of the timesheet category
- scheduleOnDaysOff? boolean - Whether to include weekends and holidays in the schedule
- notes? string - Additional notes on the schedule
- hoursPerDay? decimal - Hours allocated per working day
- dateUpdated? string - Date and time the record was last updated
- updatedByUserIDFK? Signed32 - User ID of the person who last updated this schedule
- taskIDFK? Signed32 - The task this booking is linked to, if any
- lastname? string - Scheduled user's last name
- startTime? string - Optional start time of day for the scheduled work
- accountIDFK? Signed32 - The Avaza account this schedule belongs to
- taskTitle? string - Title of the associated task
- companyIDFK? Signed32 - The customer company of the associated project
- endDate? string - End date of the schedule series
- timeSheetCategoryIDFK? Signed32 - The timesheet category for this booking
- totalDuration? decimal - Total hours across the entire schedule series
- isBillable? boolean - Whether this booking is billable, based on project billing method and category settings
- firstname? string - Scheduled user's first name
- projectTitle? string - Title of the associated project
- userIDFK? Signed32 - The user this schedule is assigned to
avaza: ScheduleSeriesFilterRequest
Request model for filtering schedule series with criteria including date ranges, user, project, and category
Fields
- scheduleEndDateTo? string - Filter series ending on or before this date
- companyID? Signed32 - Filter by the customer company ID of the associated project
- pageSize? Signed32 - Number of results per page. Default 20, maximum 1000
- scheduleStartDateTo? string - Filter series starting on or before this date
- projectID? Signed32 - Filter by project ID
- userEmail? string - Filter by the scheduled user's email address
- leaveTypeID? Signed32 - Filter by leave type ID
- updatedAfter? string - Filter to records updated after this date-time
- scheduleStartDateFrom? string - Filter series starting on or after this date
- pageNumber? Signed32 - 1-based page number. Default 1
- userID? Signed32 - Filter by the scheduled user's ID
- timeSheetCategoryID? Signed32 - Filter by timesheet category ID
- scheduleSeriesIDs? int[] - Optional list of specific Schedule Series IDs to retrieve
- sort? string - Sort order. Values: DateUpdated, DateCreated (append ' desc' for descending)
- timeSheetCategoryName? string - Filter by exact timesheet category name
- scheduleEndDateFrom? string - Filter series ending on or after this date
avaza: ScheduleSeriesList
Paginated collection of schedule series (bookings and leave)
Fields
- totalCount? Signed32 - Total number of records matching the query across all pages
- pageSize? Signed32 - The number of records per page
- scheduleSeries? ScheduleSeriesDetails[] - The list of schedule series records for this page
- pageNumber? Signed32 - The current page number (1-based)
avaza: SectionDetails
A section (task group) within a project, with title, dates, display order, and project association
Fields
- startDate? string - Section start date in local time
- displayOrder? Signed32 - Sort order position for display within the project
- endDateUTC? string - Section end date in UTC
- projectIDFK? Signed32 - The project this section belongs to
- title? string - Section title/name
- startDateUTC? string - Section start date in UTC
- sectionID? Signed32 - Unique identifier for the section
- endDate? string - Section end date in local time
avaza: SectionList
Collection of sections within a project
Fields
- totalCount? Signed32 - Total number of sections in the project
- sections? SectionDetails[] - List of sections in this project
avaza: StartTimerQueries
Represents the Queries record for the operation: startTimer
Fields
- sendWebhooks? boolean -
- userID? Signed32 - 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
avaza: StopTimerQueries
Represents the Queries record for the operation: stopTimer
Fields
- sendWebhooks? boolean -
- userID? Signed32 - 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
avaza: SubmitExpensesForApprovalQueries
Represents the Queries record for the operation: submitExpensesForApproval
Fields
- sendWebhooks? boolean -
- userID? Signed32 - 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
- sendNotifications? boolean - Send email alerts to expense approvers. Defaults to true
avaza: SubmitTimesheetsQueries
Represents the Queries record for the operation: submitTimesheets
Fields
- wholeWeekOf? string - A date (yyyy-MM-dd) that falls within a week to have all timesheets in that week submitted. Respects the First Day of Week setting in your account Timesheet Settings to determine the week range
- sendWebhooks? boolean -
- userID? Signed32 - The user to submit timesheets for. Defaults to current user. Only allowed to be different from the current user when the current user has rights to Impersonate other users
- wholeDayOf? string - A date (yyyy-MM-dd) to submit all timesheets on this day
- sendNotifications? boolean - Send email alerts to timesheet approvers. Defaults to true
avaza: SubscribeResult
Result of creating a webhook subscription, containing the new Subscription ID
Fields
- iD? Signed32 - The ID of the newly created webhook subscription
avaza: TagItem
A tag applied to a task, with ID, name, and hex color code
Fields
- color? string - Hex color code for the tag (e.g. '#FF5733')
- tagID? int - Unique identifier for the tag
- name? string - Tag name
avaza: TaskDetails
Full task details including project context, section, assignees, dates, status, priority, tags, estimated/actual effort, and web link
Fields
- sectionIDFK? Signed32 - The section (task group) this task belongs to
- description? string - Task description (may contain HTML)
- taskStatusName? string - Display name of the current task status
- fileAttachments? TaskFileAttachmentItem[] - File attachments currently linked to this task
- projectIDFK? Signed32 - The project this task belongs to
- dateStart? string - Task start date
- dateCreated? string - Date and time the task was created
- taskPriorityCode? string - Task priority. Values: None, Low, Medium, High, Urgent
- assignedToUsers? AssignedToUser[] - List of users assigned to this task
- viewTaskURL? string - URL to view this task in the Avaza web application
- taskPriorityName? string - Display name of the task priority
- dateCompleted? string - Date the task was marked as completed
- parentTaskTitle? string - Title of the parent task (denormalized for display). NULL for root-level tasks
- projectCode? string - Short code of the parent project
- subtaskCount? Signed32 - Number of immediate subtasks under this task
- tags? TagItem[] - List of tags applied to this task
- estimatedEffort? decimal - Estimated effort in decimal hours
- sectionTitle? string - Title of the section this task is in
- taskID? Signed32 - Unique identifier for the task
- subtaskProgress? Signed32 - Percentage of subtasks in a complete status (0-100)
- actualTime? decimal - Actual time logged against this task in decimal hours
- taskStatusCode? string - Current task status code
- dateUpdated? string - Date and time the task was last updated
- isCompleteStatus? boolean - Whether the current status represents a completed state
- title? string - Task title/name
- descriptionNoHTML? string - Task description with HTML tags stripped
- parentTaskIDFK? Signed32 - Parent task ID if this is a subtask. NULL for root-level tasks
- customFields? CustomFieldValueItem[] - Custom field values set on this task, in display order. Fields with no value are not included. Omitted entirely when the account's Custom Fields feature is disabled (external contact tokens only see fields with "Everyone" visibility). See GET /api/CustomFieldDefinition for the account's field definitions
- projectTitle? string - Title of the parent project
- accountTaskTypeIDFK? Signed32 - The task type (workflow) ID for this task
- percentComplete? decimal - Task completion percentage (0-100)
- dateDue? string - Task due date
avaza: TaskDiscussion
Discussion thread for a task, containing paginated comment/response messages
Fields
- taskID? Signed32 - The task this discussion belongs to
- startItem? int - The starting response ID for pagination
- projectIDFK? Signed32 - The project containing this task
- responses? TaskDiscussionResponse[] - List of discussion messages/comments
- pageSize? Signed32 - Number of messages returned per page
avaza: TaskDiscussionResponse
A single message in a task discussion, including author, body text, timestamps, attachments, and reply context
Fields
- createdByName? string - Display name of the message author
- unread? string - Whether this message is unread by the current user
- isInternalNote? boolean - Whether this is an internal note (not visible to external contacts)
- replyToFileType1? string -
- createdByUserIDFK? Signed32 - User ID of the message author
- attachments? TaskDiscussionResponseAttachment[] - List of file attachments on this message
- replyToFileProvider1? string -
- taskResponseID? int - Unique identifier for this discussion message
- canEdit? boolean - Whether the current user can edit this message (author + not system + active membership)
- replyToBody? string - Body of the message being replied to
- isEdited? boolean - True if the author has edited this message after posting; drives the (edited) UI indicator
- replyToFileID1? int -
- isActive? boolean - Whether this message is active (not deleted)
- dateCreatedString? string - Formatted creation date string
- replyToMessageID? int - The message ID this is a reply to, if any
- replyToCreatedByUserIDFK? int - User ID of the author of the message being replied to
- responseBody? string - The message content (may contain HTML)
- isSystem? boolean - Whether this is a system-generated message (e.g. status change notification)
- replyToFileName1? string -
- dateLastEditedUtc? string - Timestamp (UTC) of the most recent user edit. Null if never edited. Distinct from DateUpdated
- replyToDateCreated? string - Creation date of the message being replied to
- canDelete? boolean - Whether the current user can delete this message
- replyToUserName? string - Author name of the message being replied to
- replyToFilePreview1? string -
avaza: TaskDiscussionResponseAttachment
A file attachment on a task discussion message
Fields
- size? string - File size in human-readable format
- filename? string - Storage filename of the attachment
- preview? string - Preview image URL
- dateCreatedString? string - Formatted creation date of the attachment
- fileAttachmentID? int - Unique identifier for the file attachment
- uRL? string - Direct URL to the attachment
- name? string - Attachment name
- previewURL? string - URL for a preview/thumbnail of the attachment
- canPreview? boolean - Whether a preview is available for this attachment
- 'type? string - MIME type or category of the attachment
- provider? string - Storage provider code for the attachment
- fileExtension? string - File extension (e.g. '.pdf', '.png')
- publicFileURL? string - Public URL to download the attachment
avaza: TaskDropdownList
Fields
- pageNumber? Signed32 - Current page number (1 based)
- pageSize? Signed32 - Current page size
- hasMore? boolean - More records probably exist
- sections? TaskSectionGroup[] - List of Task grouped by Section
avaza: TaskDropdownSelection
Fields
- taskID? string -
- title? string -
avaza: TaskFileAttachmentItem
A file attachment linked to a task
Fields
- attachmentURL? string - Public URL to download the file
- attachmentPreviewURL? string - URL for in-browser preview of the file. Empty for non-previewable file types
- fileAttachmentIDFK? int - Foreign key to the FileAttachment record
avaza: TaskList
Paginated collection of tasks
Fields
- totalCount? Signed32 - Total number of tasks matching the filter criteria
- tasks? TaskDetails[] - List of task records for this page
- pageSize? Signed32 - Number of results per page
- pageNumber? Signed32 - Current page number (1-based)
avaza: TaskPriorityDetails
A task priority definition including code, display name, color, and sort order
Fields
- displayOrder? Signed32 - Sort order position for display (ascending)
- taskPriorityID? Signed32 - Unique identifier for the task priority
- priorityCode? string - Short code identifying this priority (e.g. "High", "Low")
- color? string - Hex color code for priority badge rendering
- name? string - Display name of the priority
avaza: TaskPriorityList
Collection of task priority definitions
Fields
- priorities? TaskPriorityDetails[] - List of task priority definitions configured in the account
avaza: TaskSectionGroup
Fields
- sectionTitle? string -
- tasks? TaskDropdownSelection[] -
avaza: TaskStatusDetails
A task status definition including status code, display name, color, sort order, associated task type, and whether it represents completion
Fields
- displayOrder? Signed32 - Sort order position for display
- accountTaskTypeIDFK? Signed32 - The task type this status belongs to
- taskStatusCode? string - Unique code identifying this task status
- color? string - Hex color code for the status display
- taskTypeName? string - Name of the parent task type
- name? string - Display name of the status
- isComplete? boolean - Whether this status represents a completed/done state
avaza: TaskStatusList
Collection of task status definitions
Fields
- statuses? TaskStatusDetails[] - List of task status definitions configured in the account
avaza: TaskTypeList
Collection of task type (workflow) definitions
Fields
- tasktypes? AccountTaskTypeDetails[] - List of task type definitions configured in the account
avaza: TaxComponent
A component of a compound tax rate, with its own code, name, percentage, and compound flag
Fields
- taxIDFK? Signed32 - The ID of the parent TaxItem this component belongs to
- percentage? decimal - The percentage rate for this individual tax component
- componentTaxCode? string - Short code identifying this tax component
- taxComponentID? Signed32 - Unique identifier for the tax component
- isCompound? boolean - Whether this component is compounded on top of the previous components (true) or applied to the original amount (false)
- name? string - Display name of the tax component
avaza: TaxItem
A tax rate with code, name, calculated percentage, and component breakdown for compound taxes
Fields
- taxCode? string - Short code identifying the tax rate
- taxComponents? TaxComponent[] - The individual components that make up a compound tax rate
- taxID? Signed32 - Unique identifier for the tax rate
- calculatedPercent? decimal - The effective tax percentage, calculated from all components for compound taxes
- name? string - Display name of the tax rate
avaza: TaxList
Collection of tax rates configured in the account
Fields
- taxes? TaxItem[] - The list of tax rates configured in the Avaza account
avaza: TimesheetApprovalBatchResponse
Response envelope for batch approve and reject endpoints
Fields
- results? TimesheetApprovalResultItem[] - One result entry per supplied TimeSheetEntryID, in the same order as the request
- summary? TimesheetApprovalSummary -
avaza: TimesheetApprovalRequest
Request body for approving a batch of timesheet entries by their IDs
Fields
- timeSheetEntryIDs? int[] - (Required) List of TimeSheetEntryIDs to approve. 1-500 unique positive integers
- approvalNote? string - (Optional) Free-text approval note. Max 1000 characters. Currently accepted but not persisted
avaza: TimesheetApprovalResultItem
Per-entry result for a batch approve or reject request
Fields
- status? string - Result status: Approved, Rejected, AlreadyApproved, AlreadyRejected, or Failed
- timeSheetEntryID? int - The TimeSheetEntryID supplied by the caller
- actedAt? string - UTC timestamp of the state change, populated only when the status changed as a result of this request
- actedByUserID? Signed32 - UserID of the caller, populated only when the status changed as a result of this request
- message? string - Human-readable failure message when Status=Failed
- errorCode? string - Machine-readable error code when Status=Failed
avaza: TimesheetApprovalSummary
Aggregated counts for a batch approve or reject request
Fields
- requested? Signed32 - Number of TimeSheetEntryIDs supplied in the request
- succeeded? Signed32 - Number of entries that successfully transitioned to the target status
- alreadyInTargetState? Signed32 - Number of entries that were already in the target status
- failed? Signed32 - Number of entries that could not be processed (forbidden, not found, ineligible, invoiced/paid, etc)
- processed? Signed32 - Number of entries the server inspected (always equals Requested)
avaza: TimesheetDetails
Full details of a single timesheet entry including user, project, category, approval, timer, and rate information
Fields
- email? string - Email address of the timesheet user
- startTimeUTC? string - The UTC start time of the entry, if start/end time tracking is enabled
- projectIDFK? Signed32 - The project ID this timesheet entry is associated with
- isInvoiced? boolean - Whether this timesheet entry has been included on an invoice
- endTimeLocal? string - The local end time of the entry, if start/end time tracking is enabled
- dateCreated? string - Date and time the record was created (UTC)
- rateAmount? decimal - Only visible to Admin role users
- timesheetCategoryIDFK? Signed32 - The timesheet category ID applied to this entry
- endTimeUTC? string - The UTC end time of the entry, if start/end time tracking is enabled
- viewTimesheetURL? string - URL to view this timesheet entry's day in the Avaza web application
- timesheetUserTimeZone? string - The IANA time zone ID of the user who owns the timesheet
- timesheetEntryID? int - Unique identifier for the timesheet entry
- invoiceLineItemIDFK? int - The invoice line item ID this entry was billed on, if invoiced
- costAmount? decimal - Only visible to Admin role users
- projectCode? string - Project code of the associated project, if project codes are enabled
- customerName? string - Name of the customer/company associated with the project
- timerStartedAtUTC? string - The UTC date and time at which the timer was started, if a timer is running
- notes? string - Free-text notes attached to this timesheet entry
- dateUpdated? string - Date and time the record was last updated (UTC)
- taskIDFK? Signed32 - The task ID this timesheet entry is linked to, if any
- lastname? string - Last name of the timesheet user
- taskTitle? string - Title of the task this entry is linked to
- duration? decimal - Duration of the timesheet entry in decimal hours
- isBillable? boolean - Whether this timesheet entry is billable to the client
- invoiceIDFK? int - The invoice Transaction ID this entry was billed on, if invoiced
- firstname? string - First name of the timesheet user
- customerIDFK? Signed32 - The customer/company ID associated with the project
- projectTitle? string - Title of the associated project
- hasTimer? boolean - Whether a timer is currently running on this entry
- startTimeLocal? string - The local start time of the entry, if start/end time tracking is enabled
- approvedBy? string - Name or email of the user who approved this entry
- entryDate? string - The date of the timesheet entry
- userIDFK? Signed32 - The ID of the user who owns this timesheet entry
- categoryName? string - Name of the timesheet category applied to this entry
- timesheetEntryApprovalStatusCode? string - Approval status of the entry. Values: Draft, Pending, Approved, Rejected, AutoApproved
- dateApproved? string - Date and time the entry was approved, if applicable
- customMetadata? string - Optional free-form metadata field for storing additional information. Maximum 1000 characters
avaza: TimesheetList
Paginated collection of timesheet entries
Fields
- totalCount? Signed32 - Total number of timesheet entries matching the filter criteria
- pageSize? Signed32 - Number of results per page
- pageNumber? Signed32 - The current page number (1-based)
- timesheets? TimesheetListDetails[] - The list of timesheet entries for the current page
avaza: TimesheetListDetails
A timesheet entry in a list response, including user, project, category, duration, status, timer state, and optional invoice linkage
Fields
- sectionIDFK? Signed32 - The section ID of the task this entry is linked to
- email? string - Email address of the timesheet user
- startTimeUTC? string - The UTC start time of the entry, if start/end time tracking is enabled
- projectIDFK? Signed32 - The project ID this timesheet entry is associated with
- isInvoiced? boolean - Whether this timesheet entry has been included on an invoice
- endTimeLocal? string - The local end time of the entry, if start/end time tracking is enabled
- dateCreated? string - Date and time the record was created (UTC)
- rateAmount? decimal - Only visible to Admin role users
- timesheetCategoryIDFK? Signed32 - The timesheet category ID applied to this entry
- endTimeUTC? string - The UTC end time of the entry, if start/end time tracking is enabled
- viewTimesheetURL? string - URL to view this timesheet entry's day in the Avaza web application
- timesheetUserTimeZone? string - The IANA time zone ID of the user who owns the timesheet
- timesheetEntryID? int - Unique identifier for the timesheet entry
- invoiceLineItemIDFK? int - The invoice line item ID this entry was billed on, if invoiced
- costAmount? decimal - Only visible to Admin role users
- projectCode? string - Project code of the associated project, if project codes are enabled
- customerName? string - Name of the customer/company associated with the project
- timerStartedAtUTC? string - The UTC date and time at which the timer was started, if a timer is running
- notes? string - Free-text notes attached to this timesheet entry
- sectionTitle? string - Title of the section the linked task belongs to
- dateUpdated? string - Date and time the record was last updated (UTC)
- taskIDFK? Signed32 - The task ID this timesheet entry is linked to, if any
- lastname? string - Last name of the timesheet user
- taskTitle? string - Title of the task this entry is linked to
- duration? decimal - Duration of the timesheet entry in decimal hours
- isBillable? boolean - Whether this timesheet entry is billable to the client
- invoiceIDFK? int - This InvoiceIDFK is only included when the api get parameter includeInvoiceDetails==true
- firstname? string - First name of the timesheet user
- customerIDFK? Signed32 - The customer/company ID associated with the project
- projectTitle? string - Title of the associated project
- hasTimer? boolean - Whether a timer is currently running on this entry
- startTimeLocal? string - The local start time of the entry, if start/end time tracking is enabled
- approvedBy? string - Name or email of the user who approved this entry
- entryDate? string - The date of the timesheet entry
- userIDFK? Signed32 - The ID of the user who owns this timesheet entry
- categoryName? string - Name of the timesheet category applied to this entry
- timesheetEntryApprovalStatusCode? string - Approval status of the entry. Values: Draft, Pending, Approved, Rejected, AutoApproved
- dateApproved? string - Date and time the entry was approved, if applicable
- customMetadata? string - Optional free-form metadata field for storing additional information. Maximum 1000 characters
avaza: TimesheetRejectionRequest
Request body for rejecting a batch of timesheet entries by their IDs
Fields
- timeSheetEntryIDs? int[] - (Required) List of TimeSheetEntryIDs to reject. 1-500 unique positive integers
- rejectionReason? string - (Optional) Free-text rejection reason included in the rejection notification email. Max 1000 characters
- sendNotifications? boolean - (Optional) When true (default), sends the standard rejection notification email to each affected timesheet user. Set to false to suppress emails
avaza: TimesheetSummaryGroup
A group within aggregated timesheet data, representing totals for one grouping dimension (e.g. a specific project or user)
Fields
- groupName? string - The display name of the group value (e.g. project title, user name)
- totalHours? decimal - Total hours for this group
- billableHours? decimal - Total billable hours for this group
- groupID? string - The ID of the group value (e.g. Project ID, User ID)
- groupData? TimesheetSummaryGroup[] - Nested group data for the next grouping level, if applicable
avaza: TimesheetSummaryResult
Aggregated timesheet statistics for a date range, including total hours, billable hours, and grouped sub-totals
Fields
- userID? Signed32[] - The list of user IDs included in this summary
- groupingLevels? string[] - The grouping dimensions applied to this summary result
- entryDateFrom? string - The start of the date range used for this summary
- entryDateTo? string - The end of the date range used for this summary
- totalHours? decimal - Total hours across all timesheet entries in the result set
- billableHours? decimal - Total billable hours across all timesheet entries in the result set
- groupData? TimesheetSummaryGroup[] - The grouped data rows, each representing totals for a grouping dimension value
avaza: UninvoicedExpenseFilter
Filters for selecting uninvoiced chargeable expenses. Only Approved/AutoApproved, chargeable, not-yet-invoiced expenses of the invoice's customer are ever selected
Fields
- includePerson? boolean - Include the person's name in generated descriptions. Default true
- dateFrom? string - Optional. Only include expenses dated on or after this date
- includeProjectName? boolean - Include the project name in generated descriptions. Default true
- includeCategory? boolean - Include the expense category in generated descriptions. Default true
- projectIDs? Signed32[] - Project IDs to pull uninvoiced expenses from. When omitted, all of the customer's uninvoiced chargeable expenses are included (with or without a project)
- grouping? string - How to group expenses into line items: NoGrouping (one line per expense) or GroupByExpenseCategory (one line per project + category + tax). Default NoGrouping
- includeNotes? boolean - Include expense notes in generated descriptions. Default true
- userIDs? Signed32[] - Optional. Only include expenses submitted by these user IDs
- includeDate? boolean - Include the expense date in generated descriptions. Default true
- includeTripName? boolean - Include the expense report (trip) name in generated descriptions. Default false
- dateTo? string - Optional. Only include expenses dated on or before this date
avaza: UninvoicedFixedAmountFilter
Filters for selecting uninvoiced fixed amounts. Each fixed amount always becomes its own line item
Fields
- onlyCompletedTasks? boolean - When true, only fixed amounts on completed tasks are included. Default false
- includeProjectName? boolean - Include the project name in generated descriptions. Default true
- projectIDs? Signed32[] - Project IDs to pull uninvoiced fixed amounts from. When omitted, all projects of the invoice's customer are included
- includeAssignedUser? boolean - Include the task's assigned users in generated descriptions. Default true
- includeTask? boolean - Include the task title in generated descriptions. Default true
- includeNotes? boolean - Include fixed amount notes in generated descriptions. Default true
avaza: UninvoicedItemsRequest
Request for previewing or adding ALL matching uninvoiced records to an invoice in one call. At least one of Time / Expenses / FixedAmounts must be provided; a present section opts that record type in. Only currently-eligible records are selected, so the operation is naturally idempotent - a repeat call selects nothing
Fields
- expenseExchangeRates? ExpenseExchangeRate[] - Optional exchange-rate overrides for expenses in a currency different from the invoice currency
- expenses? UninvoicedExpenseFilter -
- sendWebhooks? boolean - If true (add only; ignored by preview), fires invoice_updated plus timesheet_updated/expense_updated webhook events for linked records. Defaults to false
- time? UninvoicedTimeFilter -
- invoiceID int - The Transaction ID of the invoice whose customer's uninvoiced records should be selected. The invoice must not be Void
- fixedAmounts? UninvoicedFixedAmountFilter -
avaza: UninvoicedSummaryGroup
Aggregated uninvoiced billable value for one customer (or one project)
Fields
- currencyCode? string - The customer's currency. Uninvoiced time and fixed amounts are expressed in this currency
- companyName? string - The customer company name
- projectTitle? string - The project title, when grouping by project
- expenseCount? Signed32 - Number of uninvoiced chargeable expenses (Approved/AutoApproved)
- uninvoicedTimeAmount? decimal - Indicative uninvoiced time value (sum of duration x billable rate, before rounding rules) in the customer's currency. Use PreviewUninvoicedItems for exact invoice amounts
- projectIDFK? Signed32 - The project, when grouping by project. Null for expenses without a project
- uninvoicedFixedAmount? decimal - Total uninvoiced fixed amount value in the customer's currency
- uninvoicedHours? decimal - Total uninvoiced billable hours
- uninvoicedExpenseAmount? decimal - Uninvoiced chargeable expense value in the ACCOUNT's base currency (before markup). Exact converted-with-markup amounts come from PreviewUninvoicedItems
- companyIDFK? Signed32 - The customer company
- fixedAmountCount? Signed32 - Number of uninvoiced fixed amounts
- timesheetEntryCount? Signed32 - Number of uninvoiced billable timesheet entries (Approved/AutoApproved)
avaza: UninvoicedSummaryResult
Uninvoiced work summary across customers or projects
Fields
- groups? UninvoicedSummaryGroup[] - One row per customer (or per project when GroupBy=Project) that has any uninvoiced billable value
- baseCurrencyCode? string - The account's base currency, which UninvoicedExpenseAmount values are expressed in
avaza: UninvoicedTimeFilter
Filters for selecting uninvoiced timesheet entries. Only billable, Approved/AutoApproved, not-yet-invoiced entries of the invoice's customer are ever selected; entries with a running timer are skipped and reported
Fields
- taskIDs? Signed32[] - Optional. Only include time logged against these task IDs
- includePerson? boolean - Include the person's name in generated descriptions. Default true
- includeProjectName? boolean - Include the project name in generated descriptions. Default true
- includeCategory? boolean - Include the timesheet category in generated descriptions. Default true
- grouping? string - How to group entries into line items: NoGrouping (one line per entry), GroupByProject, GroupByProjectCategory, GroupByProjectUser, GroupByProjectSection or GroupByProjectTask. Grouped lines get the total duration and a blended rate. Default NoGrouping
- categoryIDs? Signed32[] - Optional. Only include time in these timesheet category IDs
- dateFrom? string - Optional. Only include entries on or after this date
- includeStartEndTime? boolean - Include start/end times in generated descriptions (entries with start/end times only). Default true
- projectIDs? Signed32[] - Project IDs to pull uninvoiced time from. When omitted, all billable projects of the invoice's customer are included
- includeTask? boolean - Include the task title in generated descriptions. Default true
- includeNotes? boolean - Include entry notes in generated descriptions. Default true
- userIDs? Signed32[] - Optional. Only include time logged by these user IDs
- includeDate? boolean - Include the entry date in generated descriptions. Default true
- dateTo? string - Optional. Only include entries on or before this date
avaza: UpdateCompany
Request model for updating an existing company. Only fields in FieldsToUpdate are modified
Fields
- taxNumberLabel? string - Updated label printed next to the tax number on invoices, e.g. "VAT No." (max 100 chars). Blank clears it so the invoice template's default label or "Tax Number" is used
- billingAddressLine? string - The updated street address line for the company's billing address
- website? string - The company's updated website URL
- fieldsToUpdate? string[] - A list of field names that should be updated. Only the fields named here will be changed
- billingAddressState? string - The updated state or province for the company's billing address
- companyID? Signed32 - The ID of the company to update. Required
- sendWebhooks? boolean - If true, fires the company_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- comments? string - Updated internal notes or comments about the company
- billingCountryCode? string - The updated ISO 2-letter country code for the company's billing address
- billingAddressPostCode? string - The updated postcode or ZIP code for the company's billing address
- billingAddressCity? string - The updated city for the company's billing address
- billingAddress? string - The updated full formatted billing address string. If set, overrides the individual address fields
- companyName? string - The new name for the company
- customFields? CustomFieldValueInput[] - Custom field values to set. Only applied when "CustomFields" is included in FieldsToUpdate. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Multi-select items REPLACE the field's whole selection; "Value": null clears a field. Fields not referenced keep their current values. Custom field definitions/options cannot be created or modified via the API
- phone? string - The company's updated primary phone number
- taxNumber? string - The company's updated tax registration number
- fax? string - The company's updated fax number
avaza: UpdatedEstimate
Request model for updating an existing estimate. Only fields in FieldsToUpdate are modified. When LineItems is included, existing lines not in the array are deleted
Fields
- exchangeRate? decimal - Exchange rate is only valid for estimates in currency other than default account currency
- lineItems? UpdatedEstimateLineItem[] - When "LineItems" is included in FieldsToUpdate: items with a matching EstimateLineItemID are updated, items without an EstimateLineItemID are added, and existing line items not present in this collection are deleted
- fieldsToUpdate string[] - Required: The collection of Field Names you wish to update. Possible Values: EstimateNumber, CustomerPONumber, DateIssued, DueDate, Subject, Notes, EstimateTaxConfigCode, ExchangeRate, InvoiceTemplateIDFK, LineItems
- sendWebhooks? boolean - If true, fires the estimate_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- estimateTaxConfigCode? string - Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). Changing this triggers recalculation of tax on all line items
- estimateID int - The ID of the Estimate to update
- subject? string - Estimate Subject in plain UTF8 text. (no HTML). 255 characters max
- estimateNumber? string - Pass a string or integer. Must remain unique within the account. Max 30 characters
- customerPONumber? string - Plain UTF8 text. 100 characters max
- dateIssued? string - The Date the Estimate is issued. Date should be specified as local date
- invoiceTemplateIDFK? Signed32 - The template to render the estimate with (an INV or EST type template). Use GET /api/InvoiceTemplate to look up template IDs by name. Required when InvoiceTemplateIDFK is listed in FieldsToUpdate
- dueDate? string - The Expiry Date of the Estimate. Must be greater than or equal to the Issue Date. Pass null to clear the Expiry Date
- notes? string - Estimate Notes in plain UTF8 text. (no HTML). Max 2000 characters
avaza: UpdatedEstimateLineItem
A line item to be included when updating an estimate
Fields
- unitPrice decimal - The unit price for the lineitem
- description? string - Plain UTF8 text. (no HTML). 5000 characters max
- discount? decimal - Enter 10.5 to give a 10.5% discount
- estimateLineItemID? int - Optional ID of an existing EstimateLineItem that should be retained and updated. Leave blank (or 0) to add a new line item
- taxIDFK Signed32 - Must match an existing Tax ID in your account
- inventoryItemIDFK int - The ID of the InventoryItem this line item is linked to. Must belong to your account
- quantity decimal - The quantity for the line item
avaza: UpdatedInvoice
Request model for updating an existing invoice. Only fields in FieldsToUpdate are modified. When LineItems is included, existing lines not in the array are deleted
Fields
- exchangeRate? decimal - Exchange rate is only valid for invoices in currency other than default account currency. If not specified it will get the market rate based on the Date Issued
- lineItems? UpdatedInvoiceLineItem[] -
- fieldsToUpdate string[] - Required: The collection of Field Names you wish to update. Possible Values: CustomerPONumber, DateIssued, PaymentTerms, DueDate, Subject, Notes, TransactionTaxConfigCode, ExchangeRate, InvoiceTemplateIDFK, InvoiceNumber, LineItems
- sendWebhooks? boolean - If true, fires the invoice_updated webhook event to any subscribed endpoints (and timesheet_updated for any timesheet rows whose invoice link changed). Defaults to false to preserve existing integration behaviour
- paymentTerms? Signed32 -
- subject? string - Invoice Subject in plain UTF8 text. (no HTML). 255 characters max
- transactionID int - The ID of the Invoice to update
- customerPONumber? string - Plain UTF8 text. 100 characters max
- dateIssued? string - The Date the Invoice is issued. Date should be specified as local date
- invoiceTemplateIDFK? Signed32 - The invoice template to render the invoice with (an INV or EST type template). Use GET /api/InvoiceTemplate to look up template IDs by name. Required when InvoiceTemplateIDFK is listed in FieldsToUpdate
- invoiceNumber? string - Pass a string or integer. If an integer is passed then the largest integer will be use as the seed to auto generate the next invoice number in the sequence
- dueDate? string - If the Due Date is specified then Payment Terms will be set to -1 (Custom). Otherwise DueDate will be auto calculated based on the provided IssueDate and Payment Term. Due Date must be greater than or equal to Issue Date
- notes? string - Invoice Notes in plain UTF8 text. (no HTML). Max 2000 characters
- transactionTaxConfigCode? string - Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left set to null/emptystring it will use the account default
avaza: UpdatedInvoiceLineItem
A line item to be included when updating an invoice
Fields
- transactionLineItemID? int - Optional ID of exisiting TransactionLineItem that should be retained and updated
- expenseIDs? int[] - Optional, NEW line items only. IDs of uninvoiced chargeable Expenses (Approved/AutoApproved, invoice's customer) to link to this line item; multiple expenses on one line must share the same tax. Rejected on existing line items
- unitPrice? decimal - The unit price for the lineitem. Required unless this is a NEW line item (no TransactionLineItemID) linking source records, in which case it is calculated from the linked records when omitted
- timesheetEntryIDs? int[] - Optional, NEW line items only (omit TransactionLineItemID). IDs of uninvoiced Timesheet entries to link to (invoice with) this line item. Same rules as invoice creation: entries must be billable, Approved/AutoApproved, not already invoiced, timer-free, belong to the invoice's customer, and share one project. InventoryItemIDFK/ProjectIDFK are derived on linked lines. Rejected on existing line items
- description? string - Plain UTF8 text. (no HTML)
- discount? decimal - Enter 10.5 to give a 10.5% discount
- taxIDFK? Signed32 - Must match an existing Tax ID
- projectIDFK? Signed32 - Optional. Project ID of an Avaza Project that belongs to this customer, so line item is attributed to that Project for reporting
- inventoryItemIDFK int - The ID of the InventoryItem this line item is linked to
- quantity? decimal - The quantity for the line item. Required unless this is a NEW line item (no TransactionLineItemID) linking source records, in which case it is calculated from the linked records when omitted
- fixedAmountIDs? int[] - Optional, NEW line items only. ID of an uninvoiced Fixed Amount to link to this line item (maximum one per line item). Rejected on existing line items
avaza: UpdateExpense
Request model for updating an existing expense entry. Only fields in FieldsToUpdate are modified
Fields
- isReimbursable? boolean - Defaults to false if not provided
- expenseCategoryIDFK? Signed32 - The expense category to link the Expense to
- exchangeRate? decimal - Optional (Only relevant if the expense currency is different to your account currency. If not provided we will look up the market exchange rate for you based on the expense date.) Exchange Rate = Expense Currency Amount / Base Currency Amount (e.g. if Expense currency is in AUD, and Base Currency is in USD, Exchange Rate = AUD $140 / USD $100 = 1.4)
- fieldsToUpdate string[] - Array of field names to update. Only listed fields will be modified
- expenseID int - The ID of the expense to update (required)
- taxIDFK? Signed32 - Avaza Tax ID the expense belongs to
- sendWebhooks? boolean - If true, fires the expense_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK? Signed32 - The Avaza project ID to associate the Expense with
- taskIDFK? Signed32 - (optional) TaskID of a Task to link the new Expense to. A Customer and Project must be provided also
- amount? decimal - Expense Amount (Required). Can be negative, e.g. to record a refund that reduces project cost and credits the client's next invoice
- merchantTaxNumber? string - A Tax number identifier for the merchant
- quantity? decimal - Conditional - available for expenses that are assigned a unit priced based expense category. e.g Mileage. A negative Quantity gives a negative Amount
- groupTripName? string - Links the expense to a Grouping/Trip report. If no matching name found, creates a new Group/Trip Report name
- expensePaymentMethodIDFK? Signed32 - (Optional) ID of Expense Payment Method
- verifyAndSave? boolean - Pass false if creating a draft expense. True otherwise
- isChargeable? boolean - aka Billable. Defaults to false if not provided. If set to true, a CustomerIDFK or CustomerName must be provided
- currencyCode? string - A 3-letter ISO CurrencyCode for the expense currency. (e.g. USD). If not provided, defaults to the Account base currency
- customerIDFK? Signed32 - The Avaza Customer ID to associate the Expense with
- expenseDate? string - The date of the expense entry
- merchant? string - The name of the merchant
- notes? string - Expense Notes
- transactionTaxConfigCode? string - Optional - Enter "INC" if the tax amount is included in the expense amount otherwise enter "EX" when the amount exlcudes the tax. Defaults to "Ex". The tax amount on the expense will be autocalculated
- fileAttachmentIDs? int[] - Array of File Attachment IDs to associate with this expense. The files need to have already been uploaded. Currently only accepts a single file
avaza: UpdateFixedAmount
Payload for updating an existing fixed-amount billing entry. Only fields named in FieldsToUpdate are applied
Fields
- fieldsToUpdate? string[] - Names of the fields to apply from this payload. Valid values: Amount, InventoryItemIDFK, Notes. Fields not named here keep their current values
- amount? decimal - The fixed billing amount, in the currency of the customer the record's project belongs to. Cannot be cleared
- inventoryItemIDFK? int - The inventory item used for this fixed amount. Must exist in the account. Cannot be cleared
- fixedAmountID? Signed32 - The ID of the fixed amount to update. Must belong to the authenticated account
- notes? string - Additional notes, maximum 255 characters. Naming Notes in FieldsToUpdate with a null value clears it
avaza: UpdateProjectMember
Request model for updating a project member's rates, budget, or permissions. Only fields in FieldsToUpdate are modified
Fields
- isTimesheetApprovalRequired? boolean -
- canUpdateTasks? boolean -
- fieldsToUpdate string[] - A string array of field names to be updated
- timesheetRateUpdateOption? string - Controls whether updated rates are applied to existing timesheet entries for this member. Possible values: "new" (default, do not update existing timesheets), "uninvoiced" (update all existing uninvoiced timesheets). Only applies when RateAmount or CostAmount is included in FieldsToUpdate
- projectIDFK Signed32 - Required. The ProjectID
- isTimesheetApprover? boolean -
- rateAmount? decimal - A new Rate Amount. Defaults to null
- isExpenseApprover? boolean -
- budgetAmount? decimal - A new Budget Amount. Defaults to null
- scheduleRateUpdateOption? string - Controls whether updated rates are applied to existing schedule bookings for this member. Possible values: "new" (default, only new bookings), "all" (all existing bookings), "active" (bookings with end date in the future). Only applies when RateAmount or CostAmount is included in FieldsToUpdate
- canDeleteTasks? boolean -
- canCommentOnTasks? boolean -
- canCreateTasks? boolean -
- costAmount? decimal - A new Cost Amount. Defaults to null
- userIDFK Signed32 - Required. The UserID
- isTimesheetAllowed? boolean -
avaza: UpdateProjectModel
Request model for updating an existing project. Only fields in FieldsToUpdate are modified
Fields
- projectStatusCode? string - Update the project status (string, optional): (Possible values: NotStarted, InProgress, Complete, OnHold)
- fieldsToUpdate? string[] - A string array of field names to be updated. Only listed fields will be modified
- isTaskRequiredOnTimesheet? boolean - Whether timesheets entered against this project require a task to be selected
- timesheetApprovalRequiredbyDefault? boolean - Whether timesheet approval should be required by default for newly added project members
- timesheetRateUpdateOption? string - Controls whether updated rates are applied to existing timesheet entries when ProjectBillableTypeCode changes. Possible values: "new" (do not update existing timesheets), "uninvoiced" (update all existing uninvoiced timesheets). Defaults to "uninvoiced" if not specified, to preserve backwards compatibility. Only applies when ProjectBillableTypeCode is included in FieldsToUpdate
- sendWebhooks? boolean - If true, fires the project_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- budgetHours? decimal - Hours budget allocated to the project
- projectID? Signed32 - The ID of the Project to update
- projectBillableTypeCode? string - The billing method of the project. (string, optional) Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly
- endDate? string - Planned end date for the project
- budgetAmount? decimal - Monetary budget allocated to the project
- startDate? string - Planned start date for the project
- scheduleRateUpdateOption? string - Controls whether updated rates are applied to existing schedule bookings when ProjectBillableTypeCode changes. Possible values: "new" (default, only new bookings), "all" (all existing bookings), "active" (bookings with end date in the future). Only applies when ProjectBillableTypeCode is included in FieldsToUpdate
- projectNotes? string - (optional) Any descriptive notes about the project. (2000 characters max)
- projectBudgetTypeCode? string - The project budgeting type. (string, optional) Possible values: NoBudget, PersonHours, ProjectFees, ProjectHours, CategoryHours
- customFields? CustomFieldValueInput[] - Custom field values to set. Only applied when "CustomFields" is included in FieldsToUpdate. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Multi-select items REPLACE the field's whole selection; "Value": null clears a field. Fields not referenced keep their current values. Custom field definitions/options cannot be created or modified via the API
- projectTitle? string - (optional) An updated project title. (255 characters max)
- projectCategoryIDFK? Signed32 - The project category ID, if categorised
- projectTags? ProjectTagInput[] - Desired final set of tags on the project (replace semantics). Object array; each item has a Name. Only applied when "ProjectTags" is present in FieldsToUpdate. An empty array removes all of the project's tag associations. Names are matched case-insensitively against the account tag pool and created on first use. (255 characters max per name)
avaza: UpdateTask
Request model for updating an existing task. Only fields in FieldsToUpdate are modified
Fields
- estimatedEffort? decimal - Decimal hours
- sectionIDFK? Signed32 - The section (task group) this task belongs to
- taskID Signed32 - Unique identifier for the task
- fieldsToUpdate string[] - Array of field names to update. Only listed fields will be modified
- description? string - Task description (may contain HTML)
- fileAttachmentIDsToAdd? int[] - FileAttachmentIDs (returned from prior /api/FileAttachment uploads) to newly link to this task. Each ID must have been created by the current user and not yet linked to any entity
- sendWebhooks? boolean - If true, fires the matching webhook event (e.g. task_updated) to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- taskStatusCode? string - Current task status code
- dateStart? string - Task start date
- title? string - Task title/name
- taskPriorityCode? string - Task priority. Values: None, Low, Medium, High, Urgent
- parentTaskIDFK? Signed32 - Re-parent this task. Set to a valid TaskID (same project) to make it a subtask; set to null (or 0) to promote it back to a root-level task. Applied only when "ParentTaskIDFK" is included in FieldsToUpdate. When set, the task inherits the parent's section, and SubtaskCount/SubtaskProgress/DisplayOrder are recalculated server-side
- customFields? CustomFieldValueInput[] - Custom field values to set. Only applied when "CustomFields" is included in FieldsToUpdate. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Multi-select items REPLACE the field's whole selection; "Value": null clears a field. Fields not referenced keep their current values. Custom field definitions/options cannot be created or modified via the API
- percentComplete? Signed32 - Task completion percentage (0-100)
- dateDue? string - Task due date
- tags? NewTag[] - List of tags to apply to this task
- assignedToUserIDFK? Signed32[] - List of user IDs to assign to this task
avaza: UpdateTimesheetModel
Request model for updating an existing timesheet entry. Only fields in FieldsToUpdate are modified. ProjectIDFK is always required
Fields
- timeSheetEntryID int - The ID of the timesheet entry to update
- fieldsToUpdate string[] - Array of field names to update. Only listed fields will be modified
- hasStartEndTime? boolean - If true, the start time is taken from the time component of EntryDate and the end time is calculated by adding Duration
- sendWebhooks? boolean - If true, fires the timesheet_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour
- projectIDFK Signed32 - The project ID for the timesheet entry. Always required
- taskIDFK? Signed32 - The task ID to link this entry to, if any
- entryDate? string - The date of the timesheet entry
- timesheetCategoryIDFK? Signed32 - The timesheet category ID to apply to this entry
- duration? decimal - Duration of the timesheet entry in decimal hours
- notes? string - Free-text notes for the timesheet entry
- customMetadata? string - Optional. free nvarchar field available via Api to store any additional metadata against a timesheet. We suggest you use Json or your preferred serialisation format. 1000 characters max
avaza: UpdateUserProfile
Request body for PUT /api/UserProfile. Only fields named in FieldsToUpdate are written
Fields
- fieldsToUpdate? string[] - Allowlist of field names to update (case-insensitive, matches JSON keys). Other fields in the payload are ignored
- email? string - New email address. Must be a valid format and unique within the account. If changed, the GlobalUser link is rebuilt
- positionTitle? string - New position title. Max 100 characters
- sendInviteEmail? boolean - Only meaningful when Roles is in FieldsToUpdate. Drives invite-email behaviour after roles are replaced — see spec matrix
- defaultBillableRate? decimal - New default billable rate. Team members only. Non-negative
- lastname? string - New last name. Max 100 characters
- roles? string[] - When included in FieldsToUpdate, fully replaces the existing role set (pass [] to remove all). Each entry must be a RoleCode that is valid for the user's existing type (UserAssignable=1 for team members, CustomerAssignable=1 for customer contacts)
- mobile? string - New mobile. Max 50 characters
- firstname? string - New first name. Max 100 characters
- timeZone? string - New Windows Time Zone ID
- customFields? CustomFieldValueInput[] - Custom field values to set. Only applied when "CustomFields" is included in FieldsToUpdate. Identify each item by CustomFieldDefinitionID (preferred) or Name (case-insensitive). Multi-select items REPLACE the field's whole selection; "Value": null clears a field. Fields not referenced keep their current values. Custom field definitions/options cannot be created or modified via the API
- userID? Signed32 - UserID of the existing, non-archived UserProfile to update
- phone? string - New phone. Max 50 characters
- defaultCostRate? decimal - New default cost rate. Team members only. Non-negative
avaza: UploadFileAttachmentQueries
Represents the Queries record for the operation: uploadFileAttachment
Fields
- linkToEntityType? string - Optional. One of: "Task", "Expense", "Estimate", "Invoice". When supplied, linkToEntityId must also be supplied
- linkToEntityId? int - Optional. The target entity's primary key. Required when linkToEntityType is supplied
avaza: UserDetails
A user/team member record with profile information, availability hours, billing rates, roles, and tags
Fields
- tuesdayAvailableHours? decimal - Available working hours on Tuesdays
- email? string - User's email address
- positionTitle? string - User's job title or position
- defaultBillableRate? decimal - The user's default billing rate per hour
- wednesdayAvailableHours? decimal - Available working hours on Wednesdays
- companyName? string - Name of the user's associated company
- isTeamMember? boolean - Whether the user is an internal team member (true) or external contact (false)
- userID? Signed32 - Unique identifier for the user
- phone? string - User's phone number
- defaultCostRate? decimal - The user's default cost rate per hour
- saturdayAvailableHours? decimal - Available working hours on Saturdays
- tags? UserTagDetails[] - List of tags applied to the user for categorisation
- lastname? string - User's last name
- accountIDFK? Signed32 - The Avaza account this user belongs to
- roles? RoleDetails[] - List of security roles assigned to the user
- companyIDFK? Signed32 - The company the user is associated with (for external contacts)
- initials? string - The user's initials, shown wherever no profile picture is set (1-3 characters, editable by the user)
- mobile? string - User's mobile phone number
- thursdayAvailableHours? decimal - Available working hours on Thursdays
- firstname? string - User's first name
- mondayAvailableHours? decimal - Available working hours on Mondays
- timeZone? string - Windows Timezone ID
- customFields? CustomFieldValueItem[] - Custom field values set on this user, in display order (Team Member custom fields for team members, Contact custom fields for customer contacts). Fields with no value are not included. Omitted entirely when the account's Custom Fields feature is disabled (external contact tokens only see fields with "Everyone" visibility). See GET /api/CustomFieldDefinition for the account's field definitions
- profilePicURL? string - Public URL of the user's profile picture (512x512 JPEG), or null when the user has no picture. Read only
- iANATimezone? string - IANA tz database timezone name
- sundayAvailableHours? decimal - Available working hours on Sundays
- fridayAvailableHours? decimal - Available working hours on Fridays
avaza: UserList
Collection of users/team members in the Avaza account
Fields
- users? UserDetails[] - The list of user records
avaza: UserProfileIDRequest
Request body for POST /api/UserProfile/Archive and POST /api/UserProfile/Unarchive
Fields
- userID? Signed32 - UserID of the existing UserProfile to archive or unarchive
avaza: UserTagDetails
A tag applied to a user for categorisation, with tag ID and name
Fields
- userTagID? Signed32 - Unique identifier for the user tag
- userTagName? string - Display name of the user tag
avaza: WebhookDetails
A webhook subscription including the subscribed event, callback URL, and owner user
Fields
- subscriptionID? Signed32 - Unique identifier for the webhook subscription
- notificationURL? string - The callback URL that receives webhook POST notifications
- userIDFK? Signed32 - The user ID who created this webhook subscription
- eventCode? string - The event type this webhook is subscribed to (e.g. 'task.created', 'invoice.created')
avaza: WebhookList
Collection of active webhook subscriptions
Fields
- webhooks? WebhookDetails[] - The list of webhook subscriptions
Import
import ballerinax/avaza;Metadata
Released date: about 15 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 44
Current verison: 1
Weekly downloads
Keywords
Vendor/Avaza
Area/Productivity & Collaboration
Type/Connector
Avaza
Contributors