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
Syncing with Saasu
There are instances where API users need to keep data in Saasu synced with data from different systems. Most of the time this requires retrieving a list of records from Saasu and checking if there are any changes to perform necessary updates.
Example
You have created a new contact in Saasu, and you need to sync the new contact with your CRM system.
- Setup a process that checks for any contact updates in Saasu at a particular time of the day, for an example at 04:00 every day.
- Every day at 04:00, the process will make a request to the ContactList resource to retrieve any contacts that were updated/inserted in Saasu after the last Sync. For an example, if the last sync ran at 04:00 on the 20th May 2009, then to get any updated/inserted contact records after the last sync make the following request:
https://.../ContactList?WSAccessKey=xxx&FileUid=999&UtcLastmodifiedFrom=2009-05-20T04:00:00&UtcLastmodifiedTo=2009-05-21T04:00:00
That’s all good, but what if there are any DELETED contacts in Saasu that I need to sync?
Good question, this is where the DeletedEntityList comes in handy. The DeletedEntityList resource will return a list of entities that were deleted from Saasu.
In this instance, to get a list of contacts that were deleted since the last sync, make the following request to the DeletedEntityList resource:
https://.../DeletedEntityList?WSAccessKey=XXX&FileUid=999&EntityTypeUid=10&UtcDeletedFrom=2009-05-20T04:00:00&UtcDeleteTo=2009-05-21T04:00:00
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:
* required
| QueryStringParameter | Type | Notes |
|---|---|---|
| * TransactionType | String | Either s or p. s = Sale. p = Purchase. |
| PaidStatus | String | If not specified, will only return unpaid invoices. Valid values are: “paid”, “unpaid”, “all”. |
| 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 | |
| IncludeAllTags | String | Either use IncludeAllTags or IncludeAnyTags, but not both. Separate tags by comma. Example: 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 | |
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8601 format. Returns a list of invoices that were modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/invoicelist?wsaccesskey=xxx&fileuid= 999&transactiontype=s&utclastmodifiedfrom= 2009-03-06T02:20:00&utclastmodifiedto= 2009-03-06T02:30:00 |
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModfiedFrom. Usually, the DateTime would be in UTC, and ISO 8601 format. |
Deprecated filters and fields
The following filters are no longer supported:
- FolderUid. Use IncludeAllTags, IncludeAnyTags, ExcludeAllTags or
ExcludeAnyTags instead.
The following return fields have been deprecated: FolderUid, FolderName.
Fields Returned
InvoiceUid, LastUpdatedUid, TransactionType,
InvoiceDate, UtcFirstCreated, UtcLastModified, Summary, InvoiceNumber, PurchaseOrderNumber, DueDate,
Ccy, AutoPopulateFxRate, FcToBcFxRate, TotalAmountInclTax, PaymentCount, TotalAmountPaid, AmountOwed,
PaidStatus, RequiresFollowUp, IsSent,
InvoiceLayout, InvoiceStatus, InvoiceTypeUid,
ContactUid, ContactGivenName, ContactFamilyName, ContactOrganisationName,ShipToContactUid, ShipToContactFirstname, ShipToContactLastName, ShipToContactOrganisation
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 | ||
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8601 format. Returns a list of invoice payments that were modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/invoicepaymentlist?wsaccesskey=xxx&fileuid=999&transactiontype=sp&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModfiedFrom. Usually, the DateTime would be in UTC, and ISO 8601 format. | |
| BankAccountUid | Int | The bank account where the payment is made or banked to. |
Valid Fields
InvoicePaymentUid, LastUpdatedUid, PaymentDate, Ccy, AutoPopulateFxRate, FcToBcFxRate, UtcFirstCreated, UtcLastModified DateCleared, Summary, Reference, BankAccountUid, BankAccountName, Amount, RequiresFollowUp
Default Fields
InvoicePaymentUid, LastUpdatedUid, PaymentDate, Ccy, AutoPopulateFxRate, FcToBcFxRate, UtcFirstCreated, UtcLastModified, DateCleared, Summary, Reference, BankAccountUid, 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 |
|---|---|---|---|
| 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, FamilyName, EmailAddress or ContactID | |
| SearchFieldNameBeginsWith | String | ||
| Contact ID | String | ||
| GivenName | String | Performs exact search by given name (a.k.a first name) | |
| FamilyName | String | Performs exact search by family name (a.k.a. last name) | |
| OrganisationName | String | Performs exact search by organisation name (a.k.a. company). | |
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8601 format. Returns a list of contacts that were modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/contactlist?wsaccesskey=xxx&fileuid=999&givenname=james&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedFrom. Usually, the DateTime would be in UTC, and ISO 8601 format. |
Deprecated filters and fields
The following filters are no longer supported: IndustryUid, StatusUid. Use IncludeAllTags, IncludeAnyTags, ExcludeAllTags or ExcludeAnyTags instead.
Fields Returned
ContactUid, UtcFirstCreated, UtcLastModified, 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,
Tags,
CustomField1, CustomField2
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
Look up Carl O’Neil from O’Neil Capital
https://.../contactlist?wsaccesskey=xxx&fileuid=999&givenname= carl&familyName=o'neil&organisationName=o'neil+capital
Look up contact by Contact ID
https://.../contactlist?wsaccesskey=xxx&fileuid=999&contactid=GLD879
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 (Chart of Account List)
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| Type | String | Valid value is one of the following: Income, Expense, Asset, Equity, Liability, 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, Liability, 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
NOTE: DEPRECATED – Use FullInventoryItemList instead
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean | ||
| CodeBeginsWith | String | ||
| DescriptionBeginsWith | String | ||
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of inventory items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/inventoryitemlist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
InventoryItemUid, LastUpdatedUid, UtcFirstCreated, UtcLastModified, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo
Default Fields
InventoryItemUid, LastUpdatedUid, UtcFirstCreated, UtcLastModified, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo
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
FullInventoryItemList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean | ||
| CodeBeginsWith | String | ||
| DescriptionBeginsWith | String | ||
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of inventory items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/inventoryitemlist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
InventoryItemUid, LastUpdatedUid, UtcFirstCreated, UtcLastModified, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo, IsInventoried, AssetAccountUid, QuantityOnOrder, QuantityCommitted, IsBought, PurchaseExpenseAccountUid, PurchaseTaxCode, MinimumStockLevel, PrimarySupplierContactUid, PrimarySupplierItemCode, DefaultReOrderQuantity, IsSold,
SaleIncomeAccountUid, SaleTaxCode, SaleCoSAccountUid, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVoucher, ValidFrom, ValidTo, IsVirtual, IsVisible, Notes
Default Fields
InventoryItemUid, LastUpdatedUid, UtcFirstCreated, UtcLastModified, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo, IsInventoried, AssetAccountUid, QuantityOnOrder, QuantityCommitted, IsBought, PurchaseExpenseAccountUid, PurchaseTaxCode, MinimumStockLevel, PrimarySupplierContactUid, PrimarySupplierItemCode, DefaultReOrderQuantity, IsSold,
SaleIncomeAccountUid, SaleTaxCode, SaleCoSAccountUid, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVoucher, ValidFrom, ValidTo, IsVirtual, IsVisible, Notes
Default Sort Options
Description ASC, Code ASC
Examples
Retrieve a list of inventory items where the description begins with Pentium.
https://.../FullInventoryItemList?WSAccessKey=XXX&FileUid= 999&DescriptionBeginsWith=Pentium
ComboItemList
NOTE: DEPRECATED – Use FullComboItemList instead
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean | ||
| CodeBeginsWith | String | ||
| DescriptionBeginsWith | String | ||
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of combo items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/comboitemlist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
InventoryItemUid, LastUpdatedUid, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo
Default Fields
InventoryItemUid, LastUpdatedUid, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo
Default Sort Options
Description ASC, Code ASC
Examples
Retrieve a list of combo items where the description begins with SOHO.
https://.../ComboItemList?WSAccessKey=XXX&FileUid=999&DescriptionBeginsWith=SOHO
FullComboItemList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| IsActive | Boolean | ||
| CodeBeginsWith | String | ||
| DescriptionBeginsWith | String | ||
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of combo items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/comboitemlist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
UtcFirstCreated, UtcLastModified, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo, IsInventoried, AssetAccountUid, QuantityOnOrder, QuantityCommitted, IsBought, PurchaseExpenseAccountUid, PurchaseTaxCode, MinimumStockLevel, PrimarySupplierContactUid, PrimarySupplierItemCode, DefaultReOrderQuantity, IsSold,
SaleIncomeAccountUid, SaleTaxCode, SaleCoSAccountUid, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVoucher, ValidFrom, ValidTo, IsVirtual, IsVisible, Notes, Items, Item, Uid, Code, Quantity
Default Fields
UtcFirstCreated, UtcLastModified, Code, Description, IsActive, StockOnHand, CurrentValue, AverageCost, RrpInclTax, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVirtual, VType, IsVisibile, IsVoucher, ValidFrom, ValidTo, IsInventoried, AssetAccountUid, QuantityOnOrder, QuantityCommitted, IsBought, PurchaseExpenseAccountUid, PurchaseTaxCode, MinimumStockLevel, PrimarySupplierContactUid, PrimarySupplierItemCode, DefaultReOrderQuantity, IsSold,
SaleIncomeAccountUid, SaleTaxCode, SaleCoSAccountUid, SellingPrice, IsSellingPriceIncTax, BuyingPrice, IsBuyingPriceIncTax, IsVoucher, ValidFrom, ValidTo, IsVirtual, IsVisible, Notes, Items, Item, Uid, Code, Quantity
Default Sort Options
Description ASC, Code ASC
Examples
Retrieve a list of combo items where the description begins with SOHO.
https://.../FullComboItemList?WSAccessKey=XXX&FileUid=999&DescriptionBeginsWith=SOHO
InventoryAdjustmentList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| DateFrom | DateTime | ||
| DateTo | DateTime | UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of inventory items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/inventoryAdjustmentlist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
InventoryAdjustmentUid, Date, Summary, UtcFirstCreated, UtcLastModified, RequiresFollowUp
Default Fields
InventoryAdjustmentUid, Date, Summary, UtcFirstCreated, UtcLastModified, RequiresFollowUp
Default Sort Options
Date DESC, Summary ASC
Examples
Retrieve a list of inventory adjustments between 2009-06-06 and 2009-07-06.
https://.../InventoryAdjustmentList?WSAccessKey=XXX&FileUid= 999&DateFrom=2009-06-06&DateTo=2009-07-06
InventoryTransferList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| DateFrom | DateTime | ||
| DateTo | DateTime | UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of inventory items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/inventoryTransferlist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
InventoryTransferUid, Date, Summary, UtcFirstCreated, UtcLastModified, RequiresFollowUp
Default Fields
InventoryTransferUid, Date, Summary, UtcFirstCreated, UtcLastModified, RequiresFollowUp
Default Sort Options
Date DESC, Summary ASC
Examples
Retrieve a list of inventory transfers between 2009-06-06 and 2009-07-06.
https://.../InventoryTransferList?WSAccessKey=XXX&FileUid=999&DateFrom= 2009-06-06&DateTo=2009-07-06
JournalList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| JournalDateFrom | DateTime | ||
| JournalDateTo | DateTime | ||
| 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” |
|
| UtcLastModifiedFrom | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. Returns a list of inventory items modified between UtcLastModifiedFrom and UtcLastModifiedTo. e.g. http://…/journallist?wsaccesskey=xxx&fileuid=999&utclastmodifiedfrom=2009-03-06T02:20:00&utclastmodifiedto=2009-03-06T02:30:00 |
|
| UtcLastModifiedTo | DateTime | Must be used together with UtcLastModifiedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Valid Fields
TransactionType, Date, Summary, Tags, Ccy, AutoPopulateFxRate, FcToBcFxRate, RequiresFollowUp, JournalItems, JournalItem, AccountUid, TaxCode, Type, Amount
Default Fields
TransactionType, Date, Summary, Tags, Ccy, AutoPopulateFxRate, FcToBcFxRate, RequiresFollowUp, JournalItems, JournalItem, AccountUid, TaxCode, Type, Amount
Examples
Returns a list of Jounrals between 2010-05-01 and 2010-05-05.
https://.../JournalList?WSAccessKey=XXX&FileUid=999&JournalDateFrom=2010-05-01&JournalDateTo=2010-05-05
TaxCodeList
Criteria
-
Examples
Returns a list of all tax codes in file.
https://.../TaxCodeList?WSAccessKey=XXX&;FileUid=999
DeletedEntityList
Criteria
| QueryStringParameter | Type | Required? | Notes |
|---|---|---|---|
| EntityTypeUid | int | Use: 4 = Sale 5 = Sale payment 7 = Purchase 8 = Purchase payment 10 = Contact 20 = Item |
|
| UtcDeletedFrom | DateTime | Must be used together with UtcDeletedTo. Usually, the DateTime would be in UTC, and ISO 8061 format. | |
| UtcDeletedTo | DateTime | Must be used together with UtcDeletedFrom. Usually, the DateTime would be in UTC, and ISO 8061 format. |
Fields Returned
EntityTypeUid, EntityUid, User, Timestamp
Examples
Retrieve a list of deleted contacts.
https://.../DeletedEntityList?WSAccessKey=XXX&;FileUid=999&;EntityTypeUid=10