Detalles de la Conexión Xero¶

Introducción¶

Versión del conector

Esta documentación se basa en la versión 21.0.8257 del conector.

Empezando¶

Compatibilidad con la versión Xero

Jitterbit Connector for Xero modela objetos de Xero Accounting, Australian Payroll, Files, Assets y Projects como una base de datos relacional.

Establecer una Conexión¶

Conexión a una API de Xero¶

El conector es compatible con las siguientes APIs de Xero:

• API de contabilidad: establece el Schema propiedad de conexión a ACCOUNTING
• API de nómina australiana: establezca Schema propiedad de conexión a PAYROLLAUS
• API de archivos: establezca Schema propiedad de conexión a FILES
• API de activos fijos: establezca Schema propiedad de conexión a ASSETS
• API de proyectos: establezca Schema propiedad de conexión a PROJECTS

También se recomienda que establezca Tenant propiedad, que puede ser el nombre o ID de una organización Xero. Xero le permite autorizar el conector para acceder a varias organizaciones. De manera predeterminada, el conector elegirá el primero, que puede no ser el que espera si el conector tiene acceso a organizaciones adicionales.

Si necesita confirmar a qué organizaciones tiene acceso el conector, puede conectarse sin Tenant y lea la vista de inquilinos. Esto proporcionará tanto el ID como el nombre de cada organización conectada. Debe usar la identificación para configurar Tenant propiedad cuando sea posible ya que varias organizaciones pueden tener el mismo nombre.

Autenticación a Xero¶

Todas las conexiones a Xero se autentican mediante OAuth. El conector admite el uso de aplicaciones PKCE y aplicaciones OAuth. Para las aplicaciones de escritorio, la aplicación predeterminada del conector es la forma más sencilla de autenticación. El único requisito adicional es establecer InitiateOAuth a GETANDREFRESH.

Cuando se inicie el conector, se abrirá un navegador y Xero solicitará su información de inicio de sesión. El conector utilizará las credenciales que proporcione para acceder a sus datos de Xero. Estas credenciales se guardarán y actualizarán automáticamente según sea necesario.

Uso de la Autenticación OAuth¶

Xero usa el estándar de autenticación OAuth. El conector facilita esto de varias maneras, como se describe a continuación.

Credenciales Integradas¶

Consulte Credenciales integradas para conectarse con las credenciales incrustadas del conector y omitir la creación de una aplicación OAuth personalizada.

Credenciales Personalizadas¶

Consulte Crear una aplicación OAuth personalizada para registrar su aplicación con Xero. Esto solo se recomienda si necesita personalizar la pantalla de autorización, como proporcionar su propia URL de devolución de llamada o marca.

Credenciales Integradas¶

Autenticación de Escritorio con la Aplicación OAuth Integrada¶

Puede conectarse sin configurar ninguna propiedad de conexión para sus credenciales de usuario.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth.

1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
2. Obtiene un nuevo token de acceso cuando caduca el antiguo.
3. Guarda los valores de OAuth en OAuthSettingsLocation para que se conserven entre las conexiones.

Credenciales Personalizadas¶

Autenticación de Escritorio con una Aplicación OAuth Personalizada¶

Siga los pasos a continuación para autenticarse con las credenciales de una aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada.

Obtenga y Actualice el Token de Acceso de OAuth¶

Después de configurar lo siguiente, está listo para conectarse:

• AuthScheme: Establézcalo en OAuth, o PKCE si configuró una aplicación PKCE.
• InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
• OAuthClientId: Establézcalo en el ID de cliente asignado cuando registró su aplicación.
• OAuthClientSecret: OAuth solo. Establézcalo en el secreto de cliente asignado cuando registró su aplicación.
• CallbackURL: establezca esto en el URI de redirección definido cuando registró su aplicación.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth:

1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
2. Obtiene un nuevo token de acceso cuando caduca.
3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Máquinas Sin Cabeza¶

Uso de OAuth en una Máquina Sin Cabeza¶

Para crear fuentes de datos Xero en servidores sin periféricos u otras máquinas en las que el conector no puede abrir un navegador, debe autenticarse desde otra máquina. La autenticación es un proceso de dos pasos.

1. En lugar de instalar el conector en otra máquina, puede seguir los pasos a continuación para obtener el OAuthVerifier valor. O bien, puede instalar el conector en otra máquina y transferir los valores de autenticación de OAuth, después de autenticarse a través del flujo habitual basado en el navegador.
2. A continuación, puede configurar el conector para actualizar automáticamente el token de acceso desde la máquina sin periféricos.

Autorizar la Conexión¶

Es necesario crear una aplicación de código de autenticación OAuth personalizada para el siguiente flujo, ya que PKCE no es compatible con ella. Consulte Crear una aplicación OAuth personalizada para un procedimiento. Luego puede seguir los procedimientos a continuación para autenticarse y conectarse a los datos.

Establezca las siguientes propiedades en la máquina sin periféricos:

• AuthScheme: Establézcalo en OAuth.
• InitiateOAuth: Establézcalo en OFF.
• OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
• OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.

Luego puede seguir los pasos a continuación para autenticarse desde otra máquina y obtener el OAuthVerifier propiedad de conexión.

1. Llame a GetOAuthAuthorizationURL procedimiento almacenado* con el parámetro de entrada CallbackURL establecido en el URI de redirección exacto que especificó en la configuración de su aplicación.
2. Abra la URL devuelta en un navegador. Inicie sesión y otorgue permisos al conector. A continuación, se le redirige a la URL de devolución de llamada, que contiene el código verificador.
3. Guarde el valor del código verificador. Establecerá esto en el OAuthVerifier propiedad de conexión.

En la máquina sin periféricos, establezca las siguientes propiedades de conexión para obtener los valores de autenticación de OAuth:

• AuthScheme: Establézcalo en OAuth.
• InitiateOAuth: Establézcalo en REFRESH.
• OAuthClientId: establezca esto en la clave de consumidor en la configuración de su aplicación.
• OAuthClientSecret: establezca esto en el secreto del consumidor en la configuración de su aplicación.
• OAuthVerifier: Establézcalo en el código del verificador.
• OAuthSettingsLocation: configure esto para conservar los valores de autenticación OAuth cifrados en el archivo especificado.

