Avaza

Avaza / Avaza

collaboration

Welcome to the autogenerated documentation & test tool for Avaza's API.

API Security & Authentication
Authentication options include OAuth2 Implicit and Authorization flows. All connections should be encrypted over SSL/TLS

To use the Api from your own app you will need us to issue you an App Client ID and Secret. You can get in touch to request one, and provide us with a redirect URI.

OAuth2 Authorization endpoint: https://any.avaza.com/oauth2/authorize
OAuth2 Token endpoint: https://any.avaza.com/oauth2/token
Base URL for subsequent API Requests: https://api.avaza.com/

Blogpost about authenticating with Avaza's API: https://www.avaza.com/avaza-api-oauth2-authentication/
Blogpost on using Avaza's webhooks: https://www.avaza.com/avaza-api-webhook-notifications/
We currently issue Access Tokens that last 1 day, and Refresh tokens that last 180 days
The Api currently assumes initial authentication by an Admin role user. In the future we will add support for access by other roles.

Support
For API Support, and to request access please contact Avaza Support Team via our support chat.

User Contributed Libraries:
Graciously contributed by 3rd party users like you.
Note these are not tested or endorsesd by Avaza. We encourage you to review before use, and use at own risk.

- PHP OAuth Client Package for Azava API (by Debiprasad Sahoo)

Resources

Account

GET

/api/Account

Account Details

Responses

200Success

Body

Name	Data Type	Description
`AccountDetails`	object

Properties

`hasStartEndTimesheets`	boolean
`has24HourTimesheetFormat`	boolean
`WeeklyTimesheetReminder`	boolean
`TimesheetDisplayFormatCode`	string
`TimesheetDayOfWeek`	integer
`Subdomain`	string
`LockApprovedTimesheets`	boolean
`CompanyName`	string
`AccountID`	integer

401Unauthorized

Company

GET

/api/Company/{id}

Gets Company by Company ID

Request

Path

Name	Data Type	Description
`id`	long	Company ID Number

Responses

200Success

Body

Name	Data Type	Description
`Company`	object

Properties

website string

TaxNumber string

Phone string

Fax string

DefaultTradingTermIDFK integer

DateUpdated dateTime

DateCreated dateTime

CurrencyCode string

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyName string

CompanyID integer

Comments string

BillingCountryCode string

BillingAddressState string

BillingAddressPostCode string

BillingAddressLine string

BillingAddressCity string

BillingAddress string

401Unauthorized

404Not Found

GET

/api/Company

Gets list of Companies

Request

Query

Name	Data Type	Description
`Sort`	string
`pageNumber`	integer	1 based page number to retrieve
`pageSize`	integer	Number of results per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`CompanyList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

Companies array [Company]

Company object

Properties

website string

TaxNumber string

Phone string

Fax string

DefaultTradingTermIDFK integer

DateUpdated dateTime

DateCreated dateTime

CurrencyCode string

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyName string

CompanyID integer

Comments string

BillingCountryCode string

BillingAddressState string

BillingAddressPostCode string

BillingAddressLine string

BillingAddressCity string

BillingAddress string

401Unauthorized

POST

/api/Company

Create a Company

Request

Body

Name	Data Type	Description
`NewCompany`	object

Properties

`website`	string
`TaxNumber`	string
`Phone`	string
`Fax`	string
`CurrencyCode`	string
`CompanyName`	string
`Comments`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

Responses

200Success

Body

Name	Data Type	Description
`Company`	object

Properties

website string

TaxNumber string

Phone string

Fax string

DefaultTradingTermIDFK integer

DateUpdated dateTime

DateCreated dateTime

CurrencyCode string

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyName string

CompanyID integer

Comments string

BillingCountryCode string

BillingAddressState string

BillingAddressPostCode string

BillingAddressLine string

BillingAddressCity string

BillingAddress string

401Unauthorized

PUT

/api/Company

Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.

Request

Body

Name	Data Type	Description
`UpdateCompany`	object

Properties

`website`	string
`TaxNumber`	string
`Phone`	string
`FieldsToUpdate`	array [string]
`Fax`	string
`CompanyName`	string
`CompanyID`	integer
`Comments`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

Responses

200OK

Body

Name	Data Type	Description
`Company`	object

Properties

website string

TaxNumber string

Phone string

Fax string

DefaultTradingTermIDFK integer

DateUpdated dateTime

DateCreated dateTime

CurrencyCode string

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyName string

CompanyID integer

Comments string

BillingCountryCode string

BillingAddressState string

BillingAddressPostCode string

BillingAddressLine string

BillingAddressCity string

BillingAddress string

Contact

GET

/api/Contact/{id}

Gets Contact by Contact ID

Request

Path

Name	Data Type	Description
`id`	long	Contact ID number

Responses

200Success

Body

Name	Data Type	Description
`CompanyContact`	object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

401Unauthorized

404Not Found

GET

/api/Contact

Gets list of Contacts

Request

Query

Name	Data Type	Description
`CompanyIDFK`	integer
`Sort`	string
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`ContactList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

401Unauthorized

POST

/api/Contact

Create a Contact

Request

Body

Name	Data Type	Description
`NewCompanyContact`	object

Properties

`UpdateExisting`	boolean
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`CurrencyCode`	string
`ContactEmail`	string
`CompanyName`	string
`CompanyIDFK`	integer
`CompanyBillingAddressState`	string
`CompanyBillingAddressPostCode`	string
`CompanyBillingAddressLine`	string
`CompanyBillingAddressCountryCode`	string
`CompanyBillingAddressCity`	string
`CompanyBillingAddress`	string

Responses

200Success

Body

Name	Data Type	Description
`CompanyContact`	object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

401Unauthorized

CreditNote

GET

/api/CreditNote/{id}

Gets Invoice by CreditNote ID

Request

Path

Name	Data Type	Description
`id`	long	Credit Note ID Number

Responses

200Success

Body

Name	Data Type	Description
`CreditNote`	object

Properties

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

Notes string

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

CreditNoteNumber string

CreditNoteLineItems array [CreditNoteLineItem]

CreditNoteLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`Discount`	double
`Description`	string
`Amount`	double

CreditNoteAllocations array [CreditNoteAllocation]

CreditNoteAllocation object

Properties

`TransactionAllocationID`	long
`InvoiceTransactionIDFK`	long
`CreditNoteTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Balance double

401Unauthorized

404Not Found

GET

/api/CreditNote

Gets list of CreditNotes

Request

Query

Name	Data Type	Description
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`CreditNoteList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

