latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Connections
Gets a list of all team's accounting connections.
get/connections
Query parameters
businessNamestring
Unique business name identifier.
businessUuidstring
Unique business identifier.
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'shopify' | 'square' | 'plaid' | 'myob' | 'zohoBooks' | 'byod'
Name of accounting service provider.
institutionNamestring
Name of banking service.
connectionIdstring
Unique connection identifier.
connectionUuidstring
Unique connection identifier.
status'pending' | 'active' | 'disconnected' | 'expired' | 'invalid'
The status of a connection.
limitnumber
offsetnumber
serviceAccountRef.idstring
serviceAccountRef.entityRef.idstring
Response
Example response
{
"meta": {
"count": 1
},
"data": [
{
"connectionUuid": "CON-e66400c1-4d2f-4683-9bea-275799943695",
"firstRecordDate": "2020-12-25T01:02:03Z",
"serviceName": "xero",
"description": "TD Bank",
"status": "active",
"createdAt": "2020-12-25T01:02:03Z",
"updatedAt": "2020-12-25T01:02:03Z",
"disconnectReason": "disconnectedByCustomer",
"institution": {
"name": "Citizens bank",
"logo": "https://serverlogo.url"
},
"isMockData": true,
"serviceAccountRef": {
"id": "12345",
"entityRef": {
"id": "100"
}
},
"businessUuid": "BIZ-26bc4510-8c6f-4688-996d-e87acf3e0b3f",
"businessName": "Railz",
"connectionId": "CON-e66400c1-4d2f-4683-9bea-275799943695"
}
]
}