Conectarse a Datos¶

Después de generar el archivo de configuración de OAuth, configure las siguientes propiedades para conectarse a los datos:

• AuthScheme: Establézcalo en OAuth.
• InitiateOAuth: Establézcalo en REFRESH.
• OAuthClientId: establezca esto en la clave de consumidor en la configuración de su aplicación.
• OAuthClientSecret: establezca esto en el secreto del consumidor en la configuración de su aplicación.
• OAuthSettingsLocation: Establézcalo en el archivo que contiene los valores de autenticación de OAuth cifrados. Asegúrese de que este archivo otorgue permisos de lectura y escritura al proveedor para habilitar la actualización automática del token de acceso.

Transferir la Configuración de OAuth¶

En lugar de completar el flujo de OAuth anterior a mano, también puede seguir los pasos a continuación para instalar el conector en otra máquina, autenticar y luego transferir los valores de OAuth resultantes.

Este flujo no requiere el uso de una aplicación OAuth personalizada.

En una segunda máquina, instale el conector y conéctese con el siguiente conjunto de propiedades:

• Colocar InitiateOAuth a GETANDREFRESH.
• OAuthSettingsLocation: establezca esto en un archivo de texto grabable.

Pruebe la conexión para autenticarse. Los valores de autenticación resultantes se escriben, se cifran, en la ruta especificada por OAuthSettingsLocation. Una vez que haya probado con éxito la conexión, copie el archivo de configuración de OAuth en su máquina sin periféricos. En la máquina sin periféricos, configure las siguientes propiedades de conexión para conectarse a los datos:

• InitiateOAuth: Establézcalo en REFRESH.
• OAuthSettingsLocation: establezca esto en la ruta a su archivo de configuración de OAuth. Asegúrese de que este archivo otorgue permisos de lectura y escritura al conector para habilitar la actualización automática del token de acceso.

Creación de una Aplicación OAuth Personalizada¶

Las siguientes secciones muestran cómo crear una aplicación OAuth personalizada para usar en Credenciales personalizadas flujo de autenticación.

Registrar una Aplicación OAuth: Escritorio¶

Siga los pasos a continuación para registrar una aplicación pública para obtener las credenciales de cliente de OAuth:

1. Inicie sesión en el portal desarrollador de Xero.
2. Haga clic en Mis aplicaciones -> Agregar aplicación. Elija el tipo de aplicación de código de autenticación.
3. Introduzca un nombre para su aplicación y la URL de su empresa. Esta información se muestra a los usuarios cuando se conectan.
4. Registre el URI de redirección apropiado para el producto que está utilizando.

Después de hacer clic en Guardar, se le muestra su ID de cliente de OAuth y puede crear un nuevo secreto de cliente de OAuth. Los establecerá en OAuthClientId y OAuthClientSecret en la guía de autenticación, Credenciales personalizadas.

Registrar una Aplicación PKCE: Escritorio¶

Además del tipo de aplicación de código de autenticación predeterminado, también puede crear aplicaciones mediante PKCE. Esto se recomienda para los desarrolladores que escriben aplicaciones del lado del cliente porque PKCE no requiere un secreto de cliente.

Registrar una aplicación PKCE es similar al proceso para registrar una aplicación OAuth. La única diferencia que Xero no devuelve un OAuthClientSecret porque no se usa en el flujo PKCE.

Límites de la API de Xero¶

Límites de la API de Xero¶

La API de Xero tiene limitaciones de uso que se pueden encontrar al usar Jitterbit Connector para Xero. Tenga en cuenta que todo esto se aplica por aplicación y por organización. Una aplicación puede exceder estos límites si está consultando a varias organizaciones, siempre que respete los límites dentro de cada organización.

Límite Concurrente¶

Como máximo, 5 llamadas API desde la aplicación pueden estar activas contra la misma organización a la vez. Por lo general, este límite no es un problema porque el conector volverá a intentar automáticamente la solicitud actual si esto ocurre.

Límite por Minuto¶

Se pueden realizar como máximo 60 llamadas API por minuto desde la aplicación a la misma organización. Este límite tampoco es un problema, ya que Xero informa un tiempo de retraso recomendado que el conector utilizará para evitar volver a alcanzar el límite.

Límite por Día¶

Se pueden realizar como máximo 5000 llamadas API por día desde la aplicación a la misma organización. Alcanzar este límite es raro, pero puede ocurrir con ciertas tablas (como tablas de historial y algunos informes) o ciertas configuraciones (como AutoExpandDetails), ya que requieren que el conector realice una única llamada a la API para cada factura/contacto/etc. eso se lee.

Si este límite se alcanza con frecuencia, el primer paso debe ser evitar las tablas o configuraciones que lo activan. También es posible convertir las consultas en versiones que leen menos filas a la vez. Esto generalmente se hace reemplazando selecciones simples con subconsultas que seleccionan pequeños grupos de filas y luego usando múltiples versiones de estas consultas en diferentes momentos:

/* Retreives history for about 1/16 of the invoices */
SELECT * FROM HistoryInvoices WHERE InvoiceId IN (
  SELECT InvoiceId FROM Invoices WHERE InvoiceId LIKE '0%'
) 

El RetryDailyLimit La opción también está disponible, pero se desaconseja enfáticamente su uso, ya que en el peor de los casos, los retrasos que sugiere Xero pueden abarcar varias horas durante las cuales el conector no estará disponible. Por lo general, es mejor reestructurar la forma en que solicita los datos para que se ajusten a los límites que ignorar los límites y ejecutar consultas que tardan varias horas en ejecutarse.

Notas Importantes¶

Procedimientos Almacenados¶

• Las funciones de procedimientos almacenados descritas en esta documentación no se admiten actualmente.
• Debido a que los procedimientos almacenados no se admiten actualmente, cualquier característica que dependa de los procedimientos almacenados tampoco se admite actualmente.

Archivos de Configuración y Sus Rutas¶

