Detalles de Conexión de Xero WorkflowMax¶
Introducción¶
Versión del conector
Esta documentación se basa en la versión 21.0.8383 del conector.
Empezando¶
Compatibilidad con la versión de Xero WorkflowMax
El conector aprovecha la API de XeroWorkflowMax para habilitar el acceso bidireccional a XeroWorkflowMax.
Establecer una Conexión¶
Conexión a Xero WorkflowMax¶
Autenticar a Través de Autenticación OAuth¶
Utilice el estándar de autenticación OAuth para conectarse a la API de Xero WorkflowMax. Puede autenticarse con una cuenta de usuario. El conector facilita esto como se describe a continuación.
Uso de una Cuenta de Usuario para Autenticarse en Xero WorkflowMax¶
El flujo de la cuenta de usuario requiere que el usuario que se autentica interactúe con Xero WorkflowMax a través del navegador.
Credenciales Personalizadas¶
Dado que la conexión con credenciales incrustadas está obsoleta, debe registrar una aplicación para obtener OAuthClientId
y OAuthClientSecret
.
Creación de una Aplicación OAuth Personalizada¶
Consulte Crear una aplicación OAuth personalizada para un procedimiento.
Uso de la Autenticación OAuth¶
Utilice el estándar de autenticación OAuth para conectarse a la API Xero WorkflowMax V3. Puede autenticarse con OAuth 2.0. El conector facilita esto como se describe a continuación.
Credenciales Personalizadas¶
Para conectarse con el conector, debe registrar una aplicación para obtener el OAuthClientId
y OAuthClientSecret
.
Cuándo Crear una Aplicación OAuth Personalizada¶
Debe crear una aplicación de OAuth personalizada para cambiar la información que se muestra cuando los usuarios inician sesión en el extremo de Xero WorkflowMax OAuth para otorgar permisos al conector.
Uso de una Cuenta de Servicio para Conectarse a Xero WorkflowMax¶
Las cuentas de servicio tienen autenticación silenciosa, sin autenticación de usuario en el navegador. También puede usar una cuenta de servicio para delegar ámbitos de acceso de toda la empresa al conector.
Debe crear una aplicación OAuth en este flujo. Luego puede conectarse a los datos de Xero WorkflowMax a los que la cuenta de servicio tiene permiso para acceder. Consulte Credenciales personalizadas para obtener una guía de autenticación.
Creación de una Aplicación OAuth Personalizada¶
Consulte Crear una aplicación OAuth personalizada para un procedimiento.
Credenciales Personalizadas¶
Puede usar una aplicación OAuth personalizada para autenticarse con una cuenta de servicio o una cuenta de usuario. Consulte Uso de la autenticación OAuth para más información.
Autenticarse con una Cuenta de Usuario¶
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:
InitiateOAuth
: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmenteOAuthAccessToken
.OAuthClientId
: Establézcalo en el ID de cliente asignado cuando registró su aplicación.OAuthClientSecret
: establezca esto en el secreto de cliente asignado cuando registró su aplicación.CallbackURL
: Establézcalo enhttp://localhost:33333
.
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:
- Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
- Actualiza el token de acceso cuando caduca.
- 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¶
Las siguientes secciones muestran cómo autenticar un servidor sin periféricos u otra máquina en la que el conector no puede abrir un navegador. Puede autenticarse con una cuenta de usuario o con una cuenta de servicio.
Autenticarse con una Cuenta de Usuario¶
Para autenticarse con una cuenta de usuario, debe hacerlo desde otra máquina. La autenticación es un proceso de dos pasos.
- 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. - A continuación, puede configurar el conector para actualizar automáticamente el token de acceso desde la máquina sin periféricos.
Puede seguir el flujo de autenticación de OAuth sin cabeza utilizando las credenciales de OAuth para su aplicación de OAuth personalizada.
Uso de las Credenciales para una Aplicación OAuth Personalizada¶
Cree una aplicación OAuth personalizada
La creación de una aplicación de OAuth personalizada es obligatoria en el flujo de OAuth sin interfaz.
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.
Obtenga un código verificador
Establezca las siguientes propiedades en la máquina sin periféricos:
InitiateOAuth
: Ajústelo a APAGADO.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.CallbackURL
: Establézcalo enhttp://localhost:33333
.
Luego puede seguir los pasos a continuación para autenticarse desde otra máquina y obtener el OAuthVerifier
propiedad de conexión.
- 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.
- 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.
- 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:
InitiateOAuth
: Establézcalo en ACTUALIZAR.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.
Después de generar el archivo de configuración de OAuth, configure las siguientes propiedades para conectarse a los datos:
InitiateOAuth
: Establézcalo en ACTUALIZAR.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 configuración de OAuth
Siga los pasos a continuación para instalar el conector en otra máquina, autenticar y luego transferir los valores de OAuth resultantes.
En una segunda máquina, instale el conector y conéctese con el siguiente conjunto de propiedades:
InitiateOAuth
: Establézcalo en GETANDREFRESH.OAuthSettingsLocation
: establezca esto en un archivo de texto grabable.OAuthClientId
: Establézcalo en el ID de cliente asignado cuando registró su aplicación.OAuthClientSecret
: establezca esto en el secreto de cliente asignado cuando registró su aplicación.CallbackURL
: Establézcalo enhttp://localhost:33333
.
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 ACTUALIZAR.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
: 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¶
Para configurar correctamente una aplicación Xero Flujo de Trabajo Max, siga las instrucciones a continuación.
Registrar una Aplicación¶
Para obtener las credenciales del cliente de OAuth, el ID del cliente y el secreto del cliente, siga estos pasos a continuación:
- Vaya a Administrador de aplicaciones Xero WorkflowMax
- En la esquina superior derecha, haga clic en
New App
. - Seleccione
Web App
. - Agregue la URL de redireccionamiento a
OAuth 2.0 redirect URI
campo por ejemplo:http://localhost:33333
que es nuestra URL de devolución de llamada interna. - Rellene los demás campos del formulario como desee.
- Haga clic en
Create App
. - Haga clic en
Save
y será redirigido a la página de su nueva aplicación. - Desplácese hasta la parte inferior y encontrará el ID de cliente.
- Haga clic en
Generate a secret
para crear su secreto de cliente.
Establecer los Permisos Correctos¶
Se ha agregado un nuevo privilegio de personal para controlar quién tiene permiso para conectar su cuenta a complementos de terceros. Cualquier miembro del personal con privilegios de administrador puede asignar este nuevo privilegio a sí mismo oa otros administradores. Siga estos pasos a continuación para cada miembro del personal que desee que pueda autorizar conexiones a complementos de terceros.
- Vaya a Configuración del personal de Xero WorkflowMax
- Busque el miembro del personal al que le gustaría agregar este permiso y haga clic en él.
- Si el Staff no tiene
Administrator
privilegio bajoAdmin Privileges
, tendrás que marcar la casilla y hacer clic enSave
. Será redirigido a la lista de personal donde tendrá que hacer clic en el miembro del personal nuevamente. - Desplácese hasta la parte inferior debajo de
API Access Privileges
, marque la casilla enAuthorise 3rd Party Full Access
y haga clic enSave
. - Ahora el personal seleccionado tiene acceso a la API Xero Flujo de Trabajo Max V3
Características Avanzadas¶
Esta sección detalla una selección de funciones avanzadas del conector Xero WorkflowMax.
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 WorkflowMax le permite definir una tabla virtual cuyo contenido se decide 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 Utilizando 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 Clients 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¶
Descripción general
Esta sección muestra los objetos de API disponibles y proporciona más información sobre cómo ejecutar SQL en las APIs de Xero WorkflowMax.
Características clave
- El conector modela entidades de Xero WorkflowMax como clientes, proveedores y trabajos como vistas relacionales, lo que le permite escribir SQL para consultar datos de Xero WorkflowMax.
- Procedimientos almacenados* le permiten ejecutar operaciones en Xero WorkflowMax.
- La conectividad en vivo a estos objetos significa que cualquier cambio en su cuenta de Xero WorkflowMax se refleja de inmediato al usar el conector.
Campos Personalizados
El controlador XeroWOrkflowMax admite campos personalizados. Para poder recuperar y actualizar campos personalizados IncludeCustomFields
debe establecerse como una propiedad de conexión. Tenga en cuenta que el controlador será lento al obtener campos personalizados, ya que los obtiene uno por uno. Para mejorar el rendimiento, intente especificar el ID del recurso que está intentando consultar.
Procesamiento colaborativo de consultas
El conector descarga la mayor parte posible del procesamiento de la declaración SELECT a Xero WorkflowMax y luego procesa el resto de la consultar en la memoria. Las limitaciones y los requisitos de la API también se documentan en esta sección.
Ver SupportEnhancedSQL
para obtener más información sobre cómo el conector elude las limitaciones de la API con el procesamiento del lado del cliente en memoria.
Mesas¶
El conector modela los datos en Xero WorkflowMax en una lista de tablas que se pueden consultar mediante instrucciones SQL estándar.
Generalmente, consultar las tablas de Xero WorkflowMax 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 WorkflowMax¶
Nombre | Descripción |
---|---|
ClientContacts | Devuelve una lista de todos los contactos de los clientes. |
ClientGroups | Devolver una lista de todos los grupos de clientes |
Clients | Devuelve una lista de todos los clientes. |
Costs | Devolver una lista de todos los costos |
JobCosts | Devuelve una lista de todos los costos de los trabajos. |
JobNotes | Devuelve una lista de todas las notas de un trabajo |
Jobs | Devuelve una lista de todos los trabajos. |
JobTasks | Devuelve una lista de todas las tareas de los trabajos. |
Leads | Devuelve una lista de todos los clientes potenciales. |
PurchaseOrderDrafts | Devolver una lista de todos los borradores de órdenes de compra |
PurchaseOrders | Devolver una lista de todas las órdenes de compra |
StaffList | Devolver una lista de todos los miembros del personal |
SupplierContacts | Devolver una lista de todos los proveedores. |
Suppliers | Devolver una lista de todos los proveedores. |
Times | Devuelve una lista de todas las hojas de tiempo. |
ClienteContactos¶
Devuelve una lista de todos los contactos de los clientes.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientContacts WHERE UUID IN ('3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9', 'd807cf4c-a2b9-428a-82e7-124b4f3ddab4')
Insertar¶
ClientUUID y Name son necesarios para insertar. La siguiente consultar crea un nuevo ClientContact:
INSERT INTO ClientContacts (ClientUUID, Name) VALUES ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', 'Rambo')
Actualizar¶
Puede actualizar un ClientContact especificando el UUID de ClientContact:
UPDATE ClientContacts SET Name = 'Arnold' WHERE UUID='3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
Borrar¶
Elimine un ClientContact especificando el UUID de ClientContact:
DELETE FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
ClientUUID | String | Falso | El ID del cliente |
UUID [KEY] | String | Verdadero | El ID del contacto que pertenece al cliente |
Name | String | Falso | El nombre del contacto |
Mobile | String | Falso | Número de móvil del contacto |
Email | String | Falso | Correo del contacto |
Phone | String | Falso | Número de teléfono del contacto |
Position | String | Falso | La posición del contacto |
Salutation | String | Falso | El saludo se usa después de 'Querido... |
Addressee | String | Falso | La dirección del contacto |
IsPrimary | String | Falso | Determina si este contacto es el contacto principal utilizado por el cliente Sí | No |
Grupos de Clientes¶
Devolver una lista de todos los grupos de clientes
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM ClientGroups WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientGroups WHERE UUID IN ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', '5a92d62b-089f-4d28-a4d2-c69692edc41a')
Insertar¶
ClientUUID y Name son necesarios para insertar. La siguiente consultar crea un nuevo ClientGroup:
INSERT INTO ClientGroups (Name, ClientUUID, Taxable) VALUES('Clients', '446ddb14-4084-48fc-83bd-76b89125450a', true)
Borrar¶
Elimine un grupo de clientes especificando el UUID del grupo de clientes:
DELETE FROM ClientGroups WHERE UUID='c6ec5c2c-2657-4ce3-b035-022c02b9f19e'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Verdadero | El ID del grupo de clientes |
Name | String | Falso | El nombre del grupo de clientes |
Taxable | String | Falso | Configuración de grupo imponible opcional para usuarios de Practice Manager |
ClientUUID | String | Falso | Se utiliza para crear un grupo de clientes, ya que se requiere colocar al menos un cliente indicado por su ID de cliente. |
Clientela¶
Devuelve una lista de todos los clientes.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.Name
admite 'CONTIENE'.
La columna UUID permite especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Clients WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
SELECT * FROM Clients WHERE CONTAINS(Name, 'Brian')
SELECT * FROM Clients WHERE ModifiedSince='2012-06-05T06:00:00'
Insertar¶
El nombre es obligatorio para insertar. La siguiente consultar crea un nuevo Cliente:
INSERT INTO Clients (Name) VALUES ('some name')
Actualizar¶
Puede actualizar especificando el UUID de los clientes:
UPDATE Clients SET Name='Arnold' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Borrar¶
Elimine un cliente especificando el UUID del cliente:
DELETE FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Archive un cliente especificando el UUID del cliente y configurando Archive=true:
DELETE FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND Archive=true
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Verdadero | El DNI del cliente. |
Name | String | Falso | El nombre del cliente. |
Email | String | Falso | El correo del cliente. |
Address | String | Falso | La dirección del cliente. |
City | String | Falso | La ciudad donde se encuentra el cliente. |
Region | String | Falso | La región donde se encuentra el cliente. |
PostCode | String | Falso | El código postal de donde se encuentra el cliente. |
Country | String | Falso | El país donde se encuentra el cliente. |
PostalAddress | String | Falso | La dirección de la oficina postal. |
PostalCity | String | Falso | La ciudad donde se encuentra la oficina postal. |
PostalRegion | String | Falso | La región donde se encuentra la oficina postal. |
PostalPostCode | String | Falso | El código postal de la oficina postal. |
PostalCountry | String | Falso | El país donde se encuentra la oficina postal. |
Phone | String | Falso | El número de teléfono del cliente. |
Fax | String | Falso | El número de fax del cliente. |
Website | String | Falso | El sitio web asociado al cliente. |
ReferralSource | String | Falso | Fuente por la cual el cliente fue referido. |
ExportCode | String | Falso | El código de exportación (como un código de cuenta/código fiscal) asociado con el cliente. |
IsProspect | String | Falso | Determina si el cliente es un cliente potencial |
AccountManagerUUID | String | Falso | Opcional - ID del miembro del personal. |
AccountManagerName | String | Verdadero | Nombre del miembro del personal. |
TypeName | String | Verdadero | El tipo de cliente |
TypeCostMarkup | String | Verdadero | El margen de beneficio % del tipo de cliente |
TypePaymentTerm | String | Verdadero | Las condiciones de pago del tipo de cliente |
TypePaymentDay | String | Verdadero | El día de pago / número de días del tipo de cliente |
FirstName | String | Falso | Opcional para personas físicas, nombre de la persona |
LastName | String | Falso | Opcional para personas físicas, Apellido de la persona física |
OtherName | String | Falso | Opcional para personas físicas, OtroNombre de la persona |
DateOfBirth | Datetime | Falso | Opcional para personas físicas, fecha de nacimiento de la persona |
BillingClientUUID | String | Falso | Se utiliza en los casos en que el cliente es diferente al cliente de facturación. |
BillingClientName | String | Falso | Nombre del cliente de facturación. |
JobManagerUUID | String | Falso | opcional - ID del miembro del personal |
JobManagerName | String | Verdadero | Nombre del miembro del personal. |
TaxNumber | String | Falso | Número de identificación utilizado a efectos fiscales |
CompanyNumber | String | Falso | El número de registro de la empresa. |
BusinessNumber | String | Falso | Nombre de la estructura comercial (según el administrador) |
BalanceMonth | String | Falso | p.ej. 1 de enero, 2 de febrero, 3 de marzo, etc. |
PrepareGST | String | Falso | si o no |
GSTRegistered | String | Falso | si o no |
GSTPeriod | String | Falso | 1, 2, 6 |
GSTBasis | String | Falso | Factura, Pago, Híbrido |
ProvisionalTaxBasis | String | Falso | Opción estándar, opción de estimación, opción de proporción |
ProvisionalTaxRatio | String | Falso | Tasa de impuestos para el cliente cuando se selecciona la opción Ratio para ProvisionalTaxBasis. |
SignedTaxAuthority | String | Falso | Sí o No (solo clientes de Nueva Zelanda) |
TaxAgent | String | Falso | Nombre del Agente fiscal (según el administrador) (solo clientes de Nueva Zelanda) |
AgencyStatus | String | Falso | Con EOT, Sin EOT, Desvinculado (solo clientes de Nueva Zelanda) |
ReturnType | String | Falso | IR3, IR3NR, IR4, IR6, IR7, IR9, PTS (solo clientes de Nueva Zelanda) |
PrepareActivityStatement | String | Falso | Sí o No (solo clientes de AU) |
PrepareTaxReturn | String | Falso | Sí o No (solo clientes de AU) |
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.
Nombre | Tipo | Descripción |
---|---|---|
ModifiedSince | String | Se utiliza para filtrar clientes desde la última vez que se modificaron. |
Archive | Boolean | Se utiliza para archivar un Cliente sin eliminarlo por completo |
Costos¶
Devolver una lista de todos los costos
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Costs WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Costs WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26av43')
Insertar¶
Descripción, UnitPrice, UnitCost son necesarios para insertar. La siguiente consultar crea un nuevo Costo:
INSERT INTO Costs (Description, UnitPrice, UnitCost) VALUES ('decr', 100, 200)
Actualizar¶
Puede actualizar un costo especificando el UUID del costo:
UPDATE Costs SET UnitPrice='101' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Borrar¶
Elimine un costo especificando el UUID del costo:
DELETE FROM Costs WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Verdadero | El ID del Costo. |
Description | String | Falso | La descripción relacionada con el costo. |
Code | String | Falso | El código de la unidad. |
Note | String | Falso | La nota relacionada con el costo. |
UnitCost | Float | Falso | Costo por unidad. |
UnitPrice | Float | Falso | Precio por unidad. |
SupplierUUID | String | Falso | Determina el identificador del proveedor. |
SupplierName | String | Verdadero | Determina el nombre del proveedor. |
Costos de Trabajo¶
Devuelve una lista de todos los costos de los trabajos.
Seleccionar¶
Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again. In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
JobID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM JobCosts WHERE JobID='J000002'
SELECT * FROM JobCosts WHERE JobID IN ('J000001', 'J000002')
Insertar¶
JobID, Fecha, Descripción, Cantidad, UnitCost, UnitPrice son necesarios para insertar. La siguiente consultar crea un nuevo JobCost:
INSERT INTO JobCosts (JobID, Date, Description, Quantity, UnitCost, UnitPrice) VALUES ('J000002', '2019-07-17T00:00:00', 'Maybach', '123', 30, 50)
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
JobID | String | Falso | Identificador de trabajo relacionado con el costo. |
UUID [KEY] | String | Verdadero | Identificador de costos. |
Date | Datetime | Falso | La fecha en que se creó el costo. |
Description | String | Falso | La descripción relacionada con el costo. |
Code | String | Falso | El código de la unidad. |
Note | String | Falso | La nota relacionada con el costo. |
Quantity | Double | Falso | Cantidad de producto. |
UnitCost | Float | Falso | Costo por unidad. |
UnitPrice | Float | Falso | Precio por unidad. |
SupplierUUID | String | Falso | Determina el identificador del proveedor. |
SupplierName | String | Verdadero | Determina el nombre del proveedor. |
Billable | String | Verdadero | Determina si el costo es facturable o no (predeterminado) | FALSO. |
Notas de Trabajo¶
Devolver una lista de todas las notas de un trabajo
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Insertar¶
JobID, Título, Texto son necesarios para insertar. La siguiente consultar crea una nueva nota de trabajo:
INSERT INTO JobNotes (JobID, Title, Text) VALUES ('J000001', '133193699', 'some notes')
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
JobID | String | Falso | El ID del trabajo que tiene la nota. |
UUID [KEY] | String | Verdadero | El identificador de la nota. |
Title | String | Falso | El título de la nota. |
Text | String | Falso | El texto de la nota. |
Folder | String | Falso | La carpeta donde está la nota. |
Date | Datetime | Verdadero | La fecha en la que se creó la nota. |
CreatedBy | String | Verdadero | El nombre del personal que creó la nota. |
Comments | String | Verdadero | Todos los comentarios en una nota en formato xml. |
Public | String | Falso | Determina si la nota es pública para los miembros del personal. verdadero | Falso |
Trabajos¶
Devuelve una lista de todos los trabajos.
Seleccionar¶
Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again. In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
Id
apoya el=
operador.AssignedStaffUUID
apoya el=
operador.ClientUUID
apoya el=
operador.CreatedDate
admite los operadores '<=,<,=,>,>='.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12'
SELECT * FROM Jobs WHERE ID='J000001'
SELECT * FROM Jobs WHERE AssignedStaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ID IN ('23423', '34534')
SELECT * FROM Jobs WHERE AssignedStaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a8f6', '9d382fcf-7013-4d97-8dd8-c08e8b26a4d2')
SELECT * FROM Jobs WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6i1')
Notes:
- Al ejecutar una consultar SELECT * simple, el conector recuperará solo sus facturas actuales.
- Al especificar la fecha de creación, el conector recuperará los trabajos actuales y archivados.
Insertar¶
Nombre, ClientUUID, StartDate, DueDate son necesarios para insertar. La siguiente consultar crea un nuevo trabajo:
INSERT INTO Jobs (Name, ClientUUID, StartDate, DueDate) VALUES ('Job Name', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', '2019-07-17T00:00:00')
Actualizar¶
Puede actualizar especificando el ID del trabajo:
UPDATE Jobs SET StartDate='2007-07-16T00:00:00' WHERE Id='J000003'
Borrar¶
Elimine un trabajo especificando el ID del trabajo:
DELETE FROM Jobs WHERE ID='J000003'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
ID [KEY] | String | Falso | Identificador de trabajo. |
Name | String | Falso | El nombre del trabajo. |
Description | String | Falso | La descripción relacionada con el puesto. |
State | String | Verdadero | El estado del trabajo. |
ClientOrderNumber | String | Falso | Número de orden asociado con este trabajo. |
StartDate | Datetime | Falso | La fecha en que se ha iniciado el trabajo. |
DueDate | Datetime | Falso | La fecha en que se debe completar el trabajo. |
CompletedDate | Datetime | Falso | La fecha en que se completó el trabajo. |
ClientUUID | String | Falso | El identificador de cliente relacionado con el trabajo. |
ClientName | String | Falso | El nombre del cliente relacionado con el trabajo. |
ContactUUID | String | Falso | El identificador de cliente relacionado con el trabajo. |
ContactName | String | Falso | El nombre del cliente relacionado con el trabajo. |
ManagerUUID | String | Falso | El identificador del administrador relacionado con el trabajo. |
ManagerName | String | Falso | El nombre del administrador relacionado con el trabajo. |
PartnerUUID | String | Falso | El identificador de socio relacionado con el trabajo. |
PartnerName | String | Falso | El nombre del socio relacionado con el trabajo. |
AssignedStaff | String | Verdadero | Lista de los miembros del personal asignados al trabajo en formato xml. |
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.
Nombre | Tipo | Descripción |
---|---|---|
TemplateUUID | String | Se utiliza al insertar un trabajo para determinar su modelo inicial. |
CategoryUUID | String | Se utiliza al insertar un trabajo para determinar su categoría inicial. |
AssignedStaffUUID | String | Se utiliza para filtrar trabajos según el miembro del personal asignado. |
CreatedDate | Date | Se utiliza para filtrar trabajos a partir de su fecha de creación. |
Tareas Laborales¶
Devuelve una lista de todas las tareas de los trabajos.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
Complete
apoya el=
operador.CreatedDate
admite los operadores '<=,<,=,>,>='.
SELECT * FROM JobTasks WHERE Complete=False
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11' AND CreatedDate<='2020-11-11'
SELECT * FROM JobTasks WHERE CreatedDate='2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11' AND CreatedDate<='2020-11-11' AND Complete=true
Insertar¶
Se requieren minutos estimados, ID de tarea, ID de trabajo, nombre, fecha de inicio, fecha de vencimiento para insertar. La siguiente consultar crea una nueva JobTask:
INSERT INTO JobTasks (EstimatedMinutes, TaskUUID, JobID, Name, StartDate, DueDate) VALUES ('100', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'J000002', '21910642', '2019-07-17T00:00:00', '2019-07-17T00:00:00')
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
JobID | String | Verdadero | El identificador de trabajo relacionado con la tarea. |
UUID [KEY] | String | Verdadero | El identificador de la tarea. |
TaskUUID | String | Verdadero | El identificador de tareas hace referencia a Tasks.ID. |
Name | String | Verdadero | El nombre de la tarea. |
Description | String | Verdadero | La descripción relacionada con la tarea. |
EstimatedMinutes | Int | Verdadero | El tiempo estimado para completar la tarea. |
ActualMinutes | Int | Verdadero | Pasó el tiempo real. |
Completed | Boolean | Verdadero | Determinar si la tarea se completó o no. |
Billable | Boolean | Verdadero | Determina si la tarea es facturable o no (predeterminado) | FALSO. |
CreatedDate | Date | Verdadero | Determina la fecha y hora en que se inició la tarea. |
DueDate | Date | Verdadero | Determina la fecha y hora en que debe finalizar la tarea. |
AssignedStaffUUID | String | Verdadero | Lista de los miembros del personal asignados al trabajo en formato xml |
Label | String | Falso | Se utiliza durante la inserción para determinar una etiqueta para la tarea. |
Dirige¶
Devuelve una lista de todos los clientes potenciales.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.CreatedDate
admite los operadores '<=,<,=,>,>='.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Leads WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Leads WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Leads WHERE CreatedDate='2000-12-12'
SELECT * FROM Leads WHERE CreatedDate>='2000-12-12'
SELECT * FROM Leads WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5k9')
Notes:
- Al ejecutar una consultar SELECT * simple, el conector recuperará solo sus clientes potenciales actuales.
- Al especificar la fecha de creación, el conector recuperará todos los clientes potenciales.
Insertar¶
Nombre, ClientUUID, OwnerID son necesarios para insertar. La siguiente consultar crea un nuevo cliente potencial:
INSERT INTO Leads (Name, ClientUUID, OwnerUUID) VALUES ('hey', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Verdadero | Identificador de plomo. |
Name | String | Verdadero | El nombre del líder. |
Description | String | Verdadero | La descripción del plomo. |
State | String | Verdadero | El estado del plomo. |
CreatedDate | Datetime | Verdadero | La fecha en que se creó el cliente potencial. |
DateWonLost | String | Verdadero | Fecha en que se ganó o se perdió esta ventaja. |
Category | String | Verdadero | La categoría del protagonista. |
EstimatedValue | Int | Verdadero | Valor estimado del lead. |
ClientUUID | String | Verdadero | El identificador de cliente relacionado con el cliente potencial. |
ClientName | String | Verdadero | El nombre del cliente relacionado con el cliente potencial. |
ContactUUID | String | Verdadero | El ID de contacto del cliente relacionado con el cliente potencial. |
ContactName | String | Verdadero | El nombre de contacto del cliente relacionado con el prospecto. |
OwnerUUID | String | Verdadero | El ID del propietario relacionado con el cliente potencial. |
OwnerName | String | Verdadero | El nombre del propietario relacionado con el cliente potencial. |
CategoryUUID | String | Falso | Se utiliza durante la inserción para determinar una categoría para el cliente potencial. |
TemplateUUID | String | Falso | Se utiliza durante la inserción para determinar una modelo para el cable. |
Borradores de Orden de Compra¶
Devolver una lista de todos los borradores de órdenes de compra
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Insertar¶
Para insertar en Borradores de pedido de compra, deberá insertar temporalmente al menos un Costo de pedido de compra que servirá como artículos para el Pedido de compra. Puede hacerlo indicando el nombre de la tabla como CostosOrdenCompra#TEMP. Después de insertar en la tabla temporal, puede ejecutar una inserción en Pedidos de compra configurando Costos de pedido de compra = Costos de pedido de compra # TEMP como en la consultar a continuación. Se requiere insertar JobID, SupplierUUID, Date, PurchaseOrderCosts. Se necesitan las siguientes consultas para crear un nuevo pedido de compra con 2 elementos de coste del pedido de compra:
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrderDrafts (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')
Alternativamente, puede ejecutar una operación INSERT en el pedido de compra estableciendo el valor de los costos del pedido de compra como una cadena xml de elementos en la siguiente estructura:
<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
ID [KEY] | String | Falso | El identificador de la orden de compra. |
Description | String | Falso | La descripción relacionada con la orden de compra. |
State | String | Falso | El estado de la orden de compra. |
CreatedDate | Datetime | Verdadero | La fecha en que se creó la orden de compra. |
DeliveryAddress | String | Falso | Dirección de entrega de la orden de compra. |
Amount | Float | Verdadero | La cantidad a pagar. |
AmountTax | Float | Verdadero | El monto del impuesto a pagar. |
AmountIncludingTax | Float | Verdadero | El monto total a pagar incluyendo impuestos. |
SupplierUUID | String | Falso | El identificador del proveedor relacionado con la orden de compra. |
SupplierName | String | Verdadero | El nombre del proveedor relacionado con la orden de compra. |
JobID | String | Falso | El identificador del trabajo relacionado con la orden de compra. |
JobName | String | Verdadero | El nombre del trabajo relacionado con la orden de compra. |
PurchaseOrderCosts | String | Falso | Enumera todos los costos de las órdenes de compra, formato xml. |
Ordenes de Compra¶
Devolver una lista de todas las órdenes de compra
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
Id
apoya el=
operador.JobID
apoya el=
operador.CreatedDate
admite los operadores '<=,<,=,>,>='.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM PurchaseOrders WHERE ID='2512811'
SELECT * FROM PurchaseOrders WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate='2000-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate>='2000-12-12'
SELECT * FROM PurchaseOrders WHERE ID IN ('23423', '34534')
SELECT * FROM PurchaseOrders WHERE JobID IN ('23423', '34534')
Notes:
- Al ejecutar una consultar SELECT * simple, el conector recuperará solo sus pedidos de compra actuales.
- Al especificar la fecha de creación, el conector recuperará los pedidos de compra actuales y archivados.
Insertar¶
Para insertar en Pedidos de compra, deberá insertar temporalmente al menos un Costo de pedido de compra que servirá como artículos para el Pedido de compra. Puede hacerlo indicando el nombre de la tabla como CostosOrdenCompra#TEMP. Después de insertar en la tabla temporal, puede ejecutar una inserción en Pedidos de compra configurando Costos de pedido de compra = Costos de pedido de compra # TEMP como en la consultar a continuación. Se requiere insertar JobID, SupplierUUID, Date, PurchaseOrderCosts. Se necesitan las siguientes consultas para crear un nuevo pedido de compra con 2 elementos de coste del pedido de compra:
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrders (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')
Alternativamente, puede ejecutar una operación INSERT en el pedido de compra estableciendo el valor de los costos del pedido de compra como una cadena xml de elementos en la siguiente estructura:
<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
ID [KEY] | String | Falso | El identificador de la orden de compra. |
Description | String | Falso | La descripción relacionada con la orden de compra. |
State | String | Falso | El estado de la orden de compra. |
CreatedDate | Datetime | Verdadero | La fecha en que se creó la orden de compra. |
DeliveryAddress | String | Falso | Dirección de entrega de la orden de compra. |
Amount | Float | Verdadero | La cantidad a pagar. |
AmountTax | Float | Verdadero | El monto del impuesto a pagar. |
AmountIncludingTax | Float | Verdadero | El monto total a pagar incluyendo impuestos. |
SupplierUUID | String | Falso | El identificador del proveedor relacionado con la orden de compra. |
SupplierName | String | Verdadero | El nombre del proveedor relacionado con la orden de compra. |
JobID | String | Falso | El identificador del trabajo relacionado con la orden de compra. |
JobName | String | Verdadero | El nombre del trabajo relacionado con la orden de compra. |
PurchaseOrderCosts | String | Falso | Enumera todos los costos de las órdenes de compra, formato xml. |
Lista de Personal¶
Devolver una lista de todos los miembros del personal
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM StaffList WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM StaffList WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a9f6')
Insertar¶
El nombre es obligatorio para insertar. La siguiente consultar crea un nuevo miembro StaffList:
INSERT INTO StaffList (Name) VALUES ('J000002')
Actualizar¶
Puede actualizar un miembro del personal especificando el UUID del miembro del personal:
UPDATE StaffList SET Email='hey@gmail.com', Phone='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Borrar¶
Elimine un miembro del personal especificando el UUID del miembro del personal:
DELETE FROM StaffList WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Verdadero | El identificador del miembro del personal. |
Name | String | Falso | El nombre del miembro del personal. |
Email | String | Falso | El correo del miembro del personal. |
Phone | String | Falso | El número de teléfono del miembro del personal. |
Mobile | String | Falso | El número de móvil del miembro del personal. |
Address | String | Falso | La dirección del miembro del personal. |
PayrollCode | String | Falso | Código de nómina del funcionario. |
ProveedorContactos¶
Devolver una lista de todos los proveedores.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM SupplierContacts WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5hj')
SELECT * FROM SupplierContacts WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Insertar¶
ProveedorUUID, nombre son necesarios para insertar. La siguiente consultar crea un nuevo contacto de proveedor:
INSERT INTO SupplierContacts (SupplierUUID, Name) VALUES ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'ckemi')
Actualizar¶
Puede actualizar un contacto de proveedor especificando el UUID de contacto de proveedor:
UPDATE SupplierContacts SET Name='hey@gmail.com', Mobile='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
SupplierUUID | String | Falso | El DNI del proveedor. |
UUID [KEY] | String | Verdadero | El ID del contacto que pertenece al proveedor. |
Name | String | Falso | El nombre del contacto. |
Mobile | String | Falso | El número de móvil del contacto. |
Email | String | Falso | El correo del contacto. |
Phone | String | Falso | El número de teléfono del contacto. |
Position | String | Falso | La posición del contacto. |
Proveedores¶
Devolver una lista de todos los proveedores.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Suppliers WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')
Insertar¶
El nombre es obligatorio para insertar. La siguiente consultar crea un nuevo Proveedor:
INSERT INTO Suppliers (Name) VALUES ('Arnold')
Actualizar¶
Puede actualizar especificando el UUID:
UPDATE Suppliers SET Address='hey@hey.com', City='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Borrar¶
Elimine un proveedor especificando el UUID del proveedor:
DELETE FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Archive un proveedor especificando el UUID del proveedor y configurando Archive=true en la consultar:
DELETE FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' and Archive=true
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Verdadero | El DNI del proveedor. |
Name | String | Falso | El nombre del proveedor. |
Address | String | Falso | La dirección del proveedor. |
City | String | Falso | La ciudad donde se encuentra el proveedor. |
Region | String | Falso | La región donde se encuentra el cliente. |
PostCode | String | Falso | El código postal de donde se encuentra el proveedor. |
Country | String | Falso | El país donde se encuentra el proveedor. |
PostalAddress | String | Falso | La dirección de la oficina postal. |
PostalCity | String | Falso | La ciudad donde se encuentra la oficina postal. |
PostalRegion | String | Falso | La región donde se encuentra la oficina postal. |
PostalPostCode | String | Falso | El código postal de la oficina postal. |
PostalCountry | String | Falso | El país donde se encuentra la oficina postal. |
Phone | String | Falso | El número de teléfono del proveedor. |
Fax | String | Falso | El número de fax del proveedor. |
Website | String | Falso | El sitio web del proveedor. |
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.
Nombre | Tipo | Descripción |
---|---|---|
Archive | String | Se utiliza para archivar un proveedor sin eliminarlo por completo |
Veces¶
Devuelve una lista de todas las hojas de tiempo.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.JobID
apoya el=
operador.StaffID
apoya el=
operador.CreatedDate
admite los operadores '<=,<,=,>,>='.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Times WHERE JobID='J000001'
SELECT * FROM Times WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Times WHERE CreatedDate>='2018-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Times WHERE StaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND CreatedDate>='2018-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Times WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE StaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE JobID IN ('J000001', 'J000002')
Insertar¶
JobID, TaskID, StaffID, Fecha, Minutos son necesarios para insertar. La siguiente consultar crea una nueva entrada de tiempo:
INSERT INTO Times (JobID, TaskUUID, StaffUUID, Date, Minutes) VALUES ('J000001', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5e8', '2019-06-27T00:00:00', '240')
Actualizar¶
Puede actualizar especificando el UUID:
UPDATE Times SET Date='2019-06-27T00:00:00', Minutes='240' WHERE UUID='250193564'
Borrar¶
Elimine una entrada de tiempo especificando el UUID:
DELETE FROM Times WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Columnas¶
Nombre | Tipo | Solo lectura | Descripción |
---|---|---|---|
UUID [KEY] | String | Falso | El ID de la entrada del parte de horas. |
JobID | String | Falso | El ID del trabajo relacionado con la entrada del parte de horas. |
JobName | String | Verdadero | El nombre del trabajo relacionado con la entrada del parte de horas. |
TaskUUID | String | Falso | El ID de la tarea relacionada con la entrada del parte de horas. |
TaskName | String | Verdadero | El nombre de la tarea relacionada con la entrada del parte de horas. |
StaffUUID | String | Falso | El ID del personal relacionado con la entrada del parte de horas. |
StaffName | String | Verdadero | El nombre del personal relacionado con la entrada del parte de horas. |
CreatedDate | Datetime | Falso | La fecha de la entrada del parte de horas. |
Minutes | Int | Falso | Los minutos de cuánto durará la entrada del parte de horas. |
Note | String | Falso | La nota relacionada con la entrada del parte de horas. |
Billable | Boolean | Falso | Booleano indicando si este tiempo es facturable o no. |
Start | Time | Falso | La hora de inicio de la entrada del parte de horas. |
End | Time | Falso | La hora en que finalizó la entrada del parte de horas. |
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 WorkflowMax¶
Nombre | Descripción |
---|---|
Categories | Devolver una lista de todas las categorías |
ClientDocuments | Devolver una lista de todos los documentos de los clientes. |
ClientNotes | Devolver todas las notas de los clientes |
InvoiceDrafts | Devolver una lista de borradores de facturas |
InvoicePayments | Devolver una lista de pagos de facturas |
Invoices | Devolver una lista de facturas |
InvoicesJobTask | Devuelve una lista de facturas relacionadas con Tareas. |
JobDocuments | Devuelve una lista de todos los documentos de un trabajo |
JobMilestones | Devolver todos los hitos de trabajos |
LeadCategories | Devolver una lista de categorías de clientes potenciales |
PurchaseOrderCosts | Devolver todos los costos de la orden de compra |
QuoteDrafts | Devolver una lista de todos los borradores de cotizaciones |
Quotes | Devolver una lista de todas las cotizaciones |
QuotesCost | Devuelve una lista de cotizaciones relacionadas con los costos. |
QuotesOption | Devuelve una lista de cotizaciones relacionadas con las opciones. |
QuotesTask | Devuelve una lista de cotizaciones relacionadas con Tareas. |
Tasks | Devolver una lista de todas las tareas |
Templates | Devolver una lista de todas las plantillas |
Categorías¶
Devolver una lista de todas las categorías.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
UUID [KEY] | String | El ID de la categoría |
Name | String | El nombre de la categoría |
ClienteDocumentos¶
Devolver una lista de todos los documentos de los clientes.
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
ClientUUID
apoya el=
operador.
Para ejecutar una consultar SELECT a ClientDocuments, debe proporcionar ClientUUID como condición WHERE. Específicamente, lo siguiente se procesa del lado del servidor:
SELECT * FROM ClientDocuments WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM ClientDocuments WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
ClientUUID [KEY] | String | El DNI del cliente que tiene el documento. |
Title | String | El título del documento. |
Text | String | La nota relativa al documento. |
Folder | String | La carpeta donde se encuentra el documento. |
Date | Datetime | La fecha en que se creó el documento. |
CreatedBy | String | El nombre del personal que creó el documento. |
URL | String | La URL utilizada para descargar directamente el documento. |
ClienteNotas¶
Devolver todas las notas de los clientes.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
ClientUUID [KEY] | String | El ID del Cliente que tiene las notas. |
Title | String | El título de la nota. |
Text | String | El texto de la nota. |
Folder | String | La carpeta donde está la nota. |
Date | Date | La fecha en la que se creó la nota. |
CreatedBy | String | El nombre del personal que creó el documento. |
Borradores de Factura¶
Devolver una lista de borradores de facturas
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
UUID [KEY] | String | El nombre de la categoría |
Type | String | Determina el tipo de factura. |
Status | String | Estado de la factura Aprobada, Pagada, Borrador, Cancelada |
JobID | String | Id del trabajo asociado con esta factura. |
CreatedDate | Date | Determina la fecha en que se creó la factura. |
DueDate | Date | Determina la fecha de vencimiento de la factura. |
Amount | Float | La cantidad a pagar. |
AmountTax | Float | El monto del impuesto a pagar. |
AmountIncludingTax | Float | El monto total a pagar incluyendo impuestos. |
AmountPaid | Float | Determinar la cantidad que ya se ha pagado. |
AmountOutstanding | Float | Determina la cantidad que queda por pagar. |
ClientUUID | String | Identificador del cliente relacionado con la factura. |
ClientName | String | Nombre del cliente relacionado con la factura. |
ContactUUID | String | Identificador de contacto del cliente relacionado con la factura. |
ContactName | String | Nombre de contacto del cliente relacionado con la factura. |
FacturaPagos¶
Devolver una lista de pagos de facturas
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
InvoiceID [KEY] | String | El identificador de la factura |
Date | Date | La fecha del pago |
Amount | Float | La cantidad que se ha pagado. |
Reference | String | La referencia del pago |
Facturas¶
Devolver una lista de facturas
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
CreatedDate
admite los operadores '<=,<,=,>,>='.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Invoices WHERE CreatedDate>='2019-08-07' and CreatedDate<='2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate>='2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate='2019-08-07'
Notes:
- Al ejecutar una consultar SELECT * simple, el conector recuperará solo sus facturas actuales.
- Al especificar CreatedFrom y CreatedTo, el conector recuperará las facturas actuales y archivadas.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
ID [KEY] | String | El nombre de la categoría |
Type | String | Determina el tipo de factura. |
Status | String | Estado de la factura Aprobada, Pagada, Borrador, Cancelada |
JobID | String | Id del trabajo asociado con esta factura. |
CreatedDate | Date | Determina la fecha en que se creó la factura. |
DueDate | Date | Determina la fecha de vencimiento de la factura. |
Amount | Float | La cantidad a pagar. |
AmountTax | Float | El monto del impuesto a pagar. |
AmountIncludingTax | Float | El monto total a pagar incluyendo impuestos. |
AmountPaid | Float | Determinar la cantidad que ya se ha pagado. |
AmountOutstanding | Float | Determina la cantidad que queda por pagar. |
ClientUUID | String | Identificador del cliente relacionado con la factura. |
ClientName | String | Nombre del cliente relacionado con la factura. |
ContactUUID | String | Identificador de contacto del cliente relacionado con la factura. |
ContactName | String | Nombre de contacto del cliente relacionado con la factura. |
FacturasTrabajoTarea¶
Devuelve una lista de facturas relacionadas con Tareas.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente excepto InvoiceID.
SELECT * FROM InvoicesJobTask
Select * from InvoicesJobTask where InvoiceID = 'I000123'
Select * from InvoicesJobTask where InvoiceID IN ('I000124', 'I000123')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
InvoiceID [KEY] | String | El identificador de la factura |
Name | String | El Nombre de la tarea relacionada con la factura. |
Description | String | La Descripción de la tarea relacionada con la factura. |
Minutes | Int | El Acta de la tarea relacionada con la factura. |
BillableRate | Double | El BillableRate de la tarea relacionada con la factura. |
Billable | String | Facturable de la tarea relacionada con la factura. |
Amount | Double | El Importe de la tarea relacionada con la factura. |
AmountTax | Double | El AmountTax de la tarea relacionada con la factura. |
AmountIncludingTax | Double | El importe incluido el impuesto de la tarea relacionada con la factura. |
TrabajoDocumentos¶
Devolver una lista de todos los documentos de un trabajo
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
JobID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM JobDocuments WHERE JobID='J000001'
SELECT * FROM JobDocuments WHERE JobID IN ('23423', '34534')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
JobID [KEY] | String | El ID del trabajo que tiene el documento. |
Title | String | El título del documento. |
Text | String | La nota relativa al documento. |
Folder | String | La carpeta donde se encuentra el documento. |
Date | Datetime | La fecha en que se creó el documento. |
CreatedBy | String | El nombre del personal que creó el documento. |
URL | String | La URL utilizada para descargar directamente el documento. |
Hitos Laborales¶
Devolver todos los hitos de los trabajos.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
JobID [KEY] | String | El ID del trabajo relacionado con el hito. |
Date | Date | La fecha a la que se refiere el hito. |
Description | String | La descripción relacionada con el hito. |
Completed | Boolean | Determina si el hito se ha completado o no. |
Categorías de Clientes Potenciales¶
Devolver una lista de categorías de clientes potenciales
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
UUID [KEY] | String | El UUID de la categoría |
Name | String | El nombre de la categoría |
Costos de Orden de Compra¶
Devolver todos los costos de la orden de compra
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Insertar¶
Se requiere Descripción, Cantidad, Costo unitario, Código, Nota para insertar en la tabla temporal. La siguiente consultar crea una nueva entrada de BuyOrderCost en la memoria:
INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('hey descr', 4, 50, '123', 'note')
Después de insertar en Costos de orden de compra # TEMP, tiene todos los artículos que necesita para insertar la orden de compra. Vea Órdenes de Compra para obtener más detalles sobre la inserción en órdenes de compra.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
PurchaseOrderID [KEY] | String | Dado que los costos no tienen un identificador, este es el identificador de la orden de compra que hace referencia a PurchaseOrders.ID |
Description | String | La descripción relacionada con el costo |
Code | String | El código de la unidad. |
Quantity | Int | Cantidad de producto. |
UnitCost | Float | Costo por unidad. |
Amount | Float | La cantidad a pagar. |
AmountTax | Float | El monto del impuesto a pagar. |
AmountIncludingTax | Float | El monto total a pagar incluyendo impuestos. |
Note | String | La nota relacionada con el costo. |
PresupuestoBorradores¶
Devolver una lista de todos los borradores de cotizaciones
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
ID [KEY] | String | El identificador de cotización. |
Type | String | El tipo de cotización. |
State | String | El estado de la cotización. |
CreatedDate | Datetime | La fecha en que se creó la cotización. |
ValidDate | Datetime | La fecha hasta la cotización es válida. |
Budget | String | El presupuesto de la cotización. |
OptionExplanation | String | Una descripción para explicar las opciones relacionadas con la cotización. |
EstimatedCost | Float | Monto estimado del costo. |
EstimatedCostTax | Float | Monto estimado del costo del impuesto. |
EstimatedCostIncludingTax | Float | Importe total estimado impuestos incluidos. |
AmountTax | Float | Monto a pagar. |
AmountIncludingTax | Float | Importe del impuesto a pagar. |
Amount | Float | Importe total a pagar impuestos incluidos. |
ClientUUID | String | El identificador del Cliente que está relacionado con la cotización. |
ClientName | String | El nombre del Cliente relacionado con la cotización. |
ContactUUID | String | El ID de contacto del cliente que está relacionado con la cotización. |
ContactName | String | El nombre de contacto del cliente relacionado con la cotización. |
Citas¶
Devolver una lista de todas las cotizaciones
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
Id
apoya el=
operador.CreatedDate
admite los operadores '<=,<,=,>,>='.
Todas las columnas que se pueden filtrar, excepto Fecha de creación, permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Quotes WHERE ID='Q000001'
SELECT * FROM Quotes WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Quotes WHERE CreatedDate='2000-12-12'
SELECT * FROM Quotes WHERE CreatedDate>='2000-12-12'
SELECT * FROM Quotes WHERE ID IN ('Q000001', 'Q000002')
Notes:
- Al ejecutar una consultar SELECT * simple, el conector recuperará solo sus Cotizaciones actuales.
- Al especificar la fecha de creación, el conector recuperará las cotizaciones actuales y archivadas.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
ID [KEY] | String | El identificador de cotización. |
Type | String | El tipo de cotización. |
State | String | El estado de la cotización. |
CreatedDate | Datetime | La fecha en que se creó la cotización. |
ValidDate | Datetime | La fecha hasta la cotización es válida. |
Budget | String | El presupuesto de la cotización. |
OptionExplanation | String | Una descripción para explicar las opciones relacionadas con la cotización. |
EstimatedCost | Float | Monto estimado del costo. |
EstimatedCostTax | Float | Monto estimado del costo del impuesto. |
EstimatedCostIncludingTax | Float | Importe total estimado impuestos incluidos. |
AmountTax | Float | Monto a pagar. |
AmountIncludingTax | Float | Importe del impuesto a pagar. |
Amount | Float | Importe total a pagar impuestos incluidos. |
ClientUUID | String | El identificador del Cliente que está relacionado con la cotización. |
ClientName | String | El nombre del Cliente relacionado con la cotización. |
ContactUUID | String | El ID de contacto del cliente que está relacionado con la cotización. |
ContactName | String | El nombre de contacto del cliente relacionado con la cotización. |
CotizacionesCoste¶
Devuelve una lista de cotizaciones relacionadas con los costos.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente excepto QuoteID.
Select * from QuotesCost
Select * from QuotesCost where QuoteID = 'Q000123'
Select * from QuotesCost where QuoteID IN ('Q000124', 'Q000123')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
QuoteID [KEY] | String | El identificador de la Cotización. |
Description | String | La Descripción de la tarea relacionada con los costos. |
Note | String | La Nota de la tarea relacionada con los costos. |
Code | String | El Código de la tarea relacionada con los costos. |
Billable | String | El Facturable de la tarea relacionado con los costos. |
Quantity | Int | La cantidad de la tarea relacionada con los costos. |
UnitCost | Double | El UnitCost de la tarea relacionada con los costos. |
UnitPrice | Double | El UnitPrice de la tarea relacionada con los costos. |
Amount | Double | La cantidad de la tarea relacionada con los costos. |
AmountTax | Double | El AmountTax de la tarea relacionada con los costos. |
AmountIncludingTax | Double | El AmountInclusiveTax de la tarea relacionada con los costos. |
QuotesOption¶
Devuelve una lista de cotizaciones relacionadas con las opciones.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente excepto QuoteID.
Select * from QuotesOption
Select * from QuotesOption where QuoteID = 'Q000123'
Select * from QuotesOption where QuoteID IN ('Q000124', 'Q000123')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
QuoteID [KEY] | String | El identificador de la Cotización. |
Description | String | La Descripción de la tarea relacionada con las opciones. |
Note | String | La Nota de la tarea relacionada con las opciones. |
Code | String | El Código de la tarea relacionada con las opciones. |
Quantity | Int | La cantidad de la tarea relacionada con las opciones. |
UnitCost | Double | El UnitCost de la tarea relacionada con las opciones. |
UnitPrice | Double | El UnitPrice de la tarea relacionada con las opciones. |
Amount | Double | La cantidad de la tarea relacionada con las opciones. |
AmountTax | Double | El AmountTax de la tarea relacionada con las opciones. |
AmountIncludingTax | Double | El AmountInclusiveTax de la tarea relacionada con las opciones. |
CotizacionesTarea¶
Devuelve una lista de cotizaciones relacionadas con Tareas.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente excepto QuoteID.
Select * from QuotesTask
Select * from QuotesTask where QuoteID = 'Q000123'
Select * from QuotesTask where QuoteID IN ('Q000124', 'Q000123')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
QuoteID [KEY] | String | El identificador de la Cotización. |
Name | String | El Nombre de la tarea relacionada con la Cotización. |
Description | String | La Descripción de la tarea relacionada con la Cotización. |
EstimatedMinutes | Int | El Acta de la tarea relacionada con la Cotización. |
BillableRate | Double | El BillableRate de la tarea relacionada con la cotización. |
Billable | String | El Facturable de la tarea relacionada con la Cotización. |
Amount | Double | El monto de la tarea relacionada con la cotización. |
AmountTax | Double | El AmountTax de la tarea relacionada con la Cotización. |
AmountIncludingTax | Double | El ImporteIncluyendoImpuestos de la tarea relacionada con el Presupuesto. |
Tareas¶
Devolver una lista de todas las tareas
Seleccionar¶
El conector utilizará la API Xero WorkflowMax para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del controlador. Específicamente, lo siguiente se procesa del lado del servidor:
UUID
apoya el=
operador.
Todas las columnas filtrables permiten especificar varios valores mediante el operador IN. El tiempo de respuesta del servidor se puede mejorar identificando solo las filas que desea recuperar.
SELECT * FROM Tasks WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Tasks WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6g9')
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
UUID [KEY] | String | Identificador de tareas. |
Name | String | El nombre de la tarea |
Description | String | La descripción de la tarea. |
Plantillas¶
Devolver una lista de todas las plantillas.
Seleccionar¶
El conector procesará todos los filtros del lado del cliente.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
UUID [KEY] | String | El identificador de la modelo. |
Name | String | El nombre de las plantillas. |
Procedimientos Almacenados¶
Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.
Conector Jitterbit para Procedimientos Almacenados Xero WorkflowMax¶
Nombre | Descripción |
---|---|
ApplyJobTemplate | Aplicar una modelo adicional a un trabajo |
ChangeJobStatus | Se utiliza para cambiar el estado del trabajo |
ChangeTaskStatus | Se utiliza para cambiar el estado de la tarea completada o abierta |
CreateJobEstimate | Se utiliza para crear una estimación de trabajo |
CreateJobQuote | Se utiliza para crear una cotización de trabajo. |
DeleteAllCosts | Se utiliza para eliminar todos los costos. |
GetOAuthAccessToken | Obtiene un token de autenticación de Xero WorkflowMax. |
GetOAuthAuthorizationURL | Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el OAuthAccessToken desde esta URL. |
ManageClientGroupMembers | Administrar los miembros de un grupo de clientes |
ManageJobMembers | Administrar los miembros de un trabajo. |
ManageStaffLogin | Habilitar o deshabilitar el inicio de sesión de los miembros del personal. |
ManageTaskStaff | Administrar los miembros del personal de una tarea |
RefreshOAuthAccessToken | Actualiza el token de acceso de OAuth utilizado para la autenticación con varios servicios de Basecamp. |
UploadClientDocument | Subir un documento a un Cliente |
UploadJobDocument | Subir un documento a un Trabajo |
Aplicar Plantilla de Trabajo¶
Aplicar una modelo adicional a un trabajo
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | El ID del Trabajo |
TemplateUUID | String | El UUID de la modelo a aplicar |
TaskMode | String | TaskMode describe cómo se agregan tareas al trabajo. AddNew: las tareas siempre se agregan al trabajo (predeterminado). AppendExisting: cuando la misma tarea ya existe en el trabajo, la tarea de la modelo se agregará a los detalles de la tarea existente; de lo contrario, la tarea se agregará al trabajo |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
ChangeJobStatus¶
Se utiliza para cambiar el estado del trabajo
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | El ID del Trabajo |
State | String | El valor del elemento de estado es el del campo Código de interfaz para cada Estado de trabajo como se define en Admin |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
ChangeTaskStatus¶
Se utiliza para cambiar el estado de la tarea completada o abierta
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
TaskUUID | String | El UUID de la tarea |
State | String | Configure esto para completar/reabrir para marcar una tarea como completada o no. |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
CreateJobEstimate¶
Se utiliza para crear una estimación de trabajo
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | El ID del trabajo |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
CreateJobQuote¶
Se utiliza para crear una cotización de trabajo.
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | El ID del Trabajo |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
EliminarTodosLosCostos¶
Se utiliza para eliminar todos los costos.
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
Obtener Token de Acceso de OAuth¶
Obtiene un token de autenticación de Xero WorkflowMax.
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
AuthMode | String | El tipo de modo de autenticación a utilizar. Seleccione Aplicación para obtener tokens de autenticación a través de una aplicación de escritorio. Seleccione Web para obtener tokens de autenticación a través de una aplicación web. Los valores permitidos son APP, WEB. El valor predeterminado es APLICACIÓN. |
Scope | String | Una lista separada por comas de permisos para solicitar al usuario. Consulte la API de Xero WorkflowMax para obtener una lista de los permisos disponibles. |
CallbackUrl | String | La URL a la que se redirigirá al usuario después de autorizar su aplicación. Este valor debe coincidir con la URL de redirección que especificó en la configuración de la aplicación Xero WorkflowMax. Solo es necesario cuando el parámetro Authmode es Web. |
Verifier | String | El verificador devuelto por Xero WorkflowMax después de que el usuario haya autorizado su aplicación para tener acceso a sus datos. Este valor se devolverá como un parámetro para la URL de devolución de llamada. |
State | String | Indica cualquier estado que pueda ser de utilidad para su solicitud al recibir la respuesta. Su aplicación recibe el mismo valor que envió, ya que este parámetro realiza un viaje de ida y vuelta al servidor de autorización Xero WorkflowMax y viceversa. Los usos incluyen redirigir al usuario al recurso correcto en su sitio, nonces y mitigaciones de falsificación de solicitudes entre sitios. |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
OAuthAccessToken | String | El token de acceso utilizado para la comunicación con Xero WorkflowMax. |
OAuthRefreshToken | String | El token de actualización de OAuth. Es lo mismo que el token de acceso en el caso de Xero WorkflowMax. |
ExpiresIn | String | El tiempo de vida restante en el token de acceso. Un -1 indica que no caducará. |
TenantId | String | El ID asociado con un arrendatario de Xero WorkflowMax, que se necesita, junto con un OAuthAccessToken, para autenticar una aplicación de OAuth en Xero WorkflowMax. |
Obtener URL de Autorización de OAuth¶
Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el OAuthAccessToken desde esta URL.
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
CallbackUrl | String | La URL a la que se redirigirá al usuario después de autorizar su aplicación. Este valor debe coincidir con la URL de redirección en la configuración de la aplicación Xero WorkflowMax. |
Scope | String | Una lista separada por comas de ámbitos para solicitar al usuario. Consulte la documentación de la API Xero WorkflowMax para obtener una lista de los permisos disponibles. |
State | String | Indica cualquier estado que pueda ser de utilidad para su solicitud al recibir la respuesta. Su aplicación recibe el mismo valor que envió, ya que este parámetro realiza un viaje de ida y vuelta al servidor de autorización Xero WorkflowMax y viceversa. Los usos incluyen redirigir al usuario al recurso correcto en su sitio, nonces y mitigaciones de falsificación de solicitudes entre sitios. |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
URL | String | La URL de autorización, ingresada en un navegador web para obtener el token de verificación y autorizar su aplicación. |
ManageClientGroupMembers¶
Administrar los miembros de un grupo de clientes
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
ClientGroupUUID | String | ID del grupo al que agregar el cliente |
Add | String | ID del cliente para agregar al grupo |
Remove | String | ID del cliente para eliminar del grupo |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
ManageJobMembers¶
Administrar los miembros de un trabajo.
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | ID de trabajo para agregar/eliminar miembros del personal |
Add | String | UUID del miembro del personal para agregar |
Remove | String | UUID del miembro del personal para eliminar |
Operation | String | Especifique una operación de las siguientes: -ChangeStaff para agregar/eliminar miembros del personal del trabajo -ChangeManager para agregar/eliminar gerente del trabajo -ChangePartner para agregar/eliminar socio del trabajo |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
ManageStaffLogin¶
Habilitar o deshabilitar el inicio de sesión de los miembros del personal.
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
StaffUUID | String | El UUID del miembro del personal |
Status | String | deshabilitar/habilitar |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
AdministrarTareaPersonal¶
Administrar los miembros del personal de una tarea
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | ID de trabajo relacionado con la tarea. |
TaskUUID | String | UUID de Tarea para agregar/eliminar miembros del personal |
Add | String | UUID del personal para agregar a la tarea |
Remove | String | UUID del personal para eliminar de la tarea |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
RefreshOAuthAccessToken¶
Actualiza el token de acceso de OAuth utilizado para la autenticación con varios servicios de Basecamp.
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
OAuthRefreshToken | String | El token de actualización devuelto con el token de acceso anterior. |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
OAuthAccessToken | String | El token de autenticación devuelto de Basecamp. Esto se puede usar en llamadas posteriores a otras operaciones para este servicio en particular. |
OAuthRefreshToken | String | Un token que puede usarse para obtener un nuevo token de acceso. |
ExpiresIn | String | El tiempo de vida restante en el token de acceso. |
Cargar Documento de Cliente¶
Subir un documento a un Cliente
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
ClientUUID | String | El ID del cliente donde se cargará el documento. |
Title | String | Título del documento |
Text | String | La nota relativa al documento |
Folder | String | La carpeta donde se va a subir el documento |
FileName | String | Nombre de archivo del archivo |
LocalFile | String | Ruta completa del archivo que se va a cargar |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
SubirTrabajoDocumento¶
Subir un documento a un Trabajo
Aporte¶
Nombre | Tipo | Descripción |
---|---|---|
JobID | String | El ID del trabajo donde se cargará el documento. |
Title | String | Título del documento |
Text | String | La nota relativa al documento |
Folder | String | La carpeta donde se va a subir el documento |
Public | String | Determina si el documento está abierto al público |
FileName | String | Nombre de archivo del archivo |
LocalFile | String | Ruta completa del archivo que se va a cargar |
Columnas del Conjunto de Resultados¶
Nombre | Tipo | Descripción |
---|---|---|
Success | String | Este valor muestra una indicación booleana de si la operación fue exitosa o no. |
Tablas del Sistema¶
Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.
Tablas de Esquema¶
Las siguientes tablas devuelven metadatos de la base de datos para Xero WorkflowMax:
- sys_catalogs: enumera las bases de datos disponibles.
- sys_schemas: enumera los esquemas disponibles.
- sys_tablas: enumera las tablas y vistas disponibles.
- sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
- procedimientos_sys: describe los procedimientos almacenados disponibles.
- parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
- sys_keycolumns: describe las claves principal y externa.
- índices_sys: Describe los índices disponibles.
Tablas de Fuentes de Datos¶
Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:
- sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
- sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.
Tablas de Información de Consulta¶
La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:
- identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.
Sys_catalogs¶
Enumera las bases de datos disponibles.
La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:
SELECT * FROM sys_catalogs
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos. |
Sys_schemas¶
Enumera los esquemas disponibles.
La siguiente consultar recupera todos los esquemas disponibles:
SELECT * FROM sys_schemas
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos. |
SchemaName | String | El nombre del esquema. |
Sys_tables¶
Enumera las tablas disponibles.
La siguiente consultar recupera las tablas y vistas disponibles:
SELECT * FROM sys_tables
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | La base de datos que contiene la tabla o vista. |
SchemaName | String | El esquema que contiene la tabla o vista. |
TableName | String | El nombre de la tabla o vista. |
TableType | String | El tipo de tabla (tabla o vista). |
Description | String | Una descripción de la tabla o vista. |
IsUpdateable | Boolean | Si la tabla se puede actualizar. |
Sys_tablecolumns¶
Describe las columnas de las tablas y vistas disponibles.
La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Clientes:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Clients'
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos que contiene la tabla o vista. |
SchemaName | String | El esquema que contiene la tabla o vista. |
TableName | String | El nombre de la tabla o vista que contiene la columna. |
ColumnName | String | El nombre de la columna. |
DataTypeName | String | El nombre del tipo de datos. |
DataType | Int32 | Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente. |
Length | Int32 | El tamaño de almacenamiento de la columna. |
DisplaySize | Int32 | El ancho máximo normal de la columna designada en caracteres. |
NumericPrecision | Int32 | El número máximo de dígitos en datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora. |
NumericScale | Int32 | La escala de columna o número de dígitos a la derecha del punto decimal. |
IsNullable | Boolean | Si la columna puede contener nulo. |
Description | String | Una breve descripción de la columna. |
Ordinal | Int32 | El número de secuencia de la columna. |
IsAutoIncrement | String | Si el valor de la columna se asigna en incrementos fijos. |
IsGeneratedColumn | String | Si se genera la columna. |
IsHidden | Boolean | Si la columna está oculta. |
IsArray | Boolean | Si la columna es una matriz. |
Sys_procedimientos¶
Enumera los procedimientos almacenados disponibles.
La siguiente consultar recupera los procedimientos almacenados disponibles:
SELECT * FROM sys_procedures
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | La base de datos que contiene el procedimiento almacenado. |
SchemaName | String | El esquema que contiene el procedimiento almacenado. |
ProcedureName | String | El nombre del procedimiento almacenado. |
Description | String | Una descripción del procedimiento almacenado. |
ProcedureType | String | El tipo de procedimiento, como PROCEDIMIENTO o FUNCIÓN. |
Sys_procedureparameters¶
Describe procedimiento almacenado* parámetros.
La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado CreateJobEstimate:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateJobEstimate' AND Direction=1 OR Direction=2
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos que contiene el procedimiento almacenado. |
SchemaName | String | El nombre del esquema que contiene el procedimiento almacenado. |
ProcedureName | String | El nombre del procedimiento almacenado* que contiene el parámetro. |
ColumnName | String | El nombre del procedimiento almacenado* parámetro. |
Direction | Int32 | Un número entero correspondiente al tipo de parámetro: entrada (1), entrada/salida (2) o salida (4). Los parámetros de tipo de entrada/salida pueden ser tanto parámetros de entrada como de salida. |
DataTypeName | String | El nombre del tipo de datos. |
DataType | Int32 | Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente. |
Length | Int32 | El número de caracteres permitidos para los datos de caracteres. El número de dígitos permitidos para datos numéricos. |
NumericPrecision | Int32 | La máxima precisión para datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora. |
NumericScale | Int32 | El número de dígitos a la derecha del punto decimal en datos numéricos. |
IsNullable | Boolean | Si el parámetro puede contener nulo. |
IsRequired | Boolean | Si el parámetro es necesario para la ejecución del procedimiento. |
IsArray | Boolean | Si el parámetro es una matriz. |
Description | String | La descripción del parámetro. |
Ordinal | Int32 | El índice del parámetro. |
Sys_keycolumns¶
Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Clientes:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Clients'
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos que contiene la clave. |
SchemaName | String | El nombre del esquema que contiene la clave. |
TableName | String | El nombre de la tabla que contiene la clave. |
ColumnName | String | El nombre de la columna clave. |
IsKey | Boolean | Si la columna es una clave principal en la tabla a la que se hace referencia en el campo TableName. |
IsForeignKey | Boolean | Si la columna es una clave externa a la que se hace referencia en el campo TableName. |
PrimaryKeyName | String | El nombre de la clave principal. |
ForeignKeyName | String | El nombre de la clave foránea. |
ReferencedCatalogName | String | La base de datos que contiene la clave principal. |
ReferencedSchemaName | String | El esquema que contiene la clave principal. |
ReferencedTableName | String | La tabla que contiene la clave principal. |
ReferencedColumnName | String | El nombre de la columna de la clave principal. |
Sys_foreignkeys¶
Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos que contiene la clave. |
SchemaName | String | El nombre del esquema que contiene la clave. |
TableName | String | El nombre de la tabla que contiene la clave. |
ColumnName | String | El nombre de la columna clave. |
PrimaryKeyName | String | El nombre de la clave principal. |
ForeignKeyName | String | El nombre de la clave foránea. |
ReferencedCatalogName | String | La base de datos que contiene la clave principal. |
ReferencedSchemaName | String | El esquema que contiene la clave principal. |
ReferencedTableName | String | La tabla que contiene la clave principal. |
ReferencedColumnName | String | El nombre de la columna de la clave principal. |
ForeignKeyType | String | Designa si la clave externa es una clave de importación (apunta a otras tablas) o de exportación (hace referencia desde otras tablas). |
Sys_indexes¶
Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.
La siguiente consultar recupera todos los índices que no son claves principales:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
CatalogName | String | El nombre de la base de datos que contiene el índice. |
SchemaName | String | El nombre del esquema que contiene el índice. |
TableName | String | El nombre de la tabla que contiene el índice. |
IndexName | String | El nombre del índice. |
ColumnName | String | El nombre de la columna asociada con el índice. |
IsUnique | Boolean | True si el índice es único. Falso en caso contrario. |
IsPrimary | Boolean | True si el índice es una clave principal. Falso en caso contrario. |
Type | Int16 | Un valor entero correspondiente al tipo de índice: estadística (0), agrupado (1), hash (2) u otro (3). |
SortOrder | String | El orden de clasificación: A para ascender o D para descender. |
OrdinalPosition | Int16 | El número de secuencia de la columna en el índice. |
Sys_connection_props¶
Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.
Al consultar esta tabla, se debe usar la cadena de conexión de configuración:
jdbc:cdata:xeroworkflowmax:config:
Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.
La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
Name | String | El nombre de la propiedad de conexión. |
ShortDescription | String | Una breve descripción. |
Type | String | El tipo de datos de la propiedad de conexión. |
Default | String | El valor predeterminado si no se establece uno explícitamente. |
Values | String | Una lista separada por comas de valores posibles. Se lanza un error de validación si se especifica otro valor. |
Value | String | El valor que establezca o un valor predeterminado preconfigurado. |
Required | Boolean | Si la propiedad es necesaria para conectarse. |
Category | String | La categoría de la propiedad de conexión. |
IsSessionProperty | String | Si la propiedad es una propiedad de sesión, utilizada para guardar información sobre la conexión actual. |
Sensitivity | String | El nivel de sensibilidad de la propiedad. Esto informa si la propiedad está ofuscada en los formularios de registro y autenticación. |
PropertyName | String | Una forma truncada en mayúsculas y minúsculas del nombre de la propiedad de conexión. |
Ordinal | Int32 | El índice del parámetro. |
CatOrdinal | Int32 | El índice de la categoría de parámetro. |
Hierarchy | String | Muestra las propiedades dependientes asociadas que deben configurarse junto con esta. |
Visible | Boolean | Informa si la propiedad está visible en la interfaz de usuario de la conexión. |
ETC | String | Diversa información miscelánea sobre la propiedad. |
Sys_sqlinfo¶
Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.
Procesamiento Colaborativo de Consultas¶
Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL. El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT al servidor y luego procesa el resto de la consultar en la memoria.
Descubrimiento de las Capacidades SELECT de la Fuente de Datos¶
A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.
Nombre | Descripción | Valores posibles |
---|---|---|
AGGREGATE_FUNCTIONS | Funciones de agregación admitidas. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Si se admite la función COUNT. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | El carácter de apertura utilizado para escapar de un identificador. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | El carácter de cierre utilizado para escapar de un identificador. | ] |
SUPPORTED_OPERATORS | Una lista de operadores de SQL admitidos. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Si se admite GROUP BY y, de ser así, el grado de compatibilidad. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Funciones de cadena admitidas. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Funciones numéricas compatibles. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Funciones de fecha/hora admitidas. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indica tablas omitidas durante la replicación. | |
REPLICATION_TIMECHECK_COLUMNS | Una matriz de cadenas que contiene una lista de columnas que se usarán para verificar (en el orden dado) para usar como una columna modificada durante la replicación. | |
IDENTIFIER_PATTERN | Valor de cadena que indica qué cadena es válida para un identificador. | |
SUPPORT_TRANSACTION | Indica si el proveedor admite transacciones como compromiso y reversión. | YES , NO |
DIALECT | Indica el dialecto SQL a usar. | |
KEY_PROPERTIES | Indica las propiedades que identifican la base de datos uniforme. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indica si pueden existir varios esquemas para el proveedor. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indica si pueden existir varios catálogos para el proveedor. | YES , NO |
DATASYNCVERSION | La versión de sincronización de datos necesaria para acceder a este controlador. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | La categoría Sincronización de datos de este controlador. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Si se admite la funcionalidad de SQL mejorada más allá de lo que ofrece la API. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Si se admiten las operaciones lote. | YES , NO |
SQL_CAP | Todas las funciones de SQL admitidas para este controlador. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Un valor de cadena especifica las cacheOptions preferidas. | |
ENABLE_EF_ADVANCED_QUERY | Indica si el controlador admite directamente consultas avanzadas provenientes de Entity Framework. De lo contrario, las consultas se manejarán del lado del cliente. | YES , NO |
PSEUDO_COLUMNS | Una matriz de cadenas que indica las pseudocolumnas disponibles. | |
MERGE_ALWAYS | Si el valor es verdadero, el modo de combinación se ejecuta a la fuerza en la sincronización de datos. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Una consultar de selección para devolver la fecha y hora de inicio de la réplica. | |
REPLICATION_MIN_FUNCTION | Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un min del lado del servidor. | |
REPLICATION_START_DATE | Permite que un proveedor especifique una fecha de inicio de réplica. | |
REPLICATION_MAX_DATE_QUERY | Una consultar de selección para devolver la fecha y hora de finalización de la réplica. | |
REPLICATION_MAX_FUNCTION | Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un máx. del lado del servidor. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Una lista de tablas que omitirán dividir la réplica en fragmentos en la réplica inicial. | |
CHECKCACHE_USE_PARENTID | Indica si la instrucción CheckCache debe realizarse en la columna de clave principal. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indica procedimientos almacenados* que se puede utilizar para generar archivos de esquema. |
La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
NAME | String | Un componente de la sintaxis SQL o una capacidad que se puede procesar en el servidor. |
VALUE | String | Detalles sobre el SQL o la sintaxis de SQL admitidos. |
Sys_identidad¶
Devuelve información sobre los intentos de modificación.
La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:
SELECT * FROM sys_identity
Columnas¶
Nombre | Tipo | Descripción |
---|---|---|
Id | String | El ID generado por la base de datos devuelto de una operación de modificación de datos. |
Batch | String | Un identificador para el lote. 1 para una sola operación. |
Operation | String | El resultado de la operación en el lote: INSERTADO, ACTUALIZADO o ELIMINADO. |
Message | String | ÉXITO o un mensaje de error si falla la actualización en el lote. |
Propiedades de Configuraciones Avanzadas¶
Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.
Propiedad | Descripción |
---|---|
InitiateOAuth | Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte. |
OAuthClientId | El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth. |
OAuthClientSecret | El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth. |
OAuthAccessToken | El token de acceso para conectarse mediante OAuth. |
TenantId | ID de inquilino de Xero Flujo de Trabajo Max. |
CallbackURL | La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación. |
OAuthVerifier | El código verificador devuelto desde la URL de autorización de OAuth. |
OAuthRefreshToken | El token de actualización de OAuth para el token de acceso de OAuth correspondiente. |
OAuthExpiresIn | La vida útil en segundos del AccessToken de OAuth. |
OAuthTokenTimestamp | La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual. |
Propiedad | Descripción |
---|---|
SSLServerCert | El certificado que se aceptará del servidor al conectarse mediante TLS/SSL. |
Propiedad | Descripción |
---|---|
Location | Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados. |
BrowsableSchemas | Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC. |
Views | Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC. |
Propiedad | Descripción |
---|---|
IncludeCustomFields | Determina si los campos personalizados deben incluirse como columnas de la tabla o no. Incluir CustomFields afectará el rendimiento. |
Propiedad | Descripción |
---|---|
MaxRows | Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño. |
Other | Estas propiedades ocultas se usan solo en casos de uso específicos. |
PseudoColumns | Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla. |
Timeout | El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación. |
OAuth¶
Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.
Propiedad | Descripción |
---|---|
InitiateOAuth | Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte. |
OAuthClientId | El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth. |
OAuthClientSecret | El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth. |
OAuthAccessToken | El token de acceso para conectarse mediante OAuth. |
TenantId | ID de inquilino de Xero Flujo de Trabajo Max. |
CallbackURL | La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación. |
OAuthVerifier | El código verificador devuelto desde la URL de autorización de OAuth. |
OAuthRefreshToken | El token de actualización de OAuth para el token de acceso de OAuth correspondiente. |
OAuthExpiresIn | La vida útil en segundos del AccessToken de OAuth. |
OAuthTokenTimestamp | La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual. |
Iniciar OAuth¶
Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
Valores Posibles¶
OFF
, GETANDREFRESH
, REFRESH
Tipo de Datos¶
string
Valor por Defecto¶
"OFF"
Observaciones¶
Las siguientes opciones están disponibles:
OFF
: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.GETANDREFRESH
: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.REFRESH
: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.
OAuthClientId¶
El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId
valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.
OAuthClientSecretOAuthClientSecret¶
El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret
propiedad.
Token de Acceso de OAuth¶
El token de acceso para conectarse mediante OAuth.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
El OAuthAccessToken
la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken
se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.
El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.
ID de Inquilino¶
ID de inquilino de Xero Flujo de Trabajo Max.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Si por algún motivo intenta usar un token de acceso para autenticarse, debe tener en cuenta que la autenticación de Xero requiere que se pase una ID de arrendatario como encabezado para cada solicitud de API.
Recuperar el TenantId
utilizando el GetOAuthAccessToken procedimiento almacenado.
Alternativamente, puede recuperar el TenantId
como sigue:
- Cree una nueva solicitud en una herramienta de desarrollo de API como Postman.
- Establezca la URL en
<https://api.xero.com/connections>
- Establecer
Authorization
encabezado a"Bearer " + access_token
y finalmente ejecutar la solicitud. - La respuesta mostrará 1 o más información de conexión a Xero.
- Encuentra la conexión que tiene
"tenantType": "WORKFLOWMAX"
y obtener su TenantId. - Establezca esta propiedad de conexión en el TenantId recién adquirido.
URL de Devolución de Llamada¶
La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
OAuthVerifier¶
El código verificador devuelto desde la URL de autorización de OAuth.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.
Autenticación en Máquinas Sin Cabeza¶
Ver para obtener el OAuthVerifier
valor.
Establezca OAuthSettingsLocation junto con OAuthVerifier
. Cuando se conecta, el conector intercambia el OAuthVerifier
para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.
Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier
desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.
Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.
OAuthRefreshToken¶
El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
El OAuthRefreshToken
la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.
OAuthExpiresIn¶
La vida útil en segundos del AccessToken de OAuth.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.
OAuthTokenTimestamp¶
La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.
SSL¶
Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.
Propiedad | Descripción |
---|---|
SSLServerCert | El certificado que se aceptará del servidor al conectarse mediante TLS/SSL. |
SSLServerCert¶
El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.
Esta propiedad puede tomar las siguientes formas:
Descripción | Ejemplo |
---|---|
Un certificado PEM completo (ejemplo abreviado por brevedad) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
Una ruta a un archivo local que contiene el certificado | C:\cert.cer |
La clave pública (ejemplo abreviado por brevedad) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
La huella digital MD5 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) | ecadbdda5a1529c58a1e9e09828d70e4 |
La huella digital SHA1 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.
La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).
Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.
Esquema¶
Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.
Propiedad | Descripción |
---|---|
Location | Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados. |
BrowsableSchemas | Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC. |
Views | Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC. |
Ubicación¶
Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
Tipo de Datos¶
string
Valor por Defecto¶
"%APPDATA%\\\XeroWorkflowMax Data Provider\\Schema"
Observaciones¶
La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location
La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.
Si no se especifica, la ubicación predeterminada es "%APPDATA%\\XeroWorkflowMax Data Provider\Schema" con %APPDATA%
estando configurado en el directorio de configuración del usuario:
Plataforma | %APPDATA% |
---|---|
Windows | El valor de la variable de ambiente APPDATA |
Mac | ~/Biblioteca/Soporte de aplicaciones |
Linux | ~/.config |
Esquemas Navegables¶
Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.
Mesas¶
Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.
Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.
Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.
Puntos de Vista¶
Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.
Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.
Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.
Otro¶
Esta sección proporciona una lista completa de las Otras propiedades que puede configurar.
Propiedad | Descripción |
---|---|
IncludeCustomFields | Determina si los campos personalizados deben incluirse como columnas de la tabla o no. Incluir CustomFields afectará el rendimiento. |
Incluir Campos Personalizados¶
Determina si los campos personalizados deben incluirse como columnas de la tabla o no. Incluir CustomFields afectará el rendimiento.
Tipo de Datos¶
string
Valor por Defecto¶
"false"
Observaciones¶
Es posible crear campos personalizados en Xero WorkflowMax. Para recuperar sus valores, puede establecer IncludeCustomFields=true como propiedad de conexión. Al hacerlo, aparecerá una lista de los campos personalizados creados como columnas de la tabla. Estos campos personalizados también se pueden actualizar, por ej.
UPDATE Costs SET CF_1='new CF value' WHERE ID='CostID'
Nota: Aún puede actualizar los campos personalizados incluso cuando una tabla específica no admite la operación de ACTUALIZACIÓN.
Los campos personalizados son muy caros. Requieren una solicitud por registro para recuperar. Por esta razón, están deshabilitados por defecto.
Misceláneas¶
Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.
Propiedad | Descripción |
---|---|
MaxRows | Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño. |
Other | Estas propiedades ocultas se usan solo en casos de uso específicos. |
PseudoColumns | Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla. |
Timeout | El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación. |
Filas Máximas¶
Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Tipo de Datos¶
int
Valor por Defecto¶
-1
Observaciones¶
Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Otro¶
Estas propiedades ocultas se usan solo en casos de uso específicos.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.
Especifique varias propiedades en una lista separada por punto y coma.
Integración y Formateo¶
Propiedad | Descripción |
---|---|
DefaultColumnSize | Establece la longitud predeterminada de los campos de cadena cuando la fuente de datos no proporciona la longitud de columna en los metadatos. El valor predeterminado es 2000. |
ConvertDateTimeToGMT | Determina si se convierten los valores de fecha y hora a GMT, en lugar de la hora local de la máquina. |
RecordToFile=filename | Registra la transferencia de datos del socket subyacente al archivo especificado. |
Pseudocolumnas¶
Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Tipo de Datos¶
string
Valor por Defecto¶
""
Observaciones¶
Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".
Se Acabó el Tiempo¶
El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
Tipo de Datos¶
int
Valor por Defecto¶
60
Observaciones¶
Si Timeout
= 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.
Si Timeout
caduca y la operación aún no se ha completado, el conector genera una excepción.