API docs by Redocly

Boss Insights (1.26.0)

Download OpenAPI specification:Download

URL: http://bossinsights.com/support License: Apache 2.0 Terms of Service

A single API that provides a holistic view of business data including accounting, banking, commerce, marketing and more.

This documentation is intended for software developers and covers the Boss Insights API endpoints.

📚 Looking for an API overview? You'll find that at our Developer Documentation site.

AccountingTransaction

Retrieves a Collection of accounting transaction resources

Retrieves a Collection of accounting transaction resources

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a AccountingTransaction resource.

Retrieves a AccountingTransaction resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "transactionId": "string",
  • "transactionType": "string",
  • "transactionNumber": "string",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "ContactId": "string",
  • "ContactName": "string",
  • "location": "string",
  • "description": "string",
  • "accountId": "string",
  • "accountNumber": "string",
  • "accountType": "string",
  • "accountName": "string",
  • "subAccountName": "string",
  • "taxAmount": 0,
  • "taxType": "string",
  • "totalAmount": 0,
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "contactId": null,
  • "contactName": null
}

Account

Retrieves the collection of Account resources.

Retrieves the collection of Account resources.

Authorizations:
BasicAuth

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/accounts")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Account resource.

Creates a Account resource.

Authorizations:
BasicAuth
Request Body schema:

The new Account resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

code
string or null

customer defined code for the account e.g. "400" e.g. "SALES"

taxType
string or null

a tax code used for the account e.g. "TAX001"

bankAccountNumber
string or null

a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826"

bankAccountType
string or null

indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL"

currencyCode
string or null

the currency code e.g. "USD"

fullyQualifiedName
string or null

full canonical name for the account e.g. Short term cash

name
required
string or null

short name for the account e.g. "Sandra's Bank Account"

classification
string or null

The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense.

accountSubType
string or null

application based classification of the account e.g. "BANK"

currentBalanceWithSubAccounts
string or null

represents the total value of the account including any sub accounts in cents

created
string or null <date-time>

when the account was created

modified
string or null <date-time>

when any user modifiable attributes of the object were last changed

accountType
string or null

the type or class of the account e.g. "ASSET"

currentBalance
string or null

the value of the account excluding any sub accounts in cents

active
boolean or null

whether or not the account is active and should be included in calculations

subAccount
boolean or null

whether this account is actually a subaccount of another account

description
string or null

a user definable long form description of the account e.g. "This is the main company account for income and expenses"

srcId
string or null

the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

parentAccountId
string or null

if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK"

deleted
boolean or null

whether or not the account is active

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "code": "400",
  • "taxType": "TAX001",
  • "bankAccountNumber": "823772-2828773-09826",
  • "bankAccountType": "CREDITCARD",
  • "currencyCode": "USD",
  • "fullyQualifiedName": "Short Term Cash",
  • "name": "Sandra's Bank Account",
  • "classification": "Asset",
  • "accountSubType": "BANK",
  • "currentBalanceWithSubAccounts": "387687",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "accountType": "ASSET",
  • "currentBalance": "29872",
  • "active": true,
  • "subAccount": false,
  • "description": "This is the main company account for income and expenses",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK",
  • "deleted": false
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "code": "400",
  • "taxType": "TAX001",
  • "bankAccountNumber": "823772-2828773-09826",
  • "bankAccountType": "CREDITCARD",
  • "currencyCode": "USD",
  • "fullyQualifiedName": "Short Term Cash",
  • "name": "Sandra's Bank Account",
  • "classification": "Asset",
  • "accountSubType": "BANK",
  • "currentBalanceWithSubAccounts": "387687",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "accountType": "ASSET",
  • "currentBalance": "29872",
  • "active": true,
  • "subAccount": false,
  • "description": "This is the main company account for income and expenses",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK",
  • "deleted": false
}

Retrieves a Account resource.

Retrieves a Account resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/accounts/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "code": "400",
  • "taxType": "TAX001",
  • "bankAccountNumber": "823772-2828773-09826",
  • "bankAccountType": "CREDITCARD",
  • "currencyCode": "USD",
  • "fullyQualifiedName": "Short Term Cash",
  • "name": "Sandra's Bank Account",
  • "classification": "Asset",
  • "accountSubType": "BANK",
  • "currentBalanceWithSubAccounts": "387687",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "accountType": "ASSET",
  • "currentBalance": "29872",
  • "active": true,
  • "subAccount": false,
  • "description": "This is the main company account for income and expenses",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK",
  • "deleted": false
}

Replaces the Account resource.

Replaces the Account resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Account resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

code
string or null

customer defined code for the account e.g. "400" e.g. "SALES"

taxType
string or null

a tax code used for the account e.g. "TAX001"

bankAccountNumber
string or null

a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826"

bankAccountType
string or null

indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL"

currencyCode
string or null

the currency code e.g. "USD"

fullyQualifiedName
string or null

full canonical name for the account e.g. Short term cash

name
required
string or null

short name for the account e.g. "Sandra's Bank Account"

classification
string or null

The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense.

accountSubType
string or null

application based classification of the account e.g. "BANK"

currentBalanceWithSubAccounts
string or null

represents the total value of the account including any sub accounts in cents

created
string or null <date-time>

when the account was created

modified
string or null <date-time>

when any user modifiable attributes of the object were last changed

accountType
string or null

the type or class of the account e.g. "ASSET"

currentBalance
string or null

the value of the account excluding any sub accounts in cents

active
boolean or null

whether or not the account is active and should be included in calculations

subAccount
boolean or null

whether this account is actually a subaccount of another account

description
string or null

a user definable long form description of the account e.g. "This is the main company account for income and expenses"

srcId
string or null

the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

parentAccountId
string or null

if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK"

deleted
boolean or null

whether or not the account is active

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "code": "400",
  • "taxType": "TAX001",
  • "bankAccountNumber": "823772-2828773-09826",
  • "bankAccountType": "CREDITCARD",
  • "currencyCode": "USD",
  • "fullyQualifiedName": "Short Term Cash",
  • "name": "Sandra's Bank Account",
  • "classification": "Asset",
  • "accountSubType": "BANK",
  • "currentBalanceWithSubAccounts": "387687",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "accountType": "ASSET",
  • "currentBalance": "29872",
  • "active": true,
  • "subAccount": false,
  • "description": "This is the main company account for income and expenses",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK",
  • "deleted": false
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "code": "400",
  • "taxType": "TAX001",
  • "bankAccountNumber": "823772-2828773-09826",
  • "bankAccountType": "CREDITCARD",
  • "currencyCode": "USD",
  • "fullyQualifiedName": "Short Term Cash",
  • "name": "Sandra's Bank Account",
  • "classification": "Asset",
  • "accountSubType": "BANK",
  • "currentBalanceWithSubAccounts": "387687",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "accountType": "ASSET",
  • "currentBalance": "29872",
  • "active": true,
  • "subAccount": false,
  • "description": "This is the main company account for income and expenses",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "parentAccountId": "JS882-67283H-YW82KHX-2883KK-DJ3SK",
  • "deleted": false
}

Removes the Account resource.

Removes the Account resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/accounts/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Activity

Retrieves the collection of Activity resources.

Retrieves the collection of Activity resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Activity resource.

Retrieves a Activity resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/activities/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "emailsSent": 0,
  • "totalItems": 0
}

AgedPayablesExcel

Retrieves an excel workbook of an aged payables report

Retrieves a AgedPayablesExcel resource.

Authorizations:
BasicAuth
query Parameters
asOf
string <date-time>
Example: asOf=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

sort
string
Enum: "descending" "ascending" "alphabetical"
Example: sort=descending

Vendors can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "asOf": "This endpoint returns an .xlsx file."
}

AgedPayablesReport

Retrieves an aged payables report

Retrieves a AgedPayablesReport resource.

Authorizations:
BasicAuth
query Parameters
asOf
string <date-time>
Example: asOf=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

sort
string
Enum: "descending" "ascending" "alphabetical"
Example: sort=descending

Vendors can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "asOf": "2021-06-30",
  • "summary": [
    ],
  • "lastReconciled": "2021-01-31",
  • "isReconciled": false,
  • "sources": [
    ]
}

AgedReceivablesExcel

Retrieves an excel workbook of an aged receivables report

Retrieves a AgedReceivablesExcel resource.

Authorizations:
BasicAuth
query Parameters
asOf
string <date-time>
Example: asOf=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

sort
string
Enum: "descending" "ascending" "alphabetical"
Example: sort=descending

Customers can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "file": "This endpoint returns an .xlsx file."
}

AgedReceivablesReport

Retrieves an aged receivables report

Retrieves a AgedReceivablesReport resource.

Authorizations:
BasicAuth
query Parameters
asOf
string <date-time>
Example: asOf=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

sort
string
Enum: "descending" "ascending" "alphabetical"
Example: sort=descending

Can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "asOf": "2021-06-30",
  • "summary": [
    ],
  • "lastReconciled": "2021-01-31",
  • "isReconciled": false,
  • "sources": [
    ]
}

ApplicationCharge

Retrieves the collection of ApplicationCharge resources.

Retrieves the collection of ApplicationCharge resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a ApplicationCharge resource.

Retrieves a ApplicationCharge resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/application_charges/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "apiClientId": "string",
  • "price": 0,
  • "status": "string",
  • "returnUrl": "string",
  • "created": "string",
  • "modified": "string",
  • "chargeType": "string",
  • "decoratedReturnUrl": "string"
}

ApplicationCredit

Retrieves the collection of ApplicationCredit resources.

Retrieves the collection of ApplicationCredit resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a ApplicationCredit resource.

Retrieves a ApplicationCredit resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/application_credits/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "amount": 0,
  • "description": "string"
}

Asset

Retrieves the collection of Asset resources.

Retrieves the collection of Asset resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Asset resource.

Retrieves a Asset resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/assets/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "organizationId": "string",
  • "description": "string",
  • "price": "string",
  • "productId": "string",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "quantity": 0
}

BalanceHistory

Retrieves the collection of BalanceHistory resources.

Retrieves the collection of BalanceHistory resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BalanceHistory resource.

Retrieves a BalanceHistory resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/balance_histories/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "amount": 0,
  • "availableOn": "string",
  • "created": "string",
  • "currency": "string",
  • "balanceDescription": "string",
  • "exchangeRate": 0,
  • "fee": 0,
  • "feeType": "string",
  • "net": 0,
  • "balanceStatus": "string",
  • "balanceType": "string"
}

BalanceSheetExcel

Retrieves an excel workbook of a series of mapped balance sheets

Retrieves an excel workbook of a series of mapped balance sheets

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "file": "This endpoint returns an .xlsx file."
}

BalanceSheetReport

Retrieves a mapped balance sheet

Retrieves a mapped balance sheet

Authorizations:
BasicAuth
query Parameters
asOf
string <date-time>
Example: asOf=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "totals": {
    },
  • "details": [
    ],
  • "asOf": "2021-06-30",
  • "lastReconciled": "2021-01-31",
  • "isReconciled": false,
  • "hasCompleteData": true,
  • "sources": [
    ]
}

BalanceSheet

Retrieves a BalanceSheet resource.

Retrieves a BalanceSheet resource.

Authorizations:
BasicAuth
query Parameters
end
required
string <date-time>
Example: end=2022-11-30

YYYY-MM-DD

accounting_method
required
string
Enum: "cash" "accrual"
Example: accounting_method=accrual

The Accounting Method

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "reportTitle": "Balance Sheet",
  • "companyName": "Flux Capacitors Inc",
  • "columns": [
    ],
  • "rows": [
    ],
  • "accountingMethod": "cash",
  • "start": "2021-01-01",
  • "end": "2021-01-31",
  • "currencyCode": "USD",
  • "totalAssets": "2786282",
  • "totalLiabilities": "287622",
  • "totalCurrentAssets": "89792",
  • "totalCurrentLiabilities": "198339",
  • "totalEquity": "625282",
  • "netIncome": 0
}

BankAccount

Retrieves the collection of BankAccount resources.

Retrieves the collection of BankAccount resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BankAccount resource.

Retrieves a BankAccount resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "number": "string",
  • "type": "string",
  • "balance": 0,
  • "bankName": "string",
  • "bankConnectionId": "string",
  • "subtype": "string",
  • "deleted": true,
  • "currencyCode": "string",
  • "isAsset": true
}

BankOpeningBalance

Retrieves the collection of BankOpeningBalance resources.

Retrieves the collection of BankOpeningBalance resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BankOpeningBalance resource.

Retrieves a BankOpeningBalance resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "bankAccountId": "string",
  • "openingDate": "string",
  • "debit": 0,
  • "credit": 0
}

BankReconciliation

Retrieves the collection of BankReconciliation resources.

Retrieves the collection of BankReconciliation resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BankReconciliation resource.

Retrieves a BankReconciliation resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "bankAccountId": "string",
  • "reconciliationDate": "string",
  • "reconciliationEndBalance": 0,
  • "totalReceived": 0,
  • "totalPaid": 0,
  • "startingBalance": 0,
  • "closingBalance": 0,
  • "reconciledBalance": 0,
  • "balanceDifference": 0,
  • "status": "string"
}

BankSummary

Retrieves the collection of BankSummary resources.

Retrieves the collection of BankSummary resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BankSummary resource.

Retrieves a BankSummary resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "report_id": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ],
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "reportId": "string"
}

BankTransaction

Retrieves the collection of BankTransaction resources.

Retrieves the collection of BankTransaction resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BankTransaction resource.

Retrieves a BankTransaction resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "contactId": "string",
  • "contactName": "string",
  • "date": "string",
  • "status": "string",
  • "lineAmountTypes": "string",
  • "lineItemDescription": "string",
  • "lineItemUnitAmount": 0,
  • "lineItemTaxType": "string",
  • "lineItemTaxAmount": 0,
  • "lineAmount": 0,
  • "lineItemAccountCode": "string",
  • "lineItemQuantity": 0,
  • "lineItemId": "string",
  • "subtotal": 0,
  • "totalTax": 0,
  • "total": 0,
  • "modified": "string",
  • "currencyCode": "string",
  • "accountId": "string",
  • "bankAccountCode": "string",
  • "bankAccountName": "string",
  • "type": "string",
  • "reference": "string",
  • "isReconciled": true,
  • "fromAccountId": "string",
  • "toAccountId": "string",
  • "paymentMode": "string",
  • "customerId": "string",
  • "vendorId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "txnId": "string",
  • "category": "string",
  • "merchant": "string",
  • "description": "string"
}

BankTransfer

Retrieves the collection of BankTransfer resources.

Retrieves the collection of BankTransfer resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BankTransfer resource.

Retrieves a BankTransfer resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "string",
  • "transferDate": "string",
  • "fromBankAccountId": "string",
  • "fromBankAccountName": "string",
  • "toBankAccountId": "string",
  • "toBankAccountName": "string",
  • "amount": 0,
  • "fromBankTransactionId": "string",
  • "toBankTransactionId": "string",
  • "modified": "string",
  • "type": "string"
}

BatchPayment

Retrieves the collection of BatchPayment resources.

Retrieves the collection of BatchPayment resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BatchPayment resource.

Retrieves a BatchPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/batch_payments/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "accountId": "string",
  • "date": "string",
  • "paymentId": "string",
  • "paymentAmount": 0,
  • "type": "string",
  • "status": "string",
  • "totalAmount": 0,
  • "modified": "string",
  • "isReconciled": true
}

BillPayment

Retrieves the collection of BillPayment resources.

Retrieves the collection of BillPayment resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a BillPayment resource.

Creates a BillPayment resource.

Authorizations:
BasicAuth
Request Body schema:

The new BillPayment resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

the unique identifier of the source 3rd party integration e.g. "460000000053219"

billId
string

The source ID of the bill being paid

vendorPaymentId
string or null

The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique

vendorId
string or null

Unique identifier for the vendor of the bill e.g. "460000000026049"

vendorName
string or null

Name of the vendor of the bill e.g. "Bowman and Co"

paymentMode
string or null

Mode of payment e.g. "Stripe"

txnDate
string or null <date-time>

Date the payment is made e.g. "2013-10-07"

referenceNumber
string or null

Reference number for the payment recorded e.g. REF#912300

amount
integer

Total amount of the payment in cents e.g. 12500

currency
string or null

Currency code e.g. "USD"

created
string or null <date-time>

Creation time of the payment e.g. 2016-12-16T00:18:42-0500

modified
string or null <date-time>

Last modified time of the payment e.g. 2016-12-16T00:18:42-0500

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "billId": "34",
  • "vendorPaymentId": "quickbooks-34",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "billId": "34",
  • "vendorPaymentId": "quickbooks-34",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Retrieves a BillPayment resource.

Retrieves a BillPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "billId": "34",
  • "vendorPaymentId": "quickbooks-34",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Replaces the BillPayment resource.

Replaces the BillPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated BillPayment resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

the unique identifier of the source 3rd party integration e.g. "460000000053219"

billId
string

The source ID of the bill being paid

vendorPaymentId
string or null

The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique

vendorId
string or null

Unique identifier for the vendor of the bill e.g. "460000000026049"

vendorName
string or null

Name of the vendor of the bill e.g. "Bowman and Co"

paymentMode
string or null

Mode of payment e.g. "Stripe"

txnDate
string or null <date-time>

Date the payment is made e.g. "2013-10-07"

referenceNumber
string or null

Reference number for the payment recorded e.g. REF#912300

amount
integer

Total amount of the payment in cents e.g. 12500

currency
string or null

Currency code e.g. "USD"

created
string or null <date-time>

Creation time of the payment e.g. 2016-12-16T00:18:42-0500

modified
string or null <date-time>

Last modified time of the payment e.g. 2016-12-16T00:18:42-0500

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "billId": "34",
  • "vendorPaymentId": "quickbooks-34",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "billId": "34",
  • "vendorPaymentId": "quickbooks-34",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Removes the BillPayment resource.

Removes the BillPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Bill

Retrieves the collection of Bill resources.

Retrieves the collection of Bill resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Bill resource.

Creates a Bill resource.

Authorizations:
BasicAuth
Request Body schema:

The new Bill resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

vendorId
string

Vendor Id e.g. "15"

vendorName
string or null

Vendor full name e.g. "Acme Corp"

currency
string or null

Currency code e.g. "USD"

balance
integer

Total balance of the bill in cents e.g. 70000

txnDate
string or null <date-time>

Transaction date e.g. "2021-05-12"

totalAmount
integer

Total amount of the bill in cents e.g. 550000

apAccountId
string or null

Account Id e.g. "15"

apAccountName
string or null

Account full name e.g. "Accounts Payable"

modified
string <date-time>

Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"

created
string or null <date-time>

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

status
string or null

Bill status e.g. "Paid"

identifier
string or null

The bill number e.g. "4560"

referenceNumber
string or null

Reference number e.g. "1234"

dueDate
string or null <date-time>

Date bill is due e.g. "2021-05-30"

subtotal
integer or null

Bill subtotal in cents e.g. 65000

taxAmount
integer or null

Bill tax amount in cents e.g. 12000

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "vendorId": "15",
  • "vendorName": "Acme Corp",
  • "currency": "USD",
  • "balance": 70000,
  • "txnDate": "2021-05-12",
  • "totalAmount": 550000,
  • "apAccountId": "15",
  • "apAccountName": "Accounts Payable",
  • "modified": "2013-12-18T02:17:40.080Z",
  • "created": "2013-11-18T02:17:40.080Z",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": "Paid",
  • "identifier": "4560",
  • "referenceNumber": "1234",
  • "dueDate": "2021-05-30",
  • "subtotal": 65000,
  • "taxAmount": 12000
}

Response samples

Content type
{
  • "id": "quickbooks-345",
  • "integration": "quickbooks",
  • "vendorId": "15",
  • "vendorName": "Acme Corp",
  • "currency": "USD",
  • "balance": 70000,
  • "txnDate": "2021-05-12",
  • "totalAmount": 550000,
  • "apAccountId": "15",
  • "apAccountName": "Accounts Payable",
  • "modified": "2013-12-18T02:17:40.080Z",
  • "created": "2013-11-18T02:17:40.080Z",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": "Paid",
  • "identifier": "4560",
  • "referenceNumber": "1234",
  • "dueDate": "2021-05-30",
  • "subtotal": 65000,
  • "taxAmount": 12000
}

Retrieves a Bill resource.

Retrieves a Bill resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bills/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-345",
  • "integration": "quickbooks",
  • "vendorId": "15",
  • "vendorName": "Acme Corp",
  • "currency": "USD",
  • "balance": 70000,
  • "txnDate": "2021-05-12",
  • "totalAmount": 550000,
  • "apAccountId": "15",
  • "apAccountName": "Accounts Payable",
  • "modified": "2013-12-18T02:17:40.080Z",
  • "created": "2013-11-18T02:17:40.080Z",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": "Paid",
  • "identifier": "4560",
  • "referenceNumber": "1234",
  • "dueDate": "2021-05-30",
  • "subtotal": 65000,
  • "taxAmount": 12000
}

Replaces the Bill resource.

Replaces the Bill resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Bill resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

vendorId
string

Vendor Id e.g. "15"

vendorName
string or null

Vendor full name e.g. "Acme Corp"

currency
string or null

Currency code e.g. "USD"

balance
integer

Total balance of the bill in cents e.g. 70000

txnDate
string or null <date-time>

Transaction date e.g. "2021-05-12"

totalAmount
integer

Total amount of the bill in cents e.g. 550000

apAccountId
string or null

Account Id e.g. "15"

apAccountName
string or null

Account full name e.g. "Accounts Payable"

modified
string <date-time>

Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"

created
string or null <date-time>

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

status
string or null

Bill status e.g. "Paid"

identifier
string or null

The bill number e.g. "4560"

referenceNumber
string or null

Reference number e.g. "1234"

dueDate
string or null <date-time>

Date bill is due e.g. "2021-05-30"

subtotal
integer or null

Bill subtotal in cents e.g. 65000

taxAmount
integer or null

Bill tax amount in cents e.g. 12000

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "vendorId": "15",
  • "vendorName": "Acme Corp",
  • "currency": "USD",
  • "balance": 70000,
  • "txnDate": "2021-05-12",
  • "totalAmount": 550000,
  • "apAccountId": "15",
  • "apAccountName": "Accounts Payable",
  • "modified": "2013-12-18T02:17:40.080Z",
  • "created": "2013-11-18T02:17:40.080Z",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": "Paid",
  • "identifier": "4560",
  • "referenceNumber": "1234",
  • "dueDate": "2021-05-30",
  • "subtotal": 65000,
  • "taxAmount": 12000
}

Response samples

Content type
{
  • "id": "quickbooks-345",
  • "integration": "quickbooks",
  • "vendorId": "15",
  • "vendorName": "Acme Corp",
  • "currency": "USD",
  • "balance": 70000,
  • "txnDate": "2021-05-12",
  • "totalAmount": 550000,
  • "apAccountId": "15",
  • "apAccountName": "Accounts Payable",
  • "modified": "2013-12-18T02:17:40.080Z",
  • "created": "2013-11-18T02:17:40.080Z",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": "Paid",
  • "identifier": "4560",
  • "referenceNumber": "1234",
  • "dueDate": "2021-05-30",
  • "subtotal": 65000,
  • "taxAmount": 12000
}