• Todas las referencias a la adición de archivos de configuración y sus rutas se refieren a archivos y ubicaciones en Harmony Agente donde está instalado el conector. Estas rutas deben ajustarse según corresponda según el agente y el sistema operativo. Si se utilizan varios agentes en un grupo de agentes, se requerirán archivos idénticos en cada agente.

Características Avanzadas¶

Esta sección detalla una selección de características avanzadas del conector Xero.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario¶

El conector Jitterbit para Xero le permite definir una tabla virtual cuyos contenidos se deciden mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

• Cree un archivo de configuración con formato JSON que defina las vistas que desea.
• Declaraciones DDL.

Definición de Vistas Usando un Archivo de Configuración¶

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

• Cada elemento raíz define el nombre de una vista.
• Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM Contacts WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Vistas Definidas por el Usuario¶

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario¶

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Dando como resultado la consultar efectiva a la fuente:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL¶

Personalización de la Configuración SSL¶

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos¶

Jitterbit Connector for Xero modela cinco APIs de Xero como bases de datos relacionales: las APIs de Contabilidad, Nómina australiana, Archivos, Activos fijos y Proyectos. Selecciona el Schema propiedad y utilice la información de cada sección para seleccionar la API adecuada en función de las necesidades de su proyecto.

Usando la API de Contabilidad

La API de contabilidad contiene la información financiera de la empresa, como contactos, facturas e informes. También contiene tablas de historial que registran cambios en la mayoría de los tipos de entidades.

Ver Modelo de datos contables para las entidades disponibles en la API de contabilidad.

Usando la API de nómina australiana

La API de nómina australiana contiene información sobre los empleados de la empresa, como hojas de tiempo, permisos y declaraciones de impuestos.

Consulte Modelo de datos de nómina de Australia para las entidades disponibles en la API de nómina australiana.

Usando la API de Archivos

La API de archivos contiene información sobre los archivos y archivos adjuntos administrados por Xero. Se puede utilizar para cargar y descargar archivos y adjuntarlos a las entidades contables.

Consulte Modelo de datos de archivos para las entidades disponibles en la API de archivos.

Usando la API de activos fijos

La API de Activos Fijos contiene información sobre los activos fijos de la empresa, como registro, depreciación y reventa.

Ver Modelo de datos de activos fijos para las entidades disponibles en la API de activos fijos.

Usando la API de Proyectos

La API de Proyectos contiene información sobre los proyectos de la empresa, como la facturación y el seguimiento del tiempo.

Ver Modelo de datos de proyectos para las entidades disponibles en la API de Proyectos.

Modelo de Datos Contables¶

Jitterbit Connector for Xero modela la API de contabilidad de Xero como tablas relacionales, vistas y procedimientos almacenados. Las limitaciones y los requisitos de la API se documentan en esta sección; puedes usar el SupportEnhancedSQL función, configurada de forma predeterminada, para eludir la mayoría de estas limitaciones.

Mesas¶

Mesas describe las tablas disponibles.

Puntos de Vista¶

Puntos de vista son tablas que no se pueden modificar. Normalmente, los datos que son de solo lectura y no se pueden actualizar se muestran como vistas.

Procedimientos Almacenados¶

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Procedimientos almacenados son interfaces similares a funciones para la fuente de datos. Se pueden utilizar para buscar, actualizar y modificar información en la fuente de datos.

Mesas¶

El conector modela los datos en Xero en una lista de tablas que se pueden consultar mediante instrucciones SQL estándar.

Generalmente, consultar tablas de Xero es lo mismo que consultar una tabla en una base de datos relacional. A veces hay casos especiales, por ejemplo, incluir una determinada columna en la cláusula WHERE puede ser necesario para obtener datos para ciertas columnas de la tabla. Esto suele ser necesario para situaciones en las que se debe realizar una solicitud separada para cada fila para obtener ciertas columnas. Estos tipos de situaciones están claramente documentados en la parte superior de la página de la tabla vinculada a continuación.

Conector Jitterbit para Tablas Xero¶

Cuentas¶

Cree, elimine y consultar cuentas para una organización de Xero.

Información Específica de la Tabla¶

La tabla Cuentas le permite SELECCIONAR e INSERTAR cuentas para una organización Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Los siguientes campos son obligatorios para las inserciones: Código, Nombre y Tipo.

INSERT INTO Accounts (Name,Code,Type) VALUES ('John Doe','2000','BANK')

Columnas¶

Transacciones Bancarias¶

Cree, actualice, elimine y consultar transacciones bancarias para una organización Xero.

Información Específica de la Tabla¶

La tabla BankTransactions le permite SELECCIONAR, INSERTAR, ACTUALIZAR y ELIMINAR transacciones bancarias para una organización Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para crear un nuevo registro de transacción bancaria, se requieren los siguientes campos además de al menos un elemento de línea: Tipo, Contact_ContactName o Contact_ContactId, y BankAccount_AccountId o BankAccount_Code. Para crear una nueva línea de pedido, se requieren los siguientes campos: LineItem_Description, LineItem_Quantity, LineItem_UnitAmount y LineItem_AccountCode.

Además de insertar una sola fila, las tablas de elementos de línea ofrecen dos formas adicionales de insertar en una tabla.

1. Puede insertar un nuevo objeto con varios elementos de línea utilizando agregados XML. Los elementos admitidos aquí son los mismos que las columnas LineItem sin el prefijo "LineItem_", excepto cuando se asignan categorías de seguimiento. Consulte la documentación de Xero de la API BankTransactions para obtener más detalles.

   INSERT INTO BankTransactions(Type, Contact_ContactName, BankAccount_Code, LineItemAggregate) VALUES (
     'RECEIVE',
     'John Doe',
     '200',
     '<LineItem><Description>LineItem1Desc</Description><Quantity>1</Quantity><AccountCode>100</AccountCode></LineItem> <LineItem><Description>LineItem2Desc</Description><Quantity>2</Quantity><AccountCode>100</AccountCode></LineItem>'
   )
   

2. También puede insertar un nuevo elemento de línea en un objeto existente especificando el identificador generado por Xero del registro existente. Por ejemplo, para agregar un artículo de línea a una transacción bancaria existente:

   INSERT INTO BankTransactions (BankTransactionId, LineItem_Description, LineItem_Quantity) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1)
   

