iotoms Docs

Get accounting connector details

GET
/api/v1/integrations/accounting/connectors/{provider}

Returns the connection status, sync settings and field mapping for one accounting connector, identified by its provider slug (for example zoho-books).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

provider*string

Connector slug, e.g. zoho-books

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?

The connector's connection status, sync settings and field mapping.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/integrations/accounting/connectors/string'
Example Response
{  "status": "string",  "message": "string",  "data": {    "provider": "string",    "displayName": "string",    "isAvailable": true,    "connectionStatus": "NOT_CONNECTED",    "orgId": "string",    "orgName": "string",    "connectedByEmail": "string",    "connectedByName": "string",    "connectedSince": "2019-08-24T14:15:22Z",    "scope": "string",    "syncSettings": {      "autoSyncInvoices": true,      "autoSyncCustomers": true,      "syncFrequency": "MANUAL",      "fieldMapping": {        "property1": {},        "property2": {}      }    },    "lastSyncAt": "2019-08-24T14:15:22Z",    "lastSyncStatus": "PENDING"  }}