Árbol del API · Referencia

Referencia

32 operaciones

Cada operación que acepta una Llave API, con sus argumentos, lo que devuelve, el permiso que necesita la llave, sus errores y un ejemplo en cinco lenguajes.

Catálogos

Operación	Tipo	Qué hace
`warehouseOptions`Query	Query	Almacenes. Lista los almacenes de la empresa ordenados por clave, con el identificador que piden las órdenes de venta y los cobros.
`currencyOptions`Query	Query	Monedas. Lista las monedas de la empresa con su clave, su nombre y cuál es la moneda base.
`unitOptions`Query	Query	Unidades de medida. Lista las unidades de medida de la empresa ordenadas por clave, o sólo la unidad de un artículo.
`priceStructureOptions`Query	Query	Estructuras de precios. Lista las estructuras de precios de la empresa o, con `orderId`, sólo las que admite una orden de venta.
`paymentMethodOptions`Query	Query	Formas de cobro. Lista las formas de cobro habilitadas en la empresa, en el orden que ella definió, y dice cuáles son con tarjeta.
`paymentTypeOptions`Query	Query	Formas de cobro sin marca de tarjeta. Lista las formas de cobro habilitadas en la empresa con su clave y su nombre, en el orden que ella definió, sin decir cuáles son con tarjeta.
`collectionTypeOptions`Query	Query	Tipos de cobro. Lista los tipos que acepta un cobro nuevo: cobro de facturas o anticipo.
`collectorOptions`Query	Query	Cobradores. Lista los empleados marcados como cobradores, ordenados por su clave de empleado.
`businessUnitOptions`Query	Query	Unidades de negocio. Lista las unidades de negocio de la empresa ordenadas por clave.

Clientes

Operación	Tipo	Qué hace
`customersConnection`Query	Query	Lista de clientes. Lista los clientes de la empresa, del modificado hace más tiempo al más reciente. Busca por nombre, RFC, correo o clave, trae sólo los que tienen saldo por cobrar o los modificados desde un momento, y recorre el resultado por páginas con cursores.
`customer`Query	Query	Detalle de un cliente. Devuelve un cliente por su `id`, con su crédito y su saldo, sus lugares de entrega y contactos, sus órdenes de venta más recientes y sus facturas con saldo por cobrar.
`customerSuggestions`Query	Query	Buscar clientes. Busca clientes activos por nombre, clave, RFC o correo y devuelve hasta 20, ordenados por nombre.
`upsertCustomerAddress`Mutation	Mutation	Registrar o actualizar un lugar de entrega. Registra un lugar de entrega nuevo para un cliente o actualiza uno que ya tiene, y devuelve el lugar de entrega como quedó.

Productos y precios

Operación	Tipo	Qué hace
`productsConnection`Query	Query	Lista de artículos. Lista los artículos de la empresa, del modificado hace más tiempo al más reciente. Busca por clave, descripción o código de barras, filtra por familia y trae el precio de cada artículo para un cliente o una estructura de precios.
`product`Query	Query	Detalle de un artículo. Devuelve un artículo por su `id`, con su unidad, su familia y su control de inventario, y su precio para un cliente o una estructura de precios.
`productSuggestions`Query	Query	Buscar artículos. Busca artículos por clave, descripción o código de barras y devuelve hasta 50, ordenados por clave.
`priceStructuresConnection`Query	Query	Lista de estructuras de precios. Lista las estructuras de precios de la empresa con las listas de precios que las forman, de la modificada hace más tiempo a la más reciente.
`priceListEntriesConnection`Query	Query	Precios de una lista. Lista los precios de una lista de precios, artículo por artículo, en el orden en que se registraron. Filtra por artículos o por fecha de modificación para traer sólo lo que cambió.

Pedidos

Operación	Tipo	Qué hace
`ordersConnection`Query	Query	Lista de órdenes de venta. Lista las órdenes de venta de la empresa, de la más reciente a la más antigua. Filtra por cliente, vendedor, almacén, estatus, origen y rango de fechas, y recorre el resultado por páginas con cursores.
`order`Query	Query	Detalle de una orden de venta. Devuelve una orden de venta por su `id`, con su cliente, sus importes y sus partidas.
`orderDefaults`Query	Query	Valores iniciales de una orden. Devuelve los valores con los que conviene empezar una orden para un cliente: estructura de precios, términos de crédito, tipos de venta, vendedor, almacén, moneda, lugares de entrega y contactos.
`quoteOrder`Query	Query	Cotizar una orden. Calcula precios, descuentos, impuestos y totales de una orden sin guardarla. Devuelve la orden calculada y las advertencias de existencia, precio y crédito.
`orderPrintOptions`Query	Query	Formatos de impresión de órdenes. Lista los formatos de impresión de órdenes de venta y las leyendas opcionales que puedes pedir en `Order.pdfUrl`.
`createOrder`Mutation	Mutation	Crear una orden de venta. Registra una orden de venta nueva con sus partidas. La orden queda registrada (`REGISTERED`), sin confirmar y sin apartar inventario.
`cancelOrder`Mutation	Mutation	Cancelar una orden de venta. Cancela una orden de venta. Una orden de venta registrada se elimina; una confirmada regresa a registrada con el motivo en sus comentarios.

Facturas y cobranza

Operación	Tipo	Qué hace
`invoicesConnection`Query	Query	Lista de facturas. Lista las facturas de la empresa con su cliente, su total y su saldo por cobrar. Filtra por cliente, estatus, fecha de emisión o texto, pide sólo las que tienen saldo pendiente y recorre el resultado por páginas con cursores.
`invoice`Query	Query	Detalle de una factura. Devuelve una factura por su `id`, con su saldo y las ligas para descargar el XML del CFDI y su PDF.
`collectionsConnection`Query	Query	Lista de cobros. Lista los cobros de la empresa con su importe, su forma de cobro y las facturas a las que se aplicaron. Filtra por cliente y por fecha del pago, y recorre el resultado por páginas con cursores.
`collection`Query	Query	Detalle de un cobro. Devuelve un cobro por su `id`, con su importe, su forma de cobro y las facturas a las que se aplicó.
`paymentComplement`Query	Query	Complemento de pago de un cobro. Devuelve el complemento de pago (REP) que incluye un cobro: el estado de su timbrado, su UUID y las ligas para descargar el XML y el PDF.
`bankTerminals`Query	Query	Terminales bancarias. Lista las terminales bancarias activas para los cobros con tarjeta de un almacén, con su cuenta bancaria y su banco.
`createCollection`Mutation	Mutation	Registrar un cobro. Registra un pago recibido de un cliente y, si lo indicas, lo aplica a sus facturas en la misma operación. No emite ni timbra el complemento de pago.

Tipos y schema

Tipos publicados

Cada objeto, input, enum y escalar que usan las operaciones publicadas.

Explorador

schema

Sigue las relaciones de operación en operación y de tipo en tipo, y descarga schema.graphql.