iotoms Docs

Save Tally settings

PUT
/api/v1/integrations/tally/config

Saves the Tally company name, sales ledger name and optional godown and voucher type. Tally has no online sign-in step, so saving these settings is what connects Tally for your account.

How to use it

  1. Send the Tally company name and sales ledger name exactly as in Tally, plus an optional godown and voucher type (defaults to Sales).
  2. The settings are saved and Tally is marked connected for the account; there is no separate sign-in step.
  3. Invoices can now be exported once their masters are mapped; see Check an invoice's Tally export readiness.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Request Body

application/json
  1. body
companyName*string

Name of the company in Tally that vouchers are imported into, exactly as in Tally. Required.

salesLedgerName*string

Name of the sales ledger in Tally that every voucher credits. Required.

godownName?|

Name of the Tally godown stock is issued from. Optional; set it if you use godowns in Tally.

voucherTypeName?|

Tally voucher type used for exported invoices. Optional; defaults to Sales.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?|

Endpoint-specific payload: null when there is nothing to return (e.g. after removing a unit); for credit note PDFs it holds returnId, creditNoteNumber, templateId, templateVersion, pdfUrl and generatedAt.

Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/integrations/tally/config' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "companyName": "string",  "salesLedgerName": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {}}