Removes the Bill resource.

Removes the Bill resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/bills/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

BlogPosting

Retrieves the collection of BlogPosting resources.

Retrieves the collection of BlogPosting resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a BlogPosting resource.

Retrieves a BlogPosting resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/blog_postings/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "string",
  • "author": "string",
  • "authorId": "string",
  • "authorEmail": "string",
  • "campaignName": "string",
  • "commentCount": 0,
  • "title": "string",
  • "url": "string",
  • "updated": "string"
}

Blog

Retrieves the collection of Blog resources.

Retrieves the collection of Blog resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Blog resource.

Retrieves a Blog resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/blogs/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "url": "string",
  • "categoryId": "string",
  • "created": "string",
  • "description": "string",
  • "name": "string",
  • "updated": "string"
}

BudgetSummary

Retrieves a BudgetSummary resource.

Retrieves a BudgetSummary resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "report_id": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ],
  • "end": "2019-08-24T14:15:22Z",
  • "reportId": "string"
}

Retrieves the collection of BudgetSummary resources.

Retrieves the collection of BudgetSummary resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Call

Retrieves the collection of Call resources.

Retrieves the collection of Call resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Call resource.

Retrieves a Call resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/calls/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "callOwner": "string",
  • "callContact": "string",
  • "callDuration": 0,
  • "callPurpose": "string",
  • "callStartTime": "2019-08-24T14:15:22Z",
  • "callResult": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "callresult": "string"
}

CampaignReport

Retrieves the collection of CampaignReport resources.

Retrieves the collection of CampaignReport resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a CampaignReport resource.

Retrieves a CampaignReport resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "campaignName": "string",
  • "type": "string",
  • "emailsSent": 0,
  • "unsubscribed": 0,
  • "sendTime": "2019-08-24T14:15:22Z",
  • "hardBounces": 0,
  • "softBounces": 0,
  • "totalOpens": 0,
  • "uniqueOpens": 0,
  • "openRate": "string",
  • "totalClicks": 0,
  • "uniqueClicks": 0,
  • "fowards": 0
}

Campaign

Retrieves the collection of Campaign resources.

Retrieves the collection of Campaign resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Campaign resource.

Retrieves a Campaign resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/campaigns/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "campaignName": "string",
  • "campaignOwner": "string",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "budgetedCost": "string",
  • "actualCost": "string",
  • "expectedRevenue": "string",
  • "status": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "nExpectedResponse": 0
}

Charge

Retrieves the collection of Charge resources.

Retrieves the collection of Charge resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Charge resource.

Retrieves a Charge resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/charges/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "amount": 0,
  • "amountRefunded": 0,
  • "applicationId": "string",
  • "applicationFeeAmount": 0,
  • "balanceTransactionId": "string",
  • "billingAddress": "string",
  • "billingEmail": "string",
  • "billingName": "string",
  • "billingPhone": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "customerId": "string",
  • "chargeDescription": "string",
  • "invoiceId": "string",
  • "receiptNumber": "string",
  • "refunded": "string",
  • "status": "string",
  • "shippingAddress": "string",
  • "shippingName": "string",
  • "shippingPhone": "string",
  • "shippingTrackingNumber": "string"
}

Client

Retrieves the collection of Client resources.

Retrieves the collection of Client resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Client resource.

Retrieves a Client resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/clients/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "emailClient": "string",
  • "numMembers": 0,
  • "totalItems": 0
}

Company

Retrieves the collection of Company resources.

Retrieves the collection of Company resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Company resource.

Retrieves a Company resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/companies/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "isActive": true,
  • "url": "string"
}

ContactGroup

Retrieves the collection of ContactGroup resources.

Retrieves the collection of ContactGroup resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a ContactGroup resource.

Retrieves a ContactGroup resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/contact_groups/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "contactId": "string",
  • "contactName": "string",
  • "isActive": true
}

Contract

Retrieves the collection of Contract resources.

Retrieves the collection of Contract resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Contract resource.

Retrieves a Contract resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/contracts/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "contractName": "string",
  • "customer": "string",
  • "contractDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "status": "string"
}

Conversion

list converted documents

Retrieves the collection of Conversion resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Converts a document from one format to another

Creates a Conversion resource.

Authorizations:
BasicAuth
Request Body schema:

The new Conversion resource

type
string

type of conversion e.g. 'financial-statement'

url
string

url or subtype of conversion, e.g. 'other-accounting'

file
string

name of file

Responses

Request samples

Content type
{
  • "type": "string",
  • "url": "string",
  • "file": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "type": "string",
  • "url": "string",
  • "status": "string",
  • "file": "string"
}

Retrieves conversion results

Retrieves a Conversion resource.

Authorizations:
BasicAuth
path Parameters
id
required
integer
Example: 42

conversion job identifier

query Parameters
format
required
string
Enum: "data" "pages" "source"
Example: format=data

document format

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": 0,
  • "type": "string",
  • "url": "string",
  • "status": "string",
  • "file": "string"
}

CreditNote

Retrieves the collection of CreditNote resources.

Retrieves the collection of CreditNote resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a CreditNote resource.

Creates a CreditNote resource.

Authorizations:
BasicAuth
Request Body schema:

The new CreditNote resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string or null

Unique identifier of the source 3rd party integration

creditnoteNumber
string or null

Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29

date
string or null

The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05"

status
string or null

Status of the credit note. This can be open, closed or void eg. "open"

customerId
string or null

Customer ID of the customer for whom the credit note is raised eg. 903000000000099

customerName
string or null

Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture"

referenceNumber
string or null

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384"

totalAmount
string or null

Total of credit note eg. "400"

balance
integer or null

Unapplied credits eg. 10

currency
string or null

Customers currency code eg. "USD"

notes
string or null

Notes on the credit notes eg. "Offer for the referral"

created
string or null <date-time>

Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "creditnoteNumber": "CN-29",
  • "date": "2016-06-05",
  • "status": "open",
  • "customerId": "903000000000099",
  • "customerName": "Bowman Furniture",
  • "referenceNumber": "INV-384",
  • "totalAmount": "400",
  • "balance": 10,
  • "currency": "USD",
  • "notes": "Offer for the referral",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "creditnoteNumber": "CN-29",
  • "date": "2016-06-05",
  • "status": "open",
  • "customerId": "903000000000099",
  • "customerName": "Bowman Furniture",
  • "referenceNumber": "INV-384",
  • "totalAmount": "400",
  • "balance": 10,
  • "currency": "USD",
  • "notes": "Offer for the referral",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z"
}

Retrieves a CreditNote resource.

Retrieves a CreditNote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "creditnoteNumber": "CN-29",
  • "date": "2016-06-05",
  • "status": "open",
  • "customerId": "903000000000099",
  • "customerName": "Bowman Furniture",
  • "referenceNumber": "INV-384",
  • "totalAmount": "400",
  • "balance": 10,
  • "currency": "USD",
  • "notes": "Offer for the referral",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z"
}

Replaces the CreditNote resource.

Replaces the CreditNote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated CreditNote resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string or null

Unique identifier of the source 3rd party integration

creditnoteNumber
string or null

Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29

date
string or null

The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05"

status
string or null

Status of the credit note. This can be open, closed or void eg. "open"

customerId
string or null

Customer ID of the customer for whom the credit note is raised eg. 903000000000099

customerName
string or null

Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture"

referenceNumber
string or null

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384"

totalAmount
string or null

Total of credit note eg. "400"

balance
integer or null

Unapplied credits eg. 10

currency
string or null

Customers currency code eg. "USD"

notes
string or null

Notes on the credit notes eg. "Offer for the referral"

created
string or null <date-time>

Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "creditnoteNumber": "CN-29",
  • "date": "2016-06-05",
  • "status": "open",
  • "customerId": "903000000000099",
  • "customerName": "Bowman Furniture",
  • "referenceNumber": "INV-384",
  • "totalAmount": "400",
  • "balance": 10,
  • "currency": "USD",
  • "notes": "Offer for the referral",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "creditnoteNumber": "CN-29",
  • "date": "2016-06-05",
  • "status": "open",
  • "customerId": "903000000000099",
  • "customerName": "Bowman Furniture",
  • "referenceNumber": "INV-384",
  • "totalAmount": "400",
  • "balance": 10,
  • "currency": "USD",
  • "notes": "Offer for the referral",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z"
}

Removes the CreditNote resource.

Removes the CreditNote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

CustomerOpeningBalance

Retrieves the collection of CustomerOpeningBalance resources.

Retrieves the collection of CustomerOpeningBalance resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a CustomerOpeningBalance resource.

Retrieves a CustomerOpeningBalance resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "openingBalanceType": "string",
  • "customerId": "string",
  • "openingDate": "string",
  • "description": "string",
  • "totalAmount": 0,
  • "currency": "string"
}

Customer

Retrieves the collection of Customer resources.

Retrieves the collection of Customer resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Customer resource.

Creates a Customer resource.

Authorizations:
BasicAuth
Request Body schema:

The new Customer resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "50"

email
string or null

Email address for the customer e.g. "janedoe@email.com"

name
string or null

Full name of the customer e.g. "Jane Doe"

givenName
string or null

First name of the customer e.g. "Jane"

familyName
string or null

Last name of the customer e.g. "Doe"

companyName
string or null

Name of the company the customer is working on e.g. "Acme Corp."

fullyQualifiedName
string or null

Fully qualified name of the company the customer is working on e.g. "Acme Corporation"

address
string or null

First line of customer address e.g. "708 Woodland Avenue"

addressLine2
string or null

Second line of customer address e.g. "Unit 105"

city
string or null

City of the address e.g. "St Paul"

postalCode
string or null

Postal code of the address * e.g. "99660"

country
string or null

Country of the address * e.g. "United States"

billingAddress
string or null

Billing address line 1 e.g. "4348 Candlelight Drive"

billingAddressLine2
string or null

Billing address line 2 e.g. "Apartment 78"

billingCity
string or null

Billing address city e.g. "Panama City"

billingState
string or null

Billing address state or province e.g. "Florida"

billingPostalCode
string or null

Billing address postal code e.g. "32417"

billingCountry
string or null

Billing address country e.g. "United States"

phone
string or null

Phone number e.g. "281-381-4241"

mobile
string or null

Mobile number e.g. "786-258-0182"

fax
string or null

Fax number e.g. "281-381-4255"

ddi
string or null

Direct dial number e.g. "5050"

balance
integer or null

Balance owed by customer in cents e.g. 19999

currency
string or null

Currency used by customer e.g. "USD"

taxable
boolean or null

Taxable status

customerAccountStatus
string or null

Accounting status of the customer e.g. "Enabled"

monthlyRecurringRevenue
integer or null

Monthly recurring revenue in cents e.g. 4500000

netMonthlyRecurringRevenue
integer or null

Net monthly recurring revenue e.g. 2500000

created
string or null <date-time>

Date of customer account creation e.g. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"

title
string or null

Job title of the customer e.g. "Manager"

department
string or null

Department where customer works in e.g. "Administrative office"

customerOwner
string or null

User in touch with the customer e.g. "josh_jameson"

description
string or null

A note about the customer e.g. "Great customer"

totalSpent
integer or null

Total spent by customer in cents e.g. 76000

acceptsMarketing
boolean or null

Whether the customer has consented to receiving promotional emails

username
string or null

Username of the customer e.g. "jane_doe123"

taxType
string or null

Tax type applied for the customer e.g. "Global"

bankAccountName
string or null

Bank account name for the customer e.g. "Business Bank Account"

bankAccountNumber
string or null

Bank account number for the customer e.g. "123654"

termId
string or null

Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"

termDays
integer or null

The days value of the payment terms for this Customer e.g. "15"

termType
string or null

The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "50",
  • "email": "janedoe@email.com",
  • "name": "Jane Doe",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Acme Corp.",
  • "fullyQualifiedName": "Acme Corporation",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "postalCode": "99660",
  • "country": "United States",
  • "billingAddress": "4348 Candlelight Drive",
  • "billingAddressLine2": "Apartment 78",
  • "billingCity": "Panama City",
  • "billingState": "Florida",
  • "billingPostalCode": "32417",
  • "billingCountry": "United States",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "ddi": "5050",
  • "balance": 19999,
  • "currency": "USD",
  • "taxable": true,
  • "customerAccountStatus": "Enabled",
  • "monthlyRecurringRevenue": 4500000,
  • "netMonthlyRecurringRevenue": 2500000,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "title": "Manager",
  • "department": "Administrative office",
  • "customerOwner": "josh_jameson",
  • "description": "Great customer",
  • "totalSpent": 76000,
  • "acceptsMarketing": true,
  • "username": "jane_doe123",
  • "taxType": "Global",
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Response samples

Content type
{
  • "id": "stripe-5050",
  • "integration": "quickbooks",
  • "srcId": "50",
  • "email": "janedoe@email.com",
  • "name": "Jane Doe",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Acme Corp.",
  • "fullyQualifiedName": "Acme Corporation",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "postalCode": "99660",
  • "country": "United States",
  • "billingAddress": "4348 Candlelight Drive",
  • "billingAddressLine2": "Apartment 78",
  • "billingCity": "Panama City",
  • "billingState": "Florida",
  • "billingPostalCode": "32417",
  • "billingCountry": "United States",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "ddi": "5050",
  • "balance": 19999,
  • "currency": "USD",
  • "taxable": true,
  • "customerAccountStatus": "Enabled",
  • "monthlyRecurringRevenue": 4500000,
  • "netMonthlyRecurringRevenue": 2500000,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "title": "Manager",
  • "department": "Administrative office",
  • "customerOwner": "josh_jameson",
  • "description": "Great customer",
  • "totalSpent": 76000,
  • "acceptsMarketing": true,
  • "username": "jane_doe123",
  • "taxType": "Global",
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Retrieves a Customer resource.

Retrieves a Customer resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/customers/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "stripe-5050",
  • "integration": "quickbooks",
  • "srcId": "50",
  • "email": "janedoe@email.com",
  • "name": "Jane Doe",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Acme Corp.",
  • "fullyQualifiedName": "Acme Corporation",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "postalCode": "99660",
  • "country": "United States",
  • "billingAddress": "4348 Candlelight Drive",
  • "billingAddressLine2": "Apartment 78",
  • "billingCity": "Panama City",
  • "billingState": "Florida",
  • "billingPostalCode": "32417",
  • "billingCountry": "United States",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "ddi": "5050",
  • "balance": 19999,
  • "currency": "USD",
  • "taxable": true,
  • "customerAccountStatus": "Enabled",
  • "monthlyRecurringRevenue": 4500000,
  • "netMonthlyRecurringRevenue": 2500000,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "title": "Manager",
  • "department": "Administrative office",
  • "customerOwner": "josh_jameson",
  • "description": "Great customer",
  • "totalSpent": 76000,
  • "acceptsMarketing": true,
  • "username": "jane_doe123",
  • "taxType": "Global",
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Replaces the Customer resource.

Replaces the Customer resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Customer resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "50"

email
string or null

Email address for the customer e.g. "janedoe@email.com"

name
string or null

Full name of the customer e.g. "Jane Doe"

givenName
string or null

First name of the customer e.g. "Jane"

familyName
string or null

Last name of the customer e.g. "Doe"

companyName
string or null

Name of the company the customer is working on e.g. "Acme Corp."

fullyQualifiedName
string or null

Fully qualified name of the company the customer is working on e.g. "Acme Corporation"

address
string or null

First line of customer address e.g. "708 Woodland Avenue"

addressLine2
string or null

Second line of customer address e.g. "Unit 105"

city
string or null

City of the address e.g. "St Paul"

postalCode
string or null

Postal code of the address * e.g. "99660"

country
string or null

Country of the address * e.g. "United States"

billingAddress
string or null

Billing address line 1 e.g. "4348 Candlelight Drive"

billingAddressLine2
string or null

Billing address line 2 e.g. "Apartment 78"

billingCity
string or null

Billing address city e.g. "Panama City"

billingState
string or null

Billing address state or province e.g. "Florida"

billingPostalCode
string or null

Billing address postal code e.g. "32417"

billingCountry
string or null

Billing address country e.g. "United States"

phone
string or null

Phone number e.g. "281-381-4241"

mobile
string or null

Mobile number e.g. "786-258-0182"

fax
string or null

Fax number e.g. "281-381-4255"

ddi
string or null

Direct dial number e.g. "5050"

balance
integer or null

Balance owed by customer in cents e.g. 19999

currency
string or null

Currency used by customer e.g. "USD"

taxable
boolean or null

Taxable status

customerAccountStatus
string or null

Accounting status of the customer e.g. "Enabled"

monthlyRecurringRevenue
integer or null

Monthly recurring revenue in cents e.g. 4500000

netMonthlyRecurringRevenue
integer or null

Net monthly recurring revenue e.g. 2500000

created
string or null <date-time>

Date of customer account creation e.g. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"

title
string or null

Job title of the customer e.g. "Manager"

department
string or null

Department where customer works in e.g. "Administrative office"

customerOwner
string or null

User in touch with the customer e.g. "josh_jameson"

description
string or null

A note about the customer e.g. "Great customer"

totalSpent
integer or null

Total spent by customer in cents e.g. 76000

acceptsMarketing
boolean or null

Whether the customer has consented to receiving promotional emails

username
string or null

Username of the customer e.g. "jane_doe123"

taxType
string or null

Tax type applied for the customer e.g. "Global"

bankAccountName
string or null

Bank account name for the customer e.g. "Business Bank Account"

bankAccountNumber
string or null

Bank account number for the customer e.g. "123654"

termId
string or null

Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"

termDays
integer or null

The days value of the payment terms for this Customer e.g. "15"

termType
string or null

The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "50",
  • "email": "janedoe@email.com",
  • "name": "Jane Doe",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Acme Corp.",
  • "fullyQualifiedName": "Acme Corporation",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "postalCode": "99660",
  • "country": "United States",
  • "billingAddress": "4348 Candlelight Drive",
  • "billingAddressLine2": "Apartment 78",
  • "billingCity": "Panama City",
  • "billingState": "Florida",
  • "billingPostalCode": "32417",
  • "billingCountry": "United States",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "ddi": "5050",
  • "balance": 19999,
  • "currency": "USD",
  • "taxable": true,
  • "customerAccountStatus": "Enabled",
  • "monthlyRecurringRevenue": 4500000,
  • "netMonthlyRecurringRevenue": 2500000,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "title": "Manager",
  • "department": "Administrative office",
  • "customerOwner": "josh_jameson",
  • "description": "Great customer",
  • "totalSpent": 76000,
  • "acceptsMarketing": true,
  • "username": "jane_doe123",
  • "taxType": "Global",
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Response samples

Content type
{
  • "id": "stripe-5050",
  • "integration": "quickbooks",
  • "srcId": "50",
  • "email": "janedoe@email.com",
  • "name": "Jane Doe",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Acme Corp.",
  • "fullyQualifiedName": "Acme Corporation",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "postalCode": "99660",
  • "country": "United States",
  • "billingAddress": "4348 Candlelight Drive",
  • "billingAddressLine2": "Apartment 78",
  • "billingCity": "Panama City",
  • "billingState": "Florida",
  • "billingPostalCode": "32417",
  • "billingCountry": "United States",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "ddi": "5050",
  • "balance": 19999,
  • "currency": "USD",
  • "taxable": true,
  • "customerAccountStatus": "Enabled",
  • "monthlyRecurringRevenue": 4500000,
  • "netMonthlyRecurringRevenue": 2500000,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "title": "Manager",
  • "department": "Administrative office",
  • "customerOwner": "josh_jameson",
  • "description": "Great customer",
  • "totalSpent": 76000,
  • "acceptsMarketing": true,
  • "username": "jane_doe123",
  • "taxType": "Global",
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Removes the Customer resource.

Removes the Customer resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/customers/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

DataSync

Syncs the latest data from a connected application and returns a success or failure message.

Retrieves a DataSync resource.

Authorizations:
BasicAuth
query Parameters
key
required
string
Example: key=quickbooks

The key of the application you would like to sync.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "message": "xero synced successfully"
}

Deal

Retrieves the collection of Deal resources.

Retrieves the collection of Deal resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Deal resource.

Creates a Deal resource.

Authorizations:
BasicAuth
Request Body schema:

The new Deal resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string
ownerId
string or null

User Id of deal responible

ownerName
string or null

User name of deal responsible

stage
string or null

Deal's stage e.g: decision

dealName
string or null

name of the deal

description
string or null

Details about the deal

prospectId
string or null

Id of the prospect customer the deal is related to

prospectName
string or null

name of the customer the deal is related to

expectedRevenue
integer or null

expected revenue from the deal

currency
string or null

currency code of the deal e.g: USD

created
string or null

date and time the deal is first created

closed
string or null <date-time>

date and time the deal is closed

associatedContactIds
Array of strings or null

A list of contact IDs that are associated with the deal

associatedCompanyIds
Array of strings or null

A list of company IDs that are associated with the deal

numAssociatedContacts
integer or null

The number of associated contacts

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "ownerId": "string",
  • "ownerName": "Dave Simpson",
  • "stage": "decision",
  • "dealName": "string",
  • "description": "string",
  • "prospectId": "string",
  • "prospectName": "string",
  • "expectedRevenue": 0,
  • "currency": "USD",
  • "created": "2021-07-28 00:00:00",
  • "closed": "2021-07-28 00:00:00",
  • "associatedContactIds": [
    ],
  • "associatedCompanyIds": [
    ],
  • "numAssociatedContacts": 5
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "ownerId": "string",
  • "ownerName": "Dave Simpson",
  • "stage": "decision",
  • "dealName": "string",
  • "description": "string",
  • "prospectId": "string",
  • "prospectName": "string",
  • "expectedRevenue": 0,
  • "currency": "USD",
  • "created": "2021-07-28 00:00:00",
  • "closed": "2021-07-28 00:00:00",
  • "associatedContactIds": [
    ],
  • "associatedCompanyIds": [
    ],
  • "numAssociatedContacts": 5
}

Retrieves a Deal resource.

Retrieves a Deal resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/deals/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "ownerId": "string",
  • "ownerName": "Dave Simpson",
  • "stage": "decision",
  • "dealName": "string",
  • "description": "string",
  • "prospectId": "string",
  • "prospectName": "string",
  • "expectedRevenue": 0,
  • "currency": "USD",
  • "created": "2021-07-28 00:00:00",
  • "closed": "2021-07-28 00:00:00",
  • "associatedContactIds": [
    ],
  • "associatedCompanyIds": [
    ],
  • "numAssociatedContacts": 5
}

Replaces the Deal resource.

Replaces the Deal resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Deal resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string
ownerId
string or null

User Id of deal responible

ownerName
string or null

User name of deal responsible

stage
string or null

Deal's stage e.g: decision

dealName
string or null

name of the deal

description
string or null

Details about the deal

prospectId
string or null

Id of the prospect customer the deal is related to

prospectName
string or null

name of the customer the deal is related to

