iotoms Docs

Mark an invoice as sent

POST
/api/v1/sales/invoices/{id}/send

Records that the invoice was sent to the customer, to the address in to or, if omitted, the customer's email on file. Fails if no contact is available.

How to use it

  1. Find the invoice ID with List sales invoices.
  2. Deliver the invoice to the customer yourself; this call only records that it was sent.
  3. Send to with the address used, or omit it to record the customer's email on file; the call fails if neither exists.
  4. sentAt and sentTo on the invoice are updated; calling again overwrites them with the latest send.

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.

Request Body

application/json
  1. body
to?|

Address the invoice was sent to. Omit to use the customer's email on file; the call fails if there is none.

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 POST 'https://beta.iotoms.com/api/v1/sales/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/send' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{}'
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      }    ]  }}