Kashoo API Documentation

soap-1.0

Endpoint Metadata

The following methods are available on this endpoint:

addAttachment

Input Parameters

name description
token (no documentation provided)
contextId (no documentation provided)
filename (no documentation provided)
contentType (no documentation provided)
characterEncoding (no documentation provided)
buffer (no documentation provided)
complete (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

addBusiness

Add a business. Most business details are copied from the businessInfo provided.

Input Parameters

name description
token Authentication token
businessInfo Business information
initialAccounts If provided, a list of accounts that are initially added to the business on creation. Similar to calling saveAccount() on each account in the list but a bit more efficient.

Return Value

A copy of the created business, with the business' id and other defaults filled in

Faults

name description
AlreadyExists If two accounts have conflicting names or numbers
BadArgument If the currency code or other parameter is invalid
NotAllowed If the token is invalid, expired, or lacks privileges to do this operation
ValidationFailed If the given parameters are not valid

addNewCustomer

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
name (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

addNewVendor

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
name (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

addRole

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
userId (no documentation provided)
roleName (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

addTax

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
name (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

appendToAttachment

Input Parameters

name description
token (no documentation provided)
attachmentId (no documentation provided)
b (no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

appendToFile

Input Parameters

name description
token (no documentation provided)
fileId (no documentation provided)
b (no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

changeUserPassword

Input Parameters

name description
token (no documentation provided)
userId (no documentation provided)
oldPassword (no documentation provided)
newPassword (no documentation provided)

Faults

name description
BadPassword (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

checkEmailVerificationCode

Input Parameters

name description
emailAddress (no documentation provided)
siteName (no documentation provided)
locale (no documentation provided)
purpose (no documentation provided)
emailVerificationCode (no documentation provided)

Return Value

(no documentation provided)

clearTaxRate

Input Parameters

name description
token (no documentation provided)
regionId (no documentation provided)
taxName (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

completeAttachment

Input Parameters

name description
token (no documentation provided)
attachmentId (no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

completeFile

Input Parameters

name description
token (no documentation provided)
fileId (no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

completePasswordReset

Input Parameters

name description
emailAddress (no documentation provided)
verificationCode (no documentation provided)
newPassword (no documentation provided)
siteName (no documentation provided)
locale (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotFound (no documentation provided)

completeSignUp

Input Parameters

name description
emailAddress (no documentation provided)
siteName (no documentation provided)
locale (no documentation provided)
emailVerificationCode (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
AlreadyActivated (no documentation provided)
BadArgument (no documentation provided)
NotFound (no documentation provided)

countBankReconciliations

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countChangesets

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countJournalEntries

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countRecords

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countRecordsForContact

Input Parameters

name description
token (no documentation provided)
contactId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countRecordsOfType

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
recordType (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countSubscriptionsWithPlan

Input Parameters

name description
token (no documentation provided)
planId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

createRestrictedToken

Create a "restricted" token from a login token. A restricted token has a restriction stored in it such that it cannot be used except to access the specified resource(s). The available restrictions should be documented with the API endpoint that supports them.

Input Parameters

name description
token Login auth token (without any restriction set)
restriction Restriction string; the format depends on the operation the token is intended for use with
duration Expiry time for the restricted token

Return Value

A new AuthToken with a restriction set

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

decodeAuthToken

Exchange a string returned by encodeAuthToken for the original AuthToken structure for use in API calls. If you have implemented a URL endpoint that accepts a parameter that is a string auth token then this can be used to convert that opaque string back into a transparent structure.

Input Parameters

name description
token String returned by encodeAuthToken()

Return Value

Hydrated auth token

Faults

name description
NotAllowed (no documentation provided)

doLogin

Login using username/email and password

Input Parameters

name description
username Email address to login with
password Password to login with
siteName Domain name you are using (i.e. "www.kashoo.com")
locale Login locale (for future use when the system becomes multi-lingual). Pass "en_US" for now.
duration Validity period of the returned token, in milliseconds. Clamped to a maximum 157680000000, or roughly 5 years

Return Value

A new auth token, if the email address and password match

Faults

name description
BadPassword If the password is incorrect
NotActivated If the user account has not been activated
NotFound If the user account does not exist
SingleSignOnRequired If the user account is required to use a single sign-on system for login rather than a password

doLogout

Logout. Currently a no-op although this may one day clear away login tokens or some other smart action.

encodeAuthToken

Exchange an AuthToken for a string referencing that AuthToken. The string can then be put onto the end of certain URLs in order to make those URLs "authenticated" URLs not requiring login to access. This is useful for generating links in a web page or email that the user clicks on to download a report, attachment, or PDF.

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

extendLogin

Exchange a login token for a new one with a later expiry. Apps can call this periodically to renew their auth tokens and prevent them from expiring.

Input Parameters

name description
token Existing auth token. Must not be restricted in any way (restriction is null or empty)
duration Validity period of the returned token, in milliseconds. Clamped to a maximum 157680000000, or roughly 5 years

Return Value

A new auth token with a later expiry date

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

findRegion

Input Parameters

name description
token (no documentation provided)
country (no documentation provided)
provinceOrState (no documentation provided)
districtOrCounty (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
DoesNotExist (no documentation provided)
NotAllowed (no documentation provided)

getAccount

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAccountByName

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
accountName (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

getAccounts

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAllDistrictsOrCounties

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAllItems

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAllProvincesOrStates

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAttachment

Input Parameters

name description
token (no documentation provided)
attachmentId (no documentation provided)
initialReadSize (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

getAutomaticMessage

Input Parameters

name description
token (no documentation provided)
messageId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAutomaticMessages

Input Parameters

name description
token (no documentation provided)
planId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAvailableContractPlans

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InvalidInviteCode (no documentation provided)
NotAllowed (no documentation provided)

getAvailablePaymentMethods

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
currencyCode (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)

getBalanceAtDate

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)
currencyCode (no documentation provided)
date (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

getBalancesAtDate

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)
date (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getBankReconciliation

Input Parameters

name description
token (no documentation provided)
bankReconciliationId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getBankReconciliations

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getBasicTaxInfo

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
taxInfoClass (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)

getBusiness

Input Parameters

name description
token (no documentation provided)
id (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getBusinessesForUser

Input Parameters

name description
token (no documentation provided)
userId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getCanadianTaxInfo

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
taxInfoClass (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)

getChangesets

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getCollaborationContext

Input Parameters

name description
token (no documentation provided)
contextId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getContact

Input Parameters

name description
token (no documentation provided)
contactId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getContacts

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getContactsOfType

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
contactType (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getContract

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getCountries

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getCurrencies

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getCurrency

Input Parameters

name description
token (no documentation provided)
currencyId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getCurrencyByCode

Input Parameters

name description
token (no documentation provided)
currencyCode (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

getCustomers

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getDefaultRegion

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getDistrictsOrCounties

Input Parameters

name description
country (no documentation provided)
provinceOrState (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getEmailSettings

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getExchangeRate

Get an exchange rate from the server so that it can be populated into a record as a reasonable "default" for the user. Note that this call should not be used to provide data for your own third-party systems; it must only be used as a convenience method to fill in exchange rates as a default which are then saved back into our system. This API is not to be used as a general source of exchange rate data.

Input Parameters

name description
token Authorization information
localCurrencyCode First currency code
foreignCurrencyCode Second currency code
asOf Date of the record being edited/created

Return Value

An exchange rate record

Faults

name description
NotAllowed Invalid credentials were provided
NotFound No exchange rate was found
ValidationFailed If the currency codes are not supported or invalid

getFile

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
name (no documentation provided)
initialReadSize (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)
NotFound (no documentation provided)

getHomeCurrency

Input Parameters

name description
token (no documentation provided)
regionId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getItem

Input Parameters

name description
token (no documentation provided)
itemId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getItems

Input Parameters

name description
token (no documentation provided)
itemCategoryId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getItemSubcategory

Input Parameters

name description
token (no documentation provided)
parentId (no documentation provided)
name (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

getJournalEntries

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getLedger

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getLedgerLength

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getLinkedContacts

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getMyBusinesses

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getMyUser

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

getOverpaidRecords

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
currencyCode (no documentation provided)
recordType (no documentation provided)
contactId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

getPaymentSetupInfoForBusiness

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
returnLink (no documentation provided)
returnUrl (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getProvincesOrStates

Input Parameters

name description
country (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getRecord

Input Parameters

name description
token (no documentation provided)
recordId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getRecords

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getRecordsForContact

Input Parameters

name description
token (no documentation provided)
contactId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getRecordsOfType

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
recordType (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

getRegion

Input Parameters

name description
token (no documentation provided)
regionId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getRoles

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
email (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getSubcategories

Input Parameters

name description
token (no documentation provided)
itemCategoryId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getSubscription

Input Parameters

name description
token (no documentation provided)
subscriptionId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getSubscriptionPlan

Input Parameters

name description
token (no documentation provided)
planId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getSubscriptionPlans

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getSubscriptionsWithContact

Input Parameters

name description
token (no documentation provided)
contactId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getSubscriptionsWithPlan

Input Parameters

name description
token (no documentation provided)
planId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getTax

Input Parameters

name description
token (no documentation provided)
taxId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getTaxCodes

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getTaxes

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getTaxRate

Input Parameters

name description
token (no documentation provided)
regionId (no documentation provided)
taxName (no documentation provided)
effectiveDate (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getTimeInZone

Input Parameters

name description
timeZone (no documentation provided)
forDate (no documentation provided)

Return Value

(no documentation provided)

getTimeZones

Return Value

(no documentation provided)

getUnclearedTransactions

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)
excludedBankReconciliationId (no documentation provided)
maxDate (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getUnpaidRecords

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
currencyCode (no documentation provided)
recordType (no documentation provided)
contactId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)

getUser

Input Parameters

name description
token (no documentation provided)
userId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getUserByEmail

Input Parameters

name description
token (no documentation provided)
email (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

getVatTaxInfo

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
taxInfoClass (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)

getVendors

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getWorldPay

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

predictAccountNumber

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
accountType (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

predictRecordNumber

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
recordType (no documentation provided)
contactId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

readAttachment

Input Parameters

name description
token (no documentation provided)
fileId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

readFile

Input Parameters

name description
token (no documentation provided)
fileId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

requestEmailVerificationCode

Input Parameters

name description
emailAddress (no documentation provided)
siteName (no documentation provided)
locale (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
InternalError (no documentation provided)
NotFound (no documentation provided)

requestPasswordReset

Input Parameters

name description
emailAddress (no documentation provided)
siteName (no documentation provided)
locale (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
InternalError (no documentation provided)
NotFound (no documentation provided)
ValidationFailed (no documentation provided)

retryContractPayment

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveAccount

Input Parameters

name description
token (no documentation provided)
account (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
AlreadyExists (no documentation provided)
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveAutomaticMessage

Input Parameters

name description
token (no documentation provided)
msgInfo (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveBankReconciliation

Input Parameters

name description
token (no documentation provided)
bankReconciliationInfo (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveBankStatementRows

Input Parameters

name description
token (no documentation provided)
accountId (no documentation provided)
rows (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveBasicTaxInfo

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
rti (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveBusiness

Input Parameters

name description
token (no documentation provided)
business (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
AlreadyExists (no documentation provided)
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveCanadianTaxInfo

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
rti (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveCollaborationEvent

Input Parameters

name description
token (no documentation provided)
event (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveContact

Input Parameters

name description
token (no documentation provided)
contact (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveEmailSettings

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
emailSettings (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveItem

Input Parameters

name description
token (no documentation provided)
item (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
AlreadyExists (no documentation provided)
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveRecord

Input Parameters

name description
token (no documentation provided)
record (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveSubscription

Input Parameters

name description
token (no documentation provided)
subscription (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
ConcurrentChangeException (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveSubscriptionPlan

Input Parameters

name description
token (no documentation provided)
plan (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveTax

Input Parameters

name description
token (no documentation provided)
tax (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
ConcurrentChangeException (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveTaxCodes

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
taxCodes (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveUser

Input Parameters

name description
token (no documentation provided)
user (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
AlreadyExists (no documentation provided)
InternalError (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveVatTaxInfo

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
rti (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

saveWorldPay

Input Parameters

name description
token (no documentation provided)
worldPay (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

sendTestEmail

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
toAddress (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

setContractLinks

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
expenseAccountId (no documentation provided)
paymentAccountId (no documentation provided)
contactId (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

setContractPlan

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
planId (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
NotFound (no documentation provided)

setTaxRate

Input Parameters

name description
token (no documentation provided)
regionId (no documentation provided)
taxName (no documentation provided)
rate (no documentation provided)
effectiveDate (no documentation provided)
previousRate (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

signUp

Input Parameters

name description
contactInformation (no documentation provided)
password (no documentation provided)
siteName (no documentation provided)
locale (no documentation provided)

Faults

name description
AlreadyExists (no documentation provided)
BadArgument (no documentation provided)
InternalError (no documentation provided)
NotFound (no documentation provided)
ValidationFailed (no documentation provided)

skipTrial

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

storeFile

Input Parameters

name description
token (no documentation provided)
businessId (no documentation provided)
filename (no documentation provided)
contentType (no documentation provided)
characterEncoding (no documentation provided)
initialContent (no documentation provided)
complete (no documentation provided)
publicAccess (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
InternalError (no documentation provided)
NotAllowed (no documentation provided)

submitFeedback

Input Parameters

name description
token (no documentation provided)
subject (no documentation provided)
body (no documentation provided)

Faults

name description
BadArgument (no documentation provided)
InternalError (no documentation provided)
ValidationFailed (no documentation provided)

testAutomaticMessage

Input Parameters

name description
token (no documentation provided)
messageId (no documentation provided)
toEmail (no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

soap-1.0

Home

REST Endpoints

SOAP Services

XML Data Elements

XML Data Types