CreditNotes array [CreditNote]

CreditNote object

Properties

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

Notes string

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

CreditNoteNumber string

CreditNoteLineItems array [CreditNoteLineItem]

CreditNoteLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`Discount`	double
`Description`	string
`Amount`	double

CreditNoteAllocations array [CreditNoteAllocation]

CreditNoteAllocation object

Properties

`TransactionAllocationID`	long
`InvoiceTransactionIDFK`	long
`CreditNoteTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Balance double

401Unauthorized

Currency

GET

/api/Currency

Estimate

GET

/api/Estimate/{id}

GET

/api/Estimate

EstimateStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"

Request

Query

Name	Data Type	Description
`CompanyIDFK`	integer
`Sort`	string
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`EstimateList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

Estimates array [EstimateDetails]

EstimateDetails object

Properties

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string
`RecipientBillingAddressCountryCode`	string
`RecipientBillingAddressCity`	string
`CompanyName`	string
`CompanyIDFK`	integer

Notes string

Links EstimateLinks

EstimateLinks object

Properties

`View`	string
`Edit`	string
`ClientView`	string

LineItems array [EstimateLineItemDetails]

EstimateLineItemDetails object

Properties

`UnitPrice`	double
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`EstimateLineItemID`	long
`Discount`	double
`Description`	string
`Amount`	double

Issuer IssuerDetails

IssuerDetails object

Properties

`TaxNumber`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

ExchangeRate double

EstimateTaxConfigCode string

EstimateStatusCode string

EstimatePrefix string

EstimateItemNumber string

EstimateID long

DueDate dateTime

DateUpdated dateTime

DateSent dateTime

DateIssued dateTime

DateCreated dateTime

CurrencyCode string

CompanyName string

CompanyIDFK integer

Balance double

AccountIDFK integer

401Unauthorized

Expense

GET

/api/Expense/{id}

Gets an Expense Entry by Expense ID

Request

Path

Name	Data Type	Description
`id`	long	Expense ID number

Responses

200Success

Body

Name	Data Type	Description
`ExpenseDetails`	object

Properties

`isChargeable`	boolean
`UserIDFK`	integer
`TransactionTaxConfigCode`	string
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`MerchantTaxNumber`	string
`Merchant`	string
`Lastname`	string
`Firstname`	string
`ExpenseReportName`	string
`ExpenseReportIDFK`	long
`ExpenseID`	long
`ExpenseDate`	dateTime
`ExpenseCategoryUnitPrice`	double
`ExpenseCategoryUnitName`	string
`ExpenseCategoryName`	string
`ExpenseCategoryIDFK`	integer
`ExpenseCategoryHasUnitPrice`	boolean
`ExpenseApprovalStatusCode`	string
`ExchangeRate`	double
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CurrencyCode`	string
`ChargeableStatusCode`	string
`AttachmentURL`	string
`Amount`	double

401Unauthorized

404Not Found

GET

/api/Expense

Gets list of Expenses

Request

Query

Name	Data Type	Description
`Sort`	string
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`isInvoiced`	boolean
`isChargeable`	boolean
`ProjectID`	integer
`CustomerID`	integer
`CategoryName`	string
`UserEmail`	string
`ExpenseDateTo`	dateTime
`ExpenseDateFrom`	dateTime
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`ExpenseList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

Expenses array [ExpenseDetails]

ExpenseDetails object

Properties

`isChargeable`	boolean
`UserIDFK`	integer
`TransactionTaxConfigCode`	string
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`MerchantTaxNumber`	string
`Merchant`	string
`Lastname`	string
`Firstname`	string
`ExpenseReportName`	string
`ExpenseReportIDFK`	long
`ExpenseID`	long
`ExpenseDate`	dateTime
`ExpenseCategoryUnitPrice`	double
`ExpenseCategoryUnitName`	string
`ExpenseCategoryName`	string
`ExpenseCategoryIDFK`	integer
`ExpenseCategoryHasUnitPrice`	boolean
`ExpenseApprovalStatusCode`	string
`ExchangeRate`	double
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CurrencyCode`	string
`ChargeableStatusCode`	string
`AttachmentURL`	string
`Amount`	double

401Unauthorized

POST

/api/Expense

Create an Expense

Request

Body

Name	Data Type	Description
`NewExpense`	object

Properties

`isChargeable`	boolean	aka Billable. Defaults to false if not provided. If set to true, a CustomerIDFK or CustomerName must be provided.
`UserIDFK`	integer	UserID for a Timesheet/Expense user in Avaza. If not provided, UserEmail field must be provided
`UserEmail`	string	The email address of a Timesheet/Expense user in Avaza. If not provided, UserIDFK 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.
`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.
`TaxIDFK`	integer	Avaza Tax ID the expense belongs to. If left blank then Tax Name must be provided.
`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.
`ProjectIDFK`	integer	The Avaza project ID to associate the Expense with.
`Notes`	string	Expense Notes
`MerchantTaxNumer`	string	A Tax number identifier for the merchant.
`Merchant`	string	The name of the merchant.
`GroupTripName`	string	Links the expense to a Grouping/Trip report. If no matching name found, creates a new Group/Trip Report name.
`ExpenseDate`	dateTime	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.
`ExpenseCategoryIDFK`	integer	The expense category to link the Expense to. If not provided, ExpenseCategoryName must be provided
`ExchangeRate`	double	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)
`CustomerName`	string	The name of an existing customer in Avaza. Must be an exact (case insensitive) match.
`CustomerIDFK`	integer	The Avaza Customer ID to associate the Expense with. Either this field or CustomerName can 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.
`Amount`	double	Expense Amount (Required). Must be >= 0

Responses

200OK

Body

Name	Data Type	Description
`ExpenseDetails`	object

Properties

`isChargeable`	boolean
`UserIDFK`	integer
`TransactionTaxConfigCode`	string
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`MerchantTaxNumber`	string
`Merchant`	string
`Lastname`	string
`Firstname`	string
`ExpenseReportName`	string
`ExpenseReportIDFK`	long
`ExpenseID`	long
`ExpenseDate`	dateTime
`ExpenseCategoryUnitPrice`	double
`ExpenseCategoryUnitName`	string
`ExpenseCategoryName`	string
`ExpenseCategoryIDFK`	integer
`ExpenseCategoryHasUnitPrice`	boolean
`ExpenseApprovalStatusCode`	string
`ExchangeRate`	double
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CurrencyCode`	string
`ChargeableStatusCode`	string
`AttachmentURL`	string
`Amount`	double

