Send Facture

The following endpoint is used to send a Facture to a customer from the Hyfin application. The Facture will be sent via text message, email or both based on the notification options set on the customer record.

Note: Any attempts to send the same customer the same Facture within a 5 minute period will be blocked.

Point de terminaison

The following endpoint can be used to send a Facture. 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}/Facture/send

Demande

Champ

Type

Requis

Description

external_id

String

L'identifiant unique Facture du système/source de données.

Sample Request

			
				{
  "external_id": "39772921"
}

Réponse

Champ

Type

Description

success

Boolean

Si le Facture a été envoyé avec succès.

action

String

Will only be returned if `success` is `true`.
One of `updated`

errors

String [ ]

A list of errors. Will only be returned if `success` is `false`.

Sample Response (Successful)

			
				{
  "success": true,
  "action": "updated"
}

Sample Response (Failed)

			
				{
  "success": false,
  "errors": [
    "Duplicate email sent < 300 sec. ago"
  ]
}