API Documentation (1.0.0)

Kashoo API Documentation (1.0.0)

Download OpenAPI specification:Download

API documentation for the Kashoo platform.

Introduction

The API reference lists all available endpoints for products Kashoo Cloud Accounting and TrulySmall Accounting. The endpoints are divided topically and have references on the product to make it easier for you to navigate through the docs.

Getting Started

A Kashoo or TrulySmall user account is needed to use the api. The quickest way to get started is to sign up for a free trial with one of our applications. This will create an account for you, along with a user and a business. You can then use your credentials to obtain an authentication token and start using the api.

The application is centered around businesses, one of which will be created for you when you sign up for an account. Most endpoints accept a business id to identify who the operation is for. For example, a business will have its own contacts, taxes, transactions, accounts, and so on.

To allow for multi-user businesses, a user account is also assigned a user id. The user id can be associated with more than one business. The authentication token will only allow access to the business data for which the user has been granted access to. The user id is also used for user-specific operations such as purging a user account.

Subscriptions are centered around businesses. Each business must pay for its own subscription. A user can access any businesses that they have access to as long as the business is on an active subscription. When developing an api client, you may ask to be put on a free subscription plan so that your business and its data stay accessible over the course of your development.

Product identification markers

This API supports two of our products: Kashoo Cloud Accounting and TrulySmall Accounting. You can sign up for either application at https://kashoo.com/. The API for the two products is essentially the same with a couple important differences:

  • TSA supports opening balances for accounts while Kashoo has to do this with adjustments.
  • The tax system is different between the two products. The TSA tax system is more structured and constrained.
  • TSA supports a shoebox items api for staging transactions before they are posted to the ledger.
  • Kashoo supports basic inventory items while TSA does not.

The API endpoints indicate which of our products they are meant for using one or both of the following product markers.

kashooKashoo Cloud Accounting (Our classic platform) tsaTrulySmall Accounting (Our leading-edge platform)

Note that the applicatinos are hosted under different domains. This is mostly cosmetic, since they map to the same backend, but is worth following. The Kashoo api is hosted at https://app.kashoo.com/api while the TSA api is at https://app.trulysmall.com/api.

Authentication

Kashoo allows for two categories of authentication: first-party and third-party. First-party authentication is simple but meant for first-party development since it requires the user's password. Third-party authentication is for external developers who wish to integrate with TrulySmall, but it takes more time to get running.

First-party Authentication

There are two ways to log the user in directly: standard user-password login or through single-sign-on providers such as Google.

The endpoints for first-party authentication are under the /authTokens path. See the ebdpoints below for more information.

When a first-party login completes successfully, the api returns a json token. For example, a login call to POST https://api.kashoo.com/authTokens with an accept header of json will return the following:

{
"authenticationCode":"asdasdasdasdasdadasdasdasda",
"expiryDate":1698789858551,
"locale":"default",
"myUserId":1231232,
"restriction":null,
"site":"app.kashoo.com"
}

This json can then be used within Authorization headers using the format:

Authorization: TOKEN json:{"authenticationCode":"asdasdasdasdasdadasdasdasda","expiryDate":1698789858551,"locale":"default","myUserId":1231232,"restriction":null,"site":"app.kashoo.com"}

These tokens are valid for a limited but relatively long time. Once they expire, the user must log in again.

Create token

Creates an auth token for accessing the api on behalf of a user. This endpoint is used for first-party login with basic auth. The caller can supply the email and password using form params. The endpoint also accepts sso login such as Google using the provider and authCode form params. Callers will usually want to accept json to return a format easy to use in an Authorization header.

Request Body schema: */*
site
string
lc
string
Default: "en_US"
duration
integer <int64>
Default: 86400000
restriction
string
email
string
password
string
mfaCode
string
provider
string
authCode
string
type
string

Responses

Response samples

Content type
{
  • "myUserId": 0,
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "restriction": "string",
  • "site": "string",
  • "locale": "string",
  • "authenticationCode": "string"
}

Verify token privileges

This endpoint is used to verify that the request's authorization information is permitted to perform the specified restriction.

query Parameters
restriction
string

Responses

OAuth2

First-party login requires the user to enter their password, which is not suitable for third-parties since the password should only be shared with Kashoo. For this purpose, Kashoo provides an OAuth2 service that allows third-parties to redirect users to Kashoo to log in and then redirects them back to the third party app with an auth code that can be exchanged for an access token. The third party can then use the access token to make api calls to Kashoo on the user's behalf.

An explanation of OAuth2 is beyond the scope of this document. There are many resources online that explain the protocol, for example this one.

To get started, a third-party developer must register their app with Kashoo. This is done manually and requires contacting Kashoo to provide the application's name and its redirect URLs for the OAuth2 flow. Note that there currently can only be one redirect url per client id. Once the app is registered, the developer will receive their client id and secret to use in the OAuth2 flow.

Here is a brief outline of the flow:

  1. A single page app (SPA) redirects the browser/user to the Kashoo OAuth2 authorization endpoint.

    // client side code
    
    // generate a random state token to prevent cross-site request forgery
    const state = Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15)
    
    // store the state somewhere to verity it upon the response (this part is simplified here)
    sessionStorage.setItem('sign-in-state', state)
    
    window.location.href = 'https://app.kashoo.com/oauth2/authorize?' +
       'client_id=' + yourClientId +
       '&response_type=code' +
       '&scope=full-access' +
       '&redirect_uri=' + encodeURIComponent(yourRedirectUrl) +
       '&state=' + state
    
  2. The user logs in to Kashoo on the OAuth2 application and is sent to the redirect URL with an authorization code.

    https://redirect-uri?code=... the authorization code ...&state=... the state ...

  3. The redirect url should be handled by a server-side handler because it will need the client secret. It will use the authorization code and client secret to obtain an access token from Kashoo.

    // server side code
    
    // send the following as form data
    let formData = new URLSearchParams()
    formData.append('code', ... received authorization code ...)
    formData.append('grant_type', 'authorization_code')
    formData.append('redirect_uri', yourRedirectUrl)
    
    // make a call to the OAuth2 server to exchange the code for an access token using form encoded data
    // and the client id and secret as a basic-auth Authorization header
    axios.post('https://app.kashoo.com/oauth2/token', formData, {
        headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
            auth: {
            username: yourClientId,
            password: yourClientSecret
        }
    })
    .then(response => {
            // parse the response data into tokens and user id
            this.bearerToken = response.data.access_token
            this.refreshToken = response.data.refresh_token
            this.expiresIn = response.data.expires_in
            this.tokenType = response.data.token_type
            this.userId = response.data.userId
    
  4. The server-side handler should store the bearer and refresh tokens for the user and use them to make api calls to Kashoo.

Start auth process

Send the user to this url with the required query parameters to begin the OAuth2 authorization process. The endpoint will send the user to the OAuth2 app to log in with their Kashoo account and authorize the client app to access their data.

query Parameters
client_id
required
string

Your OAuth2 client id

response_type
required
string

The oauth response type, for example 'code'

redirect_uri
required
string

The uri to redirect the user to after authorization

state
string

An optional state parameter that will be returned to you in the redirect

Responses

Create or refresh token

When the OAuth2 app returns control to the application along with an auth code, use this endpoint to exchange the auth code for an access token. In this case, set the grant_type to 'authorization_code'. This grant type requires code and redirect_uri parameters to be sent in the request. When refreshing a token, set the grant_type to 'refresh_token' and include the refresh token in the request.

header Parameters
Authorization
required
string

A basic auth header with the client id and secret as username and password

Request Body schema: application/x-www-form-urlencoded
required
code
string

The auth code returned from the OAuth2 app, for the 'authorization_code' grant type

grant_type
required
string

The grant type, for example 'authorization_code' or 'refresh_token'

redirect_uri
string

The uri to redirect the user to after authorization, for the 'authorization_code' grant type

refresh_token
string

The refresh token to use when refreshing a token, for the 'refresh_token' grant type

Responses

Response samples

Content type
application/json
{
  • "access_token": "example-access-token",
  • "expires_in": 3600,
  • "refresh_token": "example-refresh-token",
  • "token_type": "bearer",
  • "userId": "12355"
}

Multifactor Authentication

Users can enable multi-factor authentication (MFA) on their account. When MFA is enabled, the user must use another authentication method in addition to their password to complete their login and receive an authentication token. The api supports only sms as a second factor at this time.

Perform SMS MFA verification

This endpoint is used both for requesting the mfa verification process to begin and to verify a response from the user. If the code is not present, then a new code will be sent to the user's phone. If the code is present, then it will be verified. There is no response body for this endpoint, only a status code.

Request Body schema: */*
code
string