Inventory

GET

/api/Inventory/{id}

GET

/api/Inventory

Gets list of Inventory

Request

Query

Name	Data Type	Description
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`InventoryList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

Inventory array [InventoryItem]

InventoryItem object

Properties

`isHidden`	boolean
`SaleTaxIDFK`	integer
`SalePrice`	double
`SKU`	string
`Name`	string
`InventoryItemID`	long
`Description`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CostPrice`	double

401Unauthorized

Invoice

GET

/api/Invoice/{id}

GET

/api/Invoice

TransactionStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"

Request

Query

Name	Data Type	Description
`CompanyIDFK`	integer
`Sort`	string
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`InvoiceList`	object

Properties

TotalCount integer

PageSize integer

PageNumber integer

Invoices array [Invoice]

Invoice object

Properties

TransactionTaxConfigCode string

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string
`RecipientBillingAddressCountryCode`	string
`RecipientBillingAddressCity`	string
`CompanyName`	string
`CompanyIDFK`	integer

Notes string

Links InvoiceLinks

InvoiceLinks object

Properties

`View`	string
`Edit`	string
`ClientView`	string

LineItems array [InvoiceLineItem]

InvoiceLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`Discount`	double
`Description`	string
`Amount`	double

Issuer IssuerDetails

IssuerDetails object

Properties

`TaxNumber`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

InvoiceNumber string

ExchangeRate double

DueDate dateTime

DateUpdated dateTime

DateSent dateTime

DateIssued dateTime

DateCreated dateTime

CustomerPONumber string

CurrencyCode string

CompanyName string

CompanyIDFK integer

Balance double

AccountIDFK integer

401Unauthorized

POST

/api/Invoice

Create a new draft invoice

Request

Body

Name	Data Type	Description
`NewInvoice`	object	New invoice to be created

Properties


                        TransactionTaxConfigCode

string

Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left empty it will use the account default.


                        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.


                        Subject

string

Plain UTF8 text. (no HTML). 255 characters max


                        PaymentTerms

integer

"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)


                        Notes

string

Plain UTF8 text. (no HTML). Max 2000 characters

LineItems array [NewInvoiceLineItem]


                        NewInvoiceLineItem

object

Line item to be added to new invoice

Properties

`UnitPrice`	double	The unit price for the lineitem.
`TaxPercent`	double	The Tax Percent will only be used if a new tax is being created.
`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.
`TaxIDFK`	integer
`Quantity`	double	The quantity for the line item
`ProjectIDFK`	integer	Optional. Project ID of an Avaza Project that belongs to this customer, so line item is attributed to that Project for reporting.
`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.
`InventoryItemIDFK`	integer	If not specified then Inventory Item Name must be specified.
`Discount`	double	Enter 10.5 to give a 10.5% discount
`Description`	string	Plain UTF8 text. (no HTML)


                        Lastname

string

Specified value will be used to create a new customer contact only if a new customer is being created.


                        InvoiceTemplateIDFK

integer

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.


                        Firstname

string

Specified value will be used to create a new customer contact only if a new customer is being created.


                        ExchangeRate

double

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.

Email string


                        DueDate

dateTime

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)


                        DateIssued

dateTime

If not specified it will use today's date. The date should be specified as local date.


                        CustomerPONumber

string

Plain UTF8 text. 100 characters max


                        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.


                        CompanyIDFK

integer

If left blank then you must specify Company Name.

Responses

200OK

Body

Name	Data Type	Description
`Invoice`	object

Properties

TransactionTaxConfigCode string

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string
`RecipientBillingAddressCountryCode`	string
`RecipientBillingAddressCity`	string
`CompanyName`	string
`CompanyIDFK`	integer

Notes string

Links InvoiceLinks

InvoiceLinks object

Properties

`View`	string
`Edit`	string
`ClientView`	string

LineItems array [InvoiceLineItem]

InvoiceLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`Discount`	double
`Description`	string
`Amount`	double

Issuer IssuerDetails

IssuerDetails object

Properties

`TaxNumber`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

InvoiceNumber string

ExchangeRate double

DueDate dateTime

DateUpdated dateTime

DateSent dateTime

DateIssued dateTime

DateCreated dateTime

CustomerPONumber string

CurrencyCode string

CompanyName string

CompanyIDFK integer

Balance double

AccountIDFK integer

Payment

GET

/api/Payment/{id}

Gets Payment by Payment Transaction ID

Request

Path

Name	Data Type	Description
`id`	long	Invoice Transaction ID Number

Responses

200Success

Body

Name	Data Type	Description
`Payment`	object

Properties

TransactionStatusCode string

TransactionReference string

TransactionPrefix string

TransactionID long

TotalAmount double

PaymentProviderCode string

PaymentNumber string

PaymentAllocations array [PaymentAllocation]

PaymentAllocation object

Properties

`TransactionAllocationID`	long
`PaymentTransactionIDFK`	long
`InvoiceTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Notes string

ExchangeRate double

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

Balance double

AccountIDFK integer

401Unauthorized

404Not Found

GET

/api/Payment

Gets list of Payments

Request

Query

Name	Data Type	Description
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`PaymentList`	object

Properties

TotalCount integer

Payments array [Payment]

Payment object

Properties

TransactionStatusCode string

TransactionReference string

TransactionPrefix string

TransactionID long

TotalAmount double

PaymentProviderCode string

PaymentNumber string

PaymentAllocations array [PaymentAllocation]

PaymentAllocation object

Properties

`TransactionAllocationID`	long
`PaymentTransactionIDFK`	long
`InvoiceTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Notes string

ExchangeRate double

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

Balance double

AccountIDFK integer

PageSize integer

PageNumber integer

401Unauthorized

POST

/api/Payment

Create new Payment and optionally assign payment allocations to Invoices

Request

Body

Name	Data Type	Description
`NewPayment`	object

Properties


                        TransactionReference

string

Optional for storing the reference # of the payment method.


                        TransactionPrefix

string

Optional to override the default prefix added to Payment Numbers


                        PaymentProviderCode

string

Optional for storing the payment provider who was the source of funds.


                        PaymentNumber

string

Optional. If not specified will be automatically generated


                        PaymentAllocations

