Render an Invoices Online View

Invoices created in the Helcim system each have a unique token value contained in the invoice object. This token can be used to render an online view of the invoice, by passing the token as a URL parameter for your Helcim sub-domain.

The invoice online view URL can be linked to directly, displaying the invoice to your customers as if you had selected the "Actions > View Online" option in the invoice edit view of your Helcim account.

The online view allows you to display DUE invoices and collect payment through the Helcim implementation of HelcimPay.js, or to display PAID invoices as a record of payment that can be downloaded by your customers.

Confirming your Helcim Subdomain URL

Your subdomain URL is generated automatically when registering for a Helcim account. The subdomain will be your business DBA with ".myhelcim.com" following it.

It is displayed in various locations when logged in to your Helcim account and is shown in the online view for any of your Helcim invoices. You can confirm your subdomain URL by selecting any of your existing Helcim invoices and clicking Actions > View Online.

Example: https://your-business-dba.myhelcim.com/

Retrieving your Invoice token Value

The invoice token value is a property of the invoice object in the Helcim system and is returned when creating an invoice through Create invoice endpoint, or when retrieving an invoice through the Get invoice and Get invoices endpoints.

// Example of invoice object
{
  "invoiceId": 39547547,
  "invoiceNumber": "INV1466",
  "token": "4b9f99eb802b15a67f8153", // Invoice token value that should be combined with your subdomain
  "tipAmount": 0,
  "depositAmount": 0,
  "notes": "",
  "dateCreated": "2024-07-15 14:07:16",
  "dateUpdated": "2024-07-15 14:07:16",
  "datePaid": "0000-00-00 00:00:00",
  "dateIssued": "2024-07-15 14:07:16",
  "status": "DUE",
  "customerId": 0,
  "amount": 50,
  "currency": "CAD",
  "type": "INVOICE",
  "convenienceFee": 0,
  "orderFields": [],
  "billingAddress": [],
  "shipping": {
    "amount": 0,
    "details": "",
    "address": []
  },
  "pickup": [],
  "tax": {
    "amount": 0,
    "details": ""
  },
  "discounts": {
    "amount": 0,
    "details": ""
  },
  "lineItems": [
    {
      "sku": "ITM1434",
      "description": "Red Hat",
      "quantity": 1,
      "price": 50,
      "total": 50,
      "taxAmount": 0,
      "discountAmount": 0
    }
  ]
}

Combining your Subdomain and Invoice token Value

When the subdomain, order path, and token values are concatenated together, the online view of an invoice can be linked to from your existing system or within an email to your customer that is generated through a third-party email provider.

Example: https://your-business-dba.myhelcim.com/order/?token=1a3c3fc54657656f2997fd