Nota: La inserción en registros existentes contará como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Borrar

La API de Xero tiene soporte limitado para eliminar cualquier objeto. Para eliminar un registro de la tabla BankTransactions, debe actualizar el campo Estado a un valor apropiado.

Columnas¶

Transferencias Bancarias¶

Información de uso para la operación BankTransfers.rsd.

Información Específica de la Tabla¶

La tabla BankTransfers le permite SELECCIONAR e INSERTAR transferencias bancarias para una organización Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Los siguientes campos son obligatorios para las inserciones: FromBankAccount_Code, ToBankAccount_Code y Amount

INSERT INTO BankTransfers (FromBankAccount_Code,ToBankAccount_Code,Amount) VALUES ('3d08fd48-434d-4c18-a57b-831663ab70d2','ceef65a5-a545-423b-9312-78a53caadbc4','1000.00')

Columnas¶

Pagos por Lotes¶

Cree y consultar BatchPayments para una organización Xero.

Información Específica de la Tabla¶

La tabla BatchPayments le permite SELECCIONAR e INSERTAR pagos lote para una organización de Xero. La columna ID es generada por el conector. Este valor combina el índice del pago individual dentro del lote con el BatchPaymentId único generado por Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para crear un nuevo pago lote, se requieren AccountId y Date además de al menos un elemento de pago; los campos Payment_InvoiceId y Payment_Amount son obligatorios para insertar un elemento de pago.

También puede proporcionar varios pagos mediante un agregado XML que contiene los datos de cada pago del lote. Los elementos admitidos son los mismos que los nombres de las columnas "Pago_" sin el prefijo "Pago_".

INSERT INTO BatchPayments(AccountId, Date, PaymentAggregate) VALUES (
  'AAAAA-AAAAA-AAAAA-AAAAA',
  '2019-03-01',
  '<Payment><InvoiceID>BBBBB-...</InvoiceID><Amount>50.21</Amount></Payment> <Payment><InvoiceID>CCCCC-...</InvoiceID><Amount>12.96</Amount></Payment>'
)

Columnas¶

Grupos de Contacto¶

Cree, actualice y consultar grupos de contactos para una organización Xero.

Información Específica de la Tabla¶

La tabla ContactGroups le permite administrar tanto los grupos de contactos como los miembros de esos grupos de contactos.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Al insertar con un grupo de contactos, puede insertar un nuevo grupo de contactos o agregar contactos a un grupo existente.

Para insertar un nuevo grupo de contacto, solo se debe dar el campo Nombre:

INSERT INTO ContactGroups (Name) VALUES ('Contractors')

Para agregar un contacto a un grupo existente, se deben proporcionar tanto el ContactGroupId como el Contact_ContactId. El valor del campo Contact_ContactId se puede recuperar consultando la tabla de contactos.

INSERT INTO ContactGroups (ContactGroupId, Contact_ContactId) VALUES ('11111-11111-11111-11111', '22222-22222-22222-22222')

Se pueden proporcionar múltiples contactos usando ContactAgregate:

INSERT INTO ContactGroups (ContactGroupId, ContactAggregate) VALUES (
  '11111-11111-11111-11111', 
'<Contact><ContactID>22222-22222-22222-22222</ContactID></Contact> <Contact><ContactID>33333-33333-33333-33333</ContactID></Contact>')

ACTUALIZAR Al actualizar un grupo de contactos, los únicos campos que se pueden cambiar son el campo Nombre y Estado. Cambiar el campo Estado a ELIMINADO eliminará el grupo de contactos.

-- Renaming the group
UPDATE ContactGroup SET Name = 'External Contractors' WHERE ContactGroupId = '11111-11111-11111-1111'


-- Deleting the group
UPDATE ContactGroup SET Status = 'DELETED' WHERE ContactGroupId = '11111-11111-11111-1111'

ELIMINAR Eliminar entradas de un grupo de contactos eliminará contactos individuales del grupo.

DELETE FROM ContactGroups WHERE ID = '3|11111-11111-11111-11111'

Columnas¶

Contactos¶

Cree, actualice y consultar contactos para una organización de Xero.

Información Específica de la Tabla¶

La tabla de contactos le permite SELECCIONAR, INSERTAR y ACTUALIZAR contactos para una organización de Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. El campo Nombre es obligatorio para agregar un nuevo contacto.

INSERT INTO Contacts (Name) VALUES ('John Doe')

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Columnas¶

Notas de Crédito¶

Cree, actualice, elimine y consultar notas de crédito para una organización de Xero.

Información Específica de la Tabla¶

La tabla CreditNotes le permite SELECCIONAR, INSERTAR, ACTUALIZAR y ELIMINAR partidas de notas de crédito para una organización de Xero. La columna ID es generada por el conector; el valor de este campo combina el índice de la línea de pedido con el CreditNoteId exclusivo generado por Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para insertar una nueva nota de crédito, se requiere el campo Contact_Name. Para que se apruebe una nota de crédito, se deben definir los siguientes campos además de al menos un elemento de línea: Contact_Name, Date y LineAmountTypes.

Además de insertar una sola fila, las tablas de elementos de línea ofrecen dos formas adicionales de insertar en una tabla.

1. También puede insertar un nuevo objeto con varios elementos de línea utilizando agregados XML. Los elementos admitidos aquí son los mismos que las columnas LineItem sin el prefijo "LineItem_", excepto cuando se asignan categorías de seguimiento. Consulte la documentación de Xero de la API de CreditNotes para obtener más detalles.

   INSERT INTO CreditNotes (Type, Contact_Name, LineItemAggregate) VALUES (
     'ACCPAYCREDIT',
     'John Doe',
     '<LineItem><Description>LineItemDesc1</Description><Quantity>1</Quantity></LineItem> <LineItem><Description>LineItemDesc2</Description><Quantity>2</Quantity></LineItem>'
   )
   

