Xero

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

  Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
  • List
  • Get
  • Create
  • Update
  • Delete

  Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Xero peut traiter cinq transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Toutefois, le nombre de transactions que ce connecteur peut traiter dépend également des contraintes imposées par l'instance Xero. Pour en savoir plus, consultez les limites de débit de l'API Xero. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Actions

Cette section liste certaines des actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action DownloadAttachment

Cette action télécharge une pièce jointe.

Paramètres d'entrée de l'action DownloadAttachment

Paramètres de sortie de l'action DownloadAttachment

Si le téléchargement aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action DownloadAttachment, consultez Exemples d'actions.

Action UploadAttachment

Cette action vous permet d'importer une pièce jointe.

Paramètres d'entrée de l'action UploadAttachment

Paramètres de sortie de l'action UploadAttachment

Si l'importation de l'objet aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action UploadAttachment, consultez Exemples d'actions.

Action ListAttachment

Cette action vous permet de lister toutes les pièces jointes d'une table.

Paramètres d'entrée de l'action ListAttachment

Paramètres de sortie de l'action ListAttachment

Si la suppression aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action ListAttachment, consultez Exemples d'actions.

Action SendInvoiceMail

Cette action vous permet d'envoyer des e-mails à un émetteur de facture.

Paramètres d'entrée de l'action SendInvoiceMail

Paramètres de sortie de l'action SendInvoiceMail

Si l'opération de déplacement aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action SendInvoiceMail, consultez Exemples d'actions.

Action UploadFile

Cette action permet d'importer un fichier.

Paramètres d'entrée de l'action UploadFile

Paramètres de sortie de l'action UploadFile

Si l'importation de l'objet aboutit, cette action renvoie l'état 200 (OK).

Pour savoir comment configurer l'action UploadFile, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Télécharger une pièce jointe

Cet exemple télécharge une pièce jointe.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DownloadAttachment, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Filename": "Xero_Test.txt",
   "Table": "Contacts",
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DownloadAttachment aura une valeur semblable à la suivante :

[{
"Success": "True",
"Content": "Test content"
}]

Exemple : Importer une pièce jointe

Cet exemple importe une pièce jointe.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UploadAttachment, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Filename": "Xero_Test.txt",
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
   "ContentType": "txt",
   "Table": "Contacts",
   "Content": "Test content upload attachment"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UploadAttachment aura une valeur semblable à la suivante :

[{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

Exemple : Lister des pièces jointes

Cet exemple liste les pièces jointes de la table spécifiée.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action ListAttachment, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
   "Table": "Contacts"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche ListAttachment aura une valeur semblable à la suivante :

[{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

Exemple : Envoyer une facture par e-mail

Cet exemple envoie un e-mail pour la facture spécifiée.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action SendInvoiceMail, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche SendInvoiceMail aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Importer un fichier

Cet exemple importe un fichier.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UploadFile, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Name": "Sample1.txt",
   "Content": "This is a sample file"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UploadFile aura une valeur semblable à la suivante :

[{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister tous les enregistrements

Cet exemple liste tous les enregistrements de l'entité Accounts.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Accounts dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Par exemple, City='Bangalore'. Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques (exemple : City='Bangalore' and region='asia-south2').

Exemple : Récupérer une facture

Cet exemple récupère une facture avec l'ID spécifié à partir de l'entité Invoices.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Invoices dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 1|016a64c7-be0b-45a2-acae-13057fdf1566 dans le champ Valeur par défaut.

   Ici, 1|016a64c7-be0b-45a2-acae-13057fdf1566 est une valeur de clé primaire dans l'entité Invoices.

Exemple : Créer une facture

Cet exemple crée une facture dans l'entité Invoices.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Invoices dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Type": "ACCPAY",
   "ContactName": "ContactName1",
   "LineItem_Description": "LineItemDescription"
   }

   Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

   {
   "Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
   }

Exemple : Mettre à jour un enregistrement

Cet exemple met à jour un enregistrement dans l'entité AssetTypes.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez AssetTypes dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "BookDepreciationSetting_DepreciationRate": 10.0
   }

5. Cliquez sur entityId, puis saisissez f8d43548-25b0-4cc3-8f59-d97106974fe8 dans le champ Valeur par défaut.

   Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

   {
   "AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
   }

Exemple : Supprimer un fichier

Cet exemple supprime le fichier avec l'ID spécifié de l'entité Files.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Files dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 421c82f0-38fb-4074-a679-63b04c0d8832 dans le champ Valeur par défaut.