Xero

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene mostrata come entità, operazioni e azioni.

• Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio connesso. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore del file server, le cartelle sono le entità e in un connettore del sistema di messaggistica, le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

• Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Limitazioni di sistema

Il connettore Xero può elaborare 5 transazioni al secondo, per nodo, e limita qualsiasi transazione oltre questo limite. Tuttavia, il numero di transazioni che il connettore Xero può elaborare dipende anche dai vincoli imposti dall'istanza Xero. Per saperne di più, consulta Limiti di frequenza dell'API Xero. Per impostazione predefinita, Integration Connectors alloca due nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Azioni

Questa sezione elenca alcune delle azioni supportate dal connettore. Per capire come configurare le azioni, consulta Esempi di azioni.

Azione DownloadAttachment

Questa azione scarica un allegato.

Parametri di input dell'azione DownloadAttachment

Parametri di output dell'azione DownloadAttachment

Questa azione restituisce lo stato 200 (OK) se il download è riuscito.

Per capire come configurare l'azione DownloadAttachment, consulta Esempi di azioni.

Azione UploadAttachment

Questa azione ti consente di caricare un allegato.

Parametri di input dell'azione UploadAttachment

Parametri di output dell'azione UploadAttachment

Questa azione restituisce lo stato 200 (OK) se il caricamento dell'oggetto è riuscito.

Per capire come configurare l'azione UploadAttachment, consulta Esempi di azioni.

ListAttachment Action

Questa azione ti consente di elencare tutti gli allegati di una tabella.

Parametri di input dell'azione ListAttachment

Parametri di output dell'azione ListAttachment

Questa azione restituisce lo stato 200 (OK) se l'eliminazione ha esito positivo.

Per capire come configurare l'azione ListAttachment, consulta Esempi di azioni.

Azione SendInvoiceMail

Questa azione ti consente di inviare email a un emittente di fatture.

Parametri di input dell'azione SendInvoiceMail

Parametri di output dell'azione SendInvoiceMail

Questa azione restituisce lo stato 200 (OK) se l'operazione di spostamento ha esito positivo.

Per capire come configurare l'azione SendInvoiceMail, consulta Esempi di azioni.

Azione UploadFile

Questa azione ti consente di caricare un file.

Parametri di input dell'azione UploadFile

Parametri di output dell'azione UploadFile

Questa azione restituisce lo stato 200 (OK) se il caricamento dell'oggetto è riuscito.

Per capire come configurare l'azione UploadFile, consulta Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: scaricare un allegato

Questo esempio scarica un allegato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DownloadAttachment, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro DownloadAttachment della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: caricare un allegato

Questo esempio carica un allegato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione UploadAttachment, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività UploadAttachment avrà un valore simile al seguente:

[{
"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
}]

Esempio: elenco degli allegati

Questo esempio elenca gli allegati della tabella specificata.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione ListAttachment, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività ListAttachment avrà un valore simile al seguente:

[{
"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"
}]

Esempio: invio di un'email con fattura

Questo esempio invia un'email per la fattura specificata.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione SendInvoiceMail, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro SendInvoiceMail della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: carica un file

Questo esempio carica un file.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione UploadFile, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività UploadFile avrà un valore simile al seguente:

[{
"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"
}]

Esempi di operazioni sulle entità

Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elenca tutti i record

Questo esempio elenca tutti i record nell'entità Accounts.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Accounts dall'elenco Entity.
3. Seleziona l'operazione List, quindi fai clic su Fine.
4. (Facoltativo) Nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Ad esempio: City='Bangalore'. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici. Ad esempio, City='Bangalore' and region='asia-south2'.

Esempio: ricezione di una fattura

Questo esempio recupera una fattura con l'ID specificato dall'entità Invoices.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Invoices dall'elenco Entity.
3. Seleziona l'operazione Get, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e poi inserisci 1|016a64c7-be0b-45a2-acae-13057fdf1566 nel campo Valore predefinito.

   In questo caso, 1|016a64c7-be0b-45a2-acae-13057fdf1566 è un valore della chiave primaria nell'entità Invoices.

Esempio: creare una fattura

Questo esempio crea una fattura nell'entità Invoices.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Invoices dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

Esempio: aggiorna un record

Questo esempio aggiorna un record nell'entità AssetTypes.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona AssetTypes dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "BookDepreciationSetting_DepreciationRate": 10.0
   }

5. Fai clic su entityId, quindi inserisci f8d43548-25b0-4cc3-8f59-d97106974fe8 nel campo Valore predefinito.

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

Esempio: eliminare un file

Questo esempio elimina il file con l'ID specificato dall'entità Files.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Files dall'elenco Entity.
3. Seleziona l'operazione Delete, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 421c82f0-38fb-4074-a679-63b04c0d8832 nel campo Valore predefinito.