2. Puede insertar un nuevo elemento de línea en un objeto existente especificando el identificador generado por Xero del registro existente. Por ejemplo, para agregar un artículo de línea a una nota de crédito existente:

   INSERT INTO CreditNotes (CreditNoteId, LineItem_Description, LineItem_Quantity) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1)
   

Nota: La inserción en registros existentes contará como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Borrar

La API de Xero tiene soporte limitado para eliminar cualquier objeto. Para eliminar objetos, debe actualizar su Estado a un valor apropiado.

Los valores aplicables para este campo pueden depender del estado. Por ejemplo, las facturas solo pueden tener su estado establecido en ELIMINADO cuando el estado de la factura es BORRADOR o ENVIADO.

Columnas¶

Empleados¶

Cree, actualice y consultar a los empleados de una organización Xero.

Información Específica de la Tabla¶

La tabla Empleados le permite SELECCIONAR, INSERTAR y ACTUALIZAR empleados para una organización Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para insertar un nuevo registro de empleado, se requieren los siguientes campos: Nombre y Apellido.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Columnas¶

Reclamaciones de Gastos¶

Cree, actualice y consultar declaraciones de gastos para una organización Xero.

Información Específica de la Tabla¶

La tabla ExpenseClaims le permite SELECCIONAR, INSERTAR y ACTUALIZAR declaraciones de gastos para una organización de Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Para crear un nuevo registro de reclamo de gastos, se debe definir el campo UserId; además, se debe especificar al menos un ReceiptId. Se puede proporcionar uno a través de la columna ReceiptId:

INSERT INTO ExpenseClaims(UserId, ReceiptId) VALUES (
  'XXXXX-XXXXX-XXXXX-XXXXX', 'YYYYY-YYYYY-YYYYY-YYYYY'
)

También se pueden especificar múltiples incluyéndolos en el ReceiptAgregate:

INSERT INTO ExpenseClaims(UserId, ReceiptAggregate) VALUES (
  'XXXXX-XXXXX-XXXXX-XXXXX',
  '<Receipt><ReceiptID>YYYYY-YYYYY-YYYYY-YYYYY</ReceiptID></Receipt> <Receipt><ReceiptID>ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ</ReceiptID></Receipt>'
)

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Columnas¶

HistorialBancoTransacciones¶

Cree y consultar el historial y las notas de BankTransaction para una organización de Xero.

Información Específica de la Tabla¶

La tabla HistoryBankTransactions le permite leer las notas creadas en una transacción y el historial de cambios en esa transacción. Si no se proporciona un BankTransactionId, se recuperará el historial de todas las BankTransactions.

Se requiere un BankTransactionId y detalles para insertar una nota:

INSERT INTO HistoryBankTransactions(BankTransactionId, Details) VALUES ('...', 'Refund for overpayment'), 

Columnas¶

HistorialLotePagos¶

Cree y consultar el historial y las notas de BatchPayment para una organización de Xero.

Información Específica de la Tabla¶

La tabla HistoryBatchPayments le permite leer las notas creadas en un pago lote y el historial de cambios en ese pago lote. Si no se proporciona un BatchPaymentId, se recuperará el historial de todos los pagos lote.

Se requiere un BatchPaymentId y detalles para insertar una nota:

INSERT INTO HistoryBatchPayments(BatchPaymentId, Details) VALUES ('...', 'Batch submitted on 3/1/2019')

Columnas¶

HistorialContactos¶

Cree y consultar el historial de contactos y las notas de una organización de Xero.

Información Específica de la Tabla¶

La tabla HistoryContacts le permite leer las notas creadas en un contacto y el historial de cambios en ese contacto. Si no se proporciona un ID de contacto, se recuperará el historial de todos los contactos.

Se requiere un ID de contacto y detalles para insertar una nota:

INSERT INTO HistoryContacts(ContactId, Details) VALUES ('...', 'Reliable customer'), 

Columnas¶

HistorialCréditoNotas¶

Cree y consultar el historial y las notas de CreditNote para una organización de Xero.

Información Específica de la Tabla¶

La tabla HistoryCreditNotes le permite leer las notas creadas en una nota de crédito y el historial de cambios en esa nota de crédito. Si no se proporciona un ID de nota de crédito, se recuperará el historial de todas las notas de crédito.

SELECT * FROM HistoryCreditNotes WHERE CreditNoteId = '...'

Se requiere un CreditNoteId y detalles para insertar una nota:

INSERT INTO HistoryCreditNotes(CreditNoteId, Details) VALUES ('...', 'Offered 12% discount'), 

Columnas¶

HistorialFacturas¶

Cree y consultar el historial de facturas y las notas para una organización de Xero.

Información Específica de la Tabla¶

La tabla HistoryInvoices le permite leer las notas creadas en una factura y el historial de cambios en esa factura. Si no se proporciona un Id. de factura, se recuperará el historial de todas las facturas.

Se requiere un Id. de factura y detalles para insertar una nota:

INSERT INTO HistoryInvoices(InvoiceId, Details) VALUES ('...', 'Payment expected on December 1st'), 

Columnas¶

HistorialCompraPedidos¶

Cree y consultar el historial y las notas de los pedidos de compra para una organización de Xero.

Información Específica de la Tabla¶

La tabla HistoryPurchaseOrders le permite leer las notas creadas en una orden de compra y el historial de cambios en esa orden de compra. Si no se proporciona un Id. de pedido de compra, se recuperará el historial de todos los pedidos de compra.

Se requiere un Id. de pedido de compra y detalles para insertar una nota:

INSERT INTO HistoryPurchaseOrders(PurchaseOrderId, Details) VALUES ('...', 'Rescheduled delivery for October 9th'), 

Columnas¶

Facturas¶

Cree, actualice, elimine y consultar Facturas para una organización de Xero.

Información Específica de la Tabla¶

La tabla Facturas le permite SELECCIONAR, INSERTAR, ACTUALIZAR y ELIMINAR elementos de línea de factura para una organización de Xero. La columna ID es generada por el conector, este valor combina el índice de la línea de pedido con el InvoiceId único generado por Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para crear una nueva factura, los campos Tipo y Nombre del contacto deben configurarse además de al menos un elemento de línea. Tenga en cuenta que al menos LineItem_LineAmount o LineItem_UnitAmount también son campos obligatorios para el agregado de LineItem.

