iotoms Docs

Start connecting an accounting system

POST
/api/v1/integrations/accounting/connectors/{provider}/connect

Begins the sign-in flow for an accounting provider and returns the provider's authorization URL. Redirect the browser there; the provider sends the user back once access is granted.

How to use it

  1. Pick a connector from List accounting connectors. Only Zoho Books supports this sign-in today; connectors that are not available, and Tally Prime (which uses a file export instead), are rejected.
  2. Call this endpoint and redirect the user's browser to authorizationUrl within 10 minutes.
  3. After the user grants access, the provider returns to the dashboard's integration page with status=connected, or status=error and a reason.
  4. Confirm the result with Get accounting connector details.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

provider*string

Accounting connector slug, for example zoho-books (from List accounting connectors).

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 provider sign-in URL to redirect the browser to, and its expiry.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/integrations/accounting/connectors/string/connect'
Example Response
{  "status": "string",  "message": "string",  "data": {    "authorizationUrl": "string",    "state": "string",    "expiresAt": "2019-08-24T14:15:22Z"  }}