Use this when an invoice is ready in your system and you want the customer to get it and pay it, or when it changes.
The following endpoint can be used to add or update an invoice within the Hyfin application. When an invoice is added to Hyfin, a payment request will be automatically generated and the customer will be notified via text message, email or both, as described under Who gets notified below.
If you choose to omit the customer info, a payment link will be provided in the API response. The payment link can be used on a self-checkout system or kiosk.
If the customer is viewing the invoice on their device and the invoice is updated, a message will display letting the customer know the invoice has been updated and the new version of the invoice will automatically be displayed on the customers device.
Each customer is under exactly one notification control, worked out from the site and the customer. It is never stored and cannot be set directly.
On this version:
The following endpoint can be used to add or update an invoice. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.
{
"external_id": "439772921",
"invoice_number": "12345",
"description": "Merchandise Bundle",
"totals": {
"total": 45.99
},
"customer": {
"external_id": "39772634",
"first_name": "John",
"last_name": "Doe",
"mobile_phone": "111-222-3333",
"email": "johndoe@abc.com"
},
"options": {
"tipping_enabled": false
},
"webhook_url": "https://yourcompany.com/webhook"
}
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0",
"id": "60f720d248f143332af022e0",
"link": "https://site.url/KA39T1A45JL",
"missing_customer": false
}