iotoms Docs

Get a sales invoice

GET
/api/v1/sales/invoices/{id}

Returns one sales invoice by id, with its lines, the per-line GST split and the tax position frozen at issue, plus its ledger posting state, when and to whom it was last sent, and how many reprints were recorded.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

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 the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?

The sales invoice with its lines and tax snapshot.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/sales/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "invoiceNumber": "string",    "seriesCode": "string",    "salesOrderId": "9bd8f312-a044-4003-9f73-706a82f71a8f",    "salesOrderNumber": "string",    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",    "customerStoreId": 0,    "customerStoreName": "string",    "customerNumber": "string",    "customerNameSnapshot": "string",    "storeId": 0,    "status": "DRAFT",    "invoiceDate": "2019-08-24",    "dueDate": "2019-08-24",    "currency": "string",    "target": "OWN_BOOKS",    "ledgerState": "NOT_APPLICABLE",    "targetRef": "string",    "targetLastError": "string",    "targetLastAttemptAt": "2019-08-24T14:15:22Z",    "sellerGstin": "string",    "sellerStateCode": "string",    "buyerGstin": "string",    "buyerStateCode": "string",    "placeOfSupply": "string",    "isInterstate": true,    "gstIncomplete": true,    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "grandTotal": 0,    "directReason": "string",    "notes": "string",    "issuedBy": "string",    "issuedAt": "2019-08-24T14:15:22Z",    "sentAt": "2019-08-24T14:15:22Z",    "sentTo": "string",    "reprintCount": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lines": [      {        "id": 0,        "itemId": "string",        "itemName": "string",        "hsnCode": "string",        "uomCode": "string",        "uqcCode": "string",        "quantity": 0,        "unitPrice": 0,        "discountAmount": 0,        "taxableValue": 0,        "cgstRate": 0,        "cgstAmount": 0,        "sgstRate": 0,        "sgstAmount": 0,        "igstRate": 0,        "igstAmount": 0,        "cessAmount": 0,        "taxAmount": 0,        "lineTotal": 0,        "lineNumber": 0      }    ]  }}