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.
Name | Data Type | Description |
---|---|---|
AccountDetails
|
object |
hasStartEndTimesheets
|
boolean | |
has24HourTimesheetFormat
|
boolean | |
WeeklyTimesheetReminder
|
boolean | |
TimesheetDisplayFormatCode
|
string | |
TimesheetDayOfWeek
|
integer | |
Subdomain
|
string | |
LockApprovedTimesheets
|
boolean | |
CompanyName
|
string | |
AccountID
|
integer |
Name | Data Type | Description |
---|---|---|
id
|
long |
Company ID Number |
Name | Data Type | Description |
---|---|---|
Company
|
object |
website
|
string | |||||||||||||||||||||||||||||||||||||||||
TaxNumber
|
string | |||||||||||||||||||||||||||||||||||||||||
Phone
|
string | |||||||||||||||||||||||||||||||||||||||||
Fax
|
string | |||||||||||||||||||||||||||||||||||||||||
DefaultTradingTermIDFK
|
integer | |||||||||||||||||||||||||||||||||||||||||
DateUpdated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
DateCreated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
CurrencyCode
|
string | |||||||||||||||||||||||||||||||||||||||||
Contacts
|
array [CompanyContact] | |||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
CompanyName
|
string | |||||||||||||||||||||||||||||||||||||||||
CompanyID
|
integer | |||||||||||||||||||||||||||||||||||||||||
Comments
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingCountryCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressState
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressPostCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressLine
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressCity
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddress
|
string |
Name | Data Type | Description |
---|---|---|
Sort
|
string | |
pageNumber
|
integer |
1 based page number to retrieve |
pageSize
|
integer |
Number of results per page |
UpdatedAfter
|
dateTime |
Name | Data Type | Description |
---|---|---|
CompanyList
|
object |
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Companies
|
array [Company] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NewCompany
|
object |
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 |
Name | Data Type | Description |
---|---|---|
Company
|
object |
website
|
string | |||||||||||||||||||||||||||||||||||||||||
TaxNumber
|
string | |||||||||||||||||||||||||||||||||||||||||
Phone
|
string | |||||||||||||||||||||||||||||||||||||||||
Fax
|
string | |||||||||||||||||||||||||||||||||||||||||
DefaultTradingTermIDFK
|
integer | |||||||||||||||||||||||||||||||||||||||||
DateUpdated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
DateCreated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
CurrencyCode
|
string | |||||||||||||||||||||||||||||||||||||||||
Contacts
|
array [CompanyContact] | |||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
CompanyName
|
string | |||||||||||||||||||||||||||||||||||||||||
CompanyID
|
integer | |||||||||||||||||||||||||||||||||||||||||
Comments
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingCountryCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressState
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressPostCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressLine
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressCity
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddress
|
string |
Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.
Name | Data Type | Description |
---|---|---|
UpdateCompany
|
object |
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 |
Name | Data Type | Description |
---|---|---|
Company
|
object |
website
|
string | |||||||||||||||||||||||||||||||||||||||||
TaxNumber
|
string | |||||||||||||||||||||||||||||||||||||||||
Phone
|
string | |||||||||||||||||||||||||||||||||||||||||
Fax
|
string | |||||||||||||||||||||||||||||||||||||||||
DefaultTradingTermIDFK
|
integer | |||||||||||||||||||||||||||||||||||||||||
DateUpdated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
DateCreated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
CurrencyCode
|
string | |||||||||||||||||||||||||||||||||||||||||
Contacts
|
array [CompanyContact] | |||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
CompanyName
|
string | |||||||||||||||||||||||||||||||||||||||||
CompanyID
|
integer | |||||||||||||||||||||||||||||||||||||||||
Comments
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingCountryCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressState
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressPostCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressLine
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressCity
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddress
|
string |
Name | Data Type | Description |
---|---|---|
id
|
long |
Contact ID number |
Name | Data Type | Description |
---|---|---|
CompanyContact
|
object |
TimeZone
|
string | |
PositionTitle
|
string | |
Phone
|
string | |
Mobile
|
string | |
Lastname
|
string | |
Firstname
|
string | |
Email
|
string | |
DateUpdated
|
dateTime | |
DateCreated
|
dateTime | |
ContactID
|
integer | |
CompanyName
|
string | |
CompanyIDFK
|
integer |
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 |
Name | Data Type | Description |
---|---|---|
ContactList
|
object |
TotalCount
|
integer | |||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | |||||||||||||||||||||||||||||||||||||||||
Contacts
|
array [CompanyContact] | |||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NewCompanyContact
|
object |
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 |
Name | Data Type | Description |
---|---|---|
CompanyContact
|
object |
TimeZone
|
string | |
PositionTitle
|
string | |
Phone
|
string | |
Mobile
|
string | |
Lastname
|
string | |
Firstname
|
string | |
Email
|
string | |
DateUpdated
|
dateTime | |
DateCreated
|
dateTime | |
ContactID
|
integer | |
CompanyName
|
string | |
CompanyIDFK
|
integer |
Name | Data Type | Description |
---|---|---|
id
|
long |
Credit Note ID Number |
Name | Data Type | Description |
---|---|---|
CreditNote
|
object |
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] | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
CreditNoteAllocations
|
array [CreditNoteAllocation] | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
Balance
|
double |
Name | Data Type | Description |
---|---|---|
pageNumber
|
integer |
Page to display. Starts from 1. |
pageSize
|
integer |
Number of items per page |
UpdatedAfter
|
dateTime |
Name | Data Type | Description |
---|---|---|
CreditNoteList
|
object |
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CreditNotes
|
array [CreditNote] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
CurrencyList
|
object |
Currencies
|
array [Currency] | |||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
id
|
long |
Estimate Estimate ID number |
EstimateStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"
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 |
Name | Data Type | Description |
---|---|---|
EstimateList
|
object |
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Estimates
|
array [EstimateDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
id
|
long |
Expense ID number |
Name | Data Type | Description |
---|---|---|
ExpenseDetails
|
object |
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 |
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 |
Name | Data Type | Description |
---|---|---|
ExpenseList
|
object |
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expenses
|
array [ExpenseDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create an Expense
Name | Data Type | Description |
---|---|---|
NewExpense
|
object |
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 |
Name | Data Type | Description |
---|---|---|
ExpenseDetails
|
object |
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 |
Name | Data Type | Description |
---|---|---|
id
|
long |
InventoryItem ID number |
Name | Data Type | Description |
---|---|---|
pageNumber
|
integer |
Page to display. Starts from 1. |
pageSize
|
integer |
Number of items per page |
UpdatedAfter
|
dateTime |
Name | Data Type | Description |
---|---|---|
InventoryList
|
object |
TotalCount
|
integer | |||||||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||||||||
PageNumber
|
integer | |||||||||||||||||||||||||||||||||||
Inventory
|
array [InventoryItem] | |||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
id
|
long |
Invoice Transaction ID number |
TransactionStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"
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 |
Name | Data Type | Description |
---|---|---|
InvoiceList
|
object |
TotalCount
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invoices
|
array [Invoice] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NewInvoice
|
object |
New invoice to be created |
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] | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
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. |
Name | Data Type | Description |
---|---|---|
Invoice
|
object |
TransactionTaxConfigCode
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionStatusCode
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionPrefix
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionID
|
long | ||||||||||||||||||||||||||||||||||||||||||||||||||
TotalAmount
|
double | ||||||||||||||||||||||||||||||||||||||||||||||||||
TaxAmount
|
double | ||||||||||||||||||||||||||||||||||||||||||||||||||
Subject
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
Recipient
|
RecipientDetails | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Notes
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
Links
|
InvoiceLinks | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
LineItems
|
array [InvoiceLineItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Issuer
|
IssuerDetails | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
Name | Data Type | Description |
---|---|---|
id
|
long |
Invoice Transaction ID Number |
Name | Data Type | Description |
---|---|---|
Payment
|
object |
TransactionStatusCode
|
string | ||||||||||||||||||||
TransactionReference
|
string | ||||||||||||||||||||
TransactionPrefix
|
string | ||||||||||||||||||||
TransactionID
|
long | ||||||||||||||||||||
TotalAmount
|
double | ||||||||||||||||||||
PaymentProviderCode
|
string | ||||||||||||||||||||
PaymentNumber
|
string | ||||||||||||||||||||
PaymentAllocations
|
array [PaymentAllocation] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Notes
|
string | ||||||||||||||||||||
ExchangeRate
|
double | ||||||||||||||||||||
DateUpdated
|
dateTime | ||||||||||||||||||||
DateIssued
|
dateTime | ||||||||||||||||||||
DateCreated
|
dateTime | ||||||||||||||||||||
CustomerIDFK
|
integer | ||||||||||||||||||||
CurrencyCode
|
string | ||||||||||||||||||||
Balance
|
double | ||||||||||||||||||||
AccountIDFK
|
integer |
Name | Data Type | Description |
---|---|---|
pageNumber
|
integer |
Page to display. Starts from 1. |
pageSize
|
integer |
Number of items per page |
UpdatedAfter
|
dateTime |
Name | Data Type | Description |
---|---|---|
PaymentList
|
object |
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Payments
|
array [Payment] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer |
Name | Data Type | Description |
---|---|---|
NewPayment
|
object |
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. |
|||||||||||||
Properties
|
|||||||||||||||
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 |
Name | Data Type | Description |
---|---|---|
Payment
|
object |
TransactionStatusCode
|
string | ||||||||||||||||||||
TransactionReference
|
string | ||||||||||||||||||||
TransactionPrefix
|
string | ||||||||||||||||||||
TransactionID
|
long | ||||||||||||||||||||
TotalAmount
|
double | ||||||||||||||||||||
PaymentProviderCode
|
string | ||||||||||||||||||||
PaymentNumber
|
string | ||||||||||||||||||||
PaymentAllocations
|
array [PaymentAllocation] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Notes
|
string | ||||||||||||||||||||
ExchangeRate
|
double | ||||||||||||||||||||
DateUpdated
|
dateTime | ||||||||||||||||||||
DateIssued
|
dateTime | ||||||||||||||||||||
DateCreated
|
dateTime | ||||||||||||||||||||
CustomerIDFK
|
integer | ||||||||||||||||||||
CurrencyCode
|
string | ||||||||||||||||||||
Balance
|
double | ||||||||||||||||||||
AccountIDFK
|
integer |
Name | Data Type | Description |
---|---|---|
id
|
long |
Project ID number |
Name | Data Type | Description |
---|---|---|
ProjectDetails
|
object |
isArchived
|
boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Title
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StartDate
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sections
|
array [ProjectSectionDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProjectTags
|
array [ProjectTagItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndDate
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateUpdated
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateCreated
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompanyName
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompanyIDFK
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BudgetHours
|
double | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BudgetAmount
|
double |
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) |
Name | Data Type | Description |
---|---|---|
ProjectList
|
object |
TotalCount
|
integer | |||||||||||||||||||||||||||||
Projects
|
array [ProjectListDetails] | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||
PageNumber
|
integer |
Name | Data Type | Description |
---|---|---|
NewProjectModel
|
object |
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 |
Name | Data Type | Description |
---|---|---|
ProjectDetails
|
object |
isArchived
|
boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Title
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StartDate
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sections
|
array [ProjectSectionDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProjectTags
|
array [ProjectTagItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndDate
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateUpdated
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateCreated
|
dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompanyName
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompanyIDFK
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BudgetHours
|
double | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BudgetAmount
|
double |
Name | Data Type | Description |
---|---|---|
ProjectID
|
integer |
Get categories filtered by ProjectID |
Name | Data Type | Description |
---|---|---|
ProjectTimesheetCategoryList
|
object |
Categories
|
array [ProjectTimesheetCategoryDetails] | |||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ProjectID
|
integer |
Get sections for Project with ProjectID |
Name | Data Type | Description |
---|---|---|
SectionList
|
object |
TotalCount
|
integer | |||||||||||||||||||||||||||||
Sections
|
array [SectionDetails] | |||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
NewSection
|
object |
Title
|
string | |
StartDateUTC
|
dateTime | |
ProjectIDFK
|
integer | |
EndDateUTC
|
dateTime |
Name | Data Type | Description |
---|---|---|
SectionDetails
|
object |
Title
|
string | |
StartDateUTC
|
dateTime | |
StartDate
|
dateTime | |
SectionID
|
integer | |
ProjectIDFK
|
integer | |
EndDateUTC
|
dateTime | |
EndDate
|
dateTime | |
DisplayOrder
|
integer |
Name | Data Type | Description |
---|---|---|
id
|
long |
Task ID number |
Name | Data Type | Description |
---|---|---|
TaskDetails
|
object |
Title
|
string | ||||||||||||||
TaskStatusCode
|
string | ||||||||||||||
TaskID
|
integer | ||||||||||||||
Tags
|
array [TagItem] | ||||||||||||||
Properties
|
|||||||||||||||
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 |
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. |
Name | Data Type | Description |
---|---|---|
TaskList
|
object |
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tasks
|
array [TaskDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer |
Name | Data Type | Description |
---|---|---|
NewTask
|
object |
Title
|
string | |||||||||||
Tags
|
array [NewTag] |
Collection of tags specifying Name and Color (Hex) |
||||||||||
Properties
|
||||||||||||
SectionIDFK
|
integer | |||||||||||
ProjectIDFK
|
integer | |||||||||||
EstimatedEffort
|
double |
Decimal hours |
||||||||||
Description
|
string | |||||||||||
DateStartUTC
|
dateTime | |||||||||||
DateStart
|
dateTime | |||||||||||
DateDueUTC
|
dateTime | |||||||||||
DateDue
|
dateTime | |||||||||||
AssignedToUserIDFK
|
integer |
Name | Data Type | Description |
---|---|---|
TaskDetails
|
object |
Title
|
string | ||||||||||||||
TaskStatusCode
|
string | ||||||||||||||
TaskID
|
integer | ||||||||||||||
Tags
|
array [TagItem] | ||||||||||||||
Properties
|
|||||||||||||||
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 |
Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.
Name | Data Type | Description |
---|---|---|
UpdateTask
|
object |
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 |
Name | Data Type | Description |
---|---|---|
TaskDetails
|
object |
Title
|
string | ||||||||||||||
TaskStatusCode
|
string | ||||||||||||||
TaskID
|
integer | ||||||||||||||
Tags
|
array [TagItem] | ||||||||||||||
Properties
|
|||||||||||||||
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 |
Name | Data Type | Description |
---|---|---|
TaxList
|
object |
Taxes
|
array [TaxItem] | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
id
|
long |
The TimesheetEntryID of the Timesheet Entry |
Name | Data Type | Description |
---|---|---|
body
|
object |
Name | Data Type | Description |
---|---|---|
id
|
long |
Timesheet ID number |
Name | Data Type | Description |
---|---|---|
TimesheetDetails
|
object |
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 |
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 |
Name | Data Type | Description |
---|---|---|
TimesheetList
|
object |
TotalCount
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Timesheets
|
array [TimesheetDetails] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer |
Name | Data Type | Description |
---|---|---|
NewTimesheet
|
object |
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. |
Name | Data Type | Description |
---|---|---|
TimesheetDetails
|
object |
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 |
The FieldsToUpdate field expects a string array collection of the field names you would like updated.
Name | Data Type | Description |
---|---|---|
UpdateTimesheetModel
|
object |
hasStartEndTime
|
boolean | |
TimeSheetEntryID
|
long | |
TimeSheetCategoryIDFK
|
integer | |
TaskIDFK
|
integer | |
ProjectIDFK
|
integer | |
Notes
|
string | |
FieldsToUpdate
|
array [string] | |
EntryDate
|
dateTime | |
Duration
|
double |
Name | Data Type | Description |
---|---|---|
TimesheetDetails
|
object |
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 |
Name | Data Type | Description |
---|---|---|
id
|
long |
The ID of the existing timesheet entry that needs its timer stopped |
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 |
Name | Data Type | Description |
---|---|---|
body
|
object |
Name | Data Type | Description |
---|---|---|
id
|
long |
The ID of the existing timesheet entry on which to start a timer |
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 |
Name | Data Type | Description |
---|---|---|
body
|
object |
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 |
Name | Data Type | Description |
---|---|---|
body
|
object |
Admin and Invoice Managers can see all. Other users are limited to seeing their own profile.
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") |
Name | Data Type | Description |
---|---|---|
UserList
|
object |
Users
|
array [UserDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
id
|
integer |
Subscription id to be deleted |
Name | Data Type | Description |
---|---|---|
body
|
object |
Name | Data Type | Description |
---|---|---|
target_url
|
string |
Target URL that should be used to delete subscriptions |
Name | Data Type | Description |
---|---|---|
body
|
object |
Name | Data Type | Description |
---|---|---|
WebhookList
|
object |
Webhooks
|
array [WebhookDetails] | |||||||||||||||||
Properties
|
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]"
Name | Data Type | Description |
---|---|---|
CreateSubscription
|
object |
New Subscription to be Created |
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 |
Name | Data Type | Description |
---|---|---|
SubscribeResult
|
object |
ID
|
integer |
Name | Data Type | Description |
---|---|---|
hasStartEndTimesheets
|
boolean | |
has24HourTimesheetFormat
|
boolean | |
WeeklyTimesheetReminder
|
boolean | |
TimesheetDisplayFormatCode
|
string | |
TimesheetDayOfWeek
|
integer | |
Subdomain
|
string | |
LockApprovedTimesheets
|
boolean | |
CompanyName
|
string | |
AccountID
|
integer |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
website
|
string | |||||||||||||||||||||||||||||||||||||||||
TaxNumber
|
string | |||||||||||||||||||||||||||||||||||||||||
Phone
|
string | |||||||||||||||||||||||||||||||||||||||||
Fax
|
string | |||||||||||||||||||||||||||||||||||||||||
DefaultTradingTermIDFK
|
integer | |||||||||||||||||||||||||||||||||||||||||
DateUpdated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
DateCreated
|
dateTime | |||||||||||||||||||||||||||||||||||||||||
CurrencyCode
|
string | |||||||||||||||||||||||||||||||||||||||||
Contacts
|
array [CompanyContact] | |||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
CompanyName
|
string | |||||||||||||||||||||||||||||||||||||||||
CompanyID
|
integer | |||||||||||||||||||||||||||||||||||||||||
Comments
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingCountryCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressState
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressPostCode
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressLine
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddressCity
|
string | |||||||||||||||||||||||||||||||||||||||||
BillingAddress
|
string |
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 |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Companies
|
array [Company] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | |||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | |||||||||||||||||||||||||||||||||||||||||
Contacts
|
array [CompanyContact] | |||||||||||||||||||||||||||||||||||||||||
Properties
|
New Subscription to be Created
Name | Data Type | Description |
---|---|---|
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 |
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] | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
CreditNoteAllocations
|
array [CreditNoteAllocation] | |||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
Balance
|
double |
Name | Data Type | Description |
---|---|---|
TransactionAllocationID
|
long | |
InvoiceTransactionIDFK
|
long | |
CreditNoteTransactionIDFK
|
long | |
AllocationDate
|
dateTime | |
AllocationAmount
|
double |
Name | Data Type | Description |
---|---|---|
UnitPrice
|
double | |
TransactionLineItemID
|
long | |
TaxIDFK
|
integer | |
TaxAmount
|
double | |
Quantity
|
double | |
Discount
|
double | |
Description
|
string | |
Amount
|
double |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CreditNotes
|
array [CreditNote] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DecimalPlaces
|
integer | |
CurrencyCode
|
string |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Currencies
|
array [Currency] | |||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalAmount
|
double | ||||||||||||||||||||||||||||||||||||||||||||
TaxAmount
|
double | ||||||||||||||||||||||||||||||||||||||||||||
Subject
|
string | ||||||||||||||||||||||||||||||||||||||||||||
Recipient
|
RecipientDetails | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
Notes
|
string | ||||||||||||||||||||||||||||||||||||||||||||
Links
|
EstimateLinks | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
LineItems
|
array [EstimateLineItemDetails] | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
Issuer
|
IssuerDetails | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
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 |
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 |
Name | Data Type | Description |
---|---|---|
View
|
string | |
Edit
|
string | |
ClientView
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Estimates
|
array [EstimateDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expenses
|
array [ExpenseDetails] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | |||||||||||||||||||||||||||||||||||
PageSize
|
integer | |||||||||||||||||||||||||||||||||||
PageNumber
|
integer | |||||||||||||||||||||||||||||||||||
Inventory
|
array [InventoryItem] | |||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TransactionTaxConfigCode
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionStatusCode
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionPrefix
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
TransactionID
|
long | ||||||||||||||||||||||||||||||||||||||||||||||||||
TotalAmount
|
double | ||||||||||||||||||||||||||||||||||||||||||||||||||
TaxAmount
|
double | ||||||||||||||||||||||||||||||||||||||||||||||||||
Subject
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
Recipient
|
RecipientDetails | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Notes
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
Links
|
InvoiceLinks | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
LineItems
|
array [InvoiceLineItem] | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Issuer
|
IssuerDetails | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
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 |
Name | Data Type | Description |
---|---|---|
View
|
string | |
Edit
|
string | |
ClientView
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TotalCount
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||
PageSize
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||
PageNumber
|
integer | ||||||||||||||||||||||||||||||||||||||||||||||||
Invoices
|
array [Invoice] | ||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|