Además de insertar una sola fila, las tablas de elementos de línea ofrecen dos formas adicionales de insertar en una tabla.

1. Puede insertar un nuevo objeto con varios elementos de línea utilizando agregados XML. Los elementos admitidos aquí son los mismos que las columnas LineItem sin el prefijo "LineItem_", excepto cuando se asignan categorías de seguimiento. Consulte la documentación de Xero de la API de Facturas para obtener más detalles.

   INSERT INTO Invoices (Type, ContactName, LineItemAggregate) VALUES (
     'ACCPAY',
     'Boom FM',
     '<LineItem><Description>LineItem1Desc</Description><Quantity>1</Quantity><UnitAmount>30</UnitAmount></LineItem> <LineItem><Description>LineItem2Desc</Description><Quantity>2</Quantity><UnitAmount>50</UnitAmount></LineItem>'
   )
   

2. También puede insertar un nuevo elemento de línea en un objeto existente especificando el valor generado por Xero del registro existente. Por ejemplo, agregar un artículo de línea a una factura existente:

   INSERT INTO Invoices (InvoiceId, LineItem_Description, LineItem_Quantity, LineItem_UnitAmount) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1, 10)
   

Nota: La inserción en registros existentes contará como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Borrar

La API de Xero tiene soporte limitado para eliminar cualquier objeto. Para eliminar objetos, debe actualizar su Estado a un valor apropiado.

Los valores aplicables para este campo pueden depender del estado. Por ejemplo, las facturas solo pueden tener su estado establecido en ELIMINADO cuando el estado de la factura es BORRADOR o ENVIADO.

Montos de descuento, tasas de descuento y montos de línea Las facturas en Xero se pueden descontar a través de un monto fijo usando LineItem_DiscountAmount o con un porcentaje usando LineItem_DiscountRate. Estos dos métodos no son compatibles porque los montos de descuento son más precisos que las tasas de descuento. Por ejemplo, un artículo de línea con el monto de 2000,00 y un monto de descuento de 99,99 no se puede representar con la tasa de descuento de 4,999 porque Xero permite solo dos dígitos de precisión en las tasas de descuento. Además, establecer cualquier forma de descuento significa que Xero calcula LineItem_LineAmount.

Esto significa que, de los tres campos LIneItem_DiscountAmount, LineItem_DiscountAmount y LineItem_DiscountRate, solo se puede usar uno como parte de una consultar INSERT o UDPATE. Por ejemplo, ninguna de las siguientes consultas es válida:

INSERT INTO Invoices(Invoice, LineItem_LineAmount, LineItem_DiscountRate) VALUES ('2bf5f07b-edf0-4b05-9200-cc2cd6b89b1e', 4999.99, 6.75)
UPDATE Invoices SET LineItem_DiscountRate = 12.50, LineItem_DiscountAmount = 99.99 WHERE ID = '1|2bf5f07b-edf0-4b05-9200-cc2cd6b89b1e'

También significa que el conector eliminará los otros dos valores al asignar cualquiera de estos campos. Por ejemplo, si tuviera que asignar un LineItem_LineAmount a una Factura, el conector eliminaría cualquier valor de descuento adjunto a esa Factura.

Columnas¶

Elementos¶

Cree, actualice, elimine y consultar elementos para una organización de Xero.

Información Específica de la Tabla¶

La tabla Elementos le permite SELECCIONAR, INSERTAR y ACTUALIZAR elementos para una organización Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para insertar un nuevo registro de artículo, el campo Código debe estar definido.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Columnas¶

Transacciones Vinculadas¶

Cree, actualice y consultar transacciones vinculadas para una organización de Xero.

Columnas¶

ManualRevistas¶

Cree, actualice y consultar diarios manuales para una organización Xero.

Información Específica de la Tabla¶

La tabla ManualJournals le permite SELECCIONAR, INSERTAR y ACTUALIZAR líneas de diario de diarios manuales para una organización Xero. La columna ID es generada por el conector; combina el índice de la línea de pedido con el ManualJournalId exclusivo generado por Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para insertar un nuevo registro de diario manual, se requiere el campo Narración además de al menos dos elementos de línea. Un registro de diario debe contener al menos un crédito y un débito, para que el registro en su conjunto esté equilibrado.

1. Puede insertar un nuevo objeto con varios elementos de línea utilizando un agregado XML. Los elementos admitidos aquí son los mismos que las columnas JournalLine sin el prefijo "JournalLine_", excepto cuando se asignan categorías de seguimiento. Consulte la documentación de Xero de la API de ManualJournals para obtener más detalles.

   INSERT INTO ManualJournals (Narration, JournalLineAggregate) VALUES (
     'Accrued expenses',
     '<JournalLine><LineAmount>55.00</LineAmount><AccountCode>200</AccountCode></JournalLine> <JournalLine><LineAmount>-55.00</LineAmount><AccountCode>201</AccountCode></JournalLine>'
   )
   

2. También puede insertar un nuevo elemento de línea en un objeto existente especificando el valor generado por Xero del registro existente. Por ejemplo, para agregar un artículo de línea a una factura existente:

   INSERT INTO ManualJournals (ManualJournalId, JournalLine_LineAmount, JournalLine_AccountCode) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 55.00, '200')
   

Nota: La inserción en registros existentes contará como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Columnas¶

Pagos¶

Crear y consultar pagos para una organización Xero.

Información Específica de la Tabla¶

La tabla Pagos le permite SELECCIONAR e INSERTAR pagos para una organización de Xero.

Tenga en cuenta que esta tabla no incluye pagos de declaraciones de gastos; para recuperarlos, deberá leer desde la vista ExpenseClaimPayments.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para insertar un nuevo registro de pago, los campos InvoiceNumber y AccountCode son obligatorios.

Columnas¶

Ordenes de Compra¶

Cree, actualice, elimine y consultar pedidos de compra para una organización de Xero.

Columnas¶

Ingresos¶

Cree, actualice, elimine y consultar recibos para una organización de Xero.