array [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.

NewPaymentAllocation object

Properties

`InvoiceTransactionIDFK`	long	The Avaza Invoice TransactionID that is having a payment amount allocated to it.
`AllocationDate`	dateTime	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.
`AllocationAmount`	double	The Amount being allocated to the invoice. Expects same currency as invoice currency

Notes string


                        ExchangeRate

double

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.


                        DateIssued

dateTime

Date of Payment. If not specified, assumes today.


                        CustomerIDFK

integer

Only required if no invoice allocations specified.

Amount double

Responses

200OK

Body

Name	Data Type	Description
`Payment`	object

Properties

TransactionStatusCode string

TransactionReference string

TransactionPrefix string

TransactionID long

TotalAmount double

PaymentProviderCode string

PaymentNumber string

PaymentAllocations array [PaymentAllocation]

PaymentAllocation object

Properties

`TransactionAllocationID`	long
`PaymentTransactionIDFK`	long
`InvoiceTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Notes string

ExchangeRate double

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

Balance double

AccountIDFK integer

Project

GET

/api/Project/{id}

Gets Project by Project ID

Request

Path

Name	Data Type	Description
`id`	long	Project ID number

Responses

200Success

Body

Name	Data Type	Description
`ProjectDetails`	object

Properties

isArchived boolean

Title string

StartDate dateTime

Sections array [ProjectSectionDetails]

ProjectSectionDetails object

Properties

`Title`	string
`StartDate`	dateTime
`SectionID`	integer
`EndDate`	dateTime
`DisplayOrder`	integer

ProjectTags array [ProjectTagItem]

ProjectTagItem object

Properties

`ProjectTagID`	integer
`Name`	string


                        ProjectStatusCode

string

Possible values: NotStarted, InProgress, Complete

ProjectID integer

ProjectHourlyRate double

ProjectCategoryName string

ProjectCategoryIDFK integer


                        ProjectCategoryColor

string

Html Hex Color Code starting with #


                        ProjectBudgetTypeCode

string

Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours


                        ProjectBillableTypeCode

string

Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly

Notes string

Members array [ProjectMemberDetails]

ProjectMemberDetails object

Properties

`isTimesheetApprover`	boolean
`isTimesheetApprovalRequired`	boolean
`isTimesheetAllowed`	boolean
`isProjectManager`	boolean
`isMemberDisabled`	boolean
`canUpdateTasks`	boolean
`canDeleteTasks`	boolean
`canCreateTasks`	boolean
`canCommentOnTasks`	boolean
`UserIDFK`	integer
`RateAmount`	double
`Lastname`	string
`Fullname`	string
`Firstname`	string
`Email`	string
`CostAmount`	double
`BudgetAmount`	double

EndDate dateTime

DateUpdated dateTime

DateCreated dateTime

CompanyName string

CompanyIDFK integer

BudgetHours double

BudgetAmount double

401Unauthorized

404Not Found

GET

/api/Project

Gets list of Projects

Request

Query

Name	Data Type	Description
`includeArchived`	boolean	Include Archived Projects in the results
`TimesheetUserID`	integer	Filter to the projects that the supplied UserID can add timesheets to
`Sort`	string	A column to sort on. Current possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`UpdatedAfter`	dateTime	Only show project records updated after a certain date (UTC)

Responses

200OK

Body

Name	Data Type	Description
`ProjectList`	object

Properties

TotalCount integer

Projects array [ProjectListDetails]

ProjectListDetails object

Properties

`isArchived`	boolean
`Title`	string
`ProjectID`	integer
`Notes`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CompanyName`	string
`CompanyIDFK`	integer

PageSize integer

PageNumber integer

POST

/api/Project

Create a Project

Request

Body

Name	Data Type	Description
`NewProjectModel`	object

Properties

`isTaskRequiredOnTimesheet`	boolean
`TimesheetApprovalRequiredbyDefault`	boolean
`StartDate`	dateTime
`ProjectTitle`	string	The title of the new project. (255 characters max)
`ProjectStatusCode`	string
`ProjectNotes`	string	Any descriptive notes about the project. (2000 characters max)
`ProjectCategoryIDFK`	integer
`PopulateDefaultProjectMembers`	boolean
`EndDate`	dateTime
`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.
`CompanyName`	string	The name for a Company to create the project under. Will create company unless it matches an existing company name
`CompanyIDFK`	integer	An ID of a company in Avaza to create the Project under. You must provide either a CompanyID, or a CompanyName
`BudgetHours`	double
`BudgetAmount`	double

Responses

200Success

Body

Name	Data Type	Description
`ProjectDetails`	object

Properties

isArchived boolean

Title string

StartDate dateTime

Sections array [ProjectSectionDetails]

ProjectSectionDetails object

Properties

`Title`	string
`StartDate`	dateTime
`SectionID`	integer
`EndDate`	dateTime
`DisplayOrder`	integer

ProjectTags array [ProjectTagItem]

ProjectTagItem object

Properties

`ProjectTagID`	integer
`Name`	string


                        ProjectStatusCode

string

Possible values: NotStarted, InProgress, Complete

ProjectID integer

ProjectHourlyRate double

ProjectCategoryName string

ProjectCategoryIDFK integer


                        ProjectCategoryColor

string

Html Hex Color Code starting with #


                        ProjectBudgetTypeCode

string

Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours


                        ProjectBillableTypeCode

string

Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly

Notes string

Members array [ProjectMemberDetails]

ProjectMemberDetails object

Properties

`isTimesheetApprover`	boolean
`isTimesheetApprovalRequired`	boolean
`isTimesheetAllowed`	boolean
`isProjectManager`	boolean
`isMemberDisabled`	boolean
`canUpdateTasks`	boolean
`canDeleteTasks`	boolean
`canCreateTasks`	boolean
`canCommentOnTasks`	boolean
`UserIDFK`	integer
`RateAmount`	double
`Lastname`	string
`Fullname`	string
`Firstname`	string
`Email`	string
`CostAmount`	double
`BudgetAmount`	double

EndDate dateTime

DateUpdated dateTime

DateCreated dateTime

CompanyName string

CompanyIDFK integer

BudgetHours double

BudgetAmount double

401Unauthorized

ProjectTimesheetCategory

GET

/api/ProjectTimesheetCategory

Gets list of Project Timesheet Categories

Request

Query

Name	Data Type	Description
`ProjectID`	integer	Get categories filtered by ProjectID

Responses

200Success

Body

Name	Data Type	Description
`ProjectTimesheetCategoryList`	object

Properties

Categories array [ProjectTimesheetCategoryDetails]

ProjectTimesheetCategoryDetails object

Properties

`isBillable`	boolean
`TimeSheetCategoryIDFK`	integer
`RateAmount`	double
`ProjectIDFK`	integer
`Name`	string
`CostAmount`	double
`BudgetHours`	double
`AccountIDFK`	integer

401Unauthorized

Section

GET

/api/Section

Gets list of Sections

Request

Query

Name	Data Type	Description
`ProjectID`	integer	Get sections for Project with ProjectID

Responses

200Success

Body

Name	Data Type	Description
`SectionList`	object

Properties

TotalCount integer

Sections array [SectionDetails]

SectionDetails object

Properties

`Title`	string
`StartDateUTC`	dateTime
`StartDate`	dateTime
`SectionID`	integer
`ProjectIDFK`	integer
`EndDateUTC`	dateTime
`EndDate`	dateTime
`DisplayOrder`	integer

401Unauthorized

POST

/api/Section

Create a Section

Request

Body

Name	Data Type	Description
`NewSection`	object

Properties

`Title`	string
`StartDateUTC`	dateTime
`ProjectIDFK`	integer
`EndDateUTC`	dateTime

Responses

200OK

Body

Name	Data Type	Description
`SectionDetails`	object

Properties

`Title`	string
`StartDateUTC`	dateTime
`StartDate`	dateTime
`SectionID`	integer
`ProjectIDFK`	integer
`EndDateUTC`	dateTime
`EndDate`	dateTime
`DisplayOrder`	integer

Task

GET

/api/Task/{id}

Gets Task by Task ID

Request

Path

Name	Data Type	Description
`id`	long	Task ID number

Responses

200Success

Body

Name	Data Type	Description
`TaskDetails`	object

Properties

Title string

TaskStatusCode string

TaskID integer

Tags array [TagItem]

TagItem object

Properties

`TagID`	long
`Name`	string
`Color`	string

SectionTitle string

SectionIDFK integer

ProjectTitle string

ProjectIDFK integer

PercentComplete double

EstimatedEffort double

DescriptionNoHTML string

Description string

DateUpdated dateTime

DateStartUTC dateTime

DateStart dateTime

DateDueUTC dateTime

DateDue dateTime

DateCreated dateTime

AssignedToUserIDFK string

AssignedToLastname string

AssignedToFirstname string

AssignedToEmail string

ActualTime double

401Unauthorized

404Not Found

GET

/api/Task

Gets list of Tasks

Request

Query

Name	Data Type	Description
`ProjectID`	integer	Optional filter to only display tasks belonging to a specific ProjectID
`Sort`	string	Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
`pageNumber`	integer	Page to display. Starts from 1. Defaults to 1
`pageSize`	integer	Number of items per page. Defaults to 20.
`UpdatedAfter`	dateTime	Optional filter to records updated after a specific date.

Responses

200Success

Body

Name	Data Type	Description
`TaskList`	object

Properties

TotalCount integer

Tasks array [TaskDetails]

TaskDetails object

Properties

Title string

TaskStatusCode string

TaskID integer

Tags array [TagItem]

TagItem object

Properties

`TagID`	long
`Name`	string
`Color`	string

SectionTitle string

SectionIDFK integer

ProjectTitle string

ProjectIDFK integer

PercentComplete double

EstimatedEffort double

DescriptionNoHTML string

Description string

DateUpdated dateTime

DateStartUTC dateTime

DateStart dateTime

DateDueUTC dateTime

DateDue dateTime

DateCreated dateTime

AssignedToUserIDFK string

AssignedToLastname string

AssignedToFirstname string

AssignedToEmail string

ActualTime double

PageSize integer

PageNumber integer

401Unauthorized

POST

/api/Task

Create a Task

Request

Body

Name	Data Type	Description
`NewTask`	object

Properties

Title string


                        Tags

array [NewTag]

Collection of tags specifying Name and Color (Hex)

NewTag object

Properties

`Name`	string
`Color`	string

SectionIDFK integer

ProjectIDFK integer


                        EstimatedEffort

double

Decimal hours

Description string

DateStartUTC dateTime

DateStart dateTime

DateDueUTC dateTime

DateDue dateTime

AssignedToUserIDFK integer

Responses

200OK

Body

Name	Data Type	Description
`TaskDetails`	object

Properties

Title string

TaskStatusCode string

TaskID integer

Tags array [TagItem]

TagItem object

Properties

`TagID`	long
`Name`	string
`Color`	string

SectionTitle string

SectionIDFK integer

ProjectTitle string

ProjectIDFK integer

PercentComplete double

EstimatedEffort double

DescriptionNoHTML string

Description string

DateUpdated dateTime

DateStartUTC dateTime

DateStart dateTime

DateDueUTC dateTime

DateDue dateTime

DateCreated dateTime

AssignedToUserIDFK string

AssignedToLastname string

AssignedToFirstname string

AssignedToEmail string

ActualTime double

PUT

/api/Task

Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.

Request

Body

Name	Data Type	Description
`UpdateTask`	object

Properties

`Title`	string
`TaskID`	integer
`PercentComplete`	integer
`FieldsToUpdate`	array [string]
`EstimatedEffort`	double	Decimal hours
`Description`	string
`DateStartUTC`	dateTime
`DateStart`	dateTime
`DateDueUTC`	dateTime
`DateDue`	dateTime
`AssignedToUserIDFK`	integer

Responses

200OK

Body

Name	Data Type	Description
`TaskDetails`	object

Properties

Title string

TaskStatusCode string

TaskID integer

Tags array [TagItem]

TagItem object

Properties

`TagID`	long
`Name`	string
`Color`	string

SectionTitle string

SectionIDFK integer

ProjectTitle string

ProjectIDFK integer

PercentComplete double

EstimatedEffort double

DescriptionNoHTML string

Description string

DateUpdated dateTime

DateStartUTC dateTime

DateStart dateTime

DateDueUTC dateTime

DateDue dateTime

DateCreated dateTime

AssignedToUserIDFK string

AssignedToLastname string

AssignedToFirstname string

AssignedToEmail string

ActualTime double

Tax

GET

/api/Tax

Get List of Taxes configured in the Avaza account.

Responses

200OK

Body

Name	Data Type	Description
`TaxList`	object

Properties

Taxes array [TaxItem]

TaxItem object

Properties

TaxID integer

TaxComponents array [TaxComponent]

TaxComponent object

Properties

`isCompound`	boolean
`TaxIDFK`	integer
`TaxComponentID`	integer
`Percentage`	double
`Name`	string
`ComponentTaxCode`	string

TaxCode string

Name string

CalculatedPercent double

Timesheet

DELETE

/api/Timesheet/{id}

GET

/api/Timesheet/{id}

Gets a Timesheet Entry by Timesheet ID

Request

Path

Name	Data Type	Description
`id`	long	Timesheet ID number

Responses

200Success

Body

Name	Data Type	Description
`TimesheetDetails`	object

Properties

`isInvoiced`	boolean
`isBillable`	boolean
`UserIDFK`	integer
`TimesheetUserTimeZone`	string
`TimesheetEntryID`	long
`TimesheetEntryApprovalStatusCode`	string
`TimesheetCategoryIDFK`	integer
`TimerStartedAtUTC`	dateTime
`TaskTitle`	string
`TaskIDFK`	integer
`StartTimeUTC`	dateTime
`StartTimeLocal`	dateTime
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`Lastname`	string
`InvoiceLineItemIDFK`	long
`InvoiceIDFK`	long
`HasTimer`	boolean
`Firstname`	string
`EntryDate`	dateTime
`EndTimeUTC`	dateTime
`EndTimeLocal`	dateTime
`Email`	string
`Duration`	double
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CategoryName`	string

401Unauthorized

404Not Found

GET

/api/Timesheet

Gets list of Timsheets

Request

Query

Name	Data Type	Description
`Sort`	string	Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"
`pageNumber`	integer	Page to display. Starts from 1.
`pageSize`	integer	Number of items per page
`isTimerRunning`	boolean
`isInvoiced`	boolean
`isBillable`	boolean
`ProjectID`	integer
`CategoryName`	string
`UserEmail`	string
`UserID`	integer	The UserID of a timesheet user to filter timesheets for. Only api users with certain higher roles can see timesheets across multiple users.
`EntryDateTo`	dateTime
`EntryDateFrom`	dateTime
`UpdatedAfter`	dateTime

Responses

200Success

Body

Name	Data Type	Description
`TimesheetList`	object

Properties

TotalCount integer

Timesheets array [TimesheetDetails]

TimesheetDetails object

Properties

`isInvoiced`	boolean
`isBillable`	boolean
`UserIDFK`	integer
`TimesheetUserTimeZone`	string
`TimesheetEntryID`	long
`TimesheetEntryApprovalStatusCode`	string
`TimesheetCategoryIDFK`	integer
`TimerStartedAtUTC`	dateTime
`TaskTitle`	string
`TaskIDFK`	integer
`StartTimeUTC`	dateTime
`StartTimeLocal`	dateTime
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`Lastname`	string
`InvoiceLineItemIDFK`	long
`InvoiceIDFK`	long
`HasTimer`	boolean
`Firstname`	string
`EntryDate`	dateTime
`EndTimeUTC`	dateTime
`EndTimeLocal`	dateTime
`Email`	string
`Duration`	double
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CategoryName`	string

PageSize integer

PageNumber integer

401Unauthorized

POST

/api/Timesheet

Create a new Timesheet Entry

Request

Body

Name	Data Type	Description
`NewTimesheet`	object

Properties

`isInvoiced`	boolean	Optional. False by default. Allows you to mark the timesheet as invoiced in an external system.
`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
`UserIDFK`	integer	UserID for a Timesheet user in Avaza
`TimesheetCategoryIDFK`	integer	The Project timesheet category to link the timesheet to
`TaskIDFK`	integer	Optional. Link the timesheet to a specific task
`ProjectIDFK`	integer	The project to associate the timesheet with.
`Notes`	string	Timesheet Notes
`EntryDate`	dateTime	The date of the timesheet entry, with an optional start time component.
`Duration`	double	The duration of the timesheet, in decimal hours. If null or 0, a timer will be started.

Responses

200OK

Body

Name	Data Type	Description
`TimesheetDetails`	object

Properties

`isInvoiced`	boolean
`isBillable`	boolean
`UserIDFK`	integer
`TimesheetUserTimeZone`	string
`TimesheetEntryID`	long
`TimesheetEntryApprovalStatusCode`	string
`TimesheetCategoryIDFK`	integer
`TimerStartedAtUTC`	dateTime
`TaskTitle`	string
`TaskIDFK`	integer
`StartTimeUTC`	dateTime
`StartTimeLocal`	dateTime
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`Lastname`	string
`InvoiceLineItemIDFK`	long
`InvoiceIDFK`	long
`HasTimer`	boolean
`Firstname`	string
`EntryDate`	dateTime
`EndTimeUTC`	dateTime
`EndTimeLocal`	dateTime
`Email`	string
`Duration`	double
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CategoryName`	string

PUT

/api/Timesheet

The FieldsToUpdate field expects a string array collection of the field names you would like updated.

Request

Body

Name	Data Type	Description
`UpdateTimesheetModel`	object

Properties

`hasStartEndTime`	boolean
`TimeSheetEntryID`	long
`TimeSheetCategoryIDFK`	integer
`TaskIDFK`	integer
`ProjectIDFK`	integer
`Notes`	string
`FieldsToUpdate`	array [string]
`EntryDate`	dateTime
`Duration`	double

Responses

200OK

Body

Name	Data Type	Description
`TimesheetDetails`	object

Properties

`isInvoiced`	boolean
`isBillable`	boolean
`UserIDFK`	integer
`TimesheetUserTimeZone`	string
`TimesheetEntryID`	long
`TimesheetEntryApprovalStatusCode`	string
`TimesheetCategoryIDFK`	integer
`TimerStartedAtUTC`	dateTime
`TaskTitle`	string
`TaskIDFK`	integer
`StartTimeUTC`	dateTime
`StartTimeLocal`	dateTime
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`Lastname`	string
`InvoiceLineItemIDFK`	long
`InvoiceIDFK`	long
`HasTimer`	boolean
`Firstname`	string
`EntryDate`	dateTime
`EndTimeUTC`	dateTime
`EndTimeLocal`	dateTime
`Email`	string
`Duration`	double
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CategoryName`	string

TimesheetTimer

DELETE

/api/TimesheetTimer/{id}

Stop the timer running on an existing Timesheet Entry

Request

Path

Name	Data Type	Description
`id`	long	The ID of the existing timesheet entry that needs its timer stopped

Query

Name	Data Type	Description
`UserID`	integer	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

Responses

200Success

Body

Name	Data Type	Description
`body`	object

400Bad Request

401Unauthorized

404Not Found

POST

/api/TimesheetTimer/{id}

Starts a Timer running on an existing Timesheet Entry

Request

Path

Name	Data Type	Description
`id`	long	The ID of the existing timesheet entry on which to start a timer

Query

Name	Data Type	Description
`UserID`	integer	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

Responses

200Success

Body

Name	Data Type	Description
`body`	object

400Bad Request

401Unauthorized

404Not Found

GET

/api/TimesheetTimer

Gets the Running Timer if there is one for a user.

Request

Query

Name	Data Type	Description
`UserID`	integer	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

Responses

200Success

Body

Name	Data Type	Description
`body`	object

401Unauthorized

404Not Found

UserProfile

GET

/api/UserProfile

Admin and Invoice Managers can see all. Other users are limited to seeing their own profile.

Request

Query

Name	Data Type	Description
`CompanyIDFK`	integer	Optionally filter by Company ID
`CurrentUserOnly`	boolean	Optional boolean (true/false) to filter to only show current authenticated user (always true for non Admin/InvoiceManager users)
`Roles`	string	Optional list of comma sepaprated roele codes to filter users by (e.g. "TimesheetUser,Admin")

Responses

200OK

Body

Name	Data Type	Description
`UserList`	object

Properties

Users array [UserDetails]

UserDetails object

Properties

isTeamMember boolean

UserID integer

TimeZone string

Roles array [RoleDetails]

RoleDetails object

Properties

`RoleName`	string
`RoleCode`	string

Lastname string

Firstname string

Email string

DefaultCostRate double

DefaultBillableRate double

CompanyName string

CompanyIDFK integer

AccountIDFK integer

Webhook

DELETE

/api/Webhook/{id}

DELETE

/api/Webhook

GET

/api/Webhook

Get list of Webhook Subscriptions

Responses

200OK

Body

Name	Data Type	Description
`WebhookList`	object

Properties

Webhooks array [WebhookDetails]

WebhookDetails object

Properties

`UserIDFK`	integer
`SubscriptionID`	integer
`NotificationURL`	string
`EventCode`	string

POST

/api/Webhook

When you receive a webhook, you should respond with Http 200 OK Status Code, otherwise we will retry. Event values are: "company_created", "company_deleted", "company_updated", "contact_created", "contact_deleted", "contact_updated", "invoice_created", "invoice_sent", "project_created", "project_deleted", "project_updated", "task_created", "timesheet_created", "timesheet_deleted", "timesheet_updated". You can subscribe to any webhook, but you will only receive notifications for data appropriate to the roles of your user account. There is an optional Secret parameter (string 255 char max). This allows for webhook authentication. If provided, the Secret will be BASE 64 encoded and passed with notications as a basic authentication http header. i.e. Authorization Basic [BASE64 of Secret]"

Request

Body

Name	Data Type	Description
`CreateSubscription`	object	New Subscription to be Created

Properties

`target_url`	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, contact_created, invoice_created, invoice_sent, project_created, task_created

Responses

201Subscription created

Body

Name	Data Type	Description
`SubscribeResult`	object

Properties

ID integer

401Unauthorized

409Duplicate subscription already exists

Models

AccountDetails

Properties

Name	Data Type	Description
`hasStartEndTimesheets`	boolean
`has24HourTimesheetFormat`	boolean
`WeeklyTimesheetReminder`	boolean
`TimesheetDisplayFormatCode`	string
`TimesheetDayOfWeek`	integer
`Subdomain`	string
`LockApprovedTimesheets`	boolean
`CompanyName`	string
`AccountID`	integer

Company

Properties

Name Data Type Description

website string

TaxNumber string

Phone string

Fax string

DefaultTradingTermIDFK integer

DateUpdated dateTime

DateCreated dateTime

CurrencyCode string

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyName string

CompanyID integer

Comments string

BillingCountryCode string

BillingAddressState string

BillingAddressPostCode string

BillingAddressLine string

BillingAddressCity string

BillingAddress string

CompanyContact

Properties

Name	Data Type	Description
`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

Companies array [Company]

Company object

Properties

website string

TaxNumber string

Phone string

Fax string

DefaultTradingTermIDFK integer

DateUpdated dateTime

DateCreated dateTime

CurrencyCode string

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CompanyName string

CompanyID integer

Comments string

BillingCountryCode string

BillingAddressState string

BillingAddressPostCode string

BillingAddressLine string

BillingAddressCity string

BillingAddress string

ContactList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

Contacts array [CompanyContact]

CompanyContact object

Properties

`TimeZone`	string
`PositionTitle`	string
`Phone`	string
`Mobile`	string
`Lastname`	string
`Firstname`	string
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`ContactID`	integer
`CompanyName`	string
`CompanyIDFK`	integer

CreateSubscription

CreditNote

Properties

Name Data Type Description

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

Notes string

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

CreditNoteNumber string

CreditNoteLineItems array [CreditNoteLineItem]

CreditNoteLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`Discount`	double
`Description`	string
`Amount`	double

CreditNoteAllocations array [CreditNoteAllocation]

CreditNoteAllocation object

Properties

`TransactionAllocationID`	long
`InvoiceTransactionIDFK`	long
`CreditNoteTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Balance double

CreditNoteAllocation

CreditNoteLineItem

Properties

Name	Data Type	Description
`UnitPrice`	double
`TransactionLineItemID`	long
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`Discount`	double
`Description`	string
`Amount`	double

CreditNoteList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

CreditNotes array [CreditNote]

CreditNote object

Properties

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

Notes string

DateUpdated dateTime

DateIssued dateTime

DateCreated dateTime

CustomerIDFK integer

CurrencyCode string

CreditNoteNumber string

CreditNoteLineItems array [CreditNoteLineItem]

CreditNoteLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`Discount`	double
`Description`	string
`Amount`	double

CreditNoteAllocations array [CreditNoteAllocation]

CreditNoteAllocation object

Properties

`TransactionAllocationID`	long
`InvoiceTransactionIDFK`	long
`CreditNoteTransactionIDFK`	long
`AllocationDate`	dateTime
`AllocationAmount`	double

Balance double

Currency

CurrencyList

EstimateDetails

Properties

Name Data Type Description

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string
`RecipientBillingAddressCountryCode`	string
`RecipientBillingAddressCity`	string
`CompanyName`	string
`CompanyIDFK`	integer

Notes string

Links EstimateLinks

EstimateLinks object

Properties

`View`	string
`Edit`	string
`ClientView`	string

LineItems array [EstimateLineItemDetails]

EstimateLineItemDetails object

Properties

`UnitPrice`	double
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`EstimateLineItemID`	long
`Discount`	double
`Description`	string
`Amount`	double

Issuer IssuerDetails

IssuerDetails object

Properties

`TaxNumber`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

ExchangeRate double

EstimateTaxConfigCode string

EstimateStatusCode string

EstimatePrefix string

EstimateItemNumber string

EstimateID long

DueDate dateTime

DateUpdated dateTime

DateSent dateTime

DateIssued dateTime

DateCreated dateTime

CurrencyCode string

CompanyName string

CompanyIDFK integer

Balance double

AccountIDFK integer

EstimateLineItemDetails

Properties

Name	Data Type	Description
`UnitPrice`	double
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`EstimateLineItemID`	long
`Discount`	double
`Description`	string
`Amount`	double

EstimateLinks

EstimateList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

Estimates array [EstimateDetails]

EstimateDetails object

Properties

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string
`RecipientBillingAddressCountryCode`	string
`RecipientBillingAddressCity`	string
`CompanyName`	string
`CompanyIDFK`	integer

Notes string

Links EstimateLinks

EstimateLinks object

Properties

`View`	string
`Edit`	string
`ClientView`	string

LineItems array [EstimateLineItemDetails]

EstimateLineItemDetails object

Properties

`UnitPrice`	double
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`EstimateLineItemID`	long
`Discount`	double
`Description`	string
`Amount`	double

Issuer IssuerDetails

IssuerDetails object

Properties

`TaxNumber`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

ExchangeRate double

EstimateTaxConfigCode string

EstimateStatusCode string

EstimatePrefix string

EstimateItemNumber string

EstimateID long

DueDate dateTime

DateUpdated dateTime

DateSent dateTime

DateIssued dateTime

DateCreated dateTime

CurrencyCode string

CompanyName string

CompanyIDFK integer

Balance double

AccountIDFK integer

ExpenseDetails

Properties

Name	Data Type	Description
`isChargeable`	boolean
`UserIDFK`	integer
`TransactionTaxConfigCode`	string
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`MerchantTaxNumber`	string
`Merchant`	string
`Lastname`	string
`Firstname`	string
`ExpenseReportName`	string
`ExpenseReportIDFK`	long
`ExpenseID`	long
`ExpenseDate`	dateTime
`ExpenseCategoryUnitPrice`	double
`ExpenseCategoryUnitName`	string
`ExpenseCategoryName`	string
`ExpenseCategoryIDFK`	integer
`ExpenseCategoryHasUnitPrice`	boolean
`ExpenseApprovalStatusCode`	string
`ExchangeRate`	double
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CurrencyCode`	string
`ChargeableStatusCode`	string
`AttachmentURL`	string
`Amount`	double

ExpenseList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

Expenses array [ExpenseDetails]

ExpenseDetails object

Properties

`isChargeable`	boolean
`UserIDFK`	integer
`TransactionTaxConfigCode`	string
`TaxIDFK`	integer
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`Notes`	string
`MerchantTaxNumber`	string
`Merchant`	string
`Lastname`	string
`Firstname`	string
`ExpenseReportName`	string
`ExpenseReportIDFK`	long
`ExpenseID`	long
`ExpenseDate`	dateTime
`ExpenseCategoryUnitPrice`	double
`ExpenseCategoryUnitName`	string
`ExpenseCategoryName`	string
`ExpenseCategoryIDFK`	integer
`ExpenseCategoryHasUnitPrice`	boolean
`ExpenseApprovalStatusCode`	string
`ExchangeRate`	double
`Email`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CustomerName`	string
`CustomerIDFK`	integer
`CurrencyCode`	string
`ChargeableStatusCode`	string
`AttachmentURL`	string
`Amount`	double

InventoryItem

Properties

Name	Data Type	Description
`isHidden`	boolean
`SaleTaxIDFK`	integer
`SalePrice`	double
`SKU`	string
`Name`	string
`InventoryItemID`	long
`Description`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CostPrice`	double

InventoryList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

Inventory array [InventoryItem]

InventoryItem object

Properties

`isHidden`	boolean
`SaleTaxIDFK`	integer
`SalePrice`	double
`SKU`	string
`Name`	string
`InventoryItemID`	long
`Description`	string
`DateUpdated`	dateTime
`DateCreated`	dateTime
`CostPrice`	double

Invoice

Properties

Name Data Type Description

TransactionTaxConfigCode string

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string
`RecipientBillingAddressCountryCode`	string
`RecipientBillingAddressCity`	string
`CompanyName`	string
`CompanyIDFK`	integer

Notes string

Links InvoiceLinks

InvoiceLinks object

Properties

`View`	string
`Edit`	string
`ClientView`	string

LineItems array [InvoiceLineItem]

InvoiceLineItem object

Properties

`UnitPrice`	double
`TransactionLineItemID`	long
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`Discount`	double
`Description`	string
`Amount`	double

Issuer IssuerDetails

IssuerDetails object

Properties

`TaxNumber`	string
`BillingCountryCode`	string
`BillingAddressState`	string
`BillingAddressPostCode`	string
`BillingAddressLine`	string
`BillingAddressCity`	string
`BillingAddress`	string

InvoiceNumber string

ExchangeRate double

DueDate dateTime

DateUpdated dateTime

DateSent dateTime

DateIssued dateTime

DateCreated dateTime

CustomerPONumber string

CurrencyCode string

CompanyName string

CompanyIDFK integer

Balance double

AccountIDFK integer

InvoiceLineItem

Properties

Name	Data Type	Description
`UnitPrice`	double
`TransactionLineItemID`	long
`TaxName`	string
`TaxIDFK`	integer
`TaxCode`	string
`TaxAmount`	double
`Quantity`	double
`ProjectTitle`	string
`ProjectIDFK`	integer
`InventoryItemSKU`	string
`InventoryItemName`	string
`InventoryItemIDFK`	long
`Discount`	double
`Description`	string
`Amount`	double

InvoiceLinks

InvoiceList

Properties

Name Data Type Description

TotalCount integer

PageSize integer

PageNumber integer

Invoices array [Invoice]

Invoice object

Properties

TransactionTaxConfigCode string

TransactionStatusCode string

TransactionPrefix string

TransactionID long

TotalAmount double

TaxAmount double

Subject string

Recipient RecipientDetails

RecipientDetails object

Properties

`RecipientFormattedBillingAddress`	string
`RecipientBillingAddressState`	string
`RecipientBillingAddressPostCode`	string
`RecipientBillingAddressLine`	string