Responses

Enable SMS MFA for a user

Assuming the code is correct, this will enable SMS MFA on the user account. The user will then need to complete SMS MFA whenever logging in. If the code passed in is incorrect, a Forbidden response will be returned.

Request Body schema: */*
code
string

Responses

Disable SMS MFA for the user

The user will no longer need to complete SMS MFA when logging in. This endpoint requires a valid auth token for the user and returns either a Forbidden or a No Content response.

Responses

List user's enabled mfa methods

Lists the enabled mfa methods for a user. If there are none, then mfa is not required for logging in. Otherwise, one of the listed mfa methods is required to complete login.

Responses

Response samples

Content type
[
  • {
    }
]

Users

kashootsaContains endpoints to manage users, groups, and roles in a business.

Create a new user

Adds a new user to our system. This is an unverified user, meaning that we are not yet certain that they own the associated credentials. To make sure of this, a verification email is sent to user and permanent access is only granted if they click on the associated link.

Request Body schema: */*
first
string
last
string
email
string
password
string
additionalParams
string
Default: ""
site
string
lc
string
Default: "en_US"
duration
integer <int64>
Default: 86400000

Responses

Creates a verified user

Adds a new user to the system. This is a verified user, which means that we assume that they are the owner of the passed in user credentials, and we do not need to send a verification email to them to make sure. This is useful in cases like iOS, Square, and oauth2, where the users have already verified with the associated provider.

Request Body schema: */*
first
string
last
string
email
string
password
string
provider_name
string
provider_access_token
string
invite
string
additionalParams
string
Default: ""
mfaCode
string
site
string
lc
string
Default: "en_US"
duration
integer <int64>
Default: 86400000

Responses

Link OAuth Accounts

Link OAuth accounts with existing user logins.

Request Body schema: */*
provider_access_token
string
provider_name
string
lc
string
Default: "en_US"

Responses

Get information about the logged in user

Responses

Response samples

Content type
No sample

Updates user

Request Body schema:
id
integer <int64>
object (ContactInformationInfo)
staff
boolean
betaTester
boolean
accountingProfessional
boolean
expireSessions
boolean
useHighContrastStyle
boolean
readOnly
boolean
removed
boolean
active
boolean
verified
boolean
object (TransferDate)
object (TransferDate)
object (TransferDate)
lastLogin
string <date-time>
serviceProvider
integer <int64>
serviceProviderAdmin
boolean
allowSelectionOfNonStandardAccounts
boolean
inviteCode
string
email
string
name
string
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Deletes user records and their businesses

Completetly deletes a user and their businesses from the database and all other third-part systems such as Intercom.

query Parameters
confirm
string

Responses

User Businesses

Activate a user's business

Request Body schema: application/x-www-form-urlencoded
campaign
string
site
string

Responses

Get the list of businesses the user has access to

query Parameters
offset
integer <int32>
Default: 0
limit
integer <int32>
Default: 0

Responses

Roles

kashootsa

Gets the roles of a users

query Parameters
offset
integer <int32>
Default: 0
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Businesses

kashootsa

Returns the groups defined for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0
type
string
Value: "CONTACT"

Responses

Response samples

Content type
No sample

Add a group to the business

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
removed
boolean
type
string
contacts
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Add an account to the business

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
type
string
Enum: "ACCOUNTS_RECEIVABLE" "ACCOUNTS_PAYABLE" "BANK" "COST_OF_GOODS_SOLD" "CREDIT_CARD" "EQUITY" "EXPENSE" "FIXED_ASSET" "INCOME" "GAIN_OR_LOSS_ON_EXCHANGE" "LONG_TERM_LIABILITY" "OTHER_CURRENT_ASSET" "OTHER_CURRENT_LIABILITY" "OTHER_ASSET" "TAXES" "CASH" "RETAINED_EARNINGS" "PREPAID_EXPENSE" "CLIENT_CREDIT" "INVENTORY" "PAYROLL_TAX"
description
string
number
string
standardTerms
string
object (TransferDate)
object (TransferDate)
removed
boolean
feed
integer <int64>
readOnly
boolean
taxNumber
integer <int64>
taxAuthorityCode
string
archived
boolean
normalBalanceCredit
boolean
system
boolean
parent
integer <int64>
nameAndNumber
string
lastModified
integer <int64>
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

List taxes associated with the business

Providing version == 2 will return a TaxCompositeInfo, else a LegacyTaxInfo

path Parameters
business_id
required
integer <int64>
query Parameters
version
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

List taxes associated with the business

path Parameters
business_id
required
integer <int64>
Request Body schema:
string

Responses

Request samples

Content type
No sample

Response samples

Content type
[
  • {
    }
]

Subscription

kashootsa

Get subscription of a business

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Gets the logged in user's subscription

Responses

Add a subscription

Request Body schema: */*
text
string

Responses

Gets a Subscription

Gets a Subscription using an subscription ID or userID (fusionauth)

query Parameters
id
string

ID of subscriptions

subscriberId
string

Subscriber ID

header Parameters
Authorization
required
string

Example: Bearer foo

Responses

Response samples

Content type
application/json
{
  • "subscription": {
    }
}

Create a Subscription

Creates a Subscription

Request Body schema: application/json
required

Create Subscription Request

appId
string
originalId
string
platformProductId
string
purchaseToken
string
purchasedExplicitlyInApp
boolean
store
required
string
subscriberId
string
subscriptionApplication
string
userEmail
string
userId
string

Responses

Request samples

Content type
application/json
{
  • "appId": "string",
  • "originalId": "string",
  • "platformProductId": "string",
  • "purchaseToken": "string",
  • "purchasedExplicitlyInApp": true,
  • "store": "string",
  • "subscriberId": "string",
  • "subscriptionApplication": "string",
  • "userEmail": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "subscription": {
    }
}

Creates a new chargebee checkout window

Creates a new chargebee checkout window

header Parameters
Authorization
required
string

Example: Bearer foo

Request Body schema: application/json
required

New Checkout

couponId
Array of strings
object (serverpb.ChargeBeeCustomer)
subscriberId
required
string
subscriptionApplication
required
string
subscriptionPlanId
required
string
userId
string

Responses

Request samples

Content type
application/json
{
  • "couponId": [
    ],
  • "customer": {
    },
  • "subscriberId": "string",
  • "subscriptionApplication": "string",
  • "subscriptionPlanId": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "checkoutInfo": [
    ],
  • "content": [
    ],
  • "createdAt": 0,
  • "embed": true,
  • "expiresAt": 0,
  • "failureReason": "string",
  • "id": "string",
  • "object": "string",
  • "passThruContent": "string",
  • "resourceVersion": 0,
  • "state": "string",
  • "type": "string",
  • "updatedAt": 0,
  • "url": "string"
}

Creates a new chargebee portal session

Creates a new chargebee portal session

header Parameters
Authorization
required
string

Example: Bearer foo

Request Body schema: application/json
required

New portal session

subscriptionId
string

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "string"
}

Response samples

Content type
application/json
{
  • "accessUrl": "string",
  • "createdAt": 0,
  • "customerId": "string",
  • "expiresAt": 0,
  • "id": "string",
  • "loginAt": 0,
  • "loginIpAddress": "string",
  • "logoutAt": 0,
  • "logoutIpAddress": "string",
  • "object": "string",
  • "redirectUrl": "string",
  • "status": "string",
  • "token": "string"
}

Business Plans

kashootsa

Inspect the business' current subscription plan with Kashoo.

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Updates a business plan

path Parameters
business_id
required
integer <int64>
query Parameters
inviteCode
string
Request Body schema:
id
integer <int64>
name
string
description
string
currency
string
monthlyPrice
integer <int32>
annualPrice
integer <int32>
taxCode
string
upgradePaymentAmount
integer <int32>
selectable
boolean
externalDescription
string
numOfAdditionalUsers
integer <int32>
expiryDays
integer <int32>
free
boolean
freeTrial
boolean
paymentProcessorType
string
Enum: "NONE" "BEANSTREAM" "APPLE"
billingPlatform
string
Enum: "D_BILLING" "ITUNES" "SQUARE" "AMAZON" "OFFLINE" "CHARGEBEE" "TRULYSMALL"
delayOfInitialPaymentInDays
integer <int32>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Cancel a business plan

path Parameters
business_id
required
integer <int64>

Responses

Lists invoices on a plan

Lists the invoices that have been made on the business's current contract (plan).

path Parameters
business_id
required
integer <int64>
query Parameters
object (TransferDate)
object (TransferDate)
offset
integer <int32>
limit
integer <int32>
Default: 50

Responses

Response samples

Content type
No sample

Get a list of available plans for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
inviteCode
string

Responses

Response samples

Content type
No sample

Contacts

kashootsa

Gets contact activity report

path Parameters
contact_id
required
integer <int64>
query Parameters
object (TransferDate)
object (TransferDate)
memo
string

Responses

Response samples

Content type
No sample

Gets contact statement

path Parameters
contact_id
required
integer <int64>
query Parameters
object (TransferDate)
memo
string

Responses

Response samples

Content type
No sample

Returns the subcontacts of this contact

path Parameters
contact_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Returns the invoices and bills that involve this contact.

path Parameters
contact_id
required
integer <int64>
query Parameters
object (TransferDate)
object (TransferDate)
offset
integer <int32>
Default: 0
limit
integer <int32>
Default: 100
sortColumn
string
sortOrder
string
amountLe
integer <int64>
amountGe
integer <int64>
type
Array of strings
Items Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
search
string

Responses

Response samples

Content type
No sample

Returns the contact information.

path Parameters
contact_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Updates an existing contact.

path Parameters
contact_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
type
string
Enum: "CUSTOMER" "VENDOR" "PARTNER" "OWNER" "GOVERNMENT" "OTHER" "EMPLOYEE"
object (ContactInformationInfo)
linkedBusiness
integer <int64>
receivableAccount
integer <int64>
payableAccount
integer <int64>
incomeOrExpenseAccount
integer <int64>
defaultTaxCode
string
paymentAccount
integer <int64>
paymentTerms
string
currency
string
comments
Array of strings
collaborationContext
integer <int64>
prefix
string
removed
boolean
archived
boolean
organization
boolean
parent
integer <int64>
groups
Array of integers <int64> [ items <int64 > ]
phoneNumbers
string
email
string
address
string
name
string
lastModified
integer <int64>

Responses

Request samples

Content type
No sample

Remove a contact

path Parameters
contact_id
required
integer <int64>

Responses

Receipts

kashootsa

Submit a receipt

path Parameters
business_id
required
integer <int64>
Request Body schema: */*
text
string

