QBD Connect System API vv1
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| version* | string | Enum:
|
Home
Welcome to the QBD Connect API. This API is used for managing QBD instances. It allows users to query their customer profile, get information regarding their instances, and manage subscriptions, sessions, and requests.
Legal
This API is intended for QBD Connect clients and their users. Any use of the API without a QBD Connect subscription is stricly prohibited.
Resources
get /customers
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Query | ||
| gatewayCustomerId | string | This is the ID for the customer account with the payment provider. The current provider is Stripe. The Stripe customer ID's typically start with cus_. |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/customers?gatewayCustomerId=<value>200 OK chevron_right expand_more
Customer Customer
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID for the QBD Connect client which is the same as the user |
| organizationId | string | The organization ID from Insightly |
| gatewayCustomerId | string | The customer ID from Stripe |
| subscriptionId | string | The subscription ID from Stripe |
| name | string | The name of the client |
| address | object | The address of the customer Additional properties: Yes |
| address.street1* | string | |
| address.street2 | string | |
| address.city* | string | |
| address.state* | string | Max. length: 2 |
| address.postalCode* | string | Max. length: 10 |
| primaryBillingContact* | object | The contact that originally signed up for QBD Connect. Additional properties: Yes |
| primaryBillingContact.firstName | string | |
| primaryBillingContact.lastName | string | |
| primaryBillingContact.email* | string | |
| primaryBillingContact.phone | string | |
| qbdInstances | array | The QBD instances of the customer. |
| qbdInstances[] | object | Additional properties: Yes Inherits: Instance |
| qbdInstances[].instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| qbdInstances[].name* | string | The name of the instance |
| qbdInstances[].customerId* | string | The customer ID of the instance |
| qbdInstances[].contact* | object | Additional properties: Yes |
| qbdInstances[].contact.firstName* | string | |
| qbdInstances[].contact.lastName* | string | |
| qbdInstances[].contact.email* | string | |
| qbdInstances[].contact.phone | string | |
| qbdInstances[].qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| qbdInstances[].appUrl | string | The URL that the QBWC application will send requests |
| qbdInstances[].frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| qbdInstances[].fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| qbdInstances[].validated | boolean | Whether the validation of the user with the email address was completed |
| qbdInstances[].sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| qbdInstances[].sla.supportHours* | number | |
| qbdInstances[].sla.transactionLimit* | integer | |
| qbdInstances[].sla.defaultHourlyRate* | number | |
| qbdInstances[].dateCreated | date-only |
post /customers
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/customersRequest Body chevron_right expand_more
Customer Customer
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID for the QBD Connect client which is the same as the user |
| organizationId | string | The organization ID from Insightly |
| gatewayCustomerId | string | The customer ID from Stripe |
| subscriptionId | string | The subscription ID from Stripe |
| name | string | The name of the client |
| address | object | The address of the customer Additional properties: Yes |
| address.street1* | string | |
| address.street2 | string | |
| address.city* | string | |
| address.state* | string | Max. length: 2 |
| address.postalCode* | string | Max. length: 10 |
| primaryBillingContact* | object | The contact that originally signed up for QBD Connect. Additional properties: Yes |
| primaryBillingContact.firstName | string | |
| primaryBillingContact.lastName | string | |
| primaryBillingContact.email* | string | |
| primaryBillingContact.phone | string | |
| qbdInstances | array | The QBD instances of the customer. |
| qbdInstances[] | object | Additional properties: Yes Inherits: Instance |
| qbdInstances[].instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| qbdInstances[].name* | string | The name of the instance |
| qbdInstances[].customerId* | string | The customer ID of the instance |
| qbdInstances[].contact* | object | Additional properties: Yes |
| qbdInstances[].contact.firstName* | string | |
| qbdInstances[].contact.lastName* | string | |
| qbdInstances[].contact.email* | string | |
| qbdInstances[].contact.phone | string | |
| qbdInstances[].qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| qbdInstances[].appUrl | string | The URL that the QBWC application will send requests |
| qbdInstances[].frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| qbdInstances[].fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| qbdInstances[].validated | boolean | Whether the validation of the user with the email address was completed |
| qbdInstances[].sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| qbdInstances[].sla.supportHours* | number | |
| qbdInstances[].sla.transactionLimit* | integer | |
| qbdInstances[].sla.defaultHourlyRate* | number | |
| qbdInstances[].dateCreated | date-only |
get /customers/{customerId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| customerId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/customers/{customerId}200 OK chevron_right expand_more
Customer Customer
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID for the QBD Connect client which is the same as the user |
| organizationId | string | The organization ID from Insightly |
| gatewayCustomerId | string | The customer ID from Stripe |
| subscriptionId | string | The subscription ID from Stripe |
| name | string | The name of the client |
| address | object | The address of the customer Additional properties: Yes |
| address.street1* | string | |
| address.street2 | string | |
| address.city* | string | |
| address.state* | string | Max. length: 2 |
| address.postalCode* | string | Max. length: 10 |
| primaryBillingContact* | object | The contact that originally signed up for QBD Connect. Additional properties: Yes |
| primaryBillingContact.firstName | string | |
| primaryBillingContact.lastName | string | |
| primaryBillingContact.email* | string | |
| primaryBillingContact.phone | string | |
| qbdInstances | array | The QBD instances of the customer. |
| qbdInstances[] | object | Additional properties: Yes Inherits: Instance |
| qbdInstances[].instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| qbdInstances[].name* | string | The name of the instance |
| qbdInstances[].customerId* | string | The customer ID of the instance |
| qbdInstances[].contact* | object | Additional properties: Yes |
| qbdInstances[].contact.firstName* | string | |
| qbdInstances[].contact.lastName* | string | |
| qbdInstances[].contact.email* | string | |
| qbdInstances[].contact.phone | string | |
| qbdInstances[].qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| qbdInstances[].appUrl | string | The URL that the QBWC application will send requests |
| qbdInstances[].frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| qbdInstances[].fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| qbdInstances[].validated | boolean | Whether the validation of the user with the email address was completed |
| qbdInstances[].sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| qbdInstances[].sla.supportHours* | number | |
| qbdInstances[].sla.transactionLimit* | integer | |
| qbdInstances[].sla.defaultHourlyRate* | number | |
| qbdInstances[].dateCreated | date-only |
get /customers/{customerId}/stats
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| customerId* | string | |
| Query | ||
| begin* | datetime | |
| end* | datetime | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/customers/{customerId}/stats?begin=<value>&end=<value>200 OK chevron_right expand_more
application/json
application/json
get /instances
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Query | ||
| customerId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/instances?customerId=<value>200 OK chevron_right expand_more
application/json
application/json
| Parameter | Type | Description |
|---|---|---|
| [] Instance | object | Additional properties: Yes Inherits: object |
| [].instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| [].name* | string | The name of the instance |
| [].customerId* | string | The customer ID of the instance |
| [].contact* | object | Additional properties: Yes |
| [].contact.firstName* | string | |
| [].contact.lastName* | string | |
| [].contact.email* | string | |
| [].contact.phone | string | |
| [].qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| [].appUrl | string | The URL that the QBWC application will send requests |
| [].frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| [].fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| [].validated | boolean | Whether the validation of the user with the email address was completed |
| [].sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| [].sla.supportHours* | number | |
| [].sla.transactionLimit* | integer | |
| [].sla.defaultHourlyRate* | number | |
| [].dateCreated | date-only |
post /instances
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/instancesRequest Body chevron_right expand_more
Instance Instance
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| name* | string | The name of the instance |
| customerId* | string | The customer ID of the instance |
| contact* | object | Additional properties: Yes |
| contact.firstName* | string | |
| contact.lastName* | string | |
| contact.email* | string | |
| contact.phone | string | |
| qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| appUrl | string | The URL that the QBWC application will send requests |
| frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| validated | boolean | Whether the validation of the user with the email address was completed |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
get /instances/{instanceId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}200 OK chevron_right expand_more
Instance Instance
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| name* | string | The name of the instance |
| customerId* | string | The customer ID of the instance |
| contact* | object | Additional properties: Yes |
| contact.firstName* | string | |
| contact.lastName* | string | |
| contact.email* | string | |
| contact.phone | string | |
| qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| appUrl | string | The URL that the QBWC application will send requests |
| frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| validated | boolean | Whether the validation of the user with the email address was completed |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
put /instances/{instanceId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
Secured By chevron_right expand_more
curl -X PUT \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}Request Body chevron_right expand_more
application/json
application/json
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the QBD Connect instance |
| password | string | The password that QBWC uses to authenticate with QBD Connector |
| qbdPath | string | The path of the QuickBooks Desktop company file |
| frequencyInMinutes | integer | The frequency that QBWC polls QBD Connector for requests Default value: 60 |
200 OK chevron_right expand_more
Instance Instance
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| name* | string | The name of the instance |
| customerId* | string | The customer ID of the instance |
| contact* | object | Additional properties: Yes |
| contact.firstName* | string | |
| contact.lastName* | string | |
| contact.email* | string | |
| contact.phone | string | |
| qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| appUrl | string | The URL that the QBWC application will send requests |
| frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| validated | boolean | Whether the validation of the user with the email address was completed |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
patch /instances/{instanceId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
Secured By chevron_right expand_more
curl -X PATCH \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}delete /instances/{instanceId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
| Query | ||
| projectId | string | The project ID for the support project for the instance |
Secured By chevron_right expand_more
curl -X DELETE \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}?projectId=<value>204 No Content chevron_right expand_more
application/json
application/json
get /instances/{instanceId}/metrics/{metricId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
| metricId* | string | |
| Query | ||
| fromTime* | datetime | The from time is the JSON-formatted date-time value for the start of the metrics. The metrics are only available for 360 days, so setting this value to a date further than 360 days will only return metrics for the past year. |
| toTime* | datetime | The to time is the JSON-formatted date-time value for the end of the metrics. If a value is supplied that is in the future, the latest data will be returned. |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}/metrics/{metricId}?fromTime=<value>&toTime=<value>200 OK chevron_right expand_more
application/json
application/json
get /instances/{instanceId}/qwc
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
| Query | ||
| email Email | boolean | This is an indicator of whether or not to email the QWC file to the email address that is registered as the account owner. |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}/qwc?email=<value>200 OK chevron_right expand_more
application/xml
application/xml
get /instances/{instanceId}/users
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| instanceId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/instances/{instanceId}/users200 OK chevron_right expand_more
application/json
application/json
get /invoices
lock
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/invoicespost /invoices
lock
Secured By chevron_right expand_more
curl -X POST \
http://localhost:8081/qbdconnect-api/{version}/invoicesget /invoices/{invoiceId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| invoiceId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/invoices/{invoiceId}put /invoices/{invoiceId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| invoiceId* | string | |
Secured By chevron_right expand_more
curl -X PUT \
http://localhost:8081/qbdconnect-api/{version}/invoices/{invoiceId}get /invoices/{invoiceId}/payments
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| invoiceId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/invoices/{invoiceId}/paymentspost /invoices/{invoiceId}/payments
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| invoiceId* | string | |
Secured By chevron_right expand_more
curl -X POST \
http://localhost:8081/qbdconnect-api/{version}/invoices/{invoiceId}/paymentspost /payments
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/paymentsRequest Body chevron_right expand_more
201 Created chevron_right expand_more
application/json
application/json
post /payouts
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/payoutsRequest Body chevron_right expand_more
Payout Payout
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| dateCreated* | date-only | |
| payoutAmount* | number | |
| invoiceAmount* | number | |
| feeAmount* | number | |
| currency* | string | |
| chargeId* | string | |
| description* | string |
201 Created chevron_right expand_more
application/json
application/json
get /products
lock
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/products200 OK chevron_right expand_more
application/json
application/json
get /products/{productId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| productId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/products/{productId}200 OK chevron_right expand_more
application/json
application/json
post /subscriptions
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/subscriptionsRequest Body chevron_right expand_more
Subscription Subscription
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| subscriptionId | string | The subscription ID from String |
| productId | string | The line-item product ID for the subscription from Stripe |
| priceId | string | The line-item price ID for the subscription from Stripe |
| subscriptionItemId | string | The line-item ID for the subscription from Stripe |
| quantity | integer | The line-item quantity for the number of QBD Connect instances |
| customerId | string | The customer ID of the instance |
| string | The email address of the customer in Stripe | |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
get /subscriptions/{subscriptionId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| subscriptionId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/subscriptions/{subscriptionId}200 OK chevron_right expand_more
Subscription Subscription
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| subscriptionId | string | The subscription ID from String |
| productId | string | The line-item product ID for the subscription from Stripe |
| priceId | string | The line-item price ID for the subscription from Stripe |
| subscriptionItemId | string | The line-item ID for the subscription from Stripe |
| quantity | integer | The line-item quantity for the number of QBD Connect instances |
| customerId | string | The customer ID of the instance |
| string | The email address of the customer in Stripe | |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
put /subscriptions/{subscriptionId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| subscriptionId* | string | |
Secured By chevron_right expand_more
curl -X PUT \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/subscriptions/{subscriptionId}Request Body chevron_right expand_more
Subscription Subscription
application/json
Additional properties: Yes
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| subscriptionId | string | The subscription ID from String |
| productId | string | The line-item product ID for the subscription from Stripe |
| priceId | string | The line-item price ID for the subscription from Stripe |
| subscriptionItemId | string | The line-item ID for the subscription from Stripe |
| quantity | integer | The line-item quantity for the number of QBD Connect instances |
| customerId | string | The customer ID of the instance |
| string | The email address of the customer in Stripe | |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
post /subscriptions/checkout
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/subscriptions/checkoutRequest Body chevron_right expand_more
application/json
application/json
201 Created chevron_right expand_more
application/json
application/json
303 See Other chevron_right expand_more
Headers
| Parameter | Type | Description |
|---|---|---|
| Location* | string |
get /users
lock
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/users200 OK chevron_right expand_more
application/json
application/json
post /users
lock
Secured By chevron_right expand_more
curl -X POST \
-H "Content-type: application/json"
-d @body.json \
http://localhost:8081/qbdconnect-api/{version}/usersRequest Body chevron_right expand_more
application/json
application/json
201 Created chevron_right expand_more
application/json
application/json
get /users/{userId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| userId* | string | |
Secured By chevron_right expand_more
curl -X GET \
http://localhost:8081/qbdconnect-api/{version}/users/{userId}200 OK chevron_right expand_more
application/json
application/json
put /users/{userId}
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| userId* | string | |
Secured By chevron_right expand_more
curl -X PUT \
http://localhost:8081/qbdconnect-api/{version}/users/{userId}200 OK chevron_right expand_more
application/json
application/json
post /users/{userId}/customers
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| userId* | string | |
Secured By chevron_right expand_more
curl -X POST \
http://localhost:8081/qbdconnect-api/{version}/users/{userId}/customersdelete /users/{userId}/customers
lock
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Path | ||
| userId* | string | |
Secured By chevron_right expand_more
curl -X DELETE \
http://localhost:8081/qbdconnect-api/{version}/users/{userId}/customersSecurity Schemes
Security Scheme basic
basic
curl -X <method> \
http://localhost:8081/qbdconnect-api/{version}/<path>Types
Type Customer (object)
Customer
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID for the QBD Connect client which is the same as the user |
| organizationId | string | The organization ID from Insightly |
| gatewayCustomerId | string | The customer ID from Stripe |
| subscriptionId | string | The subscription ID from Stripe |
| name | string | The name of the client |
| address | object | The address of the customer Additional properties: Yes |
| address.street1* | string | |
| address.street2 | string | |
| address.city* | string | |
| address.state* | string | Max. length: 2 |
| address.postalCode* | string | Max. length: 10 |
| primaryBillingContact* | object | The contact that originally signed up for QBD Connect. Additional properties: Yes |
| primaryBillingContact.firstName | string | |
| primaryBillingContact.lastName | string | |
| primaryBillingContact.email* | string | |
| primaryBillingContact.phone | string | |
| qbdInstances | array | The QBD instances of the customer. |
| qbdInstances[] | object | Additional properties: Yes Inherits: Instance |
| qbdInstances[].instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| qbdInstances[].name* | string | The name of the instance |
| qbdInstances[].customerId* | string | The customer ID of the instance |
| qbdInstances[].contact* | object | Additional properties: Yes |
| qbdInstances[].contact.firstName* | string | |
| qbdInstances[].contact.lastName* | string | |
| qbdInstances[].contact.email* | string | |
| qbdInstances[].contact.phone | string | |
| qbdInstances[].qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| qbdInstances[].appUrl | string | The URL that the QBWC application will send requests |
| qbdInstances[].frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| qbdInstances[].fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| qbdInstances[].validated | boolean | Whether the validation of the user with the email address was completed |
| qbdInstances[].sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| qbdInstances[].sla.supportHours* | number | |
| qbdInstances[].sla.transactionLimit* | integer | |
| qbdInstances[].sla.defaultHourlyRate* | number | |
| qbdInstances[].dateCreated | date-only |
Type Instance (object)
Instance
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| instanceId | string | The ID for the QBD Connect instance which is the same as the user |
| name* | string | The name of the instance |
| customerId* | string | The customer ID of the instance |
| contact* | object | Additional properties: Yes |
| contact.firstName* | string | |
| contact.lastName* | string | |
| contact.email* | string | |
| contact.phone | string | |
| qbdPath | string | The file path of the QuickBooks Desktop instance that will be used |
| appUrl | string | The URL that the QBWC application will send requests |
| frequencyInMinutes | integer | The frequency in minutes that will be used to poll the QBD Connect from QBWC Min. value: 1 Default value: 60 |
| fileId | string | The ID for the file that is used to poll the QBD Connect. This should be unique per instance. It is automatically generated by uuid(). |
| validated | boolean | Whether the validation of the user with the email address was completed |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
Type EventLog (object)
EventLog
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| logId | integer | The ID for the event log |
| clientId* | string | The client ID for the event |
| timestamp* | datetime | The date and time when the event occurred |
| user* | string | The user name/ID that is supplied by QBWC for each session |
| action* | string | The action for the event. This is a database action, an API action, or any other event. |
| detail | string | The detail surrounding the event. This provides more insight into the action. |
| result | string | The result of the event. This is a return code or free-from text. |
Type Request (object)
Request
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| requestId* | string | The request ID created for the QBWC request. This should be a UUID supplied by the calling flow. |
| sessionId | string | The session ID for which the request was created. |
| timestamp* | datetime | The date and time when the request was created. The should be supplied by the calling flow. |
Type Session (object)
Session
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| sessionId* | string | The session ID created for the QBWC session. This should be created when the session is started. |
| timestamp* | datetime | The date and time when the session was created. |
| user* | string | The user name/ID that is supplied by QBWC for each session. |
| instanceId* | string | The instance ID for the session. This is a lookup value based upon the userId. While this is a lookup value, it should be stored because the user ID can change for the instance. |
| ipAddress | string | The IP address of the machine that requested the session. |
Type Subscription (object)
Subscription
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| subscriptionId | string | The subscription ID from String |
| productId | string | The line-item product ID for the subscription from Stripe |
| priceId | string | The line-item price ID for the subscription from Stripe |
| subscriptionItemId | string | The line-item ID for the subscription from Stripe |
| quantity | integer | The line-item quantity for the number of QBD Connect instances |
| customerId | string | The customer ID of the instance |
| string | The email address of the customer in Stripe | |
| sla | object | The service level agreement that accompanies the QBD Connect instance Additional properties: Yes |
| sla.supportHours* | number | |
| sla.transactionLimit* | integer | |
| sla.defaultHourlyRate* | number | |
| dateCreated | date-only |
Type Payment (object)
Payment
Inherits: object
Model
| Parameter | Type | Description |
|---|
Type Payout (object)
Payout
Additional properties: Yes
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| dateCreated* | date-only | |
| payoutAmount* | number | |
| invoiceAmount* | number | |
| feeAmount* | number | |
| currency* | string | |
| chargeId* | string | |
| description* | string |