Send Facture

The following endpoint is used to send a Facture to a customer from the Process Level 3 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}/invoice/send

Demande

Champ

Type

Description

externalId

String

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

forceSend

Boolean

Remplace le statut En attente et les options de notification de la facture afin de forcer l'envoi. Ce drapeau ne contourne pas le fait qu'un client ait toutes ses options de notification désactivées.

Sample Request

			
{
  "externalId": "39772921"
}

Réponse

Champ

Type

Description

success

Boolean

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

action

String

Sera retourné seulement si success est true.
One of updated

errors

String [ ]

Une liste d'erreurs. Ne sera retournée que si success est false.

Sample Response (Successful)

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

Sample Response (Failed)

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