Responses

Items

kashooEndpoints for managing inventory items for Kashoo classic businesses. These inventory items can be used as line items in transactions and can track quantities and costs.

Gets the inventory items for the business

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an inventory item

path Parameters
business_id
required
integer <int64>
Request Body schema: application/json
id
integer <int64>
itemId
string
business
integer <int64>
name
string
sku
string
description
string
defaultTaxCode
string
defaultDiscountCode
string
defaultBuyRate
number
defaultSellRate
number
defaultNote
string
inventoryAccount
integer <int64>
cogsAccount
integer <int64>
creditAccount
integer <int64>
debitAccount
integer <int64>
category
integer <int64>
readOnly
boolean
removed
boolean
tracked
boolean
archived
boolean
effectiveId
object
lastModified
integer <int64>
Array of objects (LinkInfo)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "itemId": "string",
  • "business": 0,
  • "name": "string",
  • "sku": "string",
  • "description": "string",
  • "defaultTaxCode": "string",
  • "defaultDiscountCode": "string",
  • "defaultBuyRate": 0,
  • "defaultSellRate": 0,
  • "defaultNote": "string",
  • "inventoryAccount": 0,
  • "cogsAccount": 0,
  • "creditAccount": 0,
  • "debitAccount": 0,
  • "category": 0,
  • "readOnly": true,
  • "removed": true,
  • "tracked": true,
  • "archived": true,
  • "effectiveId": { },
  • "lastModified": 0,
  • "links": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemId": "string",
  • "business": 0,
  • "name": "string",
  • "sku": "string",
  • "description": "string",
  • "defaultTaxCode": "string",
  • "defaultDiscountCode": "string",
  • "defaultBuyRate": 0,
  • "defaultSellRate": 0,
  • "defaultNote": "string",
  • "inventoryAccount": 0,
  • "cogsAccount": 0,
  • "creditAccount": 0,
  • "debitAccount": 0,
  • "category": 0,
  • "readOnly": true,
  • "removed": true,
  • "tracked": true,
  • "archived": true,
  • "effectiveId": { },
  • "lastModified": 0,
  • "links": [
    ]
}

Gets an inventory item for the business by its item id.

path Parameters
id
required
integer <int64>
business_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemId": "string",
  • "business": 0,
  • "name": "string",
  • "sku": "string",
  • "description": "string",
  • "defaultTaxCode": "string",
  • "defaultDiscountCode": "string",
  • "defaultBuyRate": 0,
  • "defaultSellRate": 0,
  • "defaultNote": "string",
  • "inventoryAccount": 0,
  • "cogsAccount": 0,
  • "creditAccount": 0,
  • "debitAccount": 0,
  • "category": 0,
  • "readOnly": true,
  • "removed": true,
  • "tracked": true,
  • "archived": true,
  • "effectiveId": { },
  • "lastModified": 0,
  • "links": [
    ]
}

Updates an existing inventory item

path Parameters
id
required
integer <int64>
business_id
required
integer <int64>
Request Body schema: application/json
id
integer <int64>
itemId
string
business
integer <int64>
name
string
sku
string
description
string
defaultTaxCode
string
defaultDiscountCode
string
defaultBuyRate
number
defaultSellRate
number
defaultNote
string
inventoryAccount
integer <int64>
cogsAccount
integer <int64>
creditAccount
integer <int64>
debitAccount
integer <int64>
category
integer <int64>
readOnly
boolean
removed
boolean
tracked
boolean
archived
boolean
effectiveId
object
lastModified
integer <int64>
Array of objects (LinkInfo)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "itemId": "string",
  • "business": 0,
  • "name": "string",
  • "sku": "string",
  • "description": "string",
  • "defaultTaxCode": "string",
  • "defaultDiscountCode": "string",
  • "defaultBuyRate": 0,
  • "defaultSellRate": 0,
  • "defaultNote": "string",
  • "inventoryAccount": 0,
  • "cogsAccount": 0,
  • "creditAccount": 0,
  • "debitAccount": 0,
  • "category": 0,
  • "readOnly": true,
  • "removed": true,
  • "tracked": true,
  • "archived": true,
  • "effectiveId": { },
  • "lastModified": 0,
  • "links": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemId": "string",
  • "business": 0,
  • "name": "string",
  • "sku": "string",
  • "description": "string",
  • "defaultTaxCode": "string",
  • "defaultDiscountCode": "string",
  • "defaultBuyRate": 0,
  • "defaultSellRate": 0,
  • "defaultNote": "string",
  • "inventoryAccount": 0,
  • "cogsAccount": 0,
  • "creditAccount": 0,
  • "debitAccount": 0,
  • "category": 0,
  • "readOnly": true,
  • "removed": true,
  • "tracked": true,
  • "archived": true,
  • "effectiveId": { },
  • "lastModified": 0,
  • "links": [
    ]
}

Removes an inventory item by its item id

path Parameters
id
required
integer <int64>
business_id
required
integer <int64>

Responses

Accounts

kashootsa

Get account opening balances

path Parameters
account_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Get journal entries

Get the journal entries made against an account. Returns all journal entries by default but can be filtered by date, amount, and search term. The results can be paginated and sorted.

path Parameters
account_id
required
integer <int64>
query Parameters
object (TransferDate)
object (TransferDate)
Example: endDate=2024-02-02
offset
integer <int32>
Default: 0
limit
integer <int32>
Default: 100
sortColumn
string
Example: sortColumn=date

The column to sort by

sortOrder
string
Example: sortOrder=desc

Whether to sort ascending or descending

amountLe
integer <int64>
amountGe
integer <int64>
search
string

Responses

Response samples

Content type
No sample

Get account transactions

