Accounts

Api Call Description
GET Accounts ?IsActive={1|0|true|false|yes|no}&IsBankAccount={1|0|true|false|yes|no}&AccountType={Income|Expense|Asset|Equity|Liability|OtherIncome|OtherExpense|CostOfSales}&IncludeBuiltIn={1|0|true|false|yes|no}&HeaderAccountId={111}&AccountLevel={detail|header} &FileId=#####[&wsAccessKey=XXXXX] Returns a AccountListResponse object which contains a list of Account Detail records.
GET Account/Id ?FileId=#####[&wsAccessKey=XXXXX] Retrieves a single account.
DELETE Account/id ?FileId=#####[&wsAccessKey=XXXXX] Delete an account.
POST Account ?FileId=#####[&wsAccessKey=XXXXX] Insert an account.
PUT Account/id ?FileId=#####[&wsAccessKey=XXXXX] Update an account.

Attachments

Api Call Description
POST InvoiceAttachment ?FileId=#####[&wsAccessKey=XXXXX] Inserts an attachment for the specified File and User.
GET InvoiceAttachment/id ?FileId=#####[&wsAccessKey=XXXXX] Returns the attachment with the given attachment Id.
DELETE InvoiceAttachment/id ?FileId=#####[&wsAccessKey=XXXXX] Deletes an attachment with the specified attachment Id.
GET InvoiceAttachments/Id ?FileId=#####[&wsAccessKey=XXXXX] Gets all the information around attachments for a given invoice id. Does not return the attachment itself, just the metadata/information regarding all attachments.

Company

Api Call Description
GET Company/Id ?FileId=#####[&wsAccessKey=XXXXX] Retrieves the details for a single company.
GET Companies ?LastModifiedFromDate={YYYY-MM-DD}&LastModifiedToDate={YYYY-MM-DD}&CompanyName={some text} &FileId=#####[&wsAccessKey=XXXXX] Retrieves a list of companies.
DELETE Company/id ?FileId=#####[&wsAccessKey=XXXXX] Delete a company.
POST Company ?FileId=#####[&wsAccessKey=XXXXX] Insert a company.
PUT Company/id ?FileId=#####[&wsAccessKey=XXXXX] Update a company.

Contacts

Api Call Description
GET ContactAggregate/id ?FileId=#####[&wsAccessKey=XXXXX] Retrieves the details for a contact aggregate, consisting of the contact and its associated company and contact manager.
POST ContactAggregate ?FileId=#####[&wsAccessKey=XXXXX] Insert a contact aggregate. Inserts the contact and inserts or updates the associated company and contact manager.
PUT ContactAggregate/id ?FileId=#####[&wsAccessKey=XXXXX] Update a contact aggregate. Updates a contact and inserts or updates the associated company and contact manager.
GET Contacts ?LastModifiedFromDate={YYYY-MM-DD}&LastModifiedToDate={YYYY-MM-DD}&GivenName={some text}&FamilyName={some text}&CompanyName={some text}&CompanyId={some text}&IsActive={1|0|true|false|yes|no}&IsCustomer={1|0|true|false|yes|no}&IsSupplier={1|0|true|false|yes|no}&IsContractor={1|0|true|false|yes|no}&IsPartner={1|0|true|false|yes|no}&Tags={tag1,tag2}&TagSelection={requireAll|requireAny|excludeAll|excludeAny}&Email={email@somewhere.com}&ContactId={some text} &FileId=#####[&wsAccessKey=XXXXX] Gets a list of contacts for a given file.
GET Contact/Id ?FileId=#####[&wsAccessKey=XXXXX] Retrieves an individual contact.
DELETE Contact/Id ?FileId=#####[&wsAccessKey=XXXXX] Delete a Contact.
POST Contact ?FileId=#####[&wsAccessKey=XXXXX] Insert a contact.
PUT Contact/Id ?FileId=#####[&wsAccessKey=XXXXX] Update a contact.

FileIdentity

Api Call Description
GET FileIdentity ?FileId=#####[&wsAccessKey=XXXXX] Returns a single File Identity Detail record.
GET FileIdentities [?wsAccessKey=XXXXX] Returns a list of File Identity Summary records.

Invoices