Información Específica de la Tabla¶

La tabla Recibos le permite SELECCIONAR, INSERTAR, ACTUALIZAR y ELIMINAR elementos de línea de recibo para una organización Xero. La columna ID es generada por el conector; combina el índice de la línea de pedido con el ReceiptId exclusivo generado por Xero.

Tenga en cuenta que esta tabla solo incluye recibos en borrador: para recuperar recibos que ya se han reclamado, deberá leer desde la vista ExpenseClaimReceipts.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para insertar un registro de recibo, se requieren los siguientes campos además de al menos un elemento de línea: Fecha, Contact_Name y User_UserId. Para agregar un nuevo elemento de línea, se requieren los siguientes campos: LineItem_Description, LineItem_UnitAmount y LineItem_AccountCode.

Además de insertar una sola fila, las tablas de elementos de línea ofrecen dos formas adicionales de insertar en una tabla.

1. Puede insertar un nuevo objeto con varios elementos de línea utilizando agregados XML. Los elementos admitidos aquí son los mismos que las columnas LineItem sin el prefijo "LineItem_", excepto cuando se asignan categorías de seguimiento. Consulte la documentación de Xero de la API de recibos para obtener más detalles.

   INSERT INTO Receipts (Date, Contact_Name, User_UserId, LineItemAggregate) VALUES (
     '4/19/2006 9:16:48 AM',
     'John Doe',
     'c81045b2-5740-4aea-bf8a-3956941af387',
     '<LineItem><Description>Coffee with client</Description><UnitAmount>13.00</UnitAmount><AccountCode>200</AccountCode></LineItem> <LineItem><Description>Bagel</Description><UnitAmount>2.00</UnitAmount><AccountCode>200</AccountCode></LineItem>'
   )
   

2. También puede insertar un nuevo elemento de línea en un objeto existente especificando el valor generado por Xero del registro existente. Por ejemplo, para agregar un artículo de línea a una factura existente:

   INSERT INTO Receipts (ReceiptId, LineItem_Description, LineItem_UnitAmount) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'Coffee with client', 13.80)
   

Nota: La inserción en registros existentes contará como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Borrar

La API de Xero tiene soporte limitado para eliminar cualquier objeto. Para eliminar objetos, debe actualizar su Estado a un valor apropiado.

Los valores aplicables para este campo pueden depender del estado. Por ejemplo, las facturas solo pueden tener su estado establecido en ELIMINADO cuando el estado de la factura es BORRADOR o ENVIADO.

Columnas¶

Las Tasas de Impuestos¶

Información de uso para la operación TaxRates.rsd.

Información Específica de la Tabla¶

La tabla TaxRates le permite SELECCIONAR, INSERTAR y ACTUALIZAR componentes de impuestos para las tasas de impuestos en una organización Xero. La columna ID la genera el conector. Este valor combina el índice de la línea de pedido con el TaxType exclusivo generado por Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

INSERTAR

Insertar una sola fila es sencillo, incluso con tablas de elementos de línea. Simplemente configure los campos obligatorios y se creará un nuevo objeto de tabla como una sola entrada. Para crear una nueva tasa de impuestos, el campo Nombre debe configurarse además de al menos un componente de impuestos; los campos TaxComponent_Name, TaxComponent_Rate y TaxComponent_IsCompound son obligatorios para insertar un nuevo elemento de línea.

Además de insertar una sola fila, esta tabla ofrece dos formas adicionales de insertar en una tabla.

1. Puede insertar un nuevo objeto con varios elementos de línea utilizando agregados XML. Los elementos admitidos aquí son los mismos que las columnas TaxComponent sin el prefijo "TaxComponent_".

   INSERT INTO TaxRates (Name, TaxComponentAggregate) VALUES (
     'My Tax Rate',
     '<TaxComponent><Name>customTax1</Name><Rate>1.0000</Rate><IsCompound>false</IsCompound></TaxComponent> <TaxComponent><Name>customTax2</Name><Rate>2.0000</Rate><IsCompound>false</IsCompound></TaxComponent>'
   )
   

2. También puede insertar un nuevo componente de impuestos en un objeto existente especificando el valor generado por Xero para el registro existente. Por ejemplo, agregar un componente de impuestos a una tasa de impuestos existente:

   INSERT INTO TaxRates (TaxType, TaxComponent_Name, TaxComponent_Rate, TaxComponent_IsCompound) VALUES ('TAX001', 'customTax2', '2.0000', 'False')
   

Nota: La inserción en registros existentes contará como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Actualizar

Puede actualizar cualquier campo que no sea de solo lectura.

Nota: las operaciones de actualización contarán como dos operaciones contra la API de Xero. Se requiere uno para recuperar el registro existente y otro para actualizar el registro con nuevos datos.

Nota: no puede actualizar las tasas impositivas predefinidas a través de la API de Xero.

Borrar

La API de Xero tiene soporte limitado para eliminar cualquier objeto. Para eliminar objetos, debe actualizar su Estado a un valor apropiado.

Los valores aplicables para este campo pueden depender del estado. Por ejemplo, las facturas solo pueden tener su estado establecido en ELIMINADO cuando el estado de la factura es BORRADOR o ENVIADO.

Columnas¶

Puntos de Vista¶

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido. Para obtener más información sobre las tablas y los procedimientos almacenados, vaya a sus entradas correspondientes en este documento de ayuda.

Conector Jitterbit para Vistas Xero¶

AgedPayablesByContact¶

Devuelve las cuentas por pagar antiguas de un contacto.

Información Específica de la Tabla¶

Seleccionar

Si no se proporciona el ID de contacto, se devolverá el informe de Cuentas por pagar vencidas para todos los contactos, uno tras otro.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

AgedReceivablesByContact¶

Devuelve cuentas por cobrar vencidas para un contacto.

Información Específica de la Tabla¶

Seleccionar

Si no se proporciona el ID de contacto, se devolverá el informe de Cuentas por pagar vencidas para todos los contactos, uno tras otro.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Hoja de Balance¶

Devuelve un Balance General mensual.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

BankStatement¶

Devuelve las transacciones enumeradas en la cuenta.