path Parameters
account_id
required
integer <int64>
query Parameters
object (TransferDate)
object (TransferDate)
type
Array of strings
Items Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
offset
integer <int32>
Default: 0
limit
integer <int32>
Default: 100
sortColumn
string
sortOrder
string
amountLe
integer <int64>
amountGe
integer <int64>
search
string
contactId
integer <int64>

Responses

Get account balances

path Parameters
account_id
required
integer <int64>
query Parameters
object (TransferDate)
primary
boolean

Responses

Gets an account

path Parameters
account_id
required
integer <int64>
query Parameters
fields
string

Responses

Response samples

Content type
No sample

Updates an account

path Parameters
account_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
type
string
Enum: "ACCOUNTS_RECEIVABLE" "ACCOUNTS_PAYABLE" "BANK" "COST_OF_GOODS_SOLD" "CREDIT_CARD" "EQUITY" "EXPENSE" "FIXED_ASSET" "INCOME" "GAIN_OR_LOSS_ON_EXCHANGE" "LONG_TERM_LIABILITY" "OTHER_CURRENT_ASSET" "OTHER_CURRENT_LIABILITY" "OTHER_ASSET" "TAXES" "CASH" "RETAINED_EARNINGS" "PREPAID_EXPENSE" "CLIENT_CREDIT" "INVENTORY" "PAYROLL_TAX"
description
string
number
string
standardTerms
string
object (TransferDate)
object (TransferDate)
removed
boolean
feed
integer <int64>
readOnly
boolean
taxNumber
integer <int64>
taxAuthorityCode
string
archived
boolean
normalBalanceCredit
boolean
system
boolean
parent
integer <int64>
nameAndNumber
string
lastModified
integer <int64>
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Removes an account

path Parameters
account_id
required
integer <int64>

Responses

Get bank accounts for a business

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Return a list of accounts associated with this business.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0
type
Array of strings unique
Items Enum: "ACCOUNTS_RECEIVABLE" "ACCOUNTS_PAYABLE" "BANK" "COST_OF_GOODS_SOLD" "CREDIT_CARD" "EQUITY" "EXPENSE" "FIXED_ASSET" "INCOME" "GAIN_OR_LOSS_ON_EXCHANGE" "LONG_TERM_LIABILITY" "OTHER_CURRENT_ASSET" "OTHER_CURRENT_LIABILITY" "OTHER_ASSET" "TAXES" "CASH" "RETAINED_EARNINGS" "PREPAID_EXPENSE" "CLIENT_CREDIT" "INVENTORY" "PAYROLL_TAX"
archived
boolean

Responses

Response samples

Content type
No sample

Account Types

kashootsa

Get credit card accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get equity accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get expense accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get fixed asset accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get income accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get other current asset accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get cash accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Get inventory accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get used accounts

Gets the accounts for the business that have at least one journal entry assigned to them.

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Get accounts receivable accounts.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get accounts payable accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get COGS accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get gain/loss on exchange accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get long term liability accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get other current asset accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get other current liability accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get taxes and remittances accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Get retained earnings accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Get prepaid expenses accounts

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

Records

kashootsa

Gets record sequence numbers

Returns the next sequence number for each record type. This is important for invoices and bills where the sequence number is used to generate the invoice number.

path Parameters
record_type
required
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
business_id
required
integer <int64>

Responses

Response samples

Content type
[
  • {
    }
]

Get business records

Returns all the records for a business. Records can be of several types, including:

  • Bills
  • Invoices
  • Adjustments
  • Transfers
path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
type
Array of strings
Items Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
search
string
amountGe
integer <int64>
amountLe
integer <int64>
exclude
string
status
string
object (TransferDate)
sortColumn
string
sortOrder
string
includeRemoved
boolean

Only non-removed records are included by default.

modifiedSince
integer <int64>
Example: modifiedSince=1716999647879

Include only records modified since this unix timestamp, in milliseconds.

contactId
integer <int64>

Responses

Response samples

Content type
[
  • {
    }
]

Add a record to a business

path Parameters
business_id
required
integer <int64>
Request Body schema:

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Add a set of records to a business

Add a set of records in one operation. All records must belong to the same business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
Array

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Import records from an outside source

Imports records from an outside source. Right now this only supports ofx/qbo files.

path Parameters
business_id
required
integer <int64>
Request Body schema:
uuid
string
url
string
filename
string
account
integer <int64>
preview
boolean

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Update a set of records

Updates a batch of records in one operation. All records must belong to the same business. This can take a long time because records still have to be added serially due to limitations in the books engine.

Request Body schema:
Array

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Unprocess a set of records

Unprocess a batch of records and returns them to the inbox. This operation is used for TrulySmall Accounting.

Request Body schema:
Array

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Get a record

Gets a record by its record id.

path Parameters
record_id
required
integer <int64>

Responses

Response samples

Content type
application/json
No sample

Update a record

Updates a record with the provided data.

path Parameters
record_id
required
integer <int64>
Request Body schema:

Responses

Request samples

Content type
No sample

Remove a record

Removes a record. This is a soft delete and the recodd can be restored.

path Parameters
record_id
required
integer <int64>

Responses

Invoices

kashootsa

List invoice payments associated with this business.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
search
string
amountGe
integer <int64>
amountLe
integer <int64>
sortColumn
string
sortOrder
string
includeRemoved
boolean
modifiedSince
integer <int64>
contactId
integer <int64>

Responses

Response samples

Content type
No sample

Add an invoice payment to a business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
description
string
memo
string
exchangeRate
number <double>
contact
integer <int64>
currency
string
account
integer <int64>
object (TransferDate)
collaborationContext
integer <int64>
number
string
contactName
string
removed
boolean
readOnly
boolean
homeCurrency
string
project
integer <int64>
projectName
string
creation
string <date-time>
lastModified
string <date-time>
inboxReference
string
unallocatedAmount
integer <int64>
Array of objects (PaymentAllocationOut)
creditAccount
integer <int64>
method
string
amount
integer <int64>
byCheck
boolean
type
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
foreignCurrency
boolean
Array of objects (RecordAttachmentInfo)
allowZeroAmounts
boolean
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

List invoices associated with this business.

This is the same as accessing records with type=INVOICE.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
search
string
amountGe
integer <int64>
amountLe
integer <int64>
exclude
string
status
string
object (TransferDate)
sortColumn
string
sortOrder
string
includeRemoved
boolean
modifiedSince
integer <int64>
contactId
integer <int64>

Responses

Response samples

Content type
No sample

Add an invoice to a business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
description
string
memo
string
exchangeRate
number <double>
contact
integer <int64>
currency
string
account
integer <int64>
object (TransferDate)
collaborationContext
integer <int64>
number
string
contactName
string
removed
boolean
readOnly
boolean
homeCurrency
string
project
integer <int64>
projectName
string
creation
string <date-time>
lastModified
string <date-time>
inboxReference
string
Array of objects (PaymentAllocationIn)
terms
string
object (TransferDate)
poNumber
string
Array of objects (LegacyTaxEntryInfo)
totalDue
integer <int64>
balanceDue
integer <int64>
paid
boolean
exchangePayment
boolean
keepInOriginalCurrency
boolean
balanceDueFormatted
string
totalDueFormatted
string
totalBeforeTaxes
integer <int64>
Array of objects (RecordTaxAmount)
totalLocalDue
integer <int64>
type
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
paidInvoice
boolean
totalPaidImmediately
integer <int64>
totalPaidLater
integer <int64>
totalPaid
integer <int64>
income
boolean
foreignCurrency
boolean
Array of objects (RecordAttachmentInfo)
allowZeroAmounts
boolean
Array of objects (LineItemInfo)
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Email an invoice for a record

Sends an invoice email for the record to the specified email address. If preview is true, the invoice is not sent, but a preview is returned.

path Parameters
record_id
required
integer <int64>
Request Body schema:
required
to
string
cc
string
bcc
string
message
string
processor
string
preview
boolean
previewType
string
attachments
Array of strings
template
string

Responses

Request samples

Content type
No sample

Bills

kashootsa

List bill payments associated with this business.

This is the same as accessing records with type=BILL_PAYMENT.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
search
string
amountGe
integer <int64>
amountLe
integer <int64>
sortColumn
string
sortOrder
string
includeRemoved
boolean
modifiedSince
integer <int64>
contactId
integer <int64>

