Xero

Entidades, operaciones y acciones

Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector de Xero puede procesar 5 transacciones por segundo, por nodo, y limita las transacciones que superen este límite. Sin embargo, el número de transacciones que puede procesar el conector de Xero también depende de las restricciones impuestas por la instancia de Xero. Para obtener más información, consulta los límites de frecuencia de la API de Xero. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Acciones

En esta sección se enumeran algunas de las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción DownloadAttachment

Esta acción descarga un archivo adjunto.

Parámetros de entrada de la acción DownloadAttachment

Parámetros de salida de la acción DownloadAttachment

Esta acción devuelve el estado 200 (OK) si la descarga se realiza correctamente.

Para saber cómo configurar la acción DownloadAttachment, consulta los ejemplos de acciones.

Acción UploadAttachment

Esta acción te permite subir un archivo adjunto.

Parámetros de entrada de la acción UploadAttachment

Parámetros de salida de la acción UploadAttachment

Esta acción devuelve el estado 200 (OK) si la subida del objeto se realiza correctamente.

Para saber cómo configurar la acción UploadAttachment, consulta los ejemplos de acciones.

Acción ListAttachment

Esta acción te permite enumerar todos los archivos adjuntos de una tabla.

Parámetros de entrada de la acción ListAttachment

Parámetros de salida de la acción ListAttachment

Esta acción devuelve el estado 200 (OK) si la eliminación se realiza correctamente.

Para saber cómo configurar la acción ListAttachment, consulta los ejemplos de acciones.

Acción SendInvoiceMail

Esta acción te permite enviar correos a un facturador.

Parámetros de entrada de la acción SendInvoiceMail

Parámetros de salida de la acción SendInvoiceMail

Esta acción devuelve el estado 200 (OK) si la operación de movimiento se realiza correctamente.

Para saber cómo configurar la acción SendInvoiceMail, consulta los ejemplos de acciones.

Acción UploadFile

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadFile

Parámetros de salida de la acción UploadFile

Esta acción devuelve el estado 200 (OK) si la subida del objeto se realiza correctamente.

Para saber cómo configurar la acción UploadFile, consulta los ejemplos de acciones.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: descargar un archivo adjunto

En este ejemplo se descarga un archivo adjunto.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DownloadAttachment y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DownloadAttachment tendrá un valor similar al siguiente:

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

Ejemplo: subir un archivo adjunto

En este ejemplo se sube un archivo adjunto.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UploadAttachment y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UploadAttachment tendrá un valor similar al siguiente:

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

Ejemplo: mostrar archivos adjuntos

En este ejemplo se enumeran los archivos adjuntos de la tabla especificada.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción ListAttachment y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea ListAttachment tendrá un valor similar al siguiente:

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

Ejemplo: enviar un correo de factura

En este ejemplo se envía un correo de la factura especificada.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción SendInvoiceMail y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea SendInvoiceMail tendrá un valor similar al siguiente:

[{
"Success": "true"
}]

Ejemplo: subir un archivo

En este ejemplo se sube un archivo.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UploadFile y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UploadFile tendrá un valor similar al siguiente:

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

Ejemplos de operaciones de entidades

En esta sección se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: listar todos los registros

En este ejemplo se enumeran todos los registros de la entidad Accounts.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Accounts en la lista Entity.
3. Selecciona la operación List y, a continuación, haz clic en Hecho.
4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el conjunto de resultados especificando una cláusula de filtro. Por ejemplo, City='Bangalore'. También puede especificar varias condiciones de filtro mediante operadores lógicos. Por ejemplo, City='Bangalore' and region='asia-south2'.

Ejemplo: Obtener una factura

En este ejemplo se obtiene una factura con el ID especificado de la entidad Invoices.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Invoices en la lista Entity.
3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca 1|016a64c7-be0b-45a2-acae-13057fdf1566 en el campo Valor predeterminado.

   En este caso, 1|016a64c7-be0b-45a2-acae-13057fdf1566 es un valor de clave principal de la entidad Invoices.

Ejemplo: Crear una factura

En este ejemplo, se crea una factura en la entidad Invoices.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Invoices en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

   Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: actualizar un registro

En este ejemplo se actualiza un registro de la entidad AssetTypes.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona AssetTypes en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "BookDepreciationSetting_DepreciationRate": 10.0
   }

5. Haga clic en entityId y, a continuación, introduzca f8d43548-25b0-4cc3-8f59-d97106974fe8 en el campo Valor predeterminado.

   Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: eliminar un archivo

En este ejemplo se elimina el archivo con el ID especificado de la entidad Files.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Files en la lista Entity.
3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 421c82f0-38fb-4074-a679-63b04c0d8832 en el campo Valor predeterminado.