Exécuter

Exécute une tâche de capture de factures. Plusieurs fichiers peuvent être spécifiés dans la requête.

Vous pouvez utiliser n’importe laquelle de vos applications pour traiter le document. Pour changer d’application de traitement des documents, utilisez l’en-tête Authentication avec l’identifiant et le jeton de l’application appropriée lors de l’exécution de la tâche.

ABBYY FlexiCapture for Invoices Cloud traite des factures provenant de nombreux pays et prend en charge un large éventail de langues. Pour plus d’informations, voir la section Spécification. Chaque application applique un jeu prédéfini de règles de traitement, de mots-clés et d’autres paramètres spécifiques à chaque pays une fois qu’elle a identifié le pays de l’unité commerciale facturée.

Indiquez correctement la région pour les factures que vous prévoyez de recevoir. L’utilisation de la langue appropriée améliore considérablement la qualité de reconnaissance.

​

Requête HTTP

POST https://api-{location-id}.flexicapture.com/v2/task/capture/invoices

Remplacez {location-id} par votre région prise en charge.

​

Corps de la requête

Le corps de la requête contient des données de la structure suivante :

{
  "files": [
    {
      "id": "string",
      "token": "string"
    }
  ],
  "properties": {
    "region": "US",
    "export_format": "Xls",
    "verification_type": "NoVerification"
  }
}

Champ	Type	Description
files[]	object	Obligatoire. Liste des fichiers à traiter.
files[].id	string	Obligatoire. ID du fichier renvoyé dans la réponse de la méthode file.Upload.
files[].token	string	Obligatoire. Jeton d’accès au fichier renvoyé dans la réponse de la méthode file.Upload.
region	string	Obligatoire. Région de la facture. Régions prises en charge : US : USA, AU : Australie, EU : pays de l’Union européenne, CA : Canada.
export_format	string	Obligatoire. Format du fichier de sortie. Les formats disponibles sont répertoriés dans la section Specification.
verification_type	string	Obligatoire. Type de vérification. Types disponibles : NoVerification — les documents sont toujours traités sans vérification ; Troubleshooting — les documents sont soumis à une vérification s’il y a des caractères incertains ou des erreurs ; UserVerification — les documents sont toujours soumis à une vérification.

​

Réponse

En cas de réussite, le corps de la réponse contient une instance de CaptureTask.

{
  "id": "string",
  "number": "string",
  "verification_id": "string",
  "type": "ic",
  "properties": {
    "property_name": "string"
  },
  "email": "string",
  "account": "string",
  "application": "string",
  "created": "YYYY-MM-DDT00:00:00.000",
  "started": "YYYY-MM-DDT00:00:00.000",
  "action_required": "YYYY-MM-DDT00:00:00.000",
  "billed": "YYYY-MM-DDT00:00:00.000",
  "delivered": "YYYY-MM-DDT00:00:00.000",
  "deleted": "YYYY-MM-DDT00:00:00.000",
  "progress": 0,
  "status": "Submitted",
  "is_deleted": true,
  "is_demo": true,
  "is_billed": true,
  "documents_count": 0,
  "pages_count": 0,
  "documents": [
    {
      "files": {},
      "data": {},
      "is_moved": true
    }
  ]
}

​

CaptureTask

Champ	Type	Description
id	string	Obligatoire. ID unique de la tâche.
number	string	Obligatoire. Numéro de tâche.
verification_id	string	Obligatoire. Cet ID est utilisé pour ouvrir la page de vérification, à savoir https://{cloud-host}/verification/{verification_id}.
type	string	Obligatoire. Type de tâche. Types pris en charge : ic : capture de factures, dc : capture de documents.
properties	object	Facultatif. Paramètres de traitement ou paramètres d’enregistrement personnalisés. Nombre illimité de paires nom-valeur.
email	string	Obligatoire. Adresse e-mail utilisée pour créer la tâche.
account	string	Obligatoire. ID du compte utilisé pour créer la tâche.
application	string	Obligatoire. ID d’application utilisé pour créer la tâche.
created	string ($date-time)	Obligatoire. Date de création de la tâche.
started	string ($date-time)	Facultatif. Date de début de la tâche.
action_required	string ($date-time)	Facultatif. Date à laquelle la tâche est passée au statut WaitForAction.
billed	string ($date-time)	Facultatif. Date de facturation de la tâche.
delivered	string ($date-time)	Facultatif. Date d’achèvement de la tâche.
deleted	string ($date-time)	Facultatif. Date de suppression des données.
progress	number ($double)	Obligatoire. Progression globale de la tâche.
status	string	Obligatoire. Statut d’achèvement de la tâche. Statuts pris en charge : Submitted, InProgress, WaitForAction, Done, Failed, Canceled.
is_deleted	booléen	Obligatoire. Indique si les données de la tâche ont été supprimées.
is_demo	booléen	Obligatoire. Indique si la tâche a été créée dans l’application de démonstration.
is_billed	booléen	Obligatoire. Indique si la tâche a été facturée.
documents_count	integer ($int32)	Facultatif. Nombre de documents dans la tâche.
pages_count	integer ($int32)	Facultatif. Nombre de pages dans la tâche.
documents[]	object (DataCaptureDocumentModel)	Obligatoire. Documents de la tâche.

​

DataCaptureDocumentModel

Champ	Type	Description
files	object (DataCaptureFileLinkModel)	Obligatoire. Liste des fichiers liés au document.
data	string	Facultatif. Données du document.
is_moved	booléen	Obligatoire. Indique si le document a été retiré lors de la vérification ou non.

​

DataCaptureFileLinkModel

Champ	Type	Description
id	string	Obligatoire. ID du fichier.
token	string	Obligatoire. Jeton d’accès au fichier.
name	string	Obligatoire. Nom du fichier.