Responses

Response samples

Content type
No sample

Add a bill payment to a business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
description
string
memo
string
exchangeRate
number <double>
contact
integer <int64>
currency
string
account
integer <int64>
object (TransferDate)
collaborationContext
integer <int64>
number
string
contactName
string
removed
boolean
readOnly
boolean
homeCurrency
string
project
integer <int64>
projectName
string
creation
string <date-time>
lastModified
string <date-time>
inboxReference
string
unallocatedAmount
integer <int64>
Array of objects (PaymentAllocationOut)
creditAccount
integer <int64>
method
string
amount
integer <int64>
byCheck
boolean
Array of objects (CheckRegistryInfo)
type
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
foreignCurrency
boolean
Array of objects (RecordAttachmentInfo)
allowZeroAmounts
boolean
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

List bills associated with this business.

This is the same as accessing records with type=BILL.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
search
string
amountGe
integer <int64>
amountLe
integer <int64>
exclude
string
status
string
object (TransferDate)
sortColumn
string
sortOrder
string
includeRemoved
boolean
modifiedSince
integer <int64>
contactId
integer <int64>

Responses

Response samples

Content type
No sample

Add a bill to a business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
description
string
memo
string
exchangeRate
number <double>
contact
integer <int64>
currency
string
account
integer <int64>
object (TransferDate)
collaborationContext
integer <int64>
number
string
contactName
string
removed
boolean
readOnly
boolean
homeCurrency
string
project
integer <int64>
projectName
string
creation
string <date-time>
lastModified
string <date-time>
inboxReference
string
Array of objects (PaymentAllocationIn)
terms
string
object (TransferDate)
poNumber
string
Array of objects (LegacyTaxEntryInfo)
totalDue
integer <int64>
balanceDue
integer <int64>
paid
boolean
exchangePayment
boolean
keepInOriginalCurrency
boolean
balanceDueFormatted
string
totalDueFormatted
string
totalBeforeTaxes
integer <int64>
Array of objects (RecordTaxAmount)
totalLocalDue
integer <int64>
type
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
paidInvoice
boolean
totalPaidImmediately
integer <int64>
totalPaidLater
integer <int64>
totalPaid
integer <int64>
income
boolean
foreignCurrency
boolean
Array of objects (RecordAttachmentInfo)
allowZeroAmounts
boolean
Array of objects (LineItemInfo)
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Transfers

kashootsa

List transfers associated with this business.

This is the same as accessing records with type=TRANSFER.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
search
string
amountGe
integer <int64>
amountLe
integer <int64>
sortColumn
string
sortOrder
string
includeRemoved
boolean
modifiedSince
integer <int64>
contactId
integer <int64>

Responses

Response samples

Content type
No sample

Add a transfer to a business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
description
string
memo
string
exchangeRate
number <double>
contact
integer <int64>
currency
string
account
integer <int64>
object (TransferDate)
collaborationContext
integer <int64>
number
string
contactName
string
removed
boolean
readOnly
boolean
homeCurrency
string
project
integer <int64>
projectName
string
creation
string <date-time>
lastModified
string <date-time>
inboxReference
string
depositAccount
integer <int64>
depositCurrency
string
amount
integer <int64>
foreignCurrency
boolean
type
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
Array of objects (RecordAttachmentInfo)
allowZeroAmounts
boolean
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Adjustments

List adjustments associated with this business.:

This is the same as accessing records with type=ADJUSTMENT.

path Parameters
business_id
required
integer <int64>
query Parameters
offset
integer <int32>
limit
integer <int32>
Default: 50
object (TransferDate)
object (TransferDate)
search
string
amountGe
integer <int64>
amountLe
integer <int64>
sortColumn
string
sortOrder
string
includeRemoved
boolean
modifiedSince
integer <int64>
contactId
integer <int64>

Responses

Response samples

Content type
No sample

Create an adjustment

Creates an adjustment record for the business.

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
description
string
memo
string
exchangeRate
number <double>
contact
integer <int64>
currency
string
account
integer <int64>
object (TransferDate)
collaborationContext
integer <int64>
number
string
contactName
string
removed
boolean
readOnly
boolean
homeCurrency
string
project
integer <int64>
projectName
string
creation
string <date-time>
lastModified
string <date-time>
inboxReference
string
Array of objects (AdjustmentInfo)
foreignCurrency
boolean
type
string
Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE"
Array of objects (RecordAttachmentInfo)
allowZeroAmounts
boolean
Array of objects (LinkInfo)

Responses

Request samples

Content type
No sample

Shoebox

tsa

Delete bulk items by filter

Allows bulk deletion of shoebox items that match the specified query parameters.

Request Body schema: application/json
required

items Request

account
string
amountGe
integer

Should be integer

amountLe
integer

Should be integer

businessId
required
string
complete
boolean
endDate
string
ignored
boolean
processed
boolean
search
string
sourceId
string
sources
Array of strings
startDate
string
state
string
types
Array of strings

Responses

Request samples

Content type
application/json
{
  • "account": "",
  • "amountGe": 500,
  • "amountLe": 10000,
  • "businessId": "123456",
  • "complete": true,
  • "endDate": "2020-01-10T12:30U",
  • "ignored": false,
  • "processed": false,
  • "search": "bill",
  • "sourceId": "",
  • "sources": [
    ],
  • "startDate": "2020-01-10T12:30U",
  • "state": "",
  • "types": [
    ]
}

Bulk items retrieval

Gets one or more shoebox items as requested via the item id. The item ids are specified within the body of the request as a set of strings.

Request Body schema: application/json
required

items Request

businessId
required
string

in: body

Responses

Request samples

Content type
application/json
{
  • "businessId": "123456"
}

Delete bulk items by ids

Allows bulk deletion of shoebox items by shoebox id. The item ids are specified within the body of the request as a set of strings.

Request Body schema: application/json
required

items Request

businessId
required
string

in: body

Responses

Request samples

Content type
application/json
{
  • "businessId": "123456"
}

Get bank imports

Queries specifically for shoebox items that originated from a bank import. The semantics of this search are slightly different.

Request Body schema: application/json

items Request

account
string
businessId
required
string
limit
string
offset
string

Responses

Request samples

Content type
application/json
{
  • "account": "",
  • "businessId": "123456",
  • "limit": "25",
  • "offset": "1"
}

Unprocesses a set of shoebox items for a business.

This takes the items from the processed state back to the ready state. The normal form is recalcualted and the matches are queried for again. This call is idempotent. This is called when the user would like to undo a post and have the item go through the process workflow again.

Request Body schema: application/json
required

items Request

businessId
required
string

in: body

Responses

Request samples

Content type
application/json
{
  • "businessId": "123456"
}

Updates shoebox items after the user has matched two or more of them together.

Although the books api and web app will already create the appropriate books record and process the primary shoebox item, this method updates all of the associated shoebox items accordingly. This includes processing the secondary shoebox items and writing the appropriate matching metadata.

Request Body schema: application/json
required

items Request

businessId
required
string
shoeboxItemId
required
string

Responses

Request samples

Content type
application/json
{
  • "businessId": "123456",
  • "shoeboxItemId": "123456"
}

Get business transactions

Gets the shoebox items for a given business. Includes several optional filter arguments for narrowing down the list of shoebox items.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json
required

items Request

account
string
amountGe
integer

Should be integer

amountLe
integer

Should be integer

businessId
required
string
consistent
boolean
endDate
string
exclude
string
ignored
boolean
limit
string
nonBankFeed
boolean
offset
string
order
string
processed
boolean
search
string
sort
string
sourceId
string
sources
Array of strings
startDate
string
state
string
types
Array of strings

Responses

Request samples

Content type
application/json
{
  • "account": "",
  • "amountGe": 500,
  • "amountLe": 10000,
  • "businessId": "123456",
  • "consistent": false,
  • "endDate": "2020-01-10T12:30U",
  • "exclude": "",
  • "ignored": false,
  • "limit": "25",
  • "nonBankFeed": true,
  • "offset": "1",
  • "order": "asc",
  • "processed": false,
  • "search": "bill",
  • "sort": "date",
  • "sourceId": "",
  • "sources": [
    ],
  • "startDate": "2020-01-10T12:30U",
  • "state": "",
  • "types": [
    ]
}