Api Call Description
GET Invoices ?InvoiceNumber={123}&PurchaseOrderNumber={123}&LastModifiedFromDate={YYYY-MM-DD}&LastModifiedToDate={YYYY-MM-DD}&TransactionType={S|P}&Tags={tag1,tag2}&TagSelection={requireAll|requireAny|excludeAll|excludeAny}&InvoiceFromDate={YYYY-MM-DD}&InvoiceToDate={YYYY-MM-DD}&InvoiceStatus={I|Q|O}&PaymentStatus={P|U|A}&ContactId={some text} &FileId=#####[&wsAccessKey=XXXXX] Returns a list of Invoice transaction summary records.
GET Invoice/id ?FileId=#####[&wsAccessKey=XXXXX] Return a single Invoice Transaction Summary Record.
DELETE Invoice/id ?FileId=#####[&wsAccessKey=XXXXX] Delete an invoice.
POST Invoice ?FileId=#####[&wsAccessKey=XXXXX] Insert an invoice.
PUT Invoice/id ?FileId=#####[&wsAccessKey=XXXXX] Update an invoice.
POST Invoice/id/email-contact ?FileId=#####[&wsAccessKey=XXXXX] Email an invoice to the billing contact.
POST Invoice/id/email ?FileId=#####[&wsAccessKey=XXXXX] Email an invoice to the specified email address.

Items

Api Call Description
GET Items ?LastModifiedFromDate={YYYY-MM-DD}&LastModifiedToDate={YYYY-MM-DD}&ItemType={I|C}&SearchMethod={Contains|StartsWith}&SearchText={some text} &FileId=#####[&wsAccessKey=XXXXX] Retrieves a list of items.
GET Item/id ?FileId=#####[&wsAccessKey=XXXXX] Retrieves a single item.
POST Item ?FileId=#####[&wsAccessKey=XXXXX] Insert an inventory item.
PUT Item/Id ?FileId=#####[&wsAccessKey=XXXXX] Update an inventory item.
POST Item/id/build ?FileId=#####[&wsAccessKey=XXXXX] Build a quantity of a combo item.
DELETE Item/id ?FileId=#####[&wsAccessKey=XXXXX] Delete an inventory item.

OAuth

Api Call Description
GET authorisation/token Request an access token using the password credential grant process. Visit the documentation area on authentication for detailed explanation. Requires that the grant request be performed using a GET request and URL parameters. This is NOT the preferred method and using a POST request is preferred
POST authorisation/token Request an access token using the password credential grant process. Visit the documentation area on authentication for detailed explanation. Requires that the grant request be performed using a POST request. This is the preferred method.
POST authorisation/refresh Refresh an access token using a previously issued refresh token. Visit the documentation area on authentication for detailed explanation.
GET authorisation/ping This is provided simply to be able to test whether the access/bearer token issued is valid

Payments

Api Call Description
POST Payment ?FileId=#####[&wsAccessKey=XXXXX] Insert a Payment transaction.
PUT Payment/id ?FileId=#####[&wsAccessKey=XXXXX] Update a Payment transaction.
DELETE Payment/id ?FileId=#####[&wsAccessKey=XXXXX] Delete a Payment transaction.
GET Payment/id ?FileId=#####[&wsAccessKey=XXXXX] Return a single Payment transaction record.
GET Payments ?LastModifiedFromDate={YYYY-MM-DD}&LastModifiedToDate={YYYY-MM-DD}&ForInvoiceId&ClearedFromDate={YYYY-MM-DD}&ClearedToDate={YYYY-MM-DD}&TransactionType={SP|PP}&PaymentFromDate={YYYY-MM-DD}&PaymentToDate={YYYY-MM-DD}&PaymentAccountId={123} &FileId=#####[&wsAccessKey=XXXXX] Returns a list of Payment summary records. Use ForInvoiceId={InvoiceId} to retrieve payments for a single invoice. Note: TransactionType filter will be ignored if ForInvoiceId is specified.
Api Call Description
GET Search ?Keywords={some text}&Scope={All|Transactions|Contacts|InventoryItems}&TransactionType={Transactions.Sale|Transactions.Purchase|Transactions.Journal|Transactions.Payroll}&IncludeSearchTermHighlights={1|0|true|false|yes|no} &FileId=#####[&wsAccessKey=XXXXX] Search for Transactions, Contacts and Inventory Items that have been indexed by the search platform.

TaxCodes

Api Call Description
GET TaxCodes ?IsActive={1|0|true|false|yes|no} &FileId=#####[&wsAccessKey=XXXXX] Returns a list of Tax Code detail records.
GET TaxCode/id ?FileId=#####[&wsAccessKey=XXXXX] Returns a single Tax Code detail record.

User

Api Call Description
POST User/reset-password Request password reset for a user. Initiates the process used to reset a user's password.