Send invoice

Use this to send, or re-send, an invoice that already exists, for example after the customer asks for the link again.

The following endpoint is used to send an invoice to a customer from the Hyfin application. The invoice will be sent via text message, email or both, to the recipients set on the invoice, or else to the customer's contacts that may be notified.




Endpoint

The following endpoint can be used to send an invoice. You must replace the {base_url} variable and replace the {site_id} variable with the site id that was provided when the site was created.

POST
{base_url}/api/v4/site/{site_id}/invoice/send
Request
Field
Type
Description
externalId
String
Your own id for this invoice, from your software.
forceSend
Boolean
Send now even if the invoice is held waiting for your accounting system, such as for taxes. If the invoice's recipients leave every channel off, this send ignores them and goes to the customer's contacts instead; the recipients themselves are not changed. Contacts marked do not contact are still skipped, and nothing is sent when every channel is off for the customer under customer control. An invoice put On Hold by the merchant is released and sent by this call with or without this flag.
Sample Request
			
{
  "externalId": "39772921"
}


		
Response
Field
Type
Description
success
Boolean
Whether the invoice was sent successfully.
errors
String [ ]
A list of errors. Will only be returned if success is false.
			
{
  "success": true
}


		

Related