Upserts a set of shoebox items

Upserts a set of shoebox items for a business. This either creates each shoebox item or updates the item data if it already exists. The change handlers are then run on each item to calculate their normal forms and make match suggestions. The endpoint is synchronous so that the caller can wait for the results to complete if that's important.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json

ShoeboxItemInfo[]

data
string

The data of the shoebox item stored as a json document.

previousData
string

Any previous versions of the data.

received
string

The datetime that the item was received.

source
string

The source of the item, ex: "yodlee".

sourceId
string

The id assigned to the item by the source.

state
string

The state of the shoebox item ("processed", "ready").

type
required
string

The type of item ("bank", "import").

Responses

Request samples

Content type
application/json
{
  • "data": "{\"custom\":\"data\"}",
  • "previousData": "{\"custom\":\"data-v0\"}",
  • "received": "2020-01-10T12:30U",
  • "source": "yodlee, upload",
  • "sourceId": "dd2232",
  • "state": "processed",
  • "type": "bank"
}

Upserts a set of bank shoebox items for a business

This is similar to the upsertItems call except that items are deduplicated against other bank items. This is important for bank feeds because the bank feed providers do not send only new items and instead we have to retrieve overlapping date ranges each day. In addition, a bank feed could be reconnected to an existing account.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json
required

items Request

businessId
required
string

in: body

Responses

Request samples

Content type
application/json
{
  • "businessId": "123456"
}

CategorizationRules

tsa

Lists the custom categorization rules defined for a business.

Lists all of the categorization rules that a business has created.

path Parameters
businessId
required
string

Business ID

query Parameters
limit
string

max nubmers of rules to return

offset
string

the starting offset to return the rules from

Request Body schema: application/json
required

ListRulesRequest

object (serverpb.ListRulesRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Categorizes a list of bank transactions.

Accepts a list of bank transactions as json and categorizes each one of them according to the business's rules.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json
required

CategorizeReuqest

Array of objects (serverpb.TransactionData)

Responses

Request samples

Content type
application/json
{
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "account_number": "string",
  • "account_tax_number": "string",
  • "rule": {
    },
  • "taxes": [
    ],
  • "transaction": {
    },
  • "transaction_id": "string"
}

Deletes an existing rule.

Allows the user to delete an existing rule.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json
required

DeleteRuleRequest

category
string
merchant
string

Responses

Request samples

Content type
application/json
{
  • "category": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "detail": "string",
  • "id": "string",
  • "status": "string"
}

Saves an update to an existing rule.

Allows the user to save an edit to an existing categorization rule. Used to edit the rules set up in the usual flow within the app.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json
required

SaveRuleRequest

accountNumber
string
category
string
merchant
string
taxes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "string",
  • "category": "string",
  • "merchant": "string",
  • "taxes": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "detail": "string",
  • "id": "string",
  • "status": "string"
}

Updates the custom categorization rules for a business.

Updates the categorization rule for a given transaction so that the next time that categorize is called, the indicated category is returned.

path Parameters
businessId
required
string

Business ID

Request Body schema: application/json
required

UpdateRulesRequest

account_number
string
object (anypb.Any)
merchant
string
source
integer
taxes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "account_number": "string",
  • "data": {
    },
  • "merchant": "string",
  • "source": 0,
  • "taxes": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "detail": "string",
  • "id": "string",
  • "status": "string"
}

OCR

Create transactions from images (OCR)

To create a batch of transactions with images which performs OCR on the images and save transaction details, follow the two steps below.

1) Upload attachments via blobstore

Call POST /blob/:namespace/:businessid/ and include multiple blobs in the payload. Once the POST is successfull your response will contain a list of (name, uuid).

See Attachments > Blobstore > Upload multiple blobs for a given businessId

2) Upsert shoebox items using the attachments ids

Call PUT /shoebox/businesses/{businessId}/items to upsert (update if exists, create if new) shoebox items created by the previous POST blobstore call. Remember to use the blob's uuid as the sourceId and set the source field as "upload". This call will create transactions , and they will be available in the Inbox (to review). These transactions must be posted manually.

See example payload below:

[{
    type: "document",
    source: "upload",
    state: "ready",
    sourceId: "550e8400-e29b-41d4-a716-446655440000", // uuid of the blob
    received: "2020-10-12T12:00U",
    data: {
      size: 120000, // file size in bytes
      mimeType: 'image/jpg',
      filename: 'walmart-receipt.jpg',
      lastModified: "2020-10-12T12:00U",
      date: "2020-10-12T12:00U"
    }
  }
]

See Transactions > Shoebox > Upserts a set of shoebox items

ℹ️ Note

OCR usages may be subject to separate usage charges in the future.

Create transactions from images (OCR)

To create a batch of transactions with images which performs OCR on the images and save transaction details, follow the two steps below.

1) Upload attachments via blobstore

Call POST /blob/:namespace/:businessid/ and include multiple blobs in the payload. Once the POST is successfull your response will contain a list of (name, uuid).

See Attachments > Blobstore > Upload multiple blobs for a given businessId

2) Upsert shoebox items using the attachments ids

Call PUT /shoebox/businesses/{businessId}/items to upsert (update if exists, create if new) shoebox items created by the previous POST blobstore call. Remember to use the blob's uuid as the sourceId and set the source field as "upload". This call will create transactions , and they will be available in the Inbox (to review). These transactions must be posted manually.

See example payload below:

[{
    type: "document",
    source: "upload",
    state: "ready",
    sourceId: "550e8400-e29b-41d4-a716-446655440000", // uuid of the blob
    received: "2020-10-12T12:00U",
    data: {
      size: 120000, // file size in bytes
      mimeType: 'image/jpg',
      filename: 'walmart-receipt.jpg',
      lastModified: "2020-10-12T12:00U",
      date: "2020-10-12T12:00U"
    }
  }
]

See Transactions > Shoebox > Upserts a set of shoebox items

ℹ️ Note

OCR usages may be subject to separate usage charges in the future.

Bank Feeds

kashootsa

manualRefresh

path Parameters
feed_id
required
integer <int64>

Responses

simpleRefresh

path Parameters
feed_id
required
integer <int64>

Responses

Update a bank feed by linking or unlinking accounts and retrieving transactions as needed.

path Parameters
feed_id
required
integer <int64>
Request Body schema: application/json
id
integer <int64>
business
integer <int64>
state
string
Enum: "OK" "LOCKED_OUT" "NEEDS_EDIT" "REFRESHING"
lastRefreshed
string <date-time>
creationDate
string <date-time>
displayName
string
identifier
string
provider
string
Enum: "YODLEE" "PLAID" "DEMOFEED"
errorCode
string
errorMessage
string
groupName
string
refreshProgress
number <double>
Array of objects (BankFeedAccountInfo)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "business": 0,
  • "state": "OK",
  • "lastRefreshed": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "displayName": "string",
  • "identifier": "string",
  • "provider": "YODLEE",
  • "errorCode": "string",
  • "errorMessage": "string",
  • "groupName": "string",
  • "refreshProgress": 0.1,
  • "bankFeedAccountInfos": [
    ]
}

Deletes a bank feed for a given business.

path Parameters
feed_id
required
integer <int64>

Responses

Get all the bank feeds for a given business

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a link token for launching Plaid Link from a client

path Parameters
business_id
required
integer <int64>
query Parameters
locales
Array of strings
customizationName
string
language
string
redirectUrl
string

Responses

Response samples

Content type
application/json
{
  • "expiration": "string",
  • "link_token": "string"
}

Creates a link token for launching Plaid Link to update a bank feed connection

path Parameters
business_id
required
integer <int64>
feed_id
required
integer <int64>
query Parameters
locales
Array of strings
customizationName
string
language
string
redirectUrl
string

Responses

Response samples

Content type
application/json
{
  • "expiration": "string",
  • "link_token": "string"
}

Posts a response from a Plaid Link add operation so that the associated bank connection can be created.

path Parameters
business_id
required
integer <int64>
Request Body schema: application/json
required
publicToken
string

Responses

Request samples

Content type
application/json
{
  • "publicToken": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "business": 0,
  • "state": "OK",
  • "lastRefreshed": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "displayName": "string",
  • "identifier": "string",
  • "provider": "YODLEE",
  • "errorCode": "string",
  • "errorMessage": "string",
  • "groupName": "string",
  • "refreshProgress": 0.1,
  • "bankFeedAccountInfos": [
    ]
}

