iotoms Docs

Check an invoice's Tally export readiness

GET
/api/v1/integrations/tally/invoices/{invoiceId}/readiness

Lists every Tally mapping this invoice still needs before it can be exported, all at once, so missing masters can be fixed in a single pass.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

invoiceId*string

ID of the sales invoice, from List sales invoices.

Formatuuid

Header Parameters

X-TenantID*string

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

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 GET 'https://beta.iotoms.com/api/v1/integrations/tally/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/readiness' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {}}