Información Específica de la Tabla¶

Seleccionar

Se puede proporcionar un bankAccountId al consultar esta vista. Si no se proporciona uno, este informe se ejecutará para cada cuenta bancaria almacenada en Xero.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

BancoResumen¶

Devuelve los saldos y movimientos de caja de cada cuenta bancaria.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

BrandingTemas¶

Devuelve los temas de marca definidos para la organización Xero.

Información Específica de la Tabla¶

La vista BrandingThemes le permite SELECCIONAR temas de marca para una organización de Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

Columnas¶

LíneasPresupuestarias¶

Consultar elementos de línea de presupuesto para una organización Xero

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Presupuestos¶

Presupuestos de consulta para una organización Xero

Columnas¶

Resumen del Presupuesto¶

Devuelve un resumen de presupuesto mensual.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

ContactoCISConfiguración¶

Consulte la configuración de CIS para contactos en una organización de Xero.

Columnas¶

Asignaciones de Notas de Crédito¶

Consultar asignaciones de notas de crédito para una organización Xero.

Columnas¶

Monedas¶

Recupera las divisas de una organización Xero.

Información Específica de la Tabla¶

La tabla Monedas le permite SELECCIONAR monedas para una organización Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

Columnas¶

Resumen Ejecutivo¶

Devuelve un resumen de los cambios entre un mes y el mes anterior

Información Específica de la Tabla¶

Seleccionar

Se puede proporcionar una fecha al consultar esta vista. Si no se proporciona, este informe comparará el mes actual con el mes anterior.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

GastoReclamaciónPagos¶

Crear y consultar pagos para una organización Xero.

Ver Información Específica¶

La vista ExpenseClaimPayments le permite SELECCIONAR pagos a diferentes declaraciones de gastos para una organización de Xero. La columna ID es generada por el conector; combina el índice de la línea de pedido con el ExpenseClaimID exclusivo generado por Xero.

Tenga en cuenta que esta tabla no incluye otros tipos de Pagos; para recuperarlos, deberá leer de la tabla Pagos.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

Columnas¶

Recibos de Reclamaciones de Gastos¶

Cree, actualice, elimine y consultar recibos reclamados para una organización de Xero.

Ver Información Específica¶

La vista ExpenseClaimReceipts le permite SELECCIONAR elementos de línea de recibos reclamados para una organización Xero. La columna ID es generada por el conector; combina el índice de la línea de pedido con el ExpenseClaimID exclusivo generado por Xero.

Tenga en cuenta que esta tabla no incluye recibos en borrador; para recuperarlos, deberá leer de la tabla Recibos.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

Columnas¶

HistoriaBancoTransferencias¶

Cree y consultar el historial y las notas de BankTransfer para una organización de Xero.

Ver Información Específica¶

La vista HistoryBankTransfers le permite leer las notas creadas en una transferencia y el historial de cambios en esa transferencia. Si no se proporciona un BankTransferId, se recuperará el historial de todas las transferencias bancarias.

Columnas¶

HistorialGastosReclamaciones¶

Cree y consultar el historial y las notas de ExpenseClaim para una organización de Xero.

Ver Información Específica¶

La vista Historial de reclamos de gastos le permite leer las notas creadas en un reclamo de gastos y el historial de cambios en ese reclamo de gastos. Si no se proporciona un ExpenseClaimId, se recuperará el historial de todos los ExpenseClaims.

Columnas¶

HistorialArtículos¶

Cree y consultar el historial y las notas de artículos para una organización de Xero.

Ver Información Específica¶

La vista HistoryItems le permite leer las notas creadas en un elemento y el historial de cambios en ese elemento. Si no se proporciona un ItemId, se recuperará el historial de todos los elementos.

Columnas¶

HistorialSobrepagos¶

Cree y consultar el historial y las notas de sobrepago para una organización de Xero.

Ver Información Específica¶

La vista Historial de sobrepagos le permite leer las notas creadas en un sobrepago y el historial de cambios en ese sobrepago. Si no se proporciona un ID de sobrepago, se recuperará el historial de todos los sobrepagos.

Columnas¶

HistoriaPagos¶

Cree y consultar el historial de pagos y las notas para una organización de Xero.

Columnas¶

HistoriaPagos Anticipados¶

Cree y consultar el historial y las notas de prepago para una organización de Xero.

Ver Información Específica¶

La vista Historial de prepagos le permite leer las notas creadas en un prepago y el historial de cambios en ese prepago. Si no se proporciona un Id. de prepago, se recuperará el historial de todos los prepagos.

Columnas¶

HistorialRecibos¶

Cree y consultar el historial de recibos y las notas para una organización de Xero.

Ver Información Específica¶

La vista Historial de recibos le permite leer las notas creadas en un recibo y el historial de cambios en ese recibo. Si no se proporciona un ReceiptId, se recuperará el historial de todos los recibos.

Columnas¶

HistoriaRepetirFacturas¶

Cree y consultar el historial y las notas de Facturas Repetidas para una organización de Xero.

Ver Información Específica¶

La vista Historial de Facturas Repetidas le permite leer las notas creadas en una factura repetitiva y el historial de cambios en esa factura repetitiva. Si no se proporciona un Id. de Factura Repetida, se recuperará el historial de todas las Facturas Repetidas.

Columnas¶

Revistas¶

Consulte las líneas de pedido en diarios para una organización Xero.

Información Específica de la Tabla¶

La vista Diarios le permite SELECCIONAR las líneas de diario en diarios para una organización Xero. La columna ID es generada por el conector; este valor combina el índice de la línea de pedido con el JournalId exclusivo generado por Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Organización¶

Consultar datos de organización para una organización Xero.

Información Específica de la Tabla¶

La vista de organización le permite SELECCIONAR datos de organización para una organización de Xero.

SELECCIONAR

La API de Xero permite un filtrado y un pedido extensos. Puede definir las cláusulas WHERE y ORDER BY en una consultar para filtrar y ordenar los resultados utilizando cualquier columna que no sea un elemento de línea.

Nota: La API de Xero no admite el filtrado de elementos de línea o líneas de diario.

Columnas¶