getFastlink3EditInfo

path Parameters
business_id
required
integer <int64>
feed_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "jwt": "string",
  • "params": {
    }
}

getFastlink3AddInfo

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "jwt": "string"
}

getFastlink3RefreshInfo

path Parameters
business_id
required
integer <int64>
feed_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "jwt": "string",
  • "params": {
    }
}

processFastlink3CallbackInfo

path Parameters
business_id
required
integer <int64>
Request Body schema: application/json
additionalStatus
string
bankName
string
fnToCall
string
providerAccountId
integer <int64>
providerId
integer <int64>
requestId
string
status
string
operation
string

Responses

Request samples

Content type
application/json
{
  • "additionalStatus": "string",
  • "bankName": "string",
  • "fnToCall": "string",
  • "providerAccountId": 0,
  • "providerId": 0,
  • "requestId": "string",
  • "status": "string",
  • "operation": "string"
}

Currencies

kashootsa

View a single currency

Returns the currency identified by the given 3-digit ISO currency code

path Parameters
code
required
string

Responses

Response samples

Content type
No sample

List all currencies

Returns a list of currencies defined in our system. The main use of currency information is for formatting purposes, since this will tell you the number of decimal places, the type of decimal to use, and any prefix/suffix that are appropriate.

Responses

Response samples

Content type
No sample

Exchange Rates

kashootsa

Get Exchange Rates

Returns exchange rates

header Parameters
Authorization
string

Example: foo

Responses

Response samples

Content type
application/json
{
  • "base": "string",
  • "date": "string",
  • "rates": {
    },
  • "source": "string"
}

Taxes

kashootsa

Get a tax

path Parameters
tax_id
required
integer <int64>
business_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Delete a tax

path Parameters
tax_id
required
integer <int64>
business_id
required
integer <int64>

Responses

Update a tax

path Parameters
tax_id
required
integer <int64>
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
description
string
lazyRounding
boolean
system
boolean
removed
boolean
archived
boolean
canBeRegistered
boolean
canBeRecovered
boolean
registeredDefault
boolean
recoveredDefault
boolean
Array of objects (TaxRateInfo)
object (BusinessTaxAccountConfigInfo)
Array of objects (BusinessTaxConfigInfo)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Updates a tax config

path Parameters
rate_id
required
integer <int64>
query Parameters
createAccounts
boolean
Default: false
Request Body schema:
id
integer <int64>
object (BusinessTaxAccountConfigInfo)
registered
boolean
recoverable
boolean
object (TransferDate)
object (TransferDate)
registrationNumber
string
archived
boolean
removed
boolean
business
integer <int64>
object (TransferDate)
object (Period)
tax
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Remove a tax config

path Parameters
config_id
required
integer <int64>
rate_id
required
integer <int64>

Responses

Update a tax config

path Parameters
config_id
required
integer <int64>
rate_id
required
integer <int64>
query Parameters
createAccounts
boolean
Default: false
Request Body schema:
id
integer <int64>
object (BusinessTaxAccountConfigInfo)
registered
boolean
recoverable
boolean
object (TransferDate)
object (TransferDate)
registrationNumber
string
archived
boolean
removed
boolean
business
integer <int64>
object (TransferDate)
object (Period)
tax
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Remove a tax rate

path Parameters
rate_id
required
integer <int64>
rate_id
required
integer <int64>

Responses

Updates a tax rate

path Parameters
rate_id
required
integer <int64>
rate_id
required
integer <int64>
Request Body schema:
id
integer <int64>
tax
integer <int64>
rate
number <double>
object (TransferDate)
object (TransferDate)
compound
boolean
archived
boolean
removed
boolean
Array of objects (RegionInfo)
object (Period)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Add tax rate to a business

path Parameters
rate_id
required
integer <int64>
Request Body schema:
id
integer <int64>
tax
integer <int64>
rate
number <double>
object (TransferDate)
object (TransferDate)
compound
boolean
archived
boolean
removed
boolean
Array of objects (RegionInfo)
object (Period)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Get a tax

path Parameters
rate_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Delete a tax

path Parameters
rate_id
required
integer <int64>

Responses

Update a tax

path Parameters
rate_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
description
string
lazyRounding
boolean
system
boolean
removed
boolean
archived
boolean
canBeRegistered
boolean
canBeRecovered
boolean
registeredDefault
boolean
recoveredDefault
boolean
Array of objects (TaxRateInfo)
object (BusinessTaxAccountConfigInfo)
Array of objects (BusinessTaxConfigInfo)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Tax Config

kashootsa

Updates a tax config

path Parameters
tax_id
required
integer <int64>
business_id
required
integer <int64>
query Parameters
createAccounts
boolean
Default: false
Request Body schema:
id
integer <int64>
object (BusinessTaxAccountConfigInfo)
registered
boolean
recoverable
boolean
object (TransferDate)
object (TransferDate)
registrationNumber
string
archived
boolean
removed
boolean
business
integer <int64>
object (TransferDate)
object (Period)
tax
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Remove a tax config

path Parameters
config_id
required
integer <int64>
tax_id
required
integer <int64>
business_id
required
integer <int64>

Responses

Update a tax config

path Parameters
config_id
required
integer <int64>
tax_id
required
integer <int64>
business_id
required
integer <int64>
query Parameters
createAccounts
boolean
Default: false
Request Body schema:
id
integer <int64>
object (BusinessTaxAccountConfigInfo)
registered
boolean
recoverable
boolean
object (TransferDate)
object (TransferDate)
registrationNumber
string
archived
boolean
removed
boolean
business
integer <int64>
object (TransferDate)
object (Period)
tax
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Updates a tax config

path Parameters
rate_id
required
integer <int64>
query Parameters
createAccounts
boolean
Default: false
Request Body schema:
id
integer <int64>
object (BusinessTaxAccountConfigInfo)
registered
boolean
recoverable
boolean
object (TransferDate)
object (TransferDate)
registrationNumber
string
archived
boolean
removed
boolean
business
integer <int64>
object (TransferDate)
object (Period)
tax
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Remove a tax config

path Parameters
config_id
required
integer <int64>
rate_id
required
integer <int64>

Responses

Update a tax config

path Parameters
config_id
required
integer <int64>
rate_id
required
integer <int64>
query Parameters
createAccounts
boolean
Default: false
Request Body schema:
id
integer <int64>
object (BusinessTaxAccountConfigInfo)
registered
boolean
recoverable
boolean
object (TransferDate)
object (TransferDate)
registrationNumber
string
archived
boolean
removed
boolean
business
integer <int64>
object (TransferDate)
object (Period)
tax
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Tax Rates

kashootsa

Remove a tax rate

path Parameters
rate_id
required
integer <int64>
tax_id
required
integer <int64>
business_id
required
integer <int64>

Responses

Updates a tax rate

path Parameters
rate_id
required
integer <int64>
tax_id
required
integer <int64>
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
tax
integer <int64>
rate
number <double>
object (TransferDate)
object (TransferDate)
compound
boolean
archived
boolean
removed
boolean
Array of objects (RegionInfo)
object (Period)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Add tax rate to a business

path Parameters
tax_id
required
integer <int64>
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
tax
integer <int64>
rate
number <double>
object (TransferDate)
object (TransferDate)
compound
boolean
archived
boolean
removed
boolean
Array of objects (RegionInfo)
object (Period)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Remove a tax rate

path Parameters
rate_id
required
integer <int64>
rate_id
required
integer <int64>

Responses

Updates a tax rate

path Parameters
rate_id
required
integer <int64>
rate_id
required
integer <int64>
Request Body schema:
id
integer <int64>
tax
integer <int64>
rate
number <double>
object (TransferDate)
object (TransferDate)
compound
boolean
archived
boolean
removed
boolean
Array of objects (RegionInfo)
object (Period)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Add tax rate to a business

path Parameters
rate_id
required
integer <int64>
Request Body schema:
id
integer <int64>
tax
integer <int64>
rate
number <double>
object (TransferDate)
object (TransferDate)
compound
boolean
archived
boolean
removed
boolean
Array of objects (RegionInfo)
object (Period)

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Tax Codes

kashootsa

List tax codes associated with the business

path Parameters
business_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Update a business tax codes

path Parameters
business_id
required
integer <int64>
Request Body schema:
Array
id
integer <int64>
business
integer <int64>
name
string
description
string
expansion
string
taxSystem
string
income
boolean
removed
boolean
blank
boolean
lastModified
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Add a taxCode to a business

path Parameters
business_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
description
string
expansion
string
taxSystem
string
income
boolean
removed
boolean
blank
boolean
lastModified
integer <int64>

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

Get tax code information

path Parameters
taxCode_id
required
integer <int64>

Responses

Update tax code information

path Parameters
taxCode_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
description
string
expansion
string
taxSystem
string
income
boolean
removed
boolean
blank
boolean
lastModified
integer <int64>

Responses

Request samples

Content type
No sample

Removes a tax code

path Parameters
taxCode_id
required
integer <int64>

Responses

Invoice Payments

kashootsa

Gets payment processors for a business

Gets all of the payment processors defined for a business.

Responses

Initiate an Invoice Payment

path Parameters
paymentAttemptId
required
string

paymentAttemptId

Responses

Fetch Payment Requisition

Initiate a Payment

path Parameters
paymentRequisitionId
required
string

paymentRequisitionId

Responses

Accept Payments

Endpoint for accepting payments from end customers

Responses

Submit payment to an invoice

Endpoint function for accepting adhoc payment requests from Books users directly

path Parameters
businessId
required
string

businessId

invoiceId
required
string

invoiceId

Responses

Initiate an Invoice Payment

path Parameters
id
required
string

Invoice payment ID

Responses

File Inbox

kashootsa

Process file event

Endpoint for receiving file events from BrickFTP via web callback

Responses

Blobstore

kashootsa

Upload multiple blobs for a given businessId

Upload blob(s) to a particular business, given a namespace and businessId

header Parameters
Authorization
string

Example: foo

Request Body schema: multipart/form-data
required
file
required
string <binary>

Blob

Responses

Delete a particular blob

Delete a particular blob, given a namespace, businessId and uuid

header Parameters
Authorization
string

Example: foo

Responses

Get a blob

Returns the blob given a namespace, businessId and uuid

header Parameters
Authorization
string

Example: foo

Responses

Get a blob's metadata

Returns the blob's metadata given a namespace, businessId and uuid

header Parameters
Authorization
string

Example: foo

Responses

Upload a blob to a particular uuid

Upload a blob to a particular uuid, given a namespace, businessId and uuid

header Parameters
Authorization
string

Example: foo

Request Body schema: multipart/form-data
required
file
required
string <binary>

Blob

Responses

Upload a blob to a particular uuid

Upload a blob to a particular uuid, given a namespace, businessId and uuid

header Parameters
Authorization
string

Example: foo

Request Body schema: multipart/form-data
required
file
required
string <binary>

Blob

Responses

Reports

kashootsa

Generates a debit & credit report.

Generates a debit and credit report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)
object (TransferDate)
periods
integer <int32>
accountTypes
Array of strings unique
Items Enum: "ACCOUNTS_RECEIVABLE" "ACCOUNTS_PAYABLE" "BANK" "COST_OF_GOODS_SOLD" "CREDIT_CARD" "EQUITY" "EXPENSE" "FIXED_ASSET" "INCOME" "GAIN_OR_LOSS_ON_EXCHANGE" "LONG_TERM_LIABILITY" "OTHER_CURRENT_ASSET" "OTHER_CURRENT_LIABILITY" "OTHER_ASSET" "TAXES" "CASH" "RETAINED_EARNINGS" "PREPAID_EXPENSE" "CLIENT_CREDIT" "INVENTORY" "PAYROLL_TAX"

Responses

Response samples

Content type
No sample

Generates a sales tax report.

Generates a sales tax report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)
object (TransferDate)
taxIds
Array of integers <int64> unique [ items <int64 > ]

Responses

Response samples

Content type
No sample

Generates an income statement report.

Generates an income statement report for the business. It returns TSA report format

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)
object (TransferDate)
periods
integer <int32>
multicurrency
boolean
ascending
boolean
header Parameters
Accept
string

Responses

Response samples

Content type
No sample

Generates a trial balance report.

Generates a trial balance report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)
periods
integer <int32>
accountTypes
Array of strings unique
Items Enum: "ACCOUNTS_RECEIVABLE" "ACCOUNTS_PAYABLE" "BANK" "COST_OF_GOODS_SOLD" "CREDIT_CARD" "EQUITY" "EXPENSE" "FIXED_ASSET" "INCOME" "GAIN_OR_LOSS_ON_EXCHANGE" "LONG_TERM_LIABILITY" "OTHER_CURRENT_ASSET" "OTHER_CURRENT_LIABILITY" "OTHER_ASSET" "TAXES" "CASH" "RETAINED_EARNINGS" "PREPAID_EXPENSE" "CLIENT_CREDIT" "INVENTORY" "PAYROLL_TAX"

Responses

Response samples

Content type
No sample

Generates a balance sheet.

Generates a balance sheet report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)
periods
integer <int32>
multicurrency
boolean
summary
boolean

Responses

Response samples

Content type
No sample

Generates bills mini report.

Generates a mini report on bills for the business. This is a shorter report that can be used as a summary.

path Parameters
business_id
required
integer <int64>
query Parameters
object (TransferDate)

Responses

Generates invoices mini report.

Generates a mini report on invoices for the business. This is a shorter report that can be used as a summary.

path Parameters
business_id
required
integer <int64>
query Parameters
object (TransferDate)

Responses

Generates a general ledger report.

Generates an general ledger report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
startDate
string

Start date for the report

endDate
string

End date for the report

accounts
string

A set of ids of the accounts to include in the report. If missing, all are included

excludeEmpty
string

Whether accounts without transactions should be excluded from the report

sort
string

Whether to sort the report by account name (default) or number

object (TransferDate)
object (TransferDate)
accounts
Array of integers <int64> unique [ items <int64 > ]
excludeEmpty
boolean
sort
string
header Parameters
Accept
string

Responses

Response samples

Content type
No sample

Generates an aged receivables report.

Generates an aged receivables report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)

Responses

Response samples

Content type
No sample

Generates an aged payables report.

Generates an aged payables report for the business.

path Parameters
business_id
required
integer <int64>
query Parameters
type
string
object (TransferDate)

Responses

Response samples

Content type
No sample

Report Generator

Notifications

tsa

Get the vapid public key for web push notification subscriptions

Responses

Get a particular alert subscription

path Parameters
alert_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "business": 0,
  • "user": 0,
  • "alertType": "ALERT_TYPE_BANK_FEED_UPDATE",
  • "deliveryMethod": "DELIVERY_METHOD_EMAIL",
  • "timezone": "string"
}

Unsubscribes for an alert on the business.

path Parameters
alert_id
required
integer <int64>

Responses

Subscribes the user for web push notifications

Request Body schema:
endpoint
string
object (Keys)

Responses

Request samples

Content type
No sample

Allows callers to check if the user has already subscribed for web push notifications

Responses

Handle email notification events

Handles events to process and send notifications by email.

Responses

Groups

kashootsa

Returns the group information.

path Parameters
group_id
required
integer <int64>

Responses

Response samples

Content type
No sample

Updates an existing group.

path Parameters
group_id
required
integer <int64>
Request Body schema:
id
integer <int64>
business
integer <int64>
name
string
removed
boolean
type
string
contacts
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
No sample

Removes the group

path Parameters
group_id
required
integer <int64>

Responses

References

kashootsaHelpful endpoints including getting a list of countries, country regions and currencies

Get a list of countries

Returns a list of countries based on the optional filter parameter.

query Parameters
filter
string
Default: "ALL"
Enum: "ALL" "SUPPORTED"

Responses

Response samples

Content type
No sample

Get country regions

Get all the regions of a specified country

path Parameters
ISOCode
required
string

Responses

Response samples

Content type
No sample

Get all currencies

Gets a list of currencies registered in our database

Responses

Response samples

Content type
No sample

Get supported banks

Gets a list of banks supported in our platform

query Parameters
term
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a currency

Get details about a single currency

path Parameters
code
required
string

Responses

Response samples

Content type
No sample

Get a single country

Get details of a single country by using the ISO code.

path Parameters
ISOCode
required
string

Responses

Response samples

Content type
No sample