iotoms Docs

Create or update a Tally mapping

PUT
/api/v1/integrations/tally/mappings

Sets the Tally master name for one of your records, identified by entityType and localId. The name must match Tally exactly: Tally matches masters by name on import, and a near-miss silently creates a duplicate master instead of failing.

How to use it

  1. Run Check an invoice's Tally export readiness to see which records still need a Tally name.
  2. Send entityType, your localId (item code, customer number, CGST/SGST/IGST or unit code) and the exact Tally master name.
  3. An existing mapping for the same entityType and localId is updated; otherwise a new one is created. Future exports use the name.

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
entityType*string

Kind of record: ITEM (stock item), CUSTOMER (party ledger), TAX_LEDGER (CGST/SGST/IGST duty ledger), SALES_LEDGER, GODOWN or UOM (unit symbol). Required.

Value in"ITEM""CUSTOMER""TAX_LEDGER""SALES_LEDGER""GODOWN""UOM"
localId*string

Your identifier for the record: item code, customer number, tax head (CGST, SGST, IGST) or unit code. Required.

tallyName*string

The master's name exactly as it appears in Tally. Required. A near-miss makes Tally create a duplicate master on import.

tallyGuid?|

Tally's GUID for the master, if known. Optional, stored for reference.

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/mappings' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "entityType": "ITEM",  "localId": "string",  "tallyName": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {}}