Retrieving a Single Entity
To retrieve an entity, pass in the entity uid. The entity uid is specified in the URL using the uid query string parameter. For Invoice, you can specify an additional format query string parameter. Accepted formats are xml and pdf. Setting the format value to pdf will cause the invoice to be returned as PDF instead of XML.
Example
To retrieve a contact with uid 123
https://secure.saasu.com/webservices/rest/r1/contact?wsaccesskey=test-888-888&fileuid=888888&uid=123
To retrieve an invoice with uid 123 (output as XML) https://secure.saasu.com/webservices/rest/r1/invoice?wsaccesskey=test-888-888&fileuid=888888&uid=123
To retrieve an invoice with uid 123 (output as PDF)
https://secure.saasu.com/webservices/rest/r1/invoice?wsaccesskey=test-888-888&fileuid=888888&uid=123&format=pdf
HTTP GET Queries
The term queries refers to lists and reports in this documentation.
Criteria are embedded in the request URI using query string parameters. All criteria are joined using the AND logical operator, unless explicitly specified otherwise in this documentation.
In some queries, you can specify what fields to retrieve and how the result is sorted through URL query string parameters. If no fields or sort options are specified, the operation will return with default fields and sort options as determined by the system.
Fields are specified through fields query string parameter, and sorting is specified through sort options query string parameter. Their values are comma separated.
InvoiceList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| TransactionType | String | Y | Either s or p. s = Sale. p = Purchase. |
| PaidStatus | String | Either Paid or Unpaid. | |
| InvoiceStatus | Use: Q = Quote O = Order I = Invoice |
||
| InvoiceDateFrom | Date | Must be used together with InvoiceDateTo. Returns invoices between the specified dates. If no date range specified returns the most recent ones within 100 days back, 30 days forward. |
|
| InvoiceDateTo | Date | ||
| InvoiceDueDateFrom | Date | Must be used together with InvoiceDueDateTo. Returns invoices that are due between the specified dates. |
|
| InvoiceDueDateTo | Date | ||
| ContactUid | Int | ||
| FolderUid | Int | DEPRECATED.Use IncludeAllTags, IncludeAnyTags, ExcludeAllTags or ExcludeAnyTags instead. |
|
| IncludeAllTags | String | Either use IncludeAllTags or IncludeAnyTags, but not both. Separate tags by comma. e.g. http://…/invoicelist?wsaccesskey=xxx&fileuid=999&transactiontype=s& includealltags=division1,division2. This will return all sales that have BOTH “division1″ AND “division2″ tags applied. |
|
| IncludeAnyTags | String | Either use IncludeAllTags or IncludeAnyTags, but not both. Separate tags by comma. e.g. http://…/invoicelist?wsaccesskey=xxx&fileuid=999&transactiontype=s& includeanytags=division1,division2. This will return all sales that have EITHER “division1″ OR “division2″ tags applied. |
|
| ExcludeAllTags | String | Can be used in conjunction with “IncludeAllTags” or “IncludeAnyTags” but not “ExcludeAnyTags”. |
|
| ExcludeAnyTags | String | Can be used in conjunction with “IncludeAllTags” or “IncludeAnyTags” but not “ExcludeAllTags” |
|
| IsSent | Boolean | ||
| InvoiceNumberBeginsWith | String | ||
| PurchaseOrderNumberBeginsWith | String |
Fields Returned
InvoiceUid, LastUpdatedUid, FolderUid (DEPRECATED), FolderName (DEPRECATED), TransactionType,
InvoiceDate, Summary, InvoiceNumber, PurchaseOrderNumber, DueDate,
TotalAmountInclTax, PaymentCount, TotalAmountPaid, AmountOwed,
PaidStatus, RequiresFollowUp, IsSent,
InvoiceLayout, InvoiceStatus, InvoiceTypeUid,
ContactUid, ContactGivenName, ContactFamilyName, ContactOrganisationName,
Tags
Examples
Retrieve a list of unpaid sale orders for contact 9
https://…/invoicelist?wsaccesskey=XXX&fileuid=999&transactiontype=S&contactuid=9&invoicestatus=O&paidStatus=unpaid
InvoicePaymentList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| TransactionType | String | Y | Either SP or PP SP = Sale Payment PP = Purchase Payment |
| PaymentDateFrom | Date | If PaymentDateFrom and PaymentDateTo are both provided, payments paid/received between the specified dates will be returned.If PaymentDateFrom is provided but PaymentDateTo is not provided, payments with date >= payments will be returned.
If PaymentDateFrom is not provided but PaymentDateTo is provided, payments with date <= PaymentDateTo will be returned. |
|
| PaymentDateTo | Date | ||
| DateClearedFrom | Date | If DateClearedFrom and DateClearedTo are both provided, payments cleared between the specified dates will be returned.If DateClearedFrom is provided but DateClearedTo is not provided, payments cleared date >= DateClearedFrom will be returned.
If DateClearedFrom is not provided but DateClearedTo is provided, payments cleared <= DateClearedTo will be returned. |
|
| DateClearedTo | Date | ||
| BankAccountUid | Int | The bank account where the payment is made or banked to. |
Valid Fields
InvoicePaymentUid, LastUpdatedUid, PaymentDate, DateCleared, Summary, Reference, BankAccountUid, BankAccountName, Amount, RequiresFollowUp
Default Fields
InvoicePaymentUid, LastUpdatedUid, PaymentDate, Summary, Reference, BankAccountName, Amount
Default Sort Options
PaymentDate DESC, Summary ASC
Examples
Retrieve a list of sale payments dated between 1-Jul-05 to 30-Jun-06 banked to Westpac Account (BankAccountUid = 8101).
https://…/InvoicePaymentList?WSAccessKey=XXX&FileUid=999&TransactionType=SP&
BankAccountUid=8101&PaymentDateFrom=2005-07-01&PaymentDateTo=2006-06-30
ContactList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| StatusUid | Int | DEPRECATED. Use IncludeAllTags, IncludeAnyTags, ExcludeAllTags or ExcludeAnyTags instead. |
|
| IndustryUid | Int | DEPRECATED. Use IncludeAllTags, IncludeAnyTags, ExcludeAllTags or ExcludeAnyTags instead. |
|
| IncludeAllTags | String | Either use IncludeAllTags or IncludeAnyTags, but not both. Separate tags by comma. | |
| IncludeAnyTags | String | Either use IncludeAllTags or IncludeAnyTags, but not both. Separate tags by comma. |
|
| ExcludeAllTags | String | Can be used in conjunction with “IncludeAllTags” or “IncludeAnyTags” but not “ExcludeAnyTags”. |
|
| ExcludeAnyTags | String | Can be used in conjunction with “IncludeAllTags” or “IncludeAnyTags” but not “ExcludeAllTags” |
|
| IsActive | Boolean | ||
| SearchFieldName | String | Valid values: OrganisationName, GivenName, or FamilyName. | |
| SearchFieldNameBeginsWith | String |
Fields Returned
ContactUid, LastUpdatedUid, Salutation, GivenName, MiddleInitials, FamilyName, DateOfBirth,
Organisation, OrganisationName, OrganisationABN, ABN,
OrganisationWebsite, OrganisationPosition, EmailAddress, WebsiteUrl, IsActive,
MainPhone, HomePhone, MobilePhone, OtherPhone, Fax,
Street, City, State, PostCode, Country,
OtherStreet, OtherCity, OtherState, OtherPostCode, OtherCountry,
ContactID,
AcceptDirectDeposit, DirectDepositAccountName, DirectDepositAccountBSB, DirectDepositAccountNumber,
AcceptCheque, ChequePayableTo,
StatusUid (DEPRECATED), Status (DEPRECATED), IndustryUid (DEPRECATED), Industry (DEPRECATED),
Tags
Examples
Retrieve a list prospects from IT industry (”Prospects” and “IT” are tags)
https://…/contactlist?wsaccesskey=xxx&fileuid=999&includealltags=prospects,it
Retrieve a list of contacts where the given name begins with j
https://…/contactlist?wsaccesskey=xxx&fileuid=999&&searchfieldname=givenname&searchfieldnamebeginswith=j
TagList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean |
Fields Returned
TagUid, Name, Frequency, IsActive, IsPopular,
IsFolder, IsActivity,
IsPM, IsConnector, IsInbuilt, IsCustomer,
IsProspect, IsPartner, IsSupplier
Note: IsFolder flag == IsReportTag
TransactionCategoryList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| Type | String | Valid value is one of the following: Income, Expense, Asset, Equity, Loan, Other Income, Other Expense, Cost of Sales |
|
| IsActive | Boolean | ||
| IsInbuilt | Boolean | Inbuilt Accounts are system-wide Accounts that are shared across all Files. |
Valid Fields
TransactionCategoryUid, LastUpdatedUid, Type, Name, IsActive, IsInbuilt
Default Fields
TransactionCategoryUid, LastUpdatedUid, Type, Name, IsActive
Default Sort Options
Type ASC, Name ASC
Examples
Retrieve a list of active expense Accounts that are not inbuil
https://…/TransactionCategoryList?WSAccessKey=XXX&FileUid=999&Type=Expense&IsActive=true&IsInbuilt=false
BankAccountList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| Type | String | Valid value is one of the following: Income, Expense, Asset, Equity, Loan, Other Income, Other Expense, Cost of Sales |
|
| IsActive | Boolean | ||
| IsInbuilt | Boolean | Inbuilt Accounts are system-wide Accounts that are shared across all Files. |
Valid Fields
BankAccountUid, LastUpdatedUid, Type, Name, IsActive, IsInbuilt, DisplayName, BSB, AccountNumber
Default Fields
BankAccountUid, LastUpdatedUid, Type, BSB, AccountNumber, DisplayName, IsActive
Default Sort Options
Type ASC, DisplayName ASC
Examples
Retrieve a list of active bank accounts.
https://…/BankAccountList?WSAccessKey=XXX&FileUid=999&IsActive=true
InventoryItemList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean | ||
| CodeBeginsWith | String | ||
| DescriptionBeginsWith | String |
Valid Fields
InventoryItemUid, LastUpdatedUid, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax
Default Fields
InventoryItemUid, LastUpdatedUid, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax
Default Sort Options
Description ASC, Code ASC
Examples
Retrieve a list of inventory items where the description begins with Pentium.
https://…/InventoryItemList?WSAccessKey=XXX&FileUid=999&DescriptionBeginsWith=Pentium
ComboItemList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean | ||
| CodeBeginsWith | String | ||
| DescriptionBeginsWith | String |
Valid Fields
InventoryItemUid, LastUpdatedUid, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax
Default Fields
InventoryItemUid, LastUpdatedUid, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax
Default Sort Options
Description ASC, Code ASC
Examples
Retrieve a list of combo items where the description begins with SOHO.
https://…/InventoryItemList?WSAccessKey=XXX&FileUid=999&DescriptionBeginsWith=SOHO