expectedRevenue
integer or null

expected revenue from the deal

currency
string or null

currency code of the deal e.g: USD

created
string or null

date and time the deal is first created

closed
string or null <date-time>

date and time the deal is closed

associatedContactIds
Array of strings or null

A list of contact IDs that are associated with the deal

associatedCompanyIds
Array of strings or null

A list of company IDs that are associated with the deal

numAssociatedContacts
integer or null

The number of associated contacts

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "ownerId": "string",
  • "ownerName": "Dave Simpson",
  • "stage": "decision",
  • "dealName": "string",
  • "description": "string",
  • "prospectId": "string",
  • "prospectName": "string",
  • "expectedRevenue": 0,
  • "currency": "USD",
  • "created": "2021-07-28 00:00:00",
  • "closed": "2021-07-28 00:00:00",
  • "associatedContactIds": [
    ],
  • "associatedCompanyIds": [
    ],
  • "numAssociatedContacts": 5
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "ownerId": "string",
  • "ownerName": "Dave Simpson",
  • "stage": "decision",
  • "dealName": "string",
  • "description": "string",
  • "prospectId": "string",
  • "prospectName": "string",
  • "expectedRevenue": 0,
  • "currency": "USD",
  • "created": "2021-07-28 00:00:00",
  • "closed": "2021-07-28 00:00:00",
  • "associatedContactIds": [
    ],
  • "associatedCompanyIds": [
    ],
  • "numAssociatedContacts": 5
}

Removes the Deal resource.

Removes the Deal resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/deals/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Department

Retrieves the collection of Department resources.

Retrieves the collection of Department resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Department resource.

Retrieves a Department resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/departments/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "string",
  • "directory": "string",
  • "subDepartment": true,
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Employee

Retrieves the collection of Employee resources.

Retrieves the collection of Employee resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Employee resource.

Creates a Employee resource.

Authorizations:
BasicAuth
Request Body schema:

The new Employee resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string
firstName
string or null

First name of employee

lastName
string or null

Last name of employee

fullName
string or null
active
boolean
primaryPhone
string or null
primaryAddr
string or null
primaryAddrCity
string or null
primaryAddrPostalcode
string or null
primaryAddrState
string or null
created
string or null <date-time>
modified
string or null <date-time>
link
string or null

Link to an external resource of the employee

email
string or null
mobilePhone
string or null
payRate
string or null
title
string or null
gender
string or null
birthDate
string or null <date-time>
hiredDate
string or null <date-time>
employeeNumber
string or null

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "firstName": "Steve",
  • "lastName": "James",
  • "fullName": "Steve James",
  • "active": true,
  • "primaryPhone": "4168769854",
  • "primaryAddr": "451 Lincoln street",
  • "primaryAddrCity": "Toronto",
  • "primaryAddrPostalcode": "L8H Y5F",
  • "primaryAddrState": "California",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "link": "steve.james.com",
  • "email": "steve.james@gmail.com",
  • "mobilePhone": "4167854398",
  • "payRate": "20",
  • "title": "Mr",
  • "gender": "Female",
  • "birthDate": "2021-06-24",
  • "hiredDate": "2021-06-24",
  • "employeeNumber": "Female"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "firstName": "Steve",
  • "lastName": "James",
  • "fullName": "Steve James",
  • "active": true,
  • "primaryPhone": "4168769854",
  • "primaryAddr": "451 Lincoln street",
  • "primaryAddrCity": "Toronto",
  • "primaryAddrPostalcode": "L8H Y5F",
  • "primaryAddrState": "California",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "link": "steve.james.com",
  • "email": "steve.james@gmail.com",
  • "mobilePhone": "4167854398",
  • "payRate": "20",
  • "title": "Mr",
  • "gender": "Female",
  • "birthDate": "2021-06-24",
  • "hiredDate": "2021-06-24",
  • "employeeNumber": "Female"
}

Retrieves a Employee resource.

Retrieves a Employee resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/employees/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "firstName": "Steve",
  • "lastName": "James",
  • "fullName": "Steve James",
  • "active": true,
  • "primaryPhone": "4168769854",
  • "primaryAddr": "451 Lincoln street",
  • "primaryAddrCity": "Toronto",
  • "primaryAddrPostalcode": "L8H Y5F",
  • "primaryAddrState": "California",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "link": "steve.james.com",
  • "email": "steve.james@gmail.com",
  • "mobilePhone": "4167854398",
  • "payRate": "20",
  • "title": "Mr",
  • "gender": "Female",
  • "birthDate": "2021-06-24",
  • "hiredDate": "2021-06-24",
  • "employeeNumber": "Female"
}

Replaces the Employee resource.

Replaces the Employee resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Employee resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string
firstName
string or null

First name of employee

lastName
string or null

Last name of employee

fullName
string or null
active
boolean
primaryPhone
string or null
primaryAddr
string or null
primaryAddrCity
string or null
primaryAddrPostalcode
string or null
primaryAddrState
string or null
created
string or null <date-time>
modified
string or null <date-time>
link
string or null

Link to an external resource of the employee

email
string or null
mobilePhone
string or null
payRate
string or null
title
string or null
gender
string or null
birthDate
string or null <date-time>
hiredDate
string or null <date-time>
employeeNumber
string or null

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "firstName": "Steve",
  • "lastName": "James",
  • "fullName": "Steve James",
  • "active": true,
  • "primaryPhone": "4168769854",
  • "primaryAddr": "451 Lincoln street",
  • "primaryAddrCity": "Toronto",
  • "primaryAddrPostalcode": "L8H Y5F",
  • "primaryAddrState": "California",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "link": "steve.james.com",
  • "email": "steve.james@gmail.com",
  • "mobilePhone": "4167854398",
  • "payRate": "20",
  • "title": "Mr",
  • "gender": "Female",
  • "birthDate": "2021-06-24",
  • "hiredDate": "2021-06-24",
  • "employeeNumber": "Female"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "firstName": "Steve",
  • "lastName": "James",
  • "fullName": "Steve James",
  • "active": true,
  • "primaryPhone": "4168769854",
  • "primaryAddr": "451 Lincoln street",
  • "primaryAddrCity": "Toronto",
  • "primaryAddrPostalcode": "L8H Y5F",
  • "primaryAddrState": "California",
  • "created": "2021-06-24 22:35:07",
  • "modified": "2021-06-24 22:35:07",
  • "link": "steve.james.com",
  • "email": "steve.james@gmail.com",
  • "mobilePhone": "4167854398",
  • "payRate": "20",
  • "title": "Mr",
  • "gender": "Female",
  • "birthDate": "2021-06-24",
  • "hiredDate": "2021-06-24",
  • "employeeNumber": "Female"
}

Removes the Employee resource.

Removes the Employee resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/employees/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Engagement

Retrieves the collection of Engagement resources.

Retrieves the collection of Engagement resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Engagement resource.

Retrieves a Engagement resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/engagements/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "isActive": true,
  • "created": "string",
  • "modified": "string",
  • "type": "string",
  • "contactIds": [
    ],
  • "companyId": "string",
  • "dealIds": [
    ]
}

Estimate

Retrieves the collection of Estimate resources.

Retrieves the collection of Estimate resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Estimate resource.

Retrieves a Estimate resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/estimates/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "estimateNumber": "string",
  • "txnStatus": "string",
  • "billingEmail": "string",
  • "txnDate": "2019-08-24T14:15:22Z",
  • "totalAmount": 0,
  • "customerName": "string",
  • "customerId": "string",
  • "customerMemo": "string",
  • "shippingLine1": "string",
  • "shippingLine2": "string",
  • "shippingCity": "string",
  • "shippingCountry": "string",
  • "shippingPostalcode": "string",
  • "billingLine1": "string",
  • "billingLine2": "string",
  • "billingCity": "string",
  • "billingCountry": "string",
  • "billingPostalcode": "string",
  • "totalTax": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "referenceNumber": "string",
  • "currency": "string",
  • "discountAmount": 0,
  • "billingState": "string",
  • "shippingState": "string"
}

Event

Retrieves the collection of Event resources.

Retrieves the collection of Event resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Event resource.

Retrieves a Event resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/events/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "title": "string",
  • "host": "string",
  • "eventContact": "string",
  • "eventStartTime": "2019-08-24T14:15:22Z",
  • "eventEndTime": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "type": "string",
  • "url": "string"
}

ExecutiveSummary

Retrieves a ExecutiveSummary resource.

Retrieves a ExecutiveSummary resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "report_id": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ],
  • "end": "2019-08-24T14:15:22Z",
  • "reportId": "string"
}

Retrieves the collection of ExecutiveSummary resources.

Retrieves the collection of ExecutiveSummary resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Expense

Retrieves the collection of Expense resources.

Retrieves the collection of Expense resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Expense resource.

Creates a Expense resource.

Authorizations:
BasicAuth
Request Body schema:

The new Expense resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "982000000030049"

txnId
string

Transaction ID e.g. "9856"

type
string

Type of expense: e.g. "expense"

accountId
string

ID of account associated with expense e.g. "1057"

currency
string or null

Currency code e.g. "EUR"

subtotal
integer or null

Subtotal of expense in cents e.g. 9000

totalAmount
integer or null

Total of expense in cents e.g. 12000

referenceNumber
string or null

Reference number of the expense, max length of 100 e.g. "782364"

status
string or null

Status of expense e.g. "Unbilled"

invoiceId
string or null

ID of the invoice e.g. "460000000028192"

invoiceNumber
string or null

Invoice number e.g. "INV-00003"

modified
string or null <date-time>

Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z"

accountName
string or null

Expense account name e.g. "Rent"

created
string or null <date-time>

Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z"

accountCode
string or null

Chart of accounts identifier for the account e.g. "4560"

contactId
string or null

Id of the contact which is usually a payee e.g. "23"

contactName
string or null

Name of the contact which is usually a payee e.g. "Cool Cars"

contactType
string or null

Type of the contact which can be customer, vendor, or employee

paymentMethodId
string or null

Reference to the related Payment Method object

date
string or null <date-time>

Date of the expense e.g. "2019-05-22T02:17:40.080Z"

taxAmount
integer or null

Total tax amount in cents e.g. 3000

description
string or null

A note, memo, or description for the expense e.g. "GPS rent"

deleted
boolean

Indicates if the expense has been deleted

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "982000000030049",
  • "txnId": "9856",
  • "type": "expense",
  • "accountId": "1057",
  • "currency": "EUR",
  • "subtotal": 9000,
  • "totalAmount": 12000,
  • "referenceNumber": "782364",
  • "status": "Unbilled",
  • "invoiceId": "460000000028192",
  • "invoiceNumber": "INV-00003",
  • "modified": "2019-05-25T02:17:40.080Z",
  • "accountName": "Rent",
  • "created": "2019-05-22T02:17:40.080Z",
  • "accountCode": "4560",
  • "contactId": "23",
  • "contactName": "Cool Cars",
  • "contactType": "Vendor",
  • "paymentMethodId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "date": "2019-05-22T02:17:40.080Z",
  • "taxAmount": 3000,
  • "description": "GPS rent",
  • "deleted": true
}

Response samples

Content type
{
  • "id": "xero-70",
  • "integration": "quickbooks",
  • "srcId": "982000000030049",
  • "txnId": "9856",
  • "type": "expense",
  • "accountId": "1057",
  • "currency": "EUR",
  • "subtotal": 9000,
  • "totalAmount": 12000,
  • "referenceNumber": "782364",
  • "status": "Unbilled",
  • "invoiceId": "460000000028192",
  • "invoiceNumber": "INV-00003",
  • "modified": "2019-05-25T02:17:40.080Z",
  • "accountName": "Rent",
  • "created": "2019-05-22T02:17:40.080Z",
  • "accountCode": "4560",
  • "contactId": "23",
  • "contactName": "Cool Cars",
  • "contactType": "Vendor",
  • "paymentMethodId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "date": "2019-05-22T02:17:40.080Z",
  • "taxAmount": 3000,
  • "description": "GPS rent",
  • "deleted": true
}

Retrieves a Expense resource.

Retrieves a Expense resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/expenses/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "xero-70",
  • "integration": "quickbooks",
  • "srcId": "982000000030049",
  • "txnId": "9856",
  • "type": "expense",
  • "accountId": "1057",
  • "currency": "EUR",
  • "subtotal": 9000,
  • "totalAmount": 12000,
  • "referenceNumber": "782364",
  • "status": "Unbilled",
  • "invoiceId": "460000000028192",
  • "invoiceNumber": "INV-00003",
  • "modified": "2019-05-25T02:17:40.080Z",
  • "accountName": "Rent",
  • "created": "2019-05-22T02:17:40.080Z",
  • "accountCode": "4560",
  • "contactId": "23",
  • "contactName": "Cool Cars",
  • "contactType": "Vendor",
  • "paymentMethodId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "date": "2019-05-22T02:17:40.080Z",
  • "taxAmount": 3000,
  • "description": "GPS rent",
  • "deleted": true
}

Replaces the Expense resource.

Replaces the Expense resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Expense resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "982000000030049"

txnId
string

Transaction ID e.g. "9856"

type
string

Type of expense: e.g. "expense"

accountId
string

ID of account associated with expense e.g. "1057"

currency
string or null

Currency code e.g. "EUR"

subtotal
integer or null

Subtotal of expense in cents e.g. 9000

totalAmount
integer or null

Total of expense in cents e.g. 12000

referenceNumber
string or null

Reference number of the expense, max length of 100 e.g. "782364"

status
string or null

Status of expense e.g. "Unbilled"

invoiceId
string or null

ID of the invoice e.g. "460000000028192"

invoiceNumber
string or null

Invoice number e.g. "INV-00003"

modified
string or null <date-time>

Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z"

accountName
string or null

Expense account name e.g. "Rent"

created
string or null <date-time>

Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z"

accountCode
string or null

Chart of accounts identifier for the account e.g. "4560"

contactId
string or null

Id of the contact which is usually a payee e.g. "23"

contactName
string or null

Name of the contact which is usually a payee e.g. "Cool Cars"

contactType
string or null

Type of the contact which can be customer, vendor, or employee

paymentMethodId
string or null

Reference to the related Payment Method object

date
string or null <date-time>

Date of the expense e.g. "2019-05-22T02:17:40.080Z"

taxAmount
integer or null

Total tax amount in cents e.g. 3000

description
string or null

A note, memo, or description for the expense e.g. "GPS rent"

deleted
boolean

Indicates if the expense has been deleted

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "982000000030049",
  • "txnId": "9856",
  • "type": "expense",
  • "accountId": "1057",
  • "currency": "EUR",
  • "subtotal": 9000,
  • "totalAmount": 12000,
  • "referenceNumber": "782364",
  • "status": "Unbilled",
  • "invoiceId": "460000000028192",
  • "invoiceNumber": "INV-00003",
  • "modified": "2019-05-25T02:17:40.080Z",
  • "accountName": "Rent",
  • "created": "2019-05-22T02:17:40.080Z",
  • "accountCode": "4560",
  • "contactId": "23",
  • "contactName": "Cool Cars",
  • "contactType": "Vendor",
  • "paymentMethodId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "date": "2019-05-22T02:17:40.080Z",
  • "taxAmount": 3000,
  • "description": "GPS rent",
  • "deleted": true
}

Response samples

Content type
{
  • "id": "xero-70",
  • "integration": "quickbooks",
  • "srcId": "982000000030049",
  • "txnId": "9856",
  • "type": "expense",
  • "accountId": "1057",
  • "currency": "EUR",
  • "subtotal": 9000,
  • "totalAmount": 12000,
  • "referenceNumber": "782364",
  • "status": "Unbilled",
  • "invoiceId": "460000000028192",
  • "invoiceNumber": "INV-00003",
  • "modified": "2019-05-25T02:17:40.080Z",
  • "accountName": "Rent",
  • "created": "2019-05-22T02:17:40.080Z",
  • "accountCode": "4560",
  • "contactId": "23",
  • "contactName": "Cool Cars",
  • "contactType": "Vendor",
  • "paymentMethodId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "date": "2019-05-22T02:17:40.080Z",
  • "taxAmount": 3000,
  • "description": "GPS rent",
  • "deleted": true
}

Removes the Expense resource.

Removes the Expense resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/expenses/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

FinancialMapping

Retrieves the collection of FinancialMapping resources.

Retrieves the collection of FinancialMapping resources.

Authorizations:
BasicAuth

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/financial_mapping")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a FinancialMapping resource.

Retrieves a FinancialMapping resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": null,
  • "account_id": null,
  • "account_type": null,
  • "period_id": null,
  • "created": null,
  • "modified": null,
  • "verified": null,
  • "accountId": null,
  • "accountType": null,
  • "periodId": null
}

FinancialPeriod

Retrieves the collection of FinancialPeriod resources.

Retrieves the collection of FinancialPeriod resources.

Authorizations:
BasicAuth

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/financial_periods")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a FinancialPeriod resource.

Retrieves a FinancialPeriod resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/financial_periods/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": null,
  • "name": null,
  • "start": null,
  • "integration": null,
  • "year_end": null,
  • "deleted": null,
  • "created": null,
  • "modified": null,
  • "yearEnd": null
}

FormData

Retrieves JSON Form Data

The returned object will have keys based on the 'name' attributes of each form input.

Authorizations:
BasicAuth
path Parameters
formInput1
required
string

Resource identifier

query Parameters
key
string
Example: key=profile

The key of the Form that you would like to retrieve data for. Default is 'profile'.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "formInput1": "value",
  • "formInput2": "value",
  • "formInput3": "value",
  • "formInput4": "value"
}

Form

Retrieves the collection of Form resources.

Retrieves the collection of Form resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Form resource.

Retrieves a Form resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/forms/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "notifiedRecipients": [
    ],
  • "created": "string",
  • "updated": "string"
}

GrowthHistory

Retrieves the collection of GrowthHistory resources.

Retrieves the collection of GrowthHistory resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a GrowthHistory resource.

Retrieves a GrowthHistory resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/growth_histories/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "date": "string",
  • "existing": "string",
  • "imports": 0,
  • "totalItems": 0
}

IntegrationsList

Retrieves a list of integrations

Retrieves a IntegrationsList resource.

Authorizations:
BasicAuth
path Parameters
file
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/integrations")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "file": "This endpoint returns an connected integrations"
}

Inventory

Retrieves the collection of Inventory resources.

Retrieves the collection of Inventory resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Inventory resource.

Creates a Inventory resource.

Authorizations:
BasicAuth
Request Body schema:

The new Inventory resource

sku
string or null
modified
string or null <date-time>
integration
string

The key of the integration source e.g. "quickbooks", or "xero"

productName
string
totalQuantity
integer
fulfillableQuantity
any

Responses

Request samples

Content type
{
  • "sku": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "integration": "quickbooks",
  • "productName": "string",
  • "totalQuantity": 0,
  • "fulfillableQuantity": null
}

Response samples

Content type
{
  • "id": "string",
  • "product_name": "string",
  • "total_quantity": 0,
  • "sku": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "fulfillable_quantity": "string",
  • "integration": "quickbooks",
  • "productName": "string",
  • "totalQuantity": 0,
  • "fulfillableQuantity": null
}

Retrieves a Inventory resource.

Retrieves a Inventory resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/inventories/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "product_name": "string",
  • "total_quantity": 0,
  • "sku": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "fulfillable_quantity": "string",
  • "integration": "quickbooks",
  • "productName": "string",
  • "totalQuantity": 0,
  • "fulfillableQuantity": null
}

Replaces the Inventory resource.

Replaces the Inventory resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Inventory resource

sku
string or null
modified
string or null <date-time>
integration
string

The key of the integration source e.g. "quickbooks", or "xero"

productName
string
totalQuantity
integer
fulfillableQuantity
any

Responses

Request samples

Content type
{
  • "sku": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "integration": "quickbooks",
  • "productName": "string",
  • "totalQuantity": 0,
  • "fulfillableQuantity": null
}

Response samples

Content type
{
  • "id": "string",
  • "product_name": "string",
  • "total_quantity": 0,
  • "sku": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "fulfillable_quantity": "string",
  • "integration": "quickbooks",
  • "productName": "string",
  • "totalQuantity": 0,
  • "fulfillableQuantity": null
}

Removes the Inventory resource.

Removes the Inventory resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/inventories/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

InvoiceItem

Retrieves the collection of InvoiceItem resources.

Retrieves the collection of InvoiceItem resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

invoiceId
string
invoiceId[]
Array of strings

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a InvoiceItem resource.

Creates a InvoiceItem resource.

Authorizations:
BasicAuth
Request Body schema:

The new InvoiceItem resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier for the invoice line, from the source 3rd party integration

invoiceId
string

The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique

description
string or null

Description of the line item

quantity
number or null

Number of items for the line

unitPrice
integer or null

Unit price of the item in cents

itemId
string or null

Unique identifier for the item, from the source 3rd party integration

itemName
string or null

Name of the item

lineAmount
integer or null

Amount for the line item in cents

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "1",
  • "invoiceId": "quickbooks-34",
  • "description": "Bag of soil",
  • "quantity": 2.25,
  • "unitPrice": 18900,
  • "itemId": "1002",
  • "itemName": "Bag of soil",
  • "lineAmount": 42525
}

Response samples

Content type
{
  • "id": "quickbooks-34-1",
  • "integration": "quickbooks",
  • "srcId": "1",
  • "invoiceId": "quickbooks-34",
  • "description": "Bag of soil",
  • "quantity": 2.25,
  • "unitPrice": 18900,
  • "itemId": "1002",
  • "itemName": "Bag of soil",
  • "lineAmount": 42525
}

Retrieves a InvoiceItem resource.

Retrieves a InvoiceItem resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-34-1",
  • "integration": "quickbooks",
  • "srcId": "1",
  • "invoiceId": "quickbooks-34",
  • "description": "Bag of soil",
  • "quantity": 2.25,
  • "unitPrice": 18900,
  • "itemId": "1002",
  • "itemName": "Bag of soil",
  • "lineAmount": 42525
}

Replaces the InvoiceItem resource.

Replaces the InvoiceItem resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated InvoiceItem resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier for the invoice line, from the source 3rd party integration

invoiceId
string

The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique

description
string or null

Description of the line item

quantity
number or null

Number of items for the line

unitPrice
integer or null

Unit price of the item in cents

itemId
string or null

Unique identifier for the item, from the source 3rd party integration

itemName
string or null

Name of the item

lineAmount
integer or null

Amount for the line item in cents

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "1",
  • "invoiceId": "quickbooks-34",
  • "description": "Bag of soil",
  • "quantity": 2.25,
  • "unitPrice": 18900,
  • "itemId": "1002",
  • "itemName": "Bag of soil",
  • "lineAmount": 42525
}

Response samples

Content type
{
  • "id": "quickbooks-34-1",
  • "integration": "quickbooks",
  • "srcId": "1",
  • "invoiceId": "quickbooks-34",
  • "description": "Bag of soil",
  • "quantity": 2.25,
  • "unitPrice": 18900,
  • "itemId": "1002",
  • "itemName": "Bag of soil",
  • "lineAmount": 42525
}

Removes the InvoiceItem resource.

Removes the InvoiceItem resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Invoice

Retrieves the collection of Invoice resources.

Retrieves the collection of Invoice resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Invoice resource.

Retrieves a Invoice resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/invoices/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "quickbooks",
  • "additionalType": "",
  • "category": "Spare Parts Division",
  • "confirmationNumber": "2798-2929",
  • "customerId": "672",
  • "paymentMethod": "PayPal",
  • "paymentMethodId": "3009",
  • "paymentDueDate": "2020-10-22T19:30:17.697Z",
  • "provider": "Amazon",
  • "potentialAction": "",
  • "broker": "",
  • "minimumPaymentDue": 2000,
  • "accountId": "127362",
  • "scheduledPaymentDate": "2021-10-22T19:30:17.697Z",
  • "billingPeriod": "P0Y2M0DT12H30M5S",
  • "status": "PastDue",
  • "paymentStatus": "string",
  • "created": "2020-09-07T19:58:50.550Z",
  • "modified": "2020-10-09T14:52:50.550Z",
  • "subtotal": 8750,
  • "taxAmount": 1225,
  • "currencyCode": "USD",
  • "invoiceNumber": "BP-27719",
  • "amountPaid": 0,
  • "amountCredited": 9975,
  • "customerName": "Bobs Bait Shop",
  • "customerMemo": "It's a pleasure doing business with you. Remember, referrals are appreciated!",
  • "billingEmail": "ben@arima.com",
  • "billingAddressType": "HOME",
  • "billingAddressLine1": "4567 Finch St.",
  • "billingAddressLine2": "Apartment 203",
  • "billingCity": "Beverly Hills",
  • "billingPostalCode": "90210",
  • "shippingAddressType": "BUSINESS",
  • "shippingAddressLine1": "350 S Grand Ave",
  • "shippingAddressLine2": "Suite 102",
  • "shippingCity": "Los Angeles",
  • "shippingPostalCode": "90071",
  • "srcId": "129",
  • "url": "https://bobsburger.com",
  • "txnDate": "2020-09-07T19:58:50.550Z",
  • "jsonAddress": "{}",
  • "subscriptionId": "342",
  • "referenceNumber": "B1-7855",
  • "balance": "9975",
  • "accountName": "Bills Bait Shop",
  • "purchaseOrderNum": "342",
  • "billingCountry": "United States",
  • "totalAmount": 9975,
  • "billingState": "CA",
  • "shippingCountry": "United States",
  • "shippingState": "CA",
  • "amountDue": 6275
}

Item

Retrieves the collection of Item resources.

Retrieves the collection of Item resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Item resource.

Retrieves a Item resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/items/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "string",
  • "directory": "string",
  • "type": "string",
  • "quantity": "string",
  • "sku": "string",
  • "salesTaxIncluded": true,
  • "purchaseTaxIncluded": true,
  • "description": "string",
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "AvailableForSale": "string",
  • "AvailableForPurchase": "string",
  • "UnitpriceSale": 0,
  • "UnitpricePurchase": 0,
  • "TaxtypeSale": "string",
  • "TaxtypePurchase": "string",
  • "availableForSale": "string",
  • "availableForPurchase": "string",
  • "unitpriceSale": 0,
  • "unitpricePurchase": 0,
  • "taxtypeSale": "string",
  • "taxtypePurchase": "string"
}

JournalLine

Retrieves the collection of JournalLine resources.

Retrieves the collection of JournalLine resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

journalId
string
journalId[]
Array of strings

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a JournalLine resource.

Retrieves a JournalLine resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/journal_lines/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "journalDate": "2019-08-24T14:15:22Z",
  • "journalNumber": "string",
  • "accountId": "string",
  • "accountCode": "string",
  • "accountType": "string",
  • "accountName": "string",
  • "description": "string",
  • "totalAmount": 0,
  • "debitOrCredit": "string",
  • "currencyCode": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "journalId": "string"
}

Journal

Retrieves the collection of Journal resources.

Retrieves the collection of Journal resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Journal resource.

Retrieves a Journal resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/journals/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "journalDate": "2019-08-24T14:15:22Z",
  • "journalNumber": "string",
  • "journalLines": "string",
  • "currencyCode": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Lead

Retrieves the collection of Lead resources.

Retrieves the collection of Lead resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Lead resource.

Creates a Lead resource.

Authorizations:
BasicAuth
Request Body schema:

The new Lead resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string
email
string or null

lead email address

firstName
string or null

lead first name

lastName
string or null

lead last anme

primaryPhone
string or null

lead phone number

addressLine1
string or null

line1 address of the lead

city
string or null

city address of the lead

country
string or null

country address of the lead

company
string or null

company where lead is working on

postalCode
string or null

postal code of the lead

website
string or null

website of the lead

industry
string or null

the industry lead belongs to

skypeUsername
string or null

skype username of the lead

twitter
string or null

twitter account of the lead

annualRevenue
string or null

annual revenue of the company lead is working

employeeCount
integer or null

number of employees in the company lead works in

created
string or null <date-time>

date and time lead's information is first created

modified
string or null <date-time>

date and time lead's information is last updated

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "email": "ron.aurthor@gmail.com",
  • "firstName": "Ronald",
  • "lastName": "Aurthor",
  • "primaryPhone": "416-555-0126",
  • "addressLine1": "39 Parliment road",
  • "city": "Detroit",
  • "country": "United States",
  • "company": "Ronalds Hot Rods",
  • "postalCode": "48653",
  • "website": "https://www.ronshotrods.com",
  • "industry": "Automotive",
  • "skypeUsername": "ronaldAurthor0127",
  • "twitter": "@ronaldAutomotive",
  • "annualRevenue": "50000000",
  • "employeeCount": 113,
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "email": "ron.aurthor@gmail.com",
  • "firstName": "Ronald",
  • "lastName": "Aurthor",
  • "primaryPhone": "416-555-0126",
  • "addressLine1": "39 Parliment road",
  • "city": "Detroit",
  • "country": "United States",
  • "company": "Ronalds Hot Rods",
  • "postalCode": "48653",
  • "website": "https://www.ronshotrods.com",
  • "industry": "Automotive",
  • "skypeUsername": "ronaldAurthor0127",
  • "twitter": "@ronaldAutomotive",
  • "annualRevenue": "50000000",
  • "employeeCount": 113,
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Retrieves a Lead resource.

Retrieves a Lead resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/leads/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "email": "ron.aurthor@gmail.com",
  • "firstName": "Ronald",
  • "lastName": "Aurthor",
  • "primaryPhone": "416-555-0126",
  • "addressLine1": "39 Parliment road",
  • "city": "Detroit",
  • "country": "United States",
  • "company": "Ronalds Hot Rods",
  • "postalCode": "48653",
  • "website": "https://www.ronshotrods.com",
  • "industry": "Automotive",
  • "skypeUsername": "ronaldAurthor0127",
  • "twitter": "@ronaldAutomotive",
  • "annualRevenue": "50000000",
  • "employeeCount": 113,
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Replaces the Lead resource.

Replaces the Lead resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Lead resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string
email
string or null

lead email address

firstName
string or null

lead first name

lastName
string or null

lead last anme

primaryPhone
string or null

lead phone number

addressLine1
string or null

line1 address of the lead

city
string or null

city address of the lead

country
string or null

country address of the lead

company
string or null

company where lead is working on

postalCode
string or null

postal code of the lead

website
string or null

website of the lead

industry
string or null

the industry lead belongs to

skypeUsername
string or null

skype username of the lead

twitter
string or null

twitter account of the lead

annualRevenue
string or null

annual revenue of the company lead is working

employeeCount
integer or null

number of employees in the company lead works in

created
string or null <date-time>

date and time lead's information is first created

modified
string or null <date-time>

date and time lead's information is last updated

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "email": "ron.aurthor@gmail.com",
  • "firstName": "Ronald",
  • "lastName": "Aurthor",
  • "primaryPhone": "416-555-0126",
  • "addressLine1": "39 Parliment road",
  • "city": "Detroit",
  • "country": "United States",
  • "company": "Ronalds Hot Rods",
  • "postalCode": "48653",
  • "website": "https://www.ronshotrods.com",
  • "industry": "Automotive",
  • "skypeUsername": "ronaldAurthor0127",
  • "twitter": "@ronaldAutomotive",
  • "annualRevenue": "50000000",
  • "employeeCount": 113,
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "email": "ron.aurthor@gmail.com",
  • "firstName": "Ronald",
  • "lastName": "Aurthor",
  • "primaryPhone": "416-555-0126",
  • "addressLine1": "39 Parliment road",
  • "city": "Detroit",
  • "country": "United States",
  • "company": "Ronalds Hot Rods",
  • "postalCode": "48653",
  • "website": "https://www.ronshotrods.com",
  • "industry": "Automotive",
  • "skypeUsername": "ronaldAurthor0127",
  • "twitter": "@ronaldAutomotive",
  • "annualRevenue": "50000000",
  • "employeeCount": 113,
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Removes the Lead resource.

Removes the Lead resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/leads/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

LedgerAccountOpeningBalance

Retrieves the collection of LedgerAccountOpeningBalance resources.

Retrieves the collection of LedgerAccountOpeningBalance resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a LedgerAccountOpeningBalance resource.

Retrieves a LedgerAccountOpeningBalance resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "ledgerAccountId": "string",
  • "description": "string",
  • "debit": 0,
  • "credit": 0
}

LedgerAccountType

Retrieves the collection of LedgerAccountType resources.

Retrieves the collection of LedgerAccountType resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a LedgerAccountType resource.

Retrieves a LedgerAccountType resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "string"
}

LedgerAccounts

Retrieves the collection of LedgerAccounts resources.

Retrieves the collection of LedgerAccounts resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a LedgerAccounts resource.

Retrieves a LedgerAccounts resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "ledgerAccountGroup": "string",
  • "name": "string",
  • "balance": 0,
  • "credit_or_debit": "string",
  • "credits": 0,
  • "debits": 0,
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "creditOrDebit": "string"
}

LedgerEntry

Retrieves the collection of LedgerEntry resources.

Retrieves the collection of LedgerEntry resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a LedgerEntry resource.

Retrieves a LedgerEntry resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "date": "string",
  • "credit": 0,
  • "debit": 0,
  • "journalCode": "string",
  • "description": "string",
  • "ledgerAccount": "string"
}

LinkedTransaction

Retrieves the collection of LinkedTransaction resources.

Retrieves the collection of LinkedTransaction resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a LinkedTransaction resource.

Retrieves a LinkedTransaction resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "sourceTransactionId": "string",
  • "sourceLineItemId": "string",
  • "contactId": "string",
  • "targetTransactionId": "string",
  • "targetLineItemId": "string",
  • "status": "string",
  • "type": "string",
  • "modified": "string",
  • "sourceTransactionTypeCode": "string"
}

Location

Retrieves the collection of Location resources.

Retrieves the collection of Location resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Location resource.

Creates a Location resource.

Authorizations:
BasicAuth
Request Body schema:

The new Location resource

id
string

unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y"

integration
string

The key of the integration source e.g. "square""

srcId
string

The unique identifier of the source 3rd party integration

created
string or null <date-time>

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

businessName
string or null

Name of the business e.g. "Bowman and Co"

currency
string or null

Currency code e.g. "USD"

type
string or null

Type of the Sales term e.g. STANDARD

country
string or null

Country of the address * e.g. "United States"

city
string or null

City of the address e.g. "St Paul"

state
string or null

Vendor state address e.g. "Alaska"

postalCode
string or null

Postal code of the address * e.g. "99660"

address
string or null

First line of customer address e.g. "708 Woodland Avenue"

Responses

Request samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "square",
  • "srcId": "string",
  • "created": "2013-11-18T02:17:40.080Z",
  • "businessName": "Bowman and Co",
  • "currency": "USD",
  • "type": "string",
  • "country": "United States",
  • "city": "St Paul",
  • "state": "Alaska",
  • "postalCode": "99660",
  • "address": "708 Woodland Avenue"
}

Response samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "square",
  • "srcId": "string",
  • "created": "2013-11-18T02:17:40.080Z",
  • "businessName": "Bowman and Co",
  • "currency": "USD",
  • "type": "string",
  • "country": "United States",
  • "city": "St Paul",
  • "state": "Alaska",
  • "postalCode": "99660",
  • "address": "708 Woodland Avenue"
}

Retrieves a Location resource.

Retrieves a Location resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/locations/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "square",
  • "srcId": "string",
  • "created": "2013-11-18T02:17:40.080Z",
  • "businessName": "Bowman and Co",
  • "currency": "USD",
  • "type": "string",
  • "country": "United States",
  • "city": "St Paul",
  • "state": "Alaska",
  • "postalCode": "99660",
  • "address": "708 Woodland Avenue"
}

Replaces the Location resource.

Replaces the Location resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Location resource

id
string

unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y"

integration
string

The key of the integration source e.g. "square""

srcId
string

The unique identifier of the source 3rd party integration

created
string or null <date-time>

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

businessName
string or null

Name of the business e.g. "Bowman and Co"

currency
string or null

Currency code e.g. "USD"

type
string or null

Type of the Sales term e.g. STANDARD

country
string or null

Country of the address * e.g. "United States"

city
string or null

City of the address e.g. "St Paul"

state
string or null

Vendor state address e.g. "Alaska"

postalCode
string or null

Postal code of the address * e.g. "99660"

address
string or null

First line of customer address e.g. "708 Woodland Avenue"

Responses

Request samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "square",
  • "srcId": "string",
  • "created": "2013-11-18T02:17:40.080Z",
  • "businessName": "Bowman and Co",
  • "currency": "USD",
  • "type": "string",
  • "country": "United States",
  • "city": "St Paul",
  • "state": "Alaska",
  • "postalCode": "99660",
  • "address": "708 Woodland Avenue"
}

Response samples

Content type
{
  • "id": "quickbooks-34",
  • "integration": "square",
  • "srcId": "string",
  • "created": "2013-11-18T02:17:40.080Z",
  • "businessName": "Bowman and Co",
  • "currency": "USD",
  • "type": "string",
  • "country": "United States",
  • "city": "St Paul",
  • "state": "Alaska",
  • "postalCode": "99660",
  • "address": "708 Woodland Avenue"
}

Removes the Location resource.

Removes the Location resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/locations/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

ManualJournal

Retrieves the collection of ManualJournal resources.

Retrieves the collection of ManualJournal resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a ManualJournal resource.

Retrieves a ManualJournal resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/manual_journals/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "date": "string",
  • "lineAmountTypes": "string",
  • "modified": "string",
  • "narration": "string",
  • "journalLinesDescription": "string",
  • "journalLinesTaxType": "string",
  • "journalLinesTaxAmount": 0,
  • "journalLinesLineAmount": 0,
  • "journalLinesAccountCode": "string",
  • "showOnCashBasisReports": true,
  • "hasAttachments": true
}

Metrics

Retrieves a set of metrics

Retrieves a Metrics resource.

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "end": "2021-04-31",
  • "start": "2021-01-31",
  • "metrics": {
    },
  • "sources": [
    ],
  • "timestamp": "2022-03-16T00:39:31+00:00",
  • "isReconciled": false,
  • "lastReconciled": "2021-01-31"
}

OrderReturn

Retrieves the collection of OrderReturn resources.

Retrieves the collection of OrderReturn resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a OrderReturn resource.

Retrieves a OrderReturn resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/order_returns/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "amount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "description": "string",
  • "quantity": 0,
  • "orderId": "string",
  • "refundId": "string"
}

Order

Retrieves the collection of Order resources.

Retrieves the collection of Order resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Order resource.

Creates a Order resource.

Authorizations:
BasicAuth
Request Body schema:

The new Order resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcID
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

name
string or null

Order name e.g. "New order"

orderDate
string or null <date-time>

Date and time the order is created e.g. "2019-08-25T02:17:40.080Z"

orderStatus
string or null

Status of the order e.g. "activated"

description
string or null

Additional details about the order e.g. "Monthly bundle"

amount
string or null

Amount of the order e.g. "1200"

quantity
integer or null

The number of items included in the order e.g. 5

modified
string or null <date-time>

When the order was last modified e.g. "2019-08-25T02:17:40.080Z"

customerId
string or null

Id of the customer the order is by e.g. "C005"

firstName
string or null

First name of the customer e.g. "Jane"

lastName
string or null

Last name of the customer e.g. "Doe"

currency
string or null

The currency the order was made in e.g. "USD"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcID": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "name": "New order",
  • "orderDate": "2019-08-25T02:17:40.080Z",
  • "orderStatus": "activated",
  • "description": "Monthly bundle",
  • "amount": "1200",
  • "quantity": 5,
  • "modified": "2019-08-25T02:17:40.080Z",
  • "customerId": "C005",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "currency": "USD"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcID": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "name": "New order",
  • "orderDate": "2019-08-25T02:17:40.080Z",
  • "orderStatus": "activated",
  • "description": "Monthly bundle",
  • "amount": "1200",
  • "quantity": 5,
  • "modified": "2019-08-25T02:17:40.080Z",
  • "customerId": "C005",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "currency": "USD"
}

Retrieves a Order resource.

Retrieves a Order resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/orders/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcID": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "name": "New order",
  • "orderDate": "2019-08-25T02:17:40.080Z",
  • "orderStatus": "activated",
  • "description": "Monthly bundle",
  • "amount": "1200",
  • "quantity": 5,
  • "modified": "2019-08-25T02:17:40.080Z",
  • "customerId": "C005",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "currency": "USD"
}

Replaces the Order resource.

Replaces the Order resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Order resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcID
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

name
string or null

Order name e.g. "New order"

orderDate
string or null <date-time>

Date and time the order is created e.g. "2019-08-25T02:17:40.080Z"

orderStatus
string or null

Status of the order e.g. "activated"

description
string or null

Additional details about the order e.g. "Monthly bundle"

amount
string or null

Amount of the order e.g. "1200"

quantity
integer or null

The number of items included in the order e.g. 5

modified
string or null <date-time>

When the order was last modified e.g. "2019-08-25T02:17:40.080Z"

customerId
string or null

Id of the customer the order is by e.g. "C005"

firstName
string or null

First name of the customer e.g. "Jane"

lastName
string or null

Last name of the customer e.g. "Doe"

currency
string or null

The currency the order was made in e.g. "USD"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcID": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "name": "New order",
  • "orderDate": "2019-08-25T02:17:40.080Z",
  • "orderStatus": "activated",
  • "description": "Monthly bundle",
  • "amount": "1200",
  • "quantity": 5,
  • "modified": "2019-08-25T02:17:40.080Z",
  • "customerId": "C005",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "currency": "USD"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcID": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "name": "New order",
  • "orderDate": "2019-08-25T02:17:40.080Z",
  • "orderStatus": "activated",
  • "description": "Monthly bundle",
  • "amount": "1200",
  • "quantity": 5,
  • "modified": "2019-08-25T02:17:40.080Z",
  • "customerId": "C005",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "currency": "USD"
}

Removes the Order resource.

Removes the Order resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/orders/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Organization

Retrieves the collection of Organization resources.

Retrieves the collection of Organization resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Organization resource.

Retrieves a Organization resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/organizations/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "name": "Bobs Sandwiches",
  • "legalName": "Bobs Sandwiches",
  • "primaryPhone": "4165769834",
  • "email": "bobs.sandwiches@gmail.com",
  • "addressLine1": "23 berkly street",
  • "addressLine2": "45 portland road",
  • "city": "Toronto",
  • "country": "Canada",
  • "postalCode": "H7F5R3",
  • "startDate": "2021-06-25T20:39:32+00:00",
  • "created": "2021-06-25T20:39:32+00:00",
  • "modified": "2021-09-16T20:39:32+00:00",
  • "OrganisationType": "charity",
  • "employeeCount": 75,
  • "website": "bobssandwiches.com",
  • "annualRevenue": "45000000000",
  • "description": "Best burgers in the world",
  • "industry": "hospitality",
  • "locationCount": 4,
  • "industryCode": "441221",
  • "organisationType": "string"
}

OtherIncome

Retrieves the collection of OtherIncome resources.

Retrieves the collection of OtherIncome resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a OtherIncome resource.

Retrieves a OtherIncome resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/other_incomes/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "totalAmount": 0,
  • "currencyCode": "string",
  • "category": "string",
  • "dateReceived": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "paymentType": "string",
  • "source": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Owner

Retrieves the collection of Owner resources.

Retrieves the collection of Owner resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Owner resource.

Retrieves a Owner resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/owners/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "created": "string",
  • "updated": "string",
  • "isActive": true
}

PaymentIntent

Retrieves the collection of PaymentIntent resources.

Retrieves the collection of PaymentIntent resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a PaymentIntent resource.

Retrieves a PaymentIntent resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_intents/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "amount": 0,
  • "amountCapturable": 0,
  • "amountReceived": 0,
  • "clientSecret": "string",
  • "confirmationMethod": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "customerId": "string",
  • "description": "string",
  • "invoiceId": "string",
  • "paymentMethodId": "string",
  • "email": "string",
  • "shippingName": "string",
  • "shippingPhone": "string",
  • "shippingAddress": "string",
  • "status": "string"
}

PaymentMethod

Retrieves the collection of PaymentMethod resources.

Retrieves the collection of PaymentMethod resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a PaymentMethod resource.

Creates a PaymentMethod resource.

Authorizations:
BasicAuth
Request Body schema:

The new PaymentMethod resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration

name
string or null

Name for the payment method

type
string or null

Type of the payment method

created
string or null <date-time>

Date the payment method was created

modified
string or null <date-time>

Date the payment method was last modified

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "name": "Diners Club",
  • "type": "CREDIT_CARD",
  • "created": "2021-10-22 19:30:17",
  • "modified": "2021-10-22 19:30:17"
}

Response samples

Content type
{
  • "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "name": "Diners Club",
  • "type": "CREDIT_CARD",
  • "created": "2021-10-22 19:30:17",
  • "modified": "2021-10-22 19:30:17"
}

Retrieves a PaymentMethod resource.

Retrieves a PaymentMethod resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "name": "Diners Club",
  • "type": "CREDIT_CARD",
  • "created": "2021-10-22 19:30:17",
  • "modified": "2021-10-22 19:30:17"
}

Replaces the PaymentMethod resource.

Replaces the PaymentMethod resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated PaymentMethod resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration

name
string or null

Name for the payment method

type
string or null

Type of the payment method

created
string or null <date-time>

Date the payment method was created

modified
string or null <date-time>

Date the payment method was last modified

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "name": "Diners Club",
  • "type": "CREDIT_CARD",
  • "created": "2021-10-22 19:30:17",
  • "modified": "2021-10-22 19:30:17"
}

Response samples

Content type
{
  • "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "name": "Diners Club",
  • "type": "CREDIT_CARD",
  • "created": "2021-10-22 19:30:17",
  • "modified": "2021-10-22 19:30:17"
}

Removes the PaymentMethod resource.

Removes the PaymentMethod resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

PaymentService

Retrieves the collection of PaymentService resources.

Retrieves the collection of PaymentService resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a PaymentService resource.

Retrieves a PaymentService resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payment_services/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "url": "string",
  • "payNowText": "string",
  • "type": "string"
}

Payment

Retrieves the collection of Payment resources.

Retrieves the collection of Payment resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Payment resource.

Creates a Payment resource.

Authorizations:
BasicAuth
Request Body schema:

The new Payment resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration

paymentDate
string <date-time>

Date of the payment

totalAmount
string or null

Total amount listed in the payment in cents

status
string or null

Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED

modified
string or null <date-time>

Date entry was last modified

accountId
string or null

Account Id the payment was made from

customerId
string or null

Customer Id

customerName
string or null

Customer name

linkedTxnId
string or null

Transaction Id

linkedTxnType
string or null

Transaction type e.g. Deposit, Invoice

created
string or null <date-time>

Date entry was created

invoiceId
string or null

Invoice Id

currencyCode
string or null

Currency code

paymentType
string or null

Payment type e.g. CreditCard

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "paymentDate": "2020-10-22T19:30:17.697Z",
  • "totalAmount": "8750",
  • "status": "PAID",
  • "modified": "2020-10-09T14:52:50.550Z",
  • "accountId": "562555f2-8cde-4ce9-8203-0363922537a4",
  • "customerId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "customerName": "Gateway Motors",
  • "linkedTxnId": "361a4980-7f53-4b68-820c-f6487f613284",
  • "linkedTxnType": "Deposit",
  • "created": "2021-10-22T19:30:17.697Z",
  • "invoiceId": "129",
  • "currencyCode": "USD",
  • "paymentType": "PayPal"
}

Response samples

Content type
{
  • "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "paymentDate": "2020-10-22T19:30:17.697Z",
  • "totalAmount": "8750",
  • "status": "PAID",
  • "modified": "2020-10-09T14:52:50.550Z",
  • "accountId": "562555f2-8cde-4ce9-8203-0363922537a4",
  • "customerId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "customerName": "Gateway Motors",
  • "linkedTxnId": "361a4980-7f53-4b68-820c-f6487f613284",
  • "linkedTxnType": "Deposit",
  • "created": "2021-10-22T19:30:17.697Z",
  • "invoiceId": "129",
  • "currencyCode": "USD",
  • "paymentType": "PayPal"
}

Retrieves a Payment resource.

Retrieves a Payment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payments/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "paymentDate": "2020-10-22T19:30:17.697Z",
  • "totalAmount": "8750",
  • "status": "PAID",
  • "modified": "2020-10-09T14:52:50.550Z",
  • "accountId": "562555f2-8cde-4ce9-8203-0363922537a4",
  • "customerId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "customerName": "Gateway Motors",
  • "linkedTxnId": "361a4980-7f53-4b68-820c-f6487f613284",
  • "linkedTxnType": "Deposit",
  • "created": "2021-10-22T19:30:17.697Z",
  • "invoiceId": "129",
  • "currencyCode": "USD",
  • "paymentType": "PayPal"
}

Replaces the Payment resource.

Replaces the Payment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Payment resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration

paymentDate
string <date-time>

Date of the payment

totalAmount
string or null

Total amount listed in the payment in cents

status
string or null

Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED

modified
string or null <date-time>

Date entry was last modified

accountId
string or null

Account Id the payment was made from

customerId
string or null

Customer Id

customerName
string or null

Customer name

linkedTxnId
string or null

Transaction Id

linkedTxnType
string or null

Transaction type e.g. Deposit, Invoice

created
string or null <date-time>

Date entry was created

invoiceId
string or null

Invoice Id

currencyCode
string or null

Currency code

paymentType
string or null

Payment type e.g. CreditCard

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "paymentDate": "2020-10-22T19:30:17.697Z",
  • "totalAmount": "8750",
  • "status": "PAID",
  • "modified": "2020-10-09T14:52:50.550Z",
  • "accountId": "562555f2-8cde-4ce9-8203-0363922537a4",
  • "customerId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "customerName": "Gateway Motors",
  • "linkedTxnId": "361a4980-7f53-4b68-820c-f6487f613284",
  • "linkedTxnType": "Deposit",
  • "created": "2021-10-22T19:30:17.697Z",
  • "invoiceId": "129",
  • "currencyCode": "USD",
  • "paymentType": "PayPal"
}

Response samples

Content type
{
  • "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "paymentDate": "2020-10-22T19:30:17.697Z",
  • "totalAmount": "8750",
  • "status": "PAID",
  • "modified": "2020-10-09T14:52:50.550Z",
  • "accountId": "562555f2-8cde-4ce9-8203-0363922537a4",
  • "customerId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "customerName": "Gateway Motors",
  • "linkedTxnId": "361a4980-7f53-4b68-820c-f6487f613284",
  • "linkedTxnType": "Deposit",
  • "created": "2021-10-22T19:30:17.697Z",
  • "invoiceId": "129",
  • "currencyCode": "USD",
  • "paymentType": "PayPal"
}

Removes the Payment resource.

Removes the Payment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payments/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Payout

Retrieves the collection of Payout resources.

Retrieves the collection of Payout resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Payout resource.

Creates a Payout resource.

Authorizations:
BasicAuth
Request Body schema:

The new Payout resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

amount
integer

The amount to be transferred to a bank account or debit card in cents e.g. 74753

arrivalDate
string or null

The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z"

automatic
string or null

Whether the payout was created by an automated payout schedule or not e.g. "true"

balanceTransactionId
string or null

The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464"

created
string or null

The date and time this payout was created e.g. "2020-11-03"

currency
string or null

Currency the payout is made in e.g. "USD"

payoutDescription
string or null

A description of the payout e.g. "Payout description"

destinationId
string or null

The ID of the bank account or card the payout is sent to e.g. "44"

failureBalanceTransactionId
string or null

The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77"

failureCode
string or null

Error code explaining reason for payout failure.

failureMessage
string or null

Message to user further explaining reason for payout failure e.g. "payment failed"

method
string or null

Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard"

sourceType
string or null

The source balance this payout came from e.g. "card" e.g. "bank_account"

status
string or null

Current status of the payout e.g. "paid" e.g. "pending"

payoutType
string or null

Type of payout e.g. "bank_account" e.g. "card"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "amount": 74753,
  • "arrivalDate": "2020-11-03T02:17:40.080Z",
  • "automatic": "true",
  • "balanceTransactionId": "7464",
  • "created": "2020-11-03",
  • "currency": "USD",
  • "payoutDescription": "Payout description",
  • "destinationId": "44",
  • "failureBalanceTransactionId": "py_1L9D8G2eZgTElo2CaKQjce77",
  • "failureCode": "error 43",
  • "failureMessage": "payment failed",
  • "method": "Standard",
  • "sourceType": "card",
  • "status": "pending",
  • "payoutType": "card"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "amount": 74753,
  • "arrivalDate": "2020-11-03T02:17:40.080Z",
  • "automatic": "true",
  • "balanceTransactionId": "7464",
  • "created": "2020-11-03",
  • "currency": "USD",
  • "payoutDescription": "Payout description",
  • "destinationId": "44",
  • "failureBalanceTransactionId": "py_1L9D8G2eZgTElo2CaKQjce77",
  • "failureCode": "error 43",
  • "failureMessage": "payment failed",
  • "method": "Standard",
  • "sourceType": "card",
  • "status": "pending",
  • "payoutType": "card"
}

Retrieves a Payout resource.

Retrieves a Payout resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payouts/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "amount": 74753,
  • "arrivalDate": "2020-11-03T02:17:40.080Z",
  • "automatic": "true",
  • "balanceTransactionId": "7464",
  • "created": "2020-11-03",
  • "currency": "USD",
  • "payoutDescription": "Payout description",
  • "destinationId": "44",
  • "failureBalanceTransactionId": "py_1L9D8G2eZgTElo2CaKQjce77",
  • "failureCode": "error 43",
  • "failureMessage": "payment failed",
  • "method": "Standard",
  • "sourceType": "card",
  • "status": "pending",
  • "payoutType": "card"
}

Replaces the Payout resource.

Replaces the Payout resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Payout resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

amount
integer

The amount to be transferred to a bank account or debit card in cents e.g. 74753

arrivalDate
string or null

The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z"

automatic
string or null

Whether the payout was created by an automated payout schedule or not e.g. "true"

balanceTransactionId
string or null

The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464"

created
string or null

The date and time this payout was created e.g. "2020-11-03"

currency
string or null

Currency the payout is made in e.g. "USD"

payoutDescription
string or null

A description of the payout e.g. "Payout description"

destinationId
string or null

The ID of the bank account or card the payout is sent to e.g. "44"

failureBalanceTransactionId
string or null

The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77"

failureCode
string or null

Error code explaining reason for payout failure.

failureMessage
string or null

Message to user further explaining reason for payout failure e.g. "payment failed"

method
string or null

Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard"

sourceType
string or null

The source balance this payout came from e.g. "card" e.g. "bank_account"

status
string or null

Current status of the payout e.g. "paid" e.g. "pending"

payoutType
string or null

Type of payout e.g. "bank_account" e.g. "card"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "amount": 74753,
  • "arrivalDate": "2020-11-03T02:17:40.080Z",
  • "automatic": "true",
  • "balanceTransactionId": "7464",
  • "created": "2020-11-03",
  • "currency": "USD",
  • "payoutDescription": "Payout description",
  • "destinationId": "44",
  • "failureBalanceTransactionId": "py_1L9D8G2eZgTElo2CaKQjce77",
  • "failureCode": "error 43",
  • "failureMessage": "payment failed",
  • "method": "Standard",
  • "sourceType": "card",
  • "status": "pending",
  • "payoutType": "card"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "amount": 74753,
  • "arrivalDate": "2020-11-03T02:17:40.080Z",
  • "automatic": "true",
  • "balanceTransactionId": "7464",
  • "created": "2020-11-03",
  • "currency": "USD",
  • "payoutDescription": "Payout description",
  • "destinationId": "44",
  • "failureBalanceTransactionId": "py_1L9D8G2eZgTElo2CaKQjce77",
  • "failureCode": "error 43",
  • "failureMessage": "payment failed",
  • "method": "Standard",
  • "sourceType": "card",
  • "status": "pending",
  • "payoutType": "card"
}

Removes the Payout resource.

Removes the Payout resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payouts/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Payroll

Retrieves the collection of Payroll resources.

Retrieves the collection of Payroll resources.

Authorizations:
BasicAuth

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/payroll")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Plan

Retrieves the collection of Plan resources.

Retrieves the collection of Plan resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Plan resource.

Retrieves a Plan resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/plans/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  • "isActive": true,
  • "aggregateUsage": "sum",
  • "amount": 200,
  • "billingScheme": "per_unit",
  • "created": "2019-08-24T14:15:22Z",
  • "currency": "USD",
  • "description": "Monthly streaming subscription",
  • "productId": "2",
  • "tiersMode": "volume",
  • "transformUsage": 0,
  • "usageType": "metered",
  • "intervalCount": 0,
  • "trialPeriodDays": 0
}

Product

Retrieves the collection of Product resources.

Retrieves the collection of Product resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Product resource.

Creates a Product resource.

Authorizations:
BasicAuth
Request Body schema:

The new Product resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

additionalType
string or null

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

http://schema.org/additionalType
alternateName
string or null

an alias for the item

http://schema.org/alternateName
award
string or null

an award won by or for this item

http://schema.org/award
categories
Array of strings or null

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

http://schema.org/category
color
string or null

the color of the product

http://schema.org/color
description
string or null

a description of the item

http://schema.org/description
disambiguatingDescription
string or null

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

http://schema.org/disambiguatingDescription
gtin12
string or null

The [GTIN-12](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin12
gtin13s
Array of strings or null

The [GTIN-13](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin13
gtin14s
Array of strings or null

The [GTIN-14](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin14
gtin8s
Array of strings or null

The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin8
image
string or null

An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

http://schema.org/image
isAccessoryOrSparePartFors
Array of strings or null <iri-reference>

a pointer to another product (or multiple products) for which this product is an accessory or spare part

http://schema.org/isAccessoryOrSparePartFor
isConsumableFors
Array of strings or null <iri-reference>

a pointer to another product (or multiple products) for which this product is a consumable

http://schema.org/isConsumableFor
isRelatedTo
string or null <iri-reference>

a pointer to another, somehow related product (or multiple products)

http://schema.org/isRelatedTo
isSimilarTos
Array of strings or null <iri-reference>

a pointer to another, functionally similar product (or multiple products)

http://schema.org/isSimilarTo
itemCondition
string or null

a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer

http://schema.org/itemCondition
model
string or null

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

http://schema.org/model
mpns
Array of strings or null

the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers

http://schema.org/mpn
manufacturer
string or null

the manufacturer of the product

http://schema.org/manufacturer
name
string or null

the name of the item

http://schema.org/name
productID
string or null

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

http://schema.org/productID
releaseDate
string or null <date-time>

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

http://schema.org/releaseDate
sameA
string or null

URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

http://schema.org/sameAs
skus
Array of strings or null

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

http://schema.org/sku
url
string or null

URL of the item

http://schema.org/url
material
string or null

A material that something is made from, e.g. leather, wool, cotton, paper.

http://schema.org/material
productionDate
string or null <date-time>

The date of production of the item, e.g. vehicle.

http://schema.org/productionDate
purchaseDate
string or null <date-time>

The date the item e.g. vehicle was purchased by the current owner.

http://schema.org/purchaseDate
identifier
string or null

The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

http://schema.org/identifier
srcId
string

Unique identifier for a product

isActive
string or null

Whether the product is active or not

height
integer or null

The height of the product

width
integer or null

Width of the product

weight
integer or null

Weight of the product

quantity
integer or null

Quantity of product available

availableForPurchase
boolean or null

Whether the product is available for purchase or not

updated
string or null

The date and time the product was last modified

price
integer or null

The price of the product

weightUnit
string or null

The unit weight is measured in

heightUnit
string or null

The unit height is measured in

widthUnit
string or null

The unit width is measured in

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "additionalType": "string",
  • "alternateName": "string",
  • "award": "string",
  • "categories": [
    ],
  • "color": "string",
  • "description": "string",
  • "disambiguatingDescription": "string",
  • "gtin12": "string",
  • "gtin13s": [
    ],
  • "gtin14s": [
    ],
  • "gtin8s": [
    ],
  • "image": "string",
  • "isAccessoryOrSparePartFors": [
    ],
  • "isConsumableFors": [
    ],
  • "isRelatedTo": "../словник",
  • "isSimilarTos": [
    ],
  • "itemCondition": "string",
  • "model": "string",
  • "mpns": [
    ],
  • "manufacturer": "string",
  • "name": "string",
  • "productID": "string",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "sameA": "string",
  • "skus": [
    ],
  • "url": "string",
  • "material": "string",
  • "productionDate": "2019-08-24T14:15:22Z",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "identifier": "string",
  • "srcId": "string",
  • "isActive": "string",
  • "height": 0,
  • "width": 0,
  • "weight": 0,
  • "quantity": 0,
  • "availableForPurchase": true,
  • "updated": "string",
  • "price": 0,
  • "weightUnit": "string",
  • "heightUnit": "string",
  • "widthUnit": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "additionalType": "string",
  • "alternateName": "string",
  • "award": "string",
  • "categories": [
    ],
  • "color": "string",
  • "description": "string",
  • "disambiguatingDescription": "string",
  • "gtin12": "string",
  • "gtin13s": [
    ],
  • "gtin14s": [
    ],
  • "gtin8s": [
    ],
  • "image": "string",
  • "isAccessoryOrSparePartFors": [
    ],
  • "isConsumableFors": [
    ],
  • "isRelatedTo": "../словник",
  • "isSimilarTos": [
    ],
  • "itemCondition": "string",
  • "model": "string",
  • "mpns": [
    ],
  • "manufacturer": "string",
  • "name": "string",
  • "productID": "string",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "sameA": "string",
  • "skus": [
    ],
  • "url": "string",
  • "material": "string",
  • "productionDate": "2019-08-24T14:15:22Z",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "identifier": "string",
  • "srcId": "string",
  • "isActive": "string",
  • "height": 0,
  • "width": 0,
  • "weight": 0,
  • "quantity": 0,
  • "availableForPurchase": true,
  • "updated": "string",
  • "price": 0,
  • "weightUnit": "string",
  • "heightUnit": "string",
  • "widthUnit": "string"
}

Retrieves a Product resource.

Retrieves a Product resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/products/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "additionalType": "string",
  • "alternateName": "string",
  • "award": "string",
  • "categories": [
    ],
  • "color": "string",
  • "description": "string",
  • "disambiguatingDescription": "string",
  • "gtin12": "string",
  • "gtin13s": [
    ],
  • "gtin14s": [
    ],
  • "gtin8s": [
    ],
  • "image": "string",
  • "isAccessoryOrSparePartFors": [
    ],
  • "isConsumableFors": [
    ],
  • "isRelatedTo": "../словник",
  • "isSimilarTos": [
    ],
  • "itemCondition": "string",
  • "model": "string",
  • "mpns": [
    ],
  • "manufacturer": "string",
  • "name": "string",
  • "productID": "string",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "sameA": "string",
  • "skus": [
    ],
  • "url": "string",
  • "material": "string",
  • "productionDate": "2019-08-24T14:15:22Z",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "identifier": "string",
  • "srcId": "string",
  • "isActive": "string",
  • "height": 0,
  • "width": 0,
  • "weight": 0,
  • "quantity": 0,
  • "availableForPurchase": true,
  • "updated": "string",
  • "price": 0,
  • "weightUnit": "string",
  • "heightUnit": "string",
  • "widthUnit": "string"
}

Replaces the Product resource.

Replaces the Product resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Product resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

additionalType
string or null

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

http://schema.org/additionalType
alternateName
string or null

an alias for the item

http://schema.org/alternateName
award
string or null

an award won by or for this item

http://schema.org/award
categories
Array of strings or null

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

http://schema.org/category
color
string or null

the color of the product

http://schema.org/color
description
string or null

a description of the item

http://schema.org/description
disambiguatingDescription
string or null

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

http://schema.org/disambiguatingDescription
gtin12
string or null

The [GTIN-12](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin12
gtin13s
Array of strings or null

The [GTIN-13](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin13
gtin14s
Array of strings or null

The [GTIN-14](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin14
gtin8s
Array of strings or null

The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

http://schema.org/gtin8
image
string or null

An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

http://schema.org/image
isAccessoryOrSparePartFors
Array of strings or null <iri-reference>

a pointer to another product (or multiple products) for which this product is an accessory or spare part

http://schema.org/isAccessoryOrSparePartFor
isConsumableFors
Array of strings or null <iri-reference>

a pointer to another product (or multiple products) for which this product is a consumable

http://schema.org/isConsumableFor
isRelatedTo
string or null <iri-reference>

a pointer to another, somehow related product (or multiple products)

http://schema.org/isRelatedTo
isSimilarTos
Array of strings or null <iri-reference>

a pointer to another, functionally similar product (or multiple products)

http://schema.org/isSimilarTo
itemCondition
string or null

a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer

http://schema.org/itemCondition
model
string or null

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

http://schema.org/model
mpns
Array of strings or null

the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers

http://schema.org/mpn
manufacturer
string or null

the manufacturer of the product

http://schema.org/manufacturer
name
string or null

the name of the item

http://schema.org/name
productID
string or null

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

http://schema.org/productID
releaseDate
string or null <date-time>

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

http://schema.org/releaseDate
sameA
string or null

URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

http://schema.org/sameAs
skus
Array of strings or null

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

http://schema.org/sku
url
string or null

URL of the item

http://schema.org/url
material
string or null

A material that something is made from, e.g. leather, wool, cotton, paper.

http://schema.org/material
productionDate
string or null <date-time>

The date of production of the item, e.g. vehicle.

http://schema.org/productionDate
purchaseDate
string or null <date-time>

The date the item e.g. vehicle was purchased by the current owner.

http://schema.org/purchaseDate
identifier
string or null

The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

http://schema.org/identifier
srcId
string

Unique identifier for a product

isActive
string or null

Whether the product is active or not

height
integer or null

The height of the product

width
integer or null

Width of the product

weight
integer or null

Weight of the product

quantity
integer or null

Quantity of product available

availableForPurchase
boolean or null

Whether the product is available for purchase or not

updated
string or null

The date and time the product was last modified

price
integer or null

The price of the product

weightUnit
string or null

The unit weight is measured in

heightUnit
string or null

The unit height is measured in

widthUnit
string or null

The unit width is measured in

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "additionalType": "string",
  • "alternateName": "string",
  • "award": "string",
  • "categories": [
    ],
  • "color": "string",
  • "description": "string",
  • "disambiguatingDescription": "string",
  • "gtin12": "string",
  • "gtin13s": [
    ],
  • "gtin14s": [
    ],
  • "gtin8s": [
    ],
  • "image": "string",
  • "isAccessoryOrSparePartFors": [
    ],
  • "isConsumableFors": [
    ],
  • "isRelatedTo": "../словник",
  • "isSimilarTos": [
    ],
  • "itemCondition": "string",
  • "model": "string",
  • "mpns": [
    ],
  • "manufacturer": "string",
  • "name": "string",
  • "productID": "string",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "sameA": "string",
  • "skus": [
    ],
  • "url": "string",
  • "material": "string",
  • "productionDate": "2019-08-24T14:15:22Z",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "identifier": "string",
  • "srcId": "string",
  • "isActive": "string",
  • "height": 0,
  • "width": 0,
  • "weight": 0,
  • "quantity": 0,
  • "availableForPurchase": true,
  • "updated": "string",
  • "price": 0,
  • "weightUnit": "string",
  • "heightUnit": "string",
  • "widthUnit": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "additionalType": "string",
  • "alternateName": "string",
  • "award": "string",
  • "categories": [
    ],
  • "color": "string",
  • "description": "string",
  • "disambiguatingDescription": "string",
  • "gtin12": "string",
  • "gtin13s": [
    ],
  • "gtin14s": [
    ],
  • "gtin8s": [
    ],
  • "image": "string",
  • "isAccessoryOrSparePartFors": [
    ],
  • "isConsumableFors": [
    ],
  • "isRelatedTo": "../словник",
  • "isSimilarTos": [
    ],
  • "itemCondition": "string",
  • "model": "string",
  • "mpns": [
    ],
  • "manufacturer": "string",
  • "name": "string",
  • "productID": "string",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "sameA": "string",
  • "skus": [
    ],
  • "url": "string",
  • "material": "string",
  • "productionDate": "2019-08-24T14:15:22Z",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "identifier": "string",
  • "srcId": "string",
  • "isActive": "string",
  • "height": 0,
  • "width": 0,
  • "weight": 0,
  • "quantity": 0,
  • "availableForPurchase": true,
  • "updated": "string",
  • "price": 0,
  • "weightUnit": "string",
  • "heightUnit": "string",
  • "widthUnit": "string"
}

Removes the Product resource.

Removes the Product resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/products/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

ProfitAndLoss

Retrieves a ProfitAndLoss resource.

Retrieves a ProfitAndLoss resource.

Authorizations:
BasicAuth
query Parameters
start
required
string <date-time>
Example: start=2022-11-01

YYYY-MM-DD

end
required
string <date-time>
Example: end=2022-11-30

YYYY-MM-DD

accounting_method
required
string
Enum: "cash" "accrual"
Example: accounting_method=accrual

The Accounting Method

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "reportTitle": "Profit and Loss Statement",
  • "companyName": "Flux Capacitors Inc",
  • "columns": [
    ],
  • "rows": [
    ],
  • "accountingMethod": "cash",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "currencyCode": "USD",
  • "totalIncome": "786532",
  • "totalExpenses": "756282"
}

ProfitAndLossExcel

Retrieves an excel workbook of a series of profit and loss reports

Retrieves an excel workbook of a series of profit and loss reports

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "file": "This endpoint returns an .xlsx file."
}

ProfitAndLossReport

Retrieves a mapped profit and loss report

Retrieves a mapped profit and loss report

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-01-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-01-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "timestamp": "2021-08-25T15:40:22+00:00",
  • "profit_loss": "<b>INCOME</b><br>Sales: 148440.00<br><hr><b style=\"color:#00B4FF;\">Total Income: 148440.00</b><hr><br><b>EXPENSES</b><br>Advertising: 500.00<br>Repair and maintenance: 8000.00<br><hr><b style=\"color:#00B4FF;\">Total Expenses: 8500.00</b><hr><br><hr><b style=\"color:#00B4FF;\">PROFIT: 139940.00</b><hr><br>",
  • "yoy_sales_growth": 1,
  • "periods": [
    ],
  • "start": "2021-01-01",
  • "end": "2021-08-25",
  • "series": {
    },
  • "lastReconciled": "1980-01-01",
  • "lastReconciledLabel": "Dec 79",
  • "isReconciled": false,
  • "hasCompleteData": true
}

Project

Retrieves the collection of Project resources.

Retrieves the collection of Project resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Project resource.

Retrieves a Project resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/projects/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "projectName": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "currency": "string",
  • "status": "string",
  • "billingType": "string",
  • "rate": 0,
  • "totalHours": 0,
  • "billableHours": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

ProxyRequest

make a GET request to a specific API endpoint

Retrieves the collection of ProxyRequest resources.

Authorizations:
BasicAuth
query Parameters
key
required
string
Example: key=quickbooks

The key of the application you would like to request.

url
required
string
Example: url=https://sandbox-quickbooks.api.intuit.com/v3/company/16208146365078362930/query

The url of the application you would like to request.

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • { }
]

make a POST request to a specific API endpoint

Creates a ProxyRequest resource.

Authorizations:
BasicAuth
query Parameters
key
required
string
Example: key=quickbooks

The key of the application you would like to request.

url
required
string
Example: url=https://sandbox-quickbooks.api.intuit.com/v3/company/16208146365078362930/query

The url of the application endpoint you would like to request.

Request Body schema:

The new ProxyRequest resource

object

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

PublishingChannel

Retrieves the collection of PublishingChannel resources.

Retrieves the collection of PublishingChannel resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a PublishingChannel resource.

Retrieves a PublishingChannel resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "string",
  • "updated": "string",
  • "isActive": true,
  • "shared": true,
  • "type": "string",
  • "accountType": "string",
  • "name": "string",
  • "profileUrl": "string"
}

PurchaseCreditNote

Retrieves the collection of PurchaseCreditNote resources.

Retrieves the collection of PurchaseCreditNote resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a PurchaseCreditNote resource.

Retrieves a PurchaseCreditNote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "srcId": "string",
  • "name": "string",
  • "referenceNumber": "string",
  • "totalAmount": 0,
  • "balance": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "status": "string",
  • "notes": "string",
  • "customerId": "string",
  • "customerName": "string"
}

PurchaseOrder

Retrieves the collection of PurchaseOrder resources.

Retrieves the collection of PurchaseOrder resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a PurchaseOrder resource.

Retrieves a PurchaseOrder resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "vendorId": "string",
  • "vendorName": "string",
  • "currency": "string",
  • "totalAmount": 0,
  • "poStatus": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "referenceNumber": "string",
  • "deliveryDate": "string",
  • "subtotal": 0,
  • "txnStatus": "string"
}

Purchase

Retrieves the collection of Purchase resources.

Retrieves the collection of Purchase resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Purchase resource.

Retrieves a Purchase resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/purchases/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "stripe-5050",
  • "integration": "quickbooks",
  • "paymentType": "CreditCard",
  • "accountId": "1057",
  • "currency": "USD",
  • "txnDate": "2019-08-25",
  • "totalAmount": 450000,
  • "created": "2019-08-25T02:17:40.080Z",
  • "modified": "2019-08-26T02:17:40.080Z",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "customerId": "C056",
  • "name": "purchase name",
  • "status": "shipped",
  • "quantity": 10,
  • "amountPerUnit": "450",
  • "txnId": "4560",
  • "accountName": "Cool Cars",
  • "invoiceId": "9870028192",
  • "contactName": "Cool Cars",
  • "contactType": "Vendor",
  • "paymentMethodId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d"
}

Quote

Retrieves the collection of Quote resources.

Retrieves the collection of Quote resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Quote resource.

Creates a Quote resource.

Authorizations:
BasicAuth
Request Body schema:

The new Quote resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier for the item

created
string or null <date-time>

Datetime when the item was created

modified
string or null <date-time>

Datetime when the item was last updated

customerId
string or null

Unique identifier for contact

customerName
string or null

Contact name

quoteNumber
string or null

Generated quote number

txnDate
string or null

Date of the quote

billingCity
string or null

Main address city

billingPostalcode
string or null

Main address postalcode

billingCountry
string or null

Main address country

shippingCity
string or null

Delivery address city

shippingCountry
string or null

Delivery address country

totalAmount
integer or null

Total amount of the quote

currency
string or null

Currency of the quote

txnStatus
string or null

Status of quote

shippingPostalcode
string or null

Delivery address postalcode

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00",
  • "customerId": "0124",
  • "customerName": "John Doe",
  • "quoteNumber": "99",
  • "txnDate": "2021-07-28 00:00:00",
  • "billingCity": "Toronto",
  • "billingPostalcode": "H6F0R3",
  • "billingCountry": "Canada",
  • "shippingCity": "Vancouver",
  • "shippingCountry": "Canada",
  • "totalAmount": 5000000,
  • "currency": "CAD",
  • "txnStatus": "2021-09-15 00:00:00",
  • "shippingPostalcode": "V5N7G4"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00",
  • "customerId": "0124",
  • "customerName": "John Doe",
  • "quoteNumber": "99",
  • "txnDate": "2021-07-28 00:00:00",
  • "billingCity": "Toronto",
  • "billingPostalcode": "H6F0R3",
  • "billingCountry": "Canada",
  • "shippingCity": "Vancouver",
  • "shippingCountry": "Canada",
  • "totalAmount": 5000000,
  • "currency": "CAD",
  • "txnStatus": "2021-09-15 00:00:00",
  • "shippingPostalcode": "V5N7G4"
}

Retrieves a Quote resource.

Retrieves a Quote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/quotes/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00",
  • "customerId": "0124",
  • "customerName": "John Doe",
  • "quoteNumber": "99",
  • "txnDate": "2021-07-28 00:00:00",
  • "billingCity": "Toronto",
  • "billingPostalcode": "H6F0R3",
  • "billingCountry": "Canada",
  • "shippingCity": "Vancouver",
  • "shippingCountry": "Canada",
  • "totalAmount": 5000000,
  • "currency": "CAD",
  • "txnStatus": "2021-09-15 00:00:00",
  • "shippingPostalcode": "V5N7G4"
}

Replaces the Quote resource.

Replaces the Quote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Quote resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier for the item

created
string or null <date-time>

Datetime when the item was created

modified
string or null <date-time>

Datetime when the item was last updated

customerId
string or null

Unique identifier for contact

customerName
string or null

Contact name

quoteNumber
string or null

Generated quote number

txnDate
string or null

Date of the quote

billingCity
string or null

Main address city

billingPostalcode
string or null

Main address postalcode

billingCountry
string or null

Main address country

shippingCity
string or null

Delivery address city

shippingCountry
string or null

Delivery address country

totalAmount
integer or null

Total amount of the quote

currency
string or null

Currency of the quote

txnStatus
string or null

Status of quote

shippingPostalcode
string or null

Delivery address postalcode

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00",
  • "customerId": "0124",
  • "customerName": "John Doe",
  • "quoteNumber": "99",
  • "txnDate": "2021-07-28 00:00:00",
  • "billingCity": "Toronto",
  • "billingPostalcode": "H6F0R3",
  • "billingCountry": "Canada",
  • "shippingCity": "Vancouver",
  • "shippingCountry": "Canada",
  • "totalAmount": 5000000,
  • "currency": "CAD",
  • "txnStatus": "2021-09-15 00:00:00",
  • "shippingPostalcode": "V5N7G4"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "90300000072369",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00",
  • "customerId": "0124",
  • "customerName": "John Doe",
  • "quoteNumber": "99",
  • "txnDate": "2021-07-28 00:00:00",
  • "billingCity": "Toronto",
  • "billingPostalcode": "H6F0R3",
  • "billingCountry": "Canada",
  • "shippingCity": "Vancouver",
  • "shippingCountry": "Canada",
  • "totalAmount": 5000000,
  • "currency": "CAD",
  • "txnStatus": "2021-09-15 00:00:00",
  • "shippingPostalcode": "V5N7G4"
}

Removes the Quote resource.

Removes the Quote resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/quotes/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

RecurringCharge

Retrieves the collection of RecurringCharge resources.

Retrieves the collection of RecurringCharge resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a RecurringCharge resource.

Creates a RecurringCharge resource.

Authorizations:
BasicAuth
Request Body schema:

The new RecurringCharge resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

name
string or null

Name of the recurring charge

srcId
string or null

Unique identifier for each recurring charge

apiClientId
string or null

API key for the app the charge is associated with

price
integer or null

The price of the recurring application charge

status
string or null

The status of the recurring charge e.g. "Pending" e.g. "Accepted"

returnUrl
string or null

The URL where the merchant is redirected afteraccepting the charge

billingDate
string or null <date-time>

The date and time when the customer is billed

created
string or null <date-time>

The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z"

modified
string or null <date-time>

The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z"

activationDate
string or null <date-time>

The date and time when the customer activated the recurring charge

cancellationDate
string or null <date-time>

The date and time when the merchant cancelled their recurring charge

trialDays
integer or null

The number of days that the customer is eligible for a free trial

trialEndsOn
string or null <date-time>

The date and time when the free trial ends

decoratedReturnUrl
string or null

The display URL where the merchant is redirected after accepting a charge

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "name": "Monthly Rental",
  • "srcId": "982000000567240",
  • "apiClientId": "aa2e-87c43f2a32a9",
  • "price": 1200,
  • "status": "Pending",
  • "returnUrl": "www.example.com",
  • "billingDate": "2021-07-28",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-07-28 00:00:00",
  • "activationDate": "2021-06-28",
  • "cancellationDate": "2021-08-28",
  • "trialDays": 12,
  • "trialEndsOn": "2021-07-09",
  • "decoratedReturnUrl": "https://www.example.com"
}

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "Monthly Rental",
  • "srcId": "982000000567240",
  • "apiClientId": "aa2e-87c43f2a32a9",
  • "price": 1200,
  • "status": "Pending",
  • "returnUrl": "www.example.com",
  • "billingDate": "2021-07-28",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-07-28 00:00:00",
  • "activationDate": "2021-06-28",
  • "cancellationDate": "2021-08-28",
  • "trialDays": 12,
  • "trialEndsOn": "2021-07-09",
  • "decoratedReturnUrl": "https://www.example.com"
}

Retrieves a RecurringCharge resource.

Retrieves a RecurringCharge resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "Monthly Rental",
  • "srcId": "982000000567240",
  • "apiClientId": "aa2e-87c43f2a32a9",
  • "price": 1200,
  • "status": "Pending",
  • "returnUrl": "www.example.com",
  • "billingDate": "2021-07-28",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-07-28 00:00:00",
  • "activationDate": "2021-06-28",
  • "cancellationDate": "2021-08-28",
  • "trialDays": 12,
  • "trialEndsOn": "2021-07-09",
  • "decoratedReturnUrl": "https://www.example.com"
}

Replaces the RecurringCharge resource.

Replaces the RecurringCharge resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated RecurringCharge resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

name
string or null

Name of the recurring charge

srcId
string or null

Unique identifier for each recurring charge

apiClientId
string or null

API key for the app the charge is associated with

price
integer or null

The price of the recurring application charge

status
string or null

The status of the recurring charge e.g. "Pending" e.g. "Accepted"

returnUrl
string or null

The URL where the merchant is redirected afteraccepting the charge

billingDate
string or null <date-time>

The date and time when the customer is billed

created
string or null <date-time>

The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z"

modified
string or null <date-time>

The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z"

activationDate
string or null <date-time>

The date and time when the customer activated the recurring charge

cancellationDate
string or null <date-time>

The date and time when the merchant cancelled their recurring charge

trialDays
integer or null

The number of days that the customer is eligible for a free trial

trialEndsOn
string or null <date-time>

The date and time when the free trial ends

decoratedReturnUrl
string or null

The display URL where the merchant is redirected after accepting a charge

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "name": "Monthly Rental",
  • "srcId": "982000000567240",
  • "apiClientId": "aa2e-87c43f2a32a9",
  • "price": 1200,
  • "status": "Pending",
  • "returnUrl": "www.example.com",
  • "billingDate": "2021-07-28",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-07-28 00:00:00",
  • "activationDate": "2021-06-28",
  • "cancellationDate": "2021-08-28",
  • "trialDays": 12,
  • "trialEndsOn": "2021-07-09",
  • "decoratedReturnUrl": "https://www.example.com"
}

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "Monthly Rental",
  • "srcId": "982000000567240",
  • "apiClientId": "aa2e-87c43f2a32a9",
  • "price": 1200,
  • "status": "Pending",
  • "returnUrl": "www.example.com",
  • "billingDate": "2021-07-28",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-07-28 00:00:00",
  • "activationDate": "2021-06-28",
  • "cancellationDate": "2021-08-28",
  • "trialDays": 12,
  • "trialEndsOn": "2021-07-09",
  • "decoratedReturnUrl": "https://www.example.com"
}

Removes the RecurringCharge resource.

Removes the RecurringCharge resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

RecurringExpense

Retrieves the collection of RecurringExpense resources.

Retrieves the collection of RecurringExpense resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a RecurringExpense resource.

Creates a RecurringExpense resource.

Authorizations:
BasicAuth
Request Body schema:

The new RecurringExpense resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier of the source 3rd party integration eg. 982000000567240

recurrenceName
string or null

Name of the recurring-expense eg. "Monthly Rental"

startDate
string or null

Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z

endDate
string or null

End date of the recurring expense eg. 2016-11-19T00:00:00.000Z

lastCreatedDate
string or null

When expense was last generated eg. "2013-11-18T00:00:00.000Z"

recurrenceFrequency
string or null

The frequency of time interval at which the invoice is to be generated eg. "months"

repeatEvery
string or null

The period between every recurrency frequency eg. "2"

nextExpenseDate
string or null

Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z"

accountId
string or null

Unique identifier for the account associated with the recurring expense "982000000561057"

accountName
string or null

Expense account name eg. "Rent"

currency
string or null

Currency of the expense eg. "USD"

total
integer or null

Total amount in cents eg. "1000"

customerId
string or null

Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001"

status
string or null

Status of the recurring expense eg. "active"

created
string or null <date-time>

Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "982000000567240",
  • "recurrenceName": "Monthly Rental",
  • "startDate": "2020-11-19T00:00:00.000Z",
  • "endDate": "2024-11-19T00:00:00.000Z",
  • "lastCreatedDate": "2021-11-18T00:00:00.000Z",
  • "recurrenceFrequency": "months",
  • "repeatEvery": "2",
  • "nextExpenseDate": "2021-12-18T00:00:00.000Z",
  • "accountId": "982000000561057",
  • "accountName": "Rent",
  • "currency": "USD",
  • "total": 100,
  • "customerId": "982000000567001",
  • "status": "active",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Response samples

Content type
{
  • "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "integration": "quickbooks",
  • "srcId": "982000000567240",
  • "recurrenceName": "Monthly Rental",
  • "startDate": "2020-11-19T00:00:00.000Z",
  • "endDate": "2024-11-19T00:00:00.000Z",
  • "lastCreatedDate": "2021-11-18T00:00:00.000Z",
  • "recurrenceFrequency": "months",
  • "repeatEvery": "2",
  • "nextExpenseDate": "2021-12-18T00:00:00.000Z",
  • "accountId": "982000000561057",
  • "accountName": "Rent",
  • "currency": "USD",
  • "total": 100,
  • "customerId": "982000000567001",
  • "status": "active",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Retrieves a RecurringExpense resource.

Retrieves a RecurringExpense resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "integration": "quickbooks",
  • "srcId": "982000000567240",
  • "recurrenceName": "Monthly Rental",
  • "startDate": "2020-11-19T00:00:00.000Z",
  • "endDate": "2024-11-19T00:00:00.000Z",
  • "lastCreatedDate": "2021-11-18T00:00:00.000Z",
  • "recurrenceFrequency": "months",
  • "repeatEvery": "2",
  • "nextExpenseDate": "2021-12-18T00:00:00.000Z",
  • "accountId": "982000000561057",
  • "accountName": "Rent",
  • "currency": "USD",
  • "total": 100,
  • "customerId": "982000000567001",
  • "status": "active",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Replaces the RecurringExpense resource.

Replaces the RecurringExpense resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated RecurringExpense resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier of the source 3rd party integration eg. 982000000567240

recurrenceName
string or null

Name of the recurring-expense eg. "Monthly Rental"

startDate
string or null

Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z

endDate
string or null

End date of the recurring expense eg. 2016-11-19T00:00:00.000Z

lastCreatedDate
string or null

When expense was last generated eg. "2013-11-18T00:00:00.000Z"

recurrenceFrequency
string or null

The frequency of time interval at which the invoice is to be generated eg. "months"

repeatEvery
string or null

The period between every recurrency frequency eg. "2"

nextExpenseDate
string or null

Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z"

accountId
string or null

Unique identifier for the account associated with the recurring expense "982000000561057"

accountName
string or null

Expense account name eg. "Rent"

currency
string or null

Currency of the expense eg. "USD"

total
integer or null

Total amount in cents eg. "1000"

customerId
string or null

Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001"

status
string or null

Status of the recurring expense eg. "active"

created
string or null <date-time>

Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "982000000567240",
  • "recurrenceName": "Monthly Rental",
  • "startDate": "2020-11-19T00:00:00.000Z",
  • "endDate": "2024-11-19T00:00:00.000Z",
  • "lastCreatedDate": "2021-11-18T00:00:00.000Z",
  • "recurrenceFrequency": "months",
  • "repeatEvery": "2",
  • "nextExpenseDate": "2021-12-18T00:00:00.000Z",
  • "accountId": "982000000561057",
  • "accountName": "Rent",
  • "currency": "USD",
  • "total": 100,
  • "customerId": "982000000567001",
  • "status": "active",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Response samples

Content type
{
  • "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "integration": "quickbooks",
  • "srcId": "982000000567240",
  • "recurrenceName": "Monthly Rental",
  • "startDate": "2020-11-19T00:00:00.000Z",
  • "endDate": "2024-11-19T00:00:00.000Z",
  • "lastCreatedDate": "2021-11-18T00:00:00.000Z",
  • "recurrenceFrequency": "months",
  • "repeatEvery": "2",
  • "nextExpenseDate": "2021-12-18T00:00:00.000Z",
  • "accountId": "982000000561057",
  • "accountName": "Rent",
  • "currency": "USD",
  • "total": 100,
  • "customerId": "982000000567001",
  • "status": "active",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Removes the RecurringExpense resource.

Removes the RecurringExpense resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Refund

Retrieves the collection of Refund resources.

Retrieves the collection of Refund resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Refund resource.

Creates a Refund resource.

Authorizations:
BasicAuth
Request Body schema:

The new Refund resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

accountId
string
currency
string or null

Currency the refund was made in

paymentRef
string or null

Transaction number that appears on email receipts sent for this refund

txnDate
string or null

The date and time the refund was created

totalAmount
integer

Total amount refunded

balance
integer or null
customerId
string or null
created
string or null <date-time>

The date and time the refund was created

modified
string or null <date-time>
srcId
string

Unique identifier for each refund

reason
string or null

Reason for refund

status
string or null

Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "accountId": "35",
  • "currency": "USD",
  • "paymentRef": "USD",
  • "txnDate": "2021-06-24",
  • "totalAmount": 8750,
  • "balance": 0,
  • "customerId": "15",
  • "created": "2021-06-24T22:35:07+00:00",
  • "modified": "2021-06-24T22:35:07+00:00",
  • "srcId": "66",
  • "reason": "bad item",
  • "status": "succeeded"
}

Response samples

Content type
{
  • "id": "quickbooks-66",
  • "integration": "quickbooks",
  • "accountId": "35",
  • "currency": "USD",
  • "paymentRef": "USD",
  • "txnDate": "2021-06-24",
  • "totalAmount": 8750,
  • "balance": 0,
  • "customerId": "15",
  • "created": "2021-06-24T22:35:07+00:00",
  • "modified": "2021-06-24T22:35:07+00:00",
  • "srcId": "66",
  • "reason": "bad item",
  • "status": "succeeded"
}

Retrieves a Refund resource.

Retrieves a Refund resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/refunds/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-66",
  • "integration": "quickbooks",
  • "accountId": "35",
  • "currency": "USD",
  • "paymentRef": "USD",
  • "txnDate": "2021-06-24",
  • "totalAmount": 8750,
  • "balance": 0,
  • "customerId": "15",
  • "created": "2021-06-24T22:35:07+00:00",
  • "modified": "2021-06-24T22:35:07+00:00",
  • "srcId": "66",
  • "reason": "bad item",
  • "status": "succeeded"
}

Replaces the Refund resource.

Replaces the Refund resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Refund resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

accountId
string
currency
string or null

Currency the refund was made in

paymentRef
string or null

Transaction number that appears on email receipts sent for this refund

txnDate
string or null

The date and time the refund was created

totalAmount
integer

Total amount refunded

balance
integer or null
customerId
string or null
created
string or null <date-time>

The date and time the refund was created

modified
string or null <date-time>
srcId
string

Unique identifier for each refund

reason
string or null

Reason for refund

status
string or null

Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "accountId": "35",
  • "currency": "USD",
  • "paymentRef": "USD",
  • "txnDate": "2021-06-24",
  • "totalAmount": 8750,
  • "balance": 0,
  • "customerId": "15",
  • "created": "2021-06-24T22:35:07+00:00",
  • "modified": "2021-06-24T22:35:07+00:00",
  • "srcId": "66",
  • "reason": "bad item",
  • "status": "succeeded"
}

Response samples

Content type
{
  • "id": "quickbooks-66",
  • "integration": "quickbooks",
  • "accountId": "35",
  • "currency": "USD",
  • "paymentRef": "USD",
  • "txnDate": "2021-06-24",
  • "totalAmount": 8750,
  • "balance": 0,
  • "customerId": "15",
  • "created": "2021-06-24T22:35:07+00:00",
  • "modified": "2021-06-24T22:35:07+00:00",
  • "srcId": "66",
  • "reason": "bad item",
  • "status": "succeeded"
}

Removes the Refund resource.

Removes the Refund resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/refunds/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

RepeatingInvoice

Retrieves the collection of RepeatingInvoice resources.

Retrieves the collection of RepeatingInvoice resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a RepeatingInvoice resource.

Creates a RepeatingInvoice resource.

Authorizations:
BasicAuth
Request Body schema:

The new RepeatingInvoice resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier for each repeating invoice

period
integer or null

Number of times the invoice is charged per unit

unit
string or null

Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY

dueDate
string or null

Number of days defining when the invoice is scheduled to be charged

dueDateType
string or null

The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH"

startDate
string or null

date on which the recurring invoice starts

nextScheduledDate
string or null

date at which next invoice is to be sent

type
string or null

The type of invoice e.g. "ACCPAY" e.g. "ACCREC"

reference
string or null

Order number of recurring invoice

hasAttachments
boolean or null

Whether the invoice has attachments or not

contactId
string or null

Id of customer for whom recurring invoice is raised

contactName
string or null

Full name of contact

status
string or null

Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED"

lineAmountTypes
string or null

Whether the line amount includes, excludes or doesn't have tax.

lineItemDescription
string or null

A description of the line item

lineItemUnitAmount
integer or null

The unit amount of the line item

lineItemTaxType
string or null

The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT"

lineAmount
integer or null

The final amount for the line items

lineItemAccountCode
string or null

Account code for the line item

lineItemQuantity
integer or null

The quantity of the line items

lineItemId
string or null

Unique ID for the line item

subTotal
integer or null

Total of invoice excluding taxes

totalTax
integer or null

Total tax on invoice

total
integer

Total of invoice tax inclusive

currencyCode
string or null

currency of invoice

recurrenceName
string or null

Unique name for the recurring profile given by the user

endDate
string or null

date on which the recurring invoice expires

lastSentDate
string or null

date at which the last invoice was sent

paidInvoicesTotal
integer or null

total amount paid to date

unpaidInvoicesBalance
integer or null

total amount left to be paid

discount
integer or null
billingStreet
string or null
billingStreet2
string or null
billingCity
string or null
billingState
string or null
billingPostalCode
string or null
billingCountry
string or null
created
string or null <date-time>
modified
string or null <date-time>

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "period": 1,
  • "unit": "MONTHLY",
  • "dueDate": "0",
  • "dueDateType": "DAYSAFTERBILLDATE",
  • "startDate": "2021-02-27 00:00:00",
  • "nextScheduledDate": "2021-07-28 00:00:00",
  • "type": "ACCPAY",
  • "reference": "AP",
  • "hasAttachments": false,
  • "contactId": "3b30a108-9156-4a42-a893-3bbbe7af1ef8",
  • "contactName": "Xero",
  • "status": "AUTHORISED",
  • "lineAmountTypes": "Exclusive",
  • "lineItemDescription": "Monthly subscription",
  • "lineItemUnitAmount": 29,
  • "lineItemTaxType": "INPUT",
  • "lineAmount": 29,
  • "lineItemAccountCode": "412",
  • "lineItemQuantity": 1,
  • "lineItemId": "304e5b38-d62f-4c43-91d2-24786154c3c0",
  • "subTotal": 2900,
  • "totalTax": 239,
  • "total": 3139,
  • "currencyCode": "USD",
  • "recurrenceName": "412",
  • "endDate": "2022-07-28 00:00:00",
  • "lastSentDate": "2021-08-28 00:00:00",
  • "paidInvoicesTotal": 1000,
  • "unpaidInvoicesBalance": 2139,
  • "discount": 412,
  • "billingStreet": "123 lonecrest drive",
  • "billingStreet2": "412 fuller cres",
  • "billingCity": "Toronto",
  • "billingState": "Ontario",
  • "billingPostalCode": "H6F 3F6",
  • "billingCountry": "Canada",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Response samples

Content type
{
  • "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "integration": "quickbooks",
  • "srcId": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "period": 1,
  • "unit": "MONTHLY",
  • "dueDate": "0",
  • "dueDateType": "DAYSAFTERBILLDATE",
  • "startDate": "2021-02-27 00:00:00",
  • "nextScheduledDate": "2021-07-28 00:00:00",
  • "type": "ACCPAY",
  • "reference": "AP",
  • "hasAttachments": false,
  • "contactId": "3b30a108-9156-4a42-a893-3bbbe7af1ef8",
  • "contactName": "Xero",
  • "status": "AUTHORISED",
  • "lineAmountTypes": "Exclusive",
  • "lineItemDescription": "Monthly subscription",
  • "lineItemUnitAmount": 29,
  • "lineItemTaxType": "INPUT",
  • "lineAmount": 29,
  • "lineItemAccountCode": "412",
  • "lineItemQuantity": 1,
  • "lineItemId": "304e5b38-d62f-4c43-91d2-24786154c3c0",
  • "subTotal": 2900,
  • "totalTax": 239,
  • "total": 3139,
  • "currencyCode": "USD",
  • "recurrenceName": "412",
  • "endDate": "2022-07-28 00:00:00",
  • "lastSentDate": "2021-08-28 00:00:00",
  • "paidInvoicesTotal": 1000,
  • "unpaidInvoicesBalance": 2139,
  • "discount": 412,
  • "billingStreet": "123 lonecrest drive",
  • "billingStreet2": "412 fuller cres",
  • "billingCity": "Toronto",
  • "billingState": "Ontario",
  • "billingPostalCode": "H6F 3F6",
  • "billingCountry": "Canada",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Retrieves a RepeatingInvoice resource.

Retrieves a RepeatingInvoice resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "integration": "quickbooks",
  • "srcId": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "period": 1,
  • "unit": "MONTHLY",
  • "dueDate": "0",
  • "dueDateType": "DAYSAFTERBILLDATE",
  • "startDate": "2021-02-27 00:00:00",
  • "nextScheduledDate": "2021-07-28 00:00:00",
  • "type": "ACCPAY",
  • "reference": "AP",
  • "hasAttachments": false,
  • "contactId": "3b30a108-9156-4a42-a893-3bbbe7af1ef8",
  • "contactName": "Xero",
  • "status": "AUTHORISED",
  • "lineAmountTypes": "Exclusive",
  • "lineItemDescription": "Monthly subscription",
  • "lineItemUnitAmount": 29,
  • "lineItemTaxType": "INPUT",
  • "lineAmount": 29,
  • "lineItemAccountCode": "412",
  • "lineItemQuantity": 1,
  • "lineItemId": "304e5b38-d62f-4c43-91d2-24786154c3c0",
  • "subTotal": 2900,
  • "totalTax": 239,
  • "total": 3139,
  • "currencyCode": "USD",
  • "recurrenceName": "412",
  • "endDate": "2022-07-28 00:00:00",
  • "lastSentDate": "2021-08-28 00:00:00",
  • "paidInvoicesTotal": 1000,
  • "unpaidInvoicesBalance": 2139,
  • "discount": 412,
  • "billingStreet": "123 lonecrest drive",
  • "billingStreet2": "412 fuller cres",
  • "billingCity": "Toronto",
  • "billingState": "Ontario",
  • "billingPostalCode": "H6F 3F6",
  • "billingCountry": "Canada",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Replaces the RepeatingInvoice resource.

Replaces the RepeatingInvoice resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated RepeatingInvoice resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

Unique identifier for each repeating invoice

period
integer or null

Number of times the invoice is charged per unit

unit
string or null

Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY

dueDate
string or null

Number of days defining when the invoice is scheduled to be charged

dueDateType
string or null

The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH"

startDate
string or null

date on which the recurring invoice starts

nextScheduledDate
string or null

date at which next invoice is to be sent

type
string or null

The type of invoice e.g. "ACCPAY" e.g. "ACCREC"

reference
string or null

Order number of recurring invoice

hasAttachments
boolean or null

Whether the invoice has attachments or not

contactId
string or null

Id of customer for whom recurring invoice is raised

contactName
string or null

Full name of contact

status
string or null

Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED"

lineAmountTypes
string or null

Whether the line amount includes, excludes or doesn't have tax.

lineItemDescription
string or null

A description of the line item

lineItemUnitAmount
integer or null

The unit amount of the line item

lineItemTaxType
string or null

The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT"

lineAmount
integer or null

The final amount for the line items

lineItemAccountCode
string or null

Account code for the line item

lineItemQuantity
integer or null

The quantity of the line items

lineItemId
string or null

Unique ID for the line item

subTotal
integer or null

Total of invoice excluding taxes

totalTax
integer or null

Total tax on invoice

total
integer

Total of invoice tax inclusive

currencyCode
string or null

currency of invoice

recurrenceName
string or null

Unique name for the recurring profile given by the user

endDate
string or null

date on which the recurring invoice expires

lastSentDate
string or null

date at which the last invoice was sent

paidInvoicesTotal
integer or null

total amount paid to date

unpaidInvoicesBalance
integer or null

total amount left to be paid

discount
integer or null
billingStreet
string or null
billingStreet2
string or null
billingCity
string or null
billingState
string or null
billingPostalCode
string or null
billingCountry
string or null
created
string or null <date-time>
modified
string or null <date-time>

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "period": 1,
  • "unit": "MONTHLY",
  • "dueDate": "0",
  • "dueDateType": "DAYSAFTERBILLDATE",
  • "startDate": "2021-02-27 00:00:00",
  • "nextScheduledDate": "2021-07-28 00:00:00",
  • "type": "ACCPAY",
  • "reference": "AP",
  • "hasAttachments": false,
  • "contactId": "3b30a108-9156-4a42-a893-3bbbe7af1ef8",
  • "contactName": "Xero",
  • "status": "AUTHORISED",
  • "lineAmountTypes": "Exclusive",
  • "lineItemDescription": "Monthly subscription",
  • "lineItemUnitAmount": 29,
  • "lineItemTaxType": "INPUT",
  • "lineAmount": 29,
  • "lineItemAccountCode": "412",
  • "lineItemQuantity": 1,
  • "lineItemId": "304e5b38-d62f-4c43-91d2-24786154c3c0",
  • "subTotal": 2900,
  • "totalTax": 239,
  • "total": 3139,
  • "currencyCode": "USD",
  • "recurrenceName": "412",
  • "endDate": "2022-07-28 00:00:00",
  • "lastSentDate": "2021-08-28 00:00:00",
  • "paidInvoicesTotal": 1000,
  • "unpaidInvoicesBalance": 2139,
  • "discount": 412,
  • "billingStreet": "123 lonecrest drive",
  • "billingStreet2": "412 fuller cres",
  • "billingCity": "Toronto",
  • "billingState": "Ontario",
  • "billingPostalCode": "H6F 3F6",
  • "billingCountry": "Canada",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Response samples

Content type
{
  • "id": "xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "integration": "quickbooks",
  • "srcId": "01e01427-6b48-4d5f-aa2e-87c43f2a32a9",
  • "period": 1,
  • "unit": "MONTHLY",
  • "dueDate": "0",
  • "dueDateType": "DAYSAFTERBILLDATE",
  • "startDate": "2021-02-27 00:00:00",
  • "nextScheduledDate": "2021-07-28 00:00:00",
  • "type": "ACCPAY",
  • "reference": "AP",
  • "hasAttachments": false,
  • "contactId": "3b30a108-9156-4a42-a893-3bbbe7af1ef8",
  • "contactName": "Xero",
  • "status": "AUTHORISED",
  • "lineAmountTypes": "Exclusive",
  • "lineItemDescription": "Monthly subscription",
  • "lineItemUnitAmount": 29,
  • "lineItemTaxType": "INPUT",
  • "lineAmount": 29,
  • "lineItemAccountCode": "412",
  • "lineItemQuantity": 1,
  • "lineItemId": "304e5b38-d62f-4c43-91d2-24786154c3c0",
  • "subTotal": 2900,
  • "totalTax": 239,
  • "total": 3139,
  • "currencyCode": "USD",
  • "recurrenceName": "412",
  • "endDate": "2022-07-28 00:00:00",
  • "lastSentDate": "2021-08-28 00:00:00",
  • "paidInvoicesTotal": 1000,
  • "unpaidInvoicesBalance": 2139,
  • "discount": 412,
  • "billingStreet": "123 lonecrest drive",
  • "billingStreet2": "412 fuller cres",
  • "billingCity": "Toronto",
  • "billingState": "Ontario",
  • "billingPostalCode": "H6F 3F6",
  • "billingCountry": "Canada",
  • "created": "2021-07-28 00:00:00",
  • "modified": "2021-09-15 00:00:00"
}

Removes the RepeatingInvoice resource.

Removes the RepeatingInvoice resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Report

Retrieves the collection of Report resources.

Retrieves the collection of Report resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Report resource.

Retrieves a Report resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/reports/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "category": "string",
  • "name": "string",
  • "query": "string",
  • "modified": "string"
}

Reservation

Retrieves the collection of Reservation resources.

Retrieves the collection of Reservation resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Reservation resource.

Retrieves a Reservation resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/reservations/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "mainEntityOfPageId": "string",
  • "reservationForId": "string",
  • "underNameId": "string",
  • "providerId": "string",
  • "programMembershipUsedId": "string",
  • "reservedTicketId": "string",
  • "potentialActionId": "string",
  • "additionalType": "string",
  • "alternateName": "string",
  • "description": "string",
  • "disambiguatingDescription": "string",
  • "image": "string",
  • "name": "string",
  • "url": "string",
  • "reservationId": "string",
  • "reservationStatus": "string",
  • "bookingTime": "2019-08-24T14:15:22Z",
  • "modifiedTime": "2019-08-24T14:15:22Z",
  • "totalPrice": 0,
  • "priceCurrency": "string",
  • "brokerId": "string"
}

RevenueStat

Retrieves the collection of RevenueStat resources.

Retrieves the collection of RevenueStat resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a RevenueStat resource.

Retrieves a RevenueStat resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "sellerName": "string",
  • "siteName": "string",
  • "currency": "string",
  • "totalSubscriptions": "string",
  • "totalRevenue": "string",
  • "revenueToday": "string",
  • "revenueThisMonth": "string",
  • "revenueThisYear": "string",
  • "siteId": "string"
}

SalesOrder

Retrieves the collection of SalesOrder resources.

Retrieves the collection of SalesOrder resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a SalesOrder resource.

Retrieves a SalesOrder resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/sales_orders/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "customerId": "string",
  • "Identifier": "string",
  • "referenceNumber": "string",
  • "txnDate": "string",
  • "txnStatus": "string",
  • "customerName": "string",
  • "currency": "string",
  • "subtotal": 0,
  • "totalAmount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "billingCity": "string",
  • "billingCountry": "string",
  • "billingPostalcode": "string",
  • "shippingCity": "string",
  • "shippingCountry": "string",
  • "shippingPostalcode": "string",
  • "identifier": "string"
}

SiteEvent

Retrieves the collection of SiteEvent resources.

Retrieves the collection of SiteEvent resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a SiteEvent resource.

Retrieves a SiteEvent resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/site_events/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "string",
  • "description": "string",
  • "subscriptionId": "string",
  • "created": "string"
}

Statement

Retrieves the collection of Statement resources.

Retrieves the collection of Statement resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Statement resource.

Retrieves a Statement resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/statements/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "customerFirstName": "string",
  • "customerLastName": "string",
  • "customerCompany": "string",
  • "subscriptionId": "string",
  • "description": "string",
  • "transactionId": "string",
  • "eventId": "string",
  • "created": "string"
}

SubscriberLocation

Retrieves the collection of SubscriberLocation resources.

Retrieves the collection of SubscriberLocation resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a SubscriberLocation resource.

Retrieves a SubscriberLocation resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "totalItems": 0,
  • "country": "string",
  • "percent": "string",
  • "total": 0
}

Subscription

Retrieves the collection of Subscription resources.

Retrieves the collection of Subscription resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Subscription resource.

Creates a Subscription resource.

Authorizations:
BasicAuth
Request Body schema:

The new Subscription resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

status
boolean or null

Status of the subscription e.g. expired

balance
integer or null

Amount in balance for the subscription in cents e.g. 500045

totalRevenue
integer or null

Total revenue from this specific subscription in cents e.g. 387687

productPrice
integer or null

Price of the subscribed product in cents e.g. 4999

currencyCode
string or null

Currency code e.g. "EUR"

currentPeriodStart
string or null

Current period start datetime e.g. "2014-11-18" e.g. "1655792028"

currentPeriodEnd
string or null

Current period end datetime e.g. "2014-11-18" e.g. "1653977628"

nextPeriodStart
string or null

Date next period starts e.g. "2014-11-18" e.g. "1653977628"

cancelAtEndOfPeriod
boolean or null

Boolean on if plan is canelled at the end of the current period

signupId
string or null

Signup id e.g. "user123"

signupRevenue
string or null

Signup revenue e.g. "250"

couponCode
string or null

Coupon code e.g. "PROMOCODE"

customerId
string or null

Customer id e.g. "123"

productId
string or null

Id for the subscribed product e.g. "321"

creditCardId
string or null

Credit card id e.g. "4250"

created
string or null <date-time>

The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"

customerFirstName
string or null

Customer first name e.g. "Jane"

customerLastName
string or null

Customer last name e.g. "Doe"

startDate
string or null <date-time>

Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z"

endDate
string or null <date-time>

End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z"

planName
string or null

Name of the plan of which this subscription is an instance e.g. "Basic Plan"

activated
string or null

Indicates when the subscription was activated e.g. "Jan 23 2023"

remainingIntervals
integer or null

Number of remaining subscription intervals e.g. 12

monthlyRevenue
integer or null

Revenue per month in cents e.g. 500000

netMonthlyRevenue
integer or null

Monthly revenue after taxes e.g. 300000

contractStartDate
string or null <date-time>

Date contract starts * e.g. "2013-11-18T02:17:40.080Z"

expiredTimestamp
string or null <date-time>

When the current subscription expires e.g. "2013-11-18T02:17:40.080Z"

planInterval
string or null

Length of each subscription plan e.g. "Monthly"

numOfIntervals
integer or null

Number of subscription intervals e.g. 12

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": true,
  • "balance": 500045,
  • "totalRevenue": 387687,
  • "productPrice": 4999,
  • "currencyCode": "EUR",
  • "currentPeriodStart": "1655792028",
  • "currentPeriodEnd": "1653977628",
  • "nextPeriodStart": "1653977628",
  • "cancelAtEndOfPeriod": true,
  • "signupId": "user123",
  • "signupRevenue": "250",
  • "couponCode": "PROMOCODE",
  • "customerId": "123",
  • "productId": "321",
  • "creditCardId": "4250",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z",
  • "customerFirstName": "Jane",
  • "customerLastName": "Doe",
  • "startDate": "2013-11-18T02:17:40.080Z",
  • "endDate": "2015-11-18T02:17:40.080Z",
  • "planName": "Basic Plan",
  • "activated": "Jan 23 2023",
  • "remainingIntervals": 12,
  • "monthlyRevenue": 500000,
  • "netMonthlyRevenue": 300000,
  • "contractStartDate": "2013-11-18T02:17:40.080Z",
  • "expiredTimestamp": "2013-11-18T02:17:40.080Z",
  • "planInterval": "Monthly",
  • "numOfIntervals": 12
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": true,
  • "balance": 500045,
  • "totalRevenue": 387687,
  • "productPrice": 4999,
  • "currencyCode": "EUR",
  • "currentPeriodStart": "1655792028",
  • "currentPeriodEnd": "1653977628",
  • "nextPeriodStart": "1653977628",
  • "cancelAtEndOfPeriod": true,
  • "signupId": "user123",
  • "signupRevenue": "250",
  • "couponCode": "PROMOCODE",
  • "customerId": "123",
  • "productId": "321",
  • "creditCardId": "4250",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z",
  • "customerFirstName": "Jane",
  • "customerLastName": "Doe",
  • "startDate": "2013-11-18T02:17:40.080Z",
  • "endDate": "2015-11-18T02:17:40.080Z",
  • "planName": "Basic Plan",
  • "activated": "Jan 23 2023",
  • "remainingIntervals": 12,
  • "monthlyRevenue": 500000,
  • "netMonthlyRevenue": 300000,
  • "contractStartDate": "2013-11-18T02:17:40.080Z",
  • "expiredTimestamp": "2013-11-18T02:17:40.080Z",
  • "planInterval": "Monthly",
  • "numOfIntervals": 12
}

Retrieves a Subscription resource.

Retrieves a Subscription resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": true,
  • "balance": 500045,
  • "totalRevenue": 387687,
  • "productPrice": 4999,
  • "currencyCode": "EUR",
  • "currentPeriodStart": "1655792028",
  • "currentPeriodEnd": "1653977628",
  • "nextPeriodStart": "1653977628",
  • "cancelAtEndOfPeriod": true,
  • "signupId": "user123",
  • "signupRevenue": "250",
  • "couponCode": "PROMOCODE",
  • "customerId": "123",
  • "productId": "321",
  • "creditCardId": "4250",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z",
  • "customerFirstName": "Jane",
  • "customerLastName": "Doe",
  • "startDate": "2013-11-18T02:17:40.080Z",
  • "endDate": "2015-11-18T02:17:40.080Z",
  • "planName": "Basic Plan",
  • "activated": "Jan 23 2023",
  • "remainingIntervals": 12,
  • "monthlyRevenue": 500000,
  • "netMonthlyRevenue": 300000,
  • "contractStartDate": "2013-11-18T02:17:40.080Z",
  • "expiredTimestamp": "2013-11-18T02:17:40.080Z",
  • "planInterval": "Monthly",
  • "numOfIntervals": 12
}

Replaces the Subscription resource.

Replaces the Subscription resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Subscription resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

status
boolean or null

Status of the subscription e.g. expired

balance
integer or null

Amount in balance for the subscription in cents e.g. 500045

totalRevenue
integer or null

Total revenue from this specific subscription in cents e.g. 387687

productPrice
integer or null

Price of the subscribed product in cents e.g. 4999

currencyCode
string or null

Currency code e.g. "EUR"

currentPeriodStart
string or null

Current period start datetime e.g. "2014-11-18" e.g. "1655792028"

currentPeriodEnd
string or null

Current period end datetime e.g. "2014-11-18" e.g. "1653977628"

nextPeriodStart
string or null

Date next period starts e.g. "2014-11-18" e.g. "1653977628"

cancelAtEndOfPeriod
boolean or null

Boolean on if plan is canelled at the end of the current period

signupId
string or null

Signup id e.g. "user123"

signupRevenue
string or null

Signup revenue e.g. "250"

couponCode
string or null

Coupon code e.g. "PROMOCODE"

customerId
string or null

Customer id e.g. "123"

productId
string or null

Id for the subscribed product e.g. "321"

creditCardId
string or null

Credit card id e.g. "4250"

created
string or null <date-time>

The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"

customerFirstName
string or null

Customer first name e.g. "Jane"

customerLastName
string or null

Customer last name e.g. "Doe"

startDate
string or null <date-time>

Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z"

endDate
string or null <date-time>

End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z"

planName
string or null

Name of the plan of which this subscription is an instance e.g. "Basic Plan"

activated
string or null

Indicates when the subscription was activated e.g. "Jan 23 2023"

remainingIntervals
integer or null

Number of remaining subscription intervals e.g. 12

monthlyRevenue
integer or null

Revenue per month in cents e.g. 500000

netMonthlyRevenue
integer or null

Monthly revenue after taxes e.g. 300000

contractStartDate
string or null <date-time>

Date contract starts * e.g. "2013-11-18T02:17:40.080Z"

expiredTimestamp
string or null <date-time>

When the current subscription expires e.g. "2013-11-18T02:17:40.080Z"

planInterval
string or null

Length of each subscription plan e.g. "Monthly"

numOfIntervals
integer or null

Number of subscription intervals e.g. 12

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": true,
  • "balance": 500045,
  • "totalRevenue": 387687,
  • "productPrice": 4999,
  • "currencyCode": "EUR",
  • "currentPeriodStart": "1655792028",
  • "currentPeriodEnd": "1653977628",
  • "nextPeriodStart": "1653977628",
  • "cancelAtEndOfPeriod": true,
  • "signupId": "user123",
  • "signupRevenue": "250",
  • "couponCode": "PROMOCODE",
  • "customerId": "123",
  • "productId": "321",
  • "creditCardId": "4250",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z",
  • "customerFirstName": "Jane",
  • "customerLastName": "Doe",
  • "startDate": "2013-11-18T02:17:40.080Z",
  • "endDate": "2015-11-18T02:17:40.080Z",
  • "planName": "Basic Plan",
  • "activated": "Jan 23 2023",
  • "remainingIntervals": 12,
  • "monthlyRevenue": 500000,
  • "netMonthlyRevenue": 300000,
  • "contractStartDate": "2013-11-18T02:17:40.080Z",
  • "expiredTimestamp": "2013-11-18T02:17:40.080Z",
  • "planInterval": "Monthly",
  • "numOfIntervals": 12
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "status": true,
  • "balance": 500045,
  • "totalRevenue": 387687,
  • "productPrice": 4999,
  • "currencyCode": "EUR",
  • "currentPeriodStart": "1655792028",
  • "currentPeriodEnd": "1653977628",
  • "nextPeriodStart": "1653977628",
  • "cancelAtEndOfPeriod": true,
  • "signupId": "user123",
  • "signupRevenue": "250",
  • "couponCode": "PROMOCODE",
  • "customerId": "123",
  • "productId": "321",
  • "creditCardId": "4250",
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-18T02:17:40.080Z",
  • "customerFirstName": "Jane",
  • "customerLastName": "Doe",
  • "startDate": "2013-11-18T02:17:40.080Z",
  • "endDate": "2015-11-18T02:17:40.080Z",
  • "planName": "Basic Plan",
  • "activated": "Jan 23 2023",
  • "remainingIntervals": 12,
  • "monthlyRevenue": 500000,
  • "netMonthlyRevenue": 300000,
  • "contractStartDate": "2013-11-18T02:17:40.080Z",
  • "expiredTimestamp": "2013-11-18T02:17:40.080Z",
  • "planInterval": "Monthly",
  • "numOfIntervals": 12
}

Removes the Subscription resource.

Removes the Subscription resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

SupportTicket

Retrieves the collection of SupportTicket resources.

Retrieves the collection of SupportTicket resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a SupportTicket resource.

Retrieves a SupportTicket resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/support_tickets/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "subject": "string",
  • "created": "string",
  • "status": "string"
}

Task

Retrieves the collection of Task resources.

Retrieves the collection of Task resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Task resource.

Retrieves a Task resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tasks/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "ownerId": "string",
  • "ownerName": "string",
  • "subject": "string",
  • "status": "string",
  • "priority": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "recurringActivity": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

TaxAgency

Retrieves the collection of TaxAgency resources.

Retrieves the collection of TaxAgency resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a TaxAgency resource.

Retrieves a TaxAgency resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "string",
  • "taxOnSales": true,
  • "taxOnPurchases": true,
  • "taxRegistrationNum": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

TaxRate

Retrieves the collection of TaxRate resources.

Retrieves the collection of TaxRate resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a TaxRate resource.

Retrieves a TaxRate resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tax_rates/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "string",
  • "taxRate": "string",
  • "taxType": "string",
  • "description": "string",
  • "active": true,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Term

Retrieves the collection of Term resources.

Retrieves the collection of Term resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Term resource.

Retrieves a Term resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/terms/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "name": "string",
  • "type": "string",
  • "discountPercent": "string",
  • "discountDays": 0,
  • "dayOfMonthDue": 0,
  • "discountDayOfMonth": 0,
  • "dueNextMonthDays": 0,
  • "dueDays": 0,
  • "active": true,
  • "created": "string",
  • "modified": "string",
  • "directory": "string"
}

TrackingCategory

Retrieves the collection of TrackingCategory resources.

Retrieves the collection of TrackingCategory resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a TrackingCategory resource.

Retrieves a TrackingCategory resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "name": "string",
  • "status": "string",
  • "trackingOptionId": "string",
  • "trackingOptionName": "string",
  • "trackingOptionStatus": "string"
}

TransactionMatchReport

Retrieves a transaction match report which includes a details array and a summary

Retrieves a TransactionMatchReport resource.

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "start": "2022-07-01",
  • "end": "2022-08-31",
  • "summary": {
    },
  • "details": [
    ]
}

TransactionMatchSeries

Retrieves a monthly series of transaction match reports which include details arrays and summaries

Retrieves a TransactionMatchSeries resource.

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

refresh
string
Example: refresh=true

If refresh is set, data will be fetched from the source application even when cached data is available

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "start": "2022-07-01",
  • "end": "2022-08-31",
  • "series": [
    ]
}

Transaction

Retrieves a Collection of transaction resources

Retrieves a Collection of transaction resources

Authorizations:
BasicAuth
query Parameters
start
string <date-time>
Example: start=2022-07-01

YYYY-MM-DD

end
string <date-time>
Example: end=2022-08-31

YYYY-MM-DD

page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Transaction resource.

Retrieves a Transaction resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/transactions/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "transactionType": "string",
  • "success": "string",
  • "amount": 0,
  • "description": "string",
  • "transactionId": "string",
  • "paymentId": "string",
  • "productId": "string",
  • "taxId": "string",
  • "componentId": "string",
  • "statementId": "string",
  • "customerId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "fee": 0,
  • "netAmount": 0,
  • "txnDate": "2019-08-24T14:15:22Z"
}

TrialBalance

Retrieves a TrialBalance resource.

Retrieves a TrialBalance resource.

Authorizations:
BasicAuth
query Parameters
end
required
string <date-time>
Example: end=2022-11-30

YYYY-MM-DD

accounting_method
required
string
Enum: "cash" "accrual"
Example: accounting_method=accrual

The Accounting Method

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "reportTitle": "Trial Balance",
  • "companyName": "Flux Capacitors Inc",
  • "columns": [
    ],
  • "rows": [
    ],
  • "accountingMethod": "cash",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "currencyCode": "USD",
  • "deleted": true
}

UnbilledCharge

Retrieves the collection of UnbilledCharge resources.

Retrieves the collection of UnbilledCharge resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a UnbilledCharge resource.

Retrieves a UnbilledCharge resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "amount": "string",
  • "currencyCode": "string",
  • "customerId": "string",
  • "subscriptionId": "string",
  • "description": "string",
  • "quantity": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z"
}

User

Retrieves the collection of User resources.

Retrieves the collection of User resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a User resource.

Retrieves a User resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/users/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "role": "string",
  • "primaryPhone": "string",
  • "addressLine1": "string",
  • "city": "string",
  • "country": "string",
  • "postalCode": "string",
  • "company": "string",
  • "profileUrl": "string",
  • "department": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string"
}

VendorCredit

Retrieves the collection of VendorCredit resources.

Retrieves the collection of VendorCredit resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a VendorCredit resource.

Creates a VendorCredit resource.

Authorizations:
BasicAuth
Request Body schema:

The new VendorCredit resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

the unique identifier of the source 3rd party integration e.g. "3000000002075"

date
string or null

The date the vendor credit was created e.g. "2014-08-28"

status
string or null

Status of recurring expense e.g. "open"

vendorId
string or null

ID of the vendor the vendor credit is associated with e.g. "460000000020029"

vendorName
string or null

Name of the vendor the vendor credit is associated with e.g. "Bowman and Co"

currency
string or null

Currency code e.g. "USD"

subtotal
integer or null

Subtotal of the vendor credits in cents e.g. 3000

totalAmount
required
integer or null

Total amount of the vendor credits in cents e.g. 3500

balance
integer or null

Balance in the vendor credit in cents e.g. 2150

created
string or null <date-time>

Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700"

modified
string or null <date-time>

Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "3000000002075",
  • "date": "2014-08-28",
  • "status": "open",
  • "vendorId": "460000000020029",
  • "vendorName": "Bowman and Co",
  • "currency": "USD",
  • "subtotal": 3000,
  • "totalAmount": 3500,
  • "balance": 2150,
  • "created": "2014-08-28T22:53:31-0700",
  • "modified": "2014-08-28T22:53:31-0700"
}

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "3000000002075",
  • "date": "2014-08-28",
  • "status": "open",
  • "vendorId": "460000000020029",
  • "vendorName": "Bowman and Co",
  • "currency": "USD",
  • "subtotal": 3000,
  • "totalAmount": 3500,
  • "balance": 2150,
  • "created": "2014-08-28T22:53:31-0700",
  • "modified": "2014-08-28T22:53:31-0700"
}

Retrieves a VendorCredit resource.

Retrieves a VendorCredit resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "3000000002075",
  • "date": "2014-08-28",
  • "status": "open",
  • "vendorId": "460000000020029",
  • "vendorName": "Bowman and Co",
  • "currency": "USD",
  • "subtotal": 3000,
  • "totalAmount": 3500,
  • "balance": 2150,
  • "created": "2014-08-28T22:53:31-0700",
  • "modified": "2014-08-28T22:53:31-0700"
}

Replaces the VendorCredit resource.

Replaces the VendorCredit resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated VendorCredit resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

the unique identifier of the source 3rd party integration e.g. "3000000002075"

date
string or null

The date the vendor credit was created e.g. "2014-08-28"

status
string or null

Status of recurring expense e.g. "open"

vendorId
string or null

ID of the vendor the vendor credit is associated with e.g. "460000000020029"

vendorName
string or null

Name of the vendor the vendor credit is associated with e.g. "Bowman and Co"

currency
string or null

Currency code e.g. "USD"

subtotal
integer or null

Subtotal of the vendor credits in cents e.g. 3000

totalAmount
required
integer or null

Total amount of the vendor credits in cents e.g. 3500

balance
integer or null

Balance in the vendor credit in cents e.g. 2150

created
string or null <date-time>

Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700"

modified
string or null <date-time>

Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "3000000002075",
  • "date": "2014-08-28",
  • "status": "open",
  • "vendorId": "460000000020029",
  • "vendorName": "Bowman and Co",
  • "currency": "USD",
  • "subtotal": 3000,
  • "totalAmount": 3500,
  • "balance": 2150,
  • "created": "2014-08-28T22:53:31-0700",
  • "modified": "2014-08-28T22:53:31-0700"
}

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "3000000002075",
  • "date": "2014-08-28",
  • "status": "open",
  • "vendorId": "460000000020029",
  • "vendorName": "Bowman and Co",
  • "currency": "USD",
  • "subtotal": 3000,
  • "totalAmount": 3500,
  • "balance": 2150,
  • "created": "2014-08-28T22:53:31-0700",
  • "modified": "2014-08-28T22:53:31-0700"
}

Removes the VendorCredit resource.

Removes the VendorCredit resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

VendorPayment

Retrieves the collection of VendorPayment resources.

Retrieves the collection of VendorPayment resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a VendorPayment resource.

Creates a VendorPayment resource.

Authorizations:
BasicAuth
Request Body schema:

The new VendorPayment resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

the unique identifier of the source 3rd party integration e.g. "460000000053219"

vendorId
string or null

Unique identifier for the vendor e.g. "460000000026049"

vendorName
string or null

Name of the vendor e.g. "Bowman and Co"

paymentMode
string or null

Mode of vendor payment e.g. "Stripe"

txnDate
string or null <date-time>

Date the payment is made e.g. "2013-10-07"

referenceNumber
string or null

Reference number for the vendor payment recorded e.g. REF#912300

amount
required
integer or null

Total amount of the vendor payment in cents e.g. 12500

balance
integer or null

Balance due for the bill in cents e.g. 3500

currency
string or null

Currency code e.g. "USD"

created
string or null <date-time>

Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500

modified
string or null <date-time>

Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "balance": 3500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "balance": 3500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Retrieves a VendorPayment resource.

Retrieves a VendorPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "balance": 3500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Replaces the VendorPayment resource.

Replaces the VendorPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated VendorPayment resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

the unique identifier of the source 3rd party integration e.g. "460000000053219"

vendorId
string or null

Unique identifier for the vendor e.g. "460000000026049"

vendorName
string or null

Name of the vendor e.g. "Bowman and Co"

paymentMode
string or null

Mode of vendor payment e.g. "Stripe"

txnDate
string or null <date-time>

Date the payment is made e.g. "2013-10-07"

referenceNumber
string or null

Reference number for the vendor payment recorded e.g. REF#912300

amount
required
integer or null

Total amount of the vendor payment in cents e.g. 12500

balance
integer or null

Balance due for the bill in cents e.g. 3500

currency
string or null

Currency code e.g. "USD"

created
string or null <date-time>

Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500

modified
string or null <date-time>

Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "balance": 3500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Response samples

Content type
{
  • "id": "quickbooks-321",
  • "integration": "quickbooks",
  • "srcId": "460000000053219",
  • "vendorId": "460000000026049",
  • "vendorName": "Bowman and Co",
  • "paymentMode": "Stripe",
  • "txnDate": "2013-10-07",
  • "referenceNumber": "REF#912300",
  • "amount": 12500,
  • "balance": 3500,
  • "currency": "USD",
  • "created": "2016-12-16T00:18:42-0500",
  • "modified": "2016-12-16T00:18:42-0500"
}

Removes the VendorPayment resource.

Removes the VendorPayment resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Vendor

Retrieves the collection of Vendor resources.

Retrieves the collection of Vendor resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Creates a Vendor resource.

Creates a Vendor resource.

Authorizations:
BasicAuth
Request Body schema:

The new Vendor resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

givenName
string or null

First name of the vendor e.g. "Jane"

familyName
string or null

Last name of the vendor e.g. "Doe"

companyName
string or null

Name of the company e.g. "Doyle-Koch LLC"

displayName
string or null

Name displayed for vendor e.g. "Doyle-Koch"

contactName
string or null

Name of the main contact for the vendor e.g. "John Smith"

contactTitle
string or null

Title of the main contact for the vendor e.g. "Account Manager"

accountNumber
string or null

Account number for the vendor e.g. "420042"

phone
string or null

Phone number e.g. "281-381-4241"

mobile
string or null

Mobile number e.g. "786-258-0182"

fax
string or null

Fax number e.g. "281-381-4255"

email
string or null

Email address for the vendor e.g. "doyle-koch@email.com"

website
string or null

Vendor website e.g. "https://www.doylekoch.com"

address
string or null

First line of vendor address e.g. "708 Woodland Avenue"

addressLine2
string or null

Vendor address line 2 e.g. "Unit 105"

city
string or null

City of the address e.g. "St Paul"

state
string or null

Vendor state address e.g. "Alaska"

country
string or null

Country of the address

  • e.g. "United States"
postalCode
string or null

Postal code of the address

  • e.g. "99660"
currency
string or null

Currency code used by vendor e.g. "USD"

balance
integer or null

Balance in ledger for vendor in cents e.g. 650000

bankAccountName
string or null

Bank account name associated with the vendor e.g. "Business Bank Account"

bankAccountNumber
string or null

Bank acount number associated with the vendor e.g. "123654"

notes
string or null

Additional note attached to vendor e.g. "Quality vendor"

taxType
string or null

Type of tax applied to vendor e.g. "Global"

isContractor
boolean or null

Whether the vendor is a contractor

active
boolean or null

Whether the vendor is active

created
string or null <date-time>

Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"

termId
string or null

Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"

termDays
integer or null

The days value of the payment terms for this Vendor e.g. "15"

termType
string or null

The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Doyle-Koch LLC",
  • "displayName": "Doyle-Koch",
  • "contactName": "John Smith",
  • "contactTitle": "Account Manager",
  • "accountNumber": "420042",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "email": "doyle-koch@email.com",
  • "website": "https://www.doylekoch.com",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "state": "Alaska",
  • "country": "United States",
  • "postalCode": "99660",
  • "currency": "USD",
  • "balance": 650000,
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "notes": "Quality vendor",
  • "taxType": "Global",
  • "isContractor": true,
  • "active": true,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Doyle-Koch LLC",
  • "displayName": "Doyle-Koch",
  • "contactName": "John Smith",
  • "contactTitle": "Account Manager",
  • "accountNumber": "420042",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "email": "doyle-koch@email.com",
  • "website": "https://www.doylekoch.com",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "state": "Alaska",
  • "country": "United States",
  • "postalCode": "99660",
  • "currency": "USD",
  • "balance": 650000,
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "notes": "Quality vendor",
  • "taxType": "Global",
  • "isContractor": true,
  • "active": true,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Retrieves a Vendor resource.

Retrieves a Vendor resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendors/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Doyle-Koch LLC",
  • "displayName": "Doyle-Koch",
  • "contactName": "John Smith",
  • "contactTitle": "Account Manager",
  • "accountNumber": "420042",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "email": "doyle-koch@email.com",
  • "website": "https://www.doylekoch.com",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "state": "Alaska",
  • "country": "United States",
  • "postalCode": "99660",
  • "currency": "USD",
  • "balance": 650000,
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "notes": "Quality vendor",
  • "taxType": "Global",
  • "isContractor": true,
  • "active": true,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Replaces the Vendor resource.

Replaces the Vendor resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Vendor resource

integration
string

The key of the integration source e.g. "quickbooks", or "xero"

srcId
string

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

givenName
string or null

First name of the vendor e.g. "Jane"

familyName
string or null

Last name of the vendor e.g. "Doe"

companyName
string or null

Name of the company e.g. "Doyle-Koch LLC"

displayName
string or null

Name displayed for vendor e.g. "Doyle-Koch"

contactName
string or null

Name of the main contact for the vendor e.g. "John Smith"

contactTitle
string or null

Title of the main contact for the vendor e.g. "Account Manager"

accountNumber
string or null

Account number for the vendor e.g. "420042"

phone
string or null

Phone number e.g. "281-381-4241"

mobile
string or null

Mobile number e.g. "786-258-0182"

fax
string or null

Fax number e.g. "281-381-4255"

email
string or null

Email address for the vendor e.g. "doyle-koch@email.com"

website
string or null

Vendor website e.g. "https://www.doylekoch.com"

address
string or null

First line of vendor address e.g. "708 Woodland Avenue"

addressLine2
string or null

Vendor address line 2 e.g. "Unit 105"

city
string or null

City of the address e.g. "St Paul"

state
string or null

Vendor state address e.g. "Alaska"

country
string or null

Country of the address

  • e.g. "United States"
postalCode
string or null

Postal code of the address

  • e.g. "99660"
currency
string or null

Currency code used by vendor e.g. "USD"

balance
integer or null

Balance in ledger for vendor in cents e.g. 650000

bankAccountName
string or null

Bank account name associated with the vendor e.g. "Business Bank Account"

bankAccountNumber
string or null

Bank acount number associated with the vendor e.g. "123654"

notes
string or null

Additional note attached to vendor e.g. "Quality vendor"

taxType
string or null

Type of tax applied to vendor e.g. "Global"

isContractor
boolean or null

Whether the vendor is a contractor

active
boolean or null

Whether the vendor is active

created
string or null <date-time>

Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z"

modified
string or null <date-time>

Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"

termId
string or null

Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"

termDays
integer or null

The days value of the payment terms for this Vendor e.g. "15"

termType
string or null

The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE"

Responses

Request samples

Content type
{
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Doyle-Koch LLC",
  • "displayName": "Doyle-Koch",
  • "contactName": "John Smith",
  • "contactTitle": "Account Manager",
  • "accountNumber": "420042",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "email": "doyle-koch@email.com",
  • "website": "https://www.doylekoch.com",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "state": "Alaska",
  • "country": "United States",
  • "postalCode": "99660",
  • "currency": "USD",
  • "balance": 650000,
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "notes": "Quality vendor",
  • "taxType": "Global",
  • "isContractor": true,
  • "active": true,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Response samples

Content type
{
  • "id": "quickbooks-726",
  • "integration": "quickbooks",
  • "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  • "givenName": "Jane",
  • "familyName": "Doe",
  • "companyName": "Doyle-Koch LLC",
  • "displayName": "Doyle-Koch",
  • "contactName": "John Smith",
  • "contactTitle": "Account Manager",
  • "accountNumber": "420042",
  • "phone": "281-381-4241",
  • "mobile": "786-258-0182",
  • "fax": "281-381-4255",
  • "email": "doyle-koch@email.com",
  • "website": "https://www.doylekoch.com",
  • "address": "708 Woodland Avenue",
  • "addressLine2": "Unit 105",
  • "city": "St Paul",
  • "state": "Alaska",
  • "country": "United States",
  • "postalCode": "99660",
  • "currency": "USD",
  • "balance": 650000,
  • "bankAccountName": "Business Bank Account",
  • "bankAccountNumber": "123654",
  • "notes": "Quality vendor",
  • "taxType": "Global",
  • "isContractor": true,
  • "active": true,
  • "created": "2013-11-18T02:17:40.080Z",
  • "modified": "2013-11-22T02:17:40.080Z",
  • "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  • "termDays": "15",
  • "termType": "DAYSAFTERBILLDATE"
}

Removes the Vendor resource.

Removes the Vendor resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/vendors/%7Bid%7D")
  .delete(null)
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Workflow

Retrieves the collection of Workflow resources.

Retrieves the collection of Workflow resources.

Authorizations:
BasicAuth
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 200 ]
Default: 100

The number of items per page

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
[
  • {
    }
]

Retrieves a Workflow resource.

Retrieves a Workflow resource.

Authorizations:
BasicAuth
path Parameters
id
required
string

Resource identifier

Responses

Request samples 

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://example.myintranetapps.com/api/workflows/%7Bid%7D")
  .get()
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();

Response samples

Content type
{
  • "id": "string",
  • "integration": "quickbooks",
  • "srcId": "string",
  • "created": "string",
  • "updated": "string",
  • "isActive": true,
  • "type": "string"
}