Download OpenAPI specification:Download
API documentation for the Kashoo platform.
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.
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.
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:
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.
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.
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.
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.
site | string |
lc | string Default: "en_US" |
duration | integer <int64> Default: 86400000 |
restriction | string |
string | |
password | string |
mfaCode | string |
provider | string |
authCode | string |
type | string |
{- "myUserId": 0,
- "expiryDate": "2019-08-24T14:15:22Z",
- "restriction": "string",
- "site": "string",
- "locale": "string",
- "authenticationCode": "string"
}
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:
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
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 ...
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
The server-side handler should store the bearer and refresh tokens for the user and use them to make api calls to Kashoo.
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.
Authorization required | string A basic auth header with the client id and secret as username and password |
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 |
{- "access_token": "example-access-token",
- "expires_in": 3600,
- "refresh_token": "example-refresh-token",
- "token_type": "bearer",
- "userId": "12355"
}
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.
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.
code | string |
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.
first | string |
last | string |
string | |
password | string |
additionalParams | string Default: "" |
site | string |
lc | string Default: "en_US" |
duration | integer <int64> Default: 86400000 |
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.
first | string |
last | string |
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 |
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 |
string | |
name | string |
Array of objects (LinkInfo) |
business_id required | integer <int64> |
id | integer <int64> |
business | integer <int64> |
name | string |
removed | boolean |
type | string |
contacts | Array of integers <int64> [ items <int64 > ] |
business_id required | integer <int64> |
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) |
Providing version == 2 will return a TaxCompositeInfo, else a LegacyTaxInfo
business_id required | integer <int64> |
version | integer <int32> |
[- {
- "id": 0,
- "business": 0,
- "name": "string",
- "description": "string",
- "lazyRounding": true,
- "system": true,
- "removed": true,
- "archived": true,
- "canBeRegistered": true,
- "canBeRecovered": true,
- "registeredDefault": true,
- "recoveredDefault": true,
- "rates": [
- {
- "id": 0,
- "tax": 0,
- "rate": 0.1,
- "startDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "endDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "compound": true,
- "archived": true,
- "removed": true,
- "regions": [
- {
- "id": 0,
- "country": "string",
- "provinceOrState": "string",
- "currency": "string",
- "isoCode": "string",
- "callingCode": "string",
- "empty": true
}
], - "period": {
- "start": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "end": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
}
], - "accounts": {
- "id": 0,
- "business": 0,
- "tax": 0,
- "payableAccount": 0,
- "receivableAccount": 0,
- "expenseAccount": 0,
- "archived": true
}, - "configuration": [
- {
- "id": 0,
- "businessTaxAccountConfig": {
- "id": 0,
- "business": 0,
- "tax": 0,
- "payableAccount": 0,
- "receivableAccount": 0,
- "expenseAccount": 0,
- "archived": true
}, - "registered": true,
- "recoverable": true,
- "startDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "endDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "registrationNumber": "string",
- "archived": true,
- "removed": true,
- "business": 0,
- "actualEndDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "period": {
- "start": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "end": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}, - "tax": 0
}
]
}
]
business_id required | integer <int64> |
[- {
- "id": 0,
- "business": 0,
- "name": "string",
- "description": "string",
- "lazyRounding": true,
- "system": true,
- "removed": true,
- "archived": true,
- "canBeRegistered": true,
- "canBeRecovered": true,
- "registeredDefault": true,
- "recoveredDefault": true,
- "rates": [
- {
- "id": 0,
- "tax": 0,
- "rate": 0.1,
- "startDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "endDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "compound": true,
- "archived": true,
- "removed": true,
- "regions": [
- {
- "id": 0,
- "country": "string",
- "provinceOrState": "string",
- "currency": "string",
- "isoCode": "string",
- "callingCode": "string",
- "empty": true
}
], - "period": {
- "start": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "end": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
}
], - "accounts": {
- "id": 0,
- "business": 0,
- "tax": 0,
- "payableAccount": 0,
- "receivableAccount": 0,
- "expenseAccount": 0,
- "archived": true
}, - "configuration": [
- {
- "id": 0,
- "businessTaxAccountConfig": {
- "id": 0,
- "business": 0,
- "tax": 0,
- "payableAccount": 0,
- "receivableAccount": 0,
- "expenseAccount": 0,
- "archived": true
}, - "registered": true,
- "recoverable": true,
- "startDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "endDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "registrationNumber": "string",
- "archived": true,
- "removed": true,
- "business": 0,
- "actualEndDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "period": {
- "start": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "end": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}, - "tax": 0
}
]
}
]
Gets a Subscription using an subscription ID or userID (fusionauth)
id | string ID of subscriptions |
subscriberId | string Subscriber ID |
Authorization required | string Example: Bearer foo |
{- "subscription": {
- "appId": "string",
- "expiresDate": "2019-10-12T07:20:50.52Z",
- "id": "string",
- "isSandbox": true,
- "originalId": "string",
- "originalPurchaseDate": "2019-10-12T07:20:50.52Z",
- "pauseDate": "2019-10-12T07:20:50.52Z",
- "platformProductId": "string",
- "purchaseDate": "2019-10-12T07:20:50.52Z",
- "resumeDate": "2019-10-12T07:20:50.52Z",
- "status": "string",
- "store": "string",
- "subscriberId": "string",
- "subscriptionApplication": "string",
- "unsubscribeDetectedAt": "2019-10-12T07:20:50.52Z",
- "userId": "string"
}
}
Creates a Subscription
Create Subscription Request
appId | string |
originalId | string |
platformProductId | string |
purchaseToken | string |
purchasedExplicitlyInApp | boolean |
store required | string |
subscriberId | string |
subscriptionApplication | string |
userEmail | string |
userId | string |
{- "appId": "string",
- "originalId": "string",
- "platformProductId": "string",
- "purchaseToken": "string",
- "purchasedExplicitlyInApp": true,
- "store": "string",
- "subscriberId": "string",
- "subscriptionApplication": "string",
- "userEmail": "string",
- "userId": "string"
}
{- "subscription": {
- "appId": "string",
- "expiresDate": "2019-10-12T07:20:50.52Z",
- "id": "string",
- "isSandbox": true,
- "originalId": "string",
- "originalPurchaseDate": "2019-10-12T07:20:50.52Z",
- "pauseDate": "2019-10-12T07:20:50.52Z",
- "platformProductId": "string",
- "purchaseDate": "2019-10-12T07:20:50.52Z",
- "resumeDate": "2019-10-12T07:20:50.52Z",
- "status": "string",
- "store": "string",
- "subscriberId": "string",
- "subscriptionApplication": "string",
- "unsubscribeDetectedAt": "2019-10-12T07:20:50.52Z",
- "userId": "string"
}
}
Creates a new chargebee checkout window
Authorization required | string Example: Bearer foo |
New Checkout
couponId | Array of strings |
object (serverpb.ChargeBeeCustomer) | |
subscriberId required | string |
subscriptionApplication required | string |
subscriptionPlanId required | string |
userId | string |
{- "couponId": [
- "string"
], - "customer": {
- "city": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "line1": "string",
- "line2": "string",
- "locale": "string",
- "stateCode": "string",
- "zip": "string"
}, - "subscriberId": "string",
- "subscriptionApplication": "string",
- "subscriptionPlanId": "string",
- "userId": "string"
}
{- "checkoutInfo": [
- 0
], - "content": [
- 0
], - "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
Authorization required | string Example: Bearer foo |
New portal session
subscriptionId | string |
{- "subscriptionId": "string"
}
{- "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_id required | integer <int64> |
inviteCode | string |
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> |
Lists the invoices that have been made on the business's current contract (plan).
business_id required | integer <int64> |
object (TransferDate) | |
object (TransferDate) | |
offset | integer <int32> |
limit | integer <int32> Default: 50 |
contact_id required | integer <int64> |
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 |
contact_id required | integer <int64> |
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 |
string | |
address | string |
name | string |
lastModified | integer <int64> |
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.
business_id required | integer <int64> |
[- {
- "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": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
]
business_id required | integer <int64> |
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) |
{- "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": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
{- "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": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
id required | integer <int64> |
business_id required | integer <int64> |
{- "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": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
id required | integer <int64> |
business_id required | integer <int64> |
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) |
{- "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": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
{- "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": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
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.
account_id required | integer <int64> |
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 |
account_id required | integer <int64> |
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> |
account_id required | integer <int64> |
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) |
business_id required | integer <int64> |
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 |
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.
record_type required | string Enum: "INVOICE" "TRANSFER" "ADJUSTMENT" "BILL" "BILL_PAYMENT" "INVOICE_PAYMENT" "YEAR_END_ADJUSTMENT" "OPENING_BALANCE" |
business_id required | integer <int64> |
[- {
- "type": "INVOICE",
- "number": "string"
}
]
Returns all the records for a business. Records can be of several types, including:
business_id required | integer <int64> |
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> |
[- {
- "id": 0,
- "business": 0,
- "description": "string",
- "memo": "string",
- "exchangeRate": 0.1,
- "contact": 0,
- "currency": "string",
- "account": 0,
- "date": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "collaborationContext": 0,
- "number": "string",
- "contactName": "string",
- "removed": true,
- "readOnly": true,
- "homeCurrency": "string",
- "project": 0,
- "projectName": "string",
- "creation": "2019-08-24T14:15:22Z",
- "lastModified": "2019-08-24T14:15:22Z",
- "inboxReference": "string",
- "foreignCurrency": true,
- "recordAttachments": [
- {
- "id": 0,
- "uuid": "string",
- "filename": "string",
- "mimeType": "string",
- "contentLength": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "removed": true,
- "creationTransferDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
], - "allowZeroAmounts": true,
- "type": "INVOICE",
- "links": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
]
Imports records from an outside source. Right now this only supports ofx/qbo files.
business_id required | integer <int64> |
uuid | string |
url | string |
filename | string |
account | integer <int64> |
preview | boolean |
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.
[- {
- "id": 0,
- "business": 0,
- "description": "string",
- "memo": "string",
- "exchangeRate": 0.1,
- "contact": 0,
- "currency": "string",
- "account": 0,
- "date": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "collaborationContext": 0,
- "number": "string",
- "contactName": "string",
- "removed": true,
- "readOnly": true,
- "homeCurrency": "string",
- "project": 0,
- "projectName": "string",
- "creation": "2019-08-24T14:15:22Z",
- "lastModified": "2019-08-24T14:15:22Z",
- "inboxReference": "string",
- "foreignCurrency": true,
- "recordAttachments": [
- {
- "id": 0,
- "uuid": "string",
- "filename": "string",
- "mimeType": "string",
- "contentLength": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "removed": true,
- "creationTransferDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
], - "allowZeroAmounts": true,
- "type": "INVOICE",
- "links": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
]
[- {
- "id": 0,
- "business": 0,
- "description": "string",
- "memo": "string",
- "exchangeRate": 0.1,
- "contact": 0,
- "currency": "string",
- "account": 0,
- "date": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "collaborationContext": 0,
- "number": "string",
- "contactName": "string",
- "removed": true,
- "readOnly": true,
- "homeCurrency": "string",
- "project": 0,
- "projectName": "string",
- "creation": "2019-08-24T14:15:22Z",
- "lastModified": "2019-08-24T14:15:22Z",
- "inboxReference": "string",
- "foreignCurrency": true,
- "recordAttachments": [
- {
- "id": 0,
- "uuid": "string",
- "filename": "string",
- "mimeType": "string",
- "contentLength": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "removed": true,
- "creationTransferDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
], - "allowZeroAmounts": true,
- "type": "INVOICE",
- "links": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
]
Unprocess a batch of records and returns them to the inbox. This operation is used for TrulySmall Accounting.
[- {
- "id": 0,
- "business": 0,
- "description": "string",
- "memo": "string",
- "exchangeRate": 0.1,
- "contact": 0,
- "currency": "string",
- "account": 0,
- "date": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "collaborationContext": 0,
- "number": "string",
- "contactName": "string",
- "removed": true,
- "readOnly": true,
- "homeCurrency": "string",
- "project": 0,
- "projectName": "string",
- "creation": "2019-08-24T14:15:22Z",
- "lastModified": "2019-08-24T14:15:22Z",
- "inboxReference": "string",
- "foreignCurrency": true,
- "recordAttachments": [
- {
- "id": 0,
- "uuid": "string",
- "filename": "string",
- "mimeType": "string",
- "contentLength": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "removed": true,
- "creationTransferDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
], - "allowZeroAmounts": true,
- "type": "INVOICE",
- "links": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
]
[- {
- "id": 0,
- "business": 0,
- "description": "string",
- "memo": "string",
- "exchangeRate": 0.1,
- "contact": 0,
- "currency": "string",
- "account": 0,
- "date": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}, - "collaborationContext": 0,
- "number": "string",
- "contactName": "string",
- "removed": true,
- "readOnly": true,
- "homeCurrency": "string",
- "project": 0,
- "projectName": "string",
- "creation": "2019-08-24T14:15:22Z",
- "lastModified": "2019-08-24T14:15:22Z",
- "inboxReference": "string",
- "foreignCurrency": true,
- "recordAttachments": [
- {
- "id": 0,
- "uuid": "string",
- "filename": "string",
- "mimeType": "string",
- "contentLength": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "removed": true,
- "creationTransferDate": {
- "year": 0,
- "month": 0,
- "dayOfMonth": 0,
- "lastDayOfMonth": true,
- "maxDayOfMonth": 0,
- "firstDayOfMonth": true,
- "monthEnum": "JANUARY",
- "past": true,
- "future": true,
- "dayOfYear": 0,
- "leapYear": true
}
}
], - "allowZeroAmounts": true,
- "type": "INVOICE",
- "links": [
- {
- "rel": "string",
- "href": "string",
- "type": "string"
}
]
}
]
business_id required | integer <int64> |
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> |
business_id required | integer <int64> |
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) |
This is the same as accessing records with type=INVOICE.
business_id required | integer <int64> |
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> |
business_id required | integer <int64> |
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) |
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.
record_id required | integer <int64> |
to | string |
cc | string |
bcc | string |
message | string |
processor | string |
preview | boolean |
previewType | string |
attachments | Array of strings |
template | string |
This is the same as accessing records with type=BILL_PAYMENT.
business_id required | integer <int64> |
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> |
business_id required | integer <int64> |
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) |
This is the same as accessing records with type=BILL.
business_id required | integer <int64> |
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> |
business_id required | integer <int64> |
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) |
This is the same as accessing records with type=TRANSFER.
business_id required | integer <int64> |
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> |
business_id required | integer <int64> |
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) |
This is the same as accessing records with type=ADJUSTMENT.
business_id required | integer <int64> |
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> |
Creates an adjustment record for the business.
business_id required | integer <int64> |
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) |
Allows bulk deletion of shoebox items that match the specified query parameters.
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 |
{- "account": "",
- "amountGe": 500,
- "amountLe": 10000,
- "businessId": "123456",
- "complete": true,
- "endDate": "2020-01-10T12:30U",
- "ignored": false,
- "processed": false,
- "search": "bill",
- "sourceId": "",
- "sources": [
- "['bank'",
- " 'internal']"
], - "startDate": "2020-01-10T12:30U",
- "state": "",
- "types": [
- "['invoice'",
- " 'bill']"
]
}
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.
items Request
businessId required | string in: body |
{- "businessId": "123456"
}
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.
items Request
businessId required | string in: body |
{- "businessId": "123456"
}
Queries specifically for shoebox items that originated from a bank import. The semantics of this search are slightly different.
items Request
account | string |
businessId required | string |
limit | string |
offset | string |
{- "account": "",
- "businessId": "123456",
- "limit": "25",
- "offset": "1"
}
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.
items Request
businessId required | string in: body |
{- "businessId": "123456"
}
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.
items Request
businessId required | string |
shoeboxItemId required | string |
{- "businessId": "123456",
- "shoeboxItemId": "123456"
}
Gets the shoebox items for a given business. Includes several optional filter arguments for narrowing down the list of shoebox items.
businessId required | string Business ID |
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 |
{- "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": [
- "['bank'",
- " 'internal']"
], - "startDate": "2020-01-10T12:30U",
- "state": "",
- "types": [
- "['invoice'",
- " 'bill']"
]
}
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.
businessId required | string Business ID |
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"). |
{- "data": "{\"custom\":\"data\"}",
- "previousData": "{\"custom\":\"data-v0\"}",
- "received": "2020-01-10T12:30U",
- "source": "yodlee, upload",
- "sourceId": "dd2232",
- "state": "processed",
- "type": "bank"
}
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.
businessId required | string Business ID |
items Request
businessId required | string in: body |
{- "businessId": "123456"
}
Lists all of the categorization rules that a business has created.
businessId required | string Business ID |
limit | string max nubmers of rules to return |
offset | string the starting offset to return the rules from |
ListRulesRequest
{ }
{- "rules": [
- {
- "accountNumber": "string",
- "category": "string",
- "merchant": "string",
- "taxes": [
- "string"
]
}
]
}
Accepts a list of bank transactions as json and categorizes each one of them according to the business's rules.
businessId required | string Business ID |
CategorizeReuqest
Array of objects (serverpb.TransactionData) |
{- "transactions": [
- {
- "data": {
- "type_url": "string",
- "value": [
- 0
]
}, - "source": 0
}
]
}
{- "account_number": "string",
- "account_tax_number": "string",
- "rule": {
- "category": "string",
- "merchant": "string"
}, - "taxes": [
- "string"
], - "transaction": {
- "category": "string",
- "merchant": "string"
}, - "transaction_id": "string"
}
Allows the user to delete an existing rule.
businessId required | string Business ID |
DeleteRuleRequest
category | string |
merchant | string |
{- "category": "string",
- "merchant": "string"
}
{- "code": 0,
- "detail": "string",
- "id": "string",
- "status": "string"
}
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.
businessId required | string Business ID |
SaveRuleRequest
accountNumber | string |
category | string |
merchant | string |
taxes | Array of strings |
{- "accountNumber": "string",
- "category": "string",
- "merchant": "string",
- "taxes": [
- "string"
]
}
{- "code": 0,
- "detail": "string",
- "id": "string",
- "status": "string"
}
Updates the categorization rule for a given transaction so that the next time that categorize is called, the indicated category is returned.
businessId required | string Business ID |
UpdateRulesRequest
account_number | string |
object (anypb.Any) | |
merchant | string |
source | integer |
taxes | Array of strings |
{- "account_number": "string",
- "data": {
- "type_url": "string",
- "value": [
- 0
]
}, - "merchant": "string",
- "source": 0,
- "taxes": [
- "string"
]
}
{- "code": 0,
- "detail": "string",
- "id": "string",
- "status": "string"
}
To create a batch of transactions with images which performs OCR on the images and save transaction details, follow the two steps below.
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
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.
To create a batch of transactions with images which performs OCR on the images and save transaction details, follow the two steps below.
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
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.
feed_id required | integer <int64> |
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) |
{- "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": [
- {
- "id": 0,
- "account": 0,
- "accountNumber": "string",
- "accountName": "string",
- "accountType": "BANK",
- "providerAccountId": "string",
- "lastRefreshed": "2019-08-24T14:15:22Z",
- "balance": 0,
- "currency": "string",
- "autoUpdateEnabled": true,
- "unlocked": true
}
]
}
business_id required | integer <int64> |
[- {
- "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": [
- {
- "id": 0,
- "account": 0,
- "accountNumber": "string",
- "accountName": "string",
- "accountType": "BANK",
- "providerAccountId": "string",
- "lastRefreshed": "2019-08-24T14:15:22Z",
- "balance": 0,
- "currency": "string",
- "autoUpdateEnabled": true,
- "unlocked": true
}
]
}
]
business_id required | integer <int64> |
locales | Array of strings |
customizationName | string |
language | string |
redirectUrl | string |
{- "expiration": "string",
- "link_token": "string"
}
business_id required | integer <int64> |
feed_id required | integer <int64> |
locales | Array of strings |
customizationName | string |
language | string |
redirectUrl | string |
{- "expiration": "string",
- "link_token": "string"
}
business_id required | integer <int64> |
publicToken | string |
{- "publicToken": "string"
}
{- "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": [
- {
- "id": 0,
- "account": 0,
- "accountNumber": "string",
- "accountName": "string",
- "accountType": "BANK",
- "providerAccountId": "string",
- "lastRefreshed": "2019-08-24T14:15:22Z",
- "balance": 0,
- "currency": "string",
- "autoUpdateEnabled": true,
- "unlocked": true
}
]
}
business_id required | integer <int64> |
feed_id required | integer <int64> |
{- "url": "string",
- "jwt": "string",
- "params": {
- "providerAccountId": 0,
- "userExperienceFlow": {
- "property1": { },
- "property2": { }
}, - "dataset": [
- {
- "name": "string",
- "attribute": [
- {
- "name": "string",
- "container": [
- "string"
]
}
]
}
], - "flow": "string"
}
}
business_id required | integer <int64> |
feed_id required | integer <int64> |
{- "url": "string",
- "jwt": "string",
- "params": {
- "providerAccountId": 0,
- "userExperienceFlow": {
- "property1": { },
- "property2": { }
}, - "dataset": [
- {
- "name": "string",
- "attribute": [
- {
- "name": "string",
- "container": [
- "string"
]
}
]
}
], - "flow": "string"
}
}
business_id required | integer <int64> |
additionalStatus | string |
bankName | string |
fnToCall | string |
providerAccountId | integer <int64> |
providerId | integer <int64> |
requestId | string |
status | string |
operation | string |
{- "additionalStatus": "string",
- "bankName": "string",
- "fnToCall": "string",
- "providerAccountId": 0,
- "providerId": 0,
- "requestId": "string",
- "status": "string",
- "operation": "string"
}
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.
tax_id required | integer <int64> |
business_id required | integer <int64> |
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) |
rate_id required | integer <int64> |
createAccounts | boolean Default: false |
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> |
config_id required | integer <int64> |
rate_id required | integer <int64> |
createAccounts | boolean Default: false |
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> |
rate_id required | integer <int64> |
rate_id required | integer <int64> |
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) |
rate_id required | integer <int64> |
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) |
rate_id required | integer <int64> |
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) |
tax_id required | integer <int64> |
business_id required | integer <int64> |
createAccounts | boolean Default: false |
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> |
config_id required | integer <int64> |
tax_id required | integer <int64> |
business_id required | integer <int64> |
createAccounts | boolean Default: false |
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> |
rate_id required | integer <int64> |
createAccounts | boolean Default: false |
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> |
config_id required | integer <int64> |
rate_id required | integer <int64> |
createAccounts | boolean Default: false |
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> |
rate_id required | integer <int64> |
tax_id required | integer <int64> |
business_id required | integer <int64> |
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) |
tax_id required | integer <int64> |
business_id required | integer <int64> |
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) |
rate_id required | integer <int64> |
rate_id required | integer <int64> |
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) |
rate_id required | integer <int64> |
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) |
business_id required | integer <int64> |
id | integer <int64> |
business | integer <int64> |
name | string |
description | string |
expansion | string |
taxSystem | string |
income | boolean |
removed | boolean |
blank | boolean |
lastModified | integer <int64> |
business_id required | integer <int64> |
id | integer <int64> |
business | integer <int64> |
name | string |
description | string |
expansion | string |
taxSystem | string |
income | boolean |
removed | boolean |
blank | boolean |
lastModified | integer <int64> |
taxCode_id required | integer <int64> |
id | integer <int64> |
business | integer <int64> |
name | string |
description | string |
expansion | string |
taxSystem | string |
income | boolean |
removed | boolean |
blank | boolean |
lastModified | integer <int64> |
Generates a debit and credit report for the business.
business_id required | integer <int64> |
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" |
Generates a sales tax report for the business.
business_id required | integer <int64> |
type | string |
object (TransferDate) | |
object (TransferDate) | |
taxIds | Array of integers <int64> unique [ items <int64 > ] |
Generates an income statement report for the business. It returns TSA report format
business_id required | integer <int64> |
type | string |
object (TransferDate) | |
object (TransferDate) | |
periods | integer <int32> |
multicurrency | boolean |
ascending | boolean |
Accept | string |
Generates a trial balance report for the business.
business_id required | integer <int64> |
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" |
Generates an general ledger report for the business.
business_id required | integer <int64> |
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 |
Accept | string |
kashootsaHelpful endpoints including getting a list of countries, country regions and currencies