Invoice API

The Invoice API will allow you to create and manage itemized invoices for your customers within your existing website or application. Functions include create, retrieve, and updates for invoice objects.

An invoice created through the Invoice API can be processed for payment using the invoiceNumber by linking it to a HelcimPay checkout session, or through the Payment API using the Purchase, Preauth or Verify payment endpoints.

Invoice API functionality

The Invoice API allows you to create and manage invoices that can be linked to customers and payments in the Helcim system.

Invoices

An invoice object can be created as a record of an intended or completed payment and is how you create a more detailed record of payments with more information than a transaction receipt.

An invoice stores a number of core details, including:

Unique invoiceId, invoiceNumber, and token values, that can be used to retrieve and update invoices, or link them to payments through HelcimPay.js or the Payment API.
Information on the amount due on the invoice, including any tipAmount or depositAmount.
Information on the status and type of invoice, as well as any customerId if the invoice is linked to a customer object.
An array of lineItems objects used to create an itemized invoice of products and services.
Sub-objects that provide information on custom order fields, billing and shipping address details, as well as pickup details, tax information, and discounts applied to the invoice.

Invoice online view

All invoice objects contain an invoice token that can be used to render an online view of your invoice.

If the invoice is due for payment then the customer can process a payment through the Helcim implementation of HelcimPay.js, or if the invoice is paid it serves as a visible record of the payment.

Render an invoices online view

Invoice API endpoints

Create, retrieve, and update invoice objects using the following endpoints.