<a href="https://www.openledger.com/contact" target="_blank">We are iterating quickly on our docs, please reach out if you need latest and greatest! 🔥🚀</a>
Get a demoPostman Collection
GuideReact SDKAPI Reference
GuideReact SDKAPI Reference
  • API Overview
    • Reference
    • Authentication
    • Rate Limits
    • Pagination
We are iterating quickly on our docs, please reach out if you need latest and greatest! 🔥🚀
LogoLogo
Get a demoPostman Collection
API OverviewAPI EndpointsQbo Contacts

GET
/v1/qbo/contacts
GET
/v1/qbo/contacts
1curl -G https://api-staging.openledger.com/v1/qbo/contacts \
2     -H "Authorization: Bearer <token>" \
3     -d entityId=entityId
Try it
200Retrieved
1{
2  "success": true,
3  "data": [
4    {
5      "id": "string",
6      "name": "string",
7      "companyName": "string",
8      "email": "string",
9      "phone": "string",
10      "addresses": [
11        "string"
12      ],
13      "isCustomer": true,
14      "isSupplier": true,
15      "isVendor": true,
16      "status": "string",
17      "customerId": "string",
18      "customer": {
19        "id": "string",
20        "externalId": "string",
21        "individualName": "string",
22        "entityName": "string",
23        "email": "string",
24        "exists": true
25      },
26      "vendorId": "string",
27      "vendor": {
28        "id": "string",
29        "name": "string",
30        "externalId": "string",
31        "description": "string",
32        "exists": true
33      }
34    }
35  ]
36}
Was this page helpful?
Previous

Get QBO invoices (raw data)

Next
Built with
Retrieve QuickBooks Online contacts (customers and vendors) with optional transaction relationships. Returns internal customer/vendor IDs when they exist in the system.
Get QBO contacts

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query Parameters

entityIdstringRequired
Entity ID
contactTypeenumOptional
Filter by contact type
Allowed values:
includeTransactionsbooleanOptional
Include transaction relationships
includeInvoicesbooleanOptional
Include invoice relationships
searchstringOptional
Search contacts by name

Response

QBO contacts data
successboolean or null
datalist of objects or null

Errors

Include transaction relationships
Include invoice relationships
Search contacts by name
QBO contacts data

Get QBO invoices (raw data)

Retrieve QuickBooks Online contacts (customers and vendors) with optional transaction relationships. Returns internal customer/vendor IDs when they exist in the system.