Árbol del API · Tipos › Order

Orden de venta

Order

Clase

Objeto

Dominio

Común

Campos

Lo usan

1 operación · 5 tipos

Una orden de venta con su cliente, sus importes, sus partidas y su avance de facturación, cobro y embarque.

Los importes (subtotal, discount, tax, total, openBalance) llegan como texto decimal en la moneda de la orden: "4872.00", nunca como número flotante.

Campos

Campo	Tipo	Descripción
`advanceInvoices`[OrderAdvanceInvoice!]	[OrderAdvanceInvoice!]	Facturas de anticipo del cliente que se pueden aplicar a la orden. Requiere «Ventas» en la llave; sin él llega `null`.
`advancesAppliedTotal`Money	Money	Total de anticipos aplicados a la orden. Requiere «Ventas» en la llave; sin él llega `null`.
`clientKey`String	String	La `idempotencyKey` con la que esta misma llave creó la orden con `createOrder`; `null` si la creó otra llave, un usuario o la aplicación, o si su registro ya se depuró (una tarea diaria borra los de más de 30 días).
`collectionStatus`String	String	Estatus de cobro; vacío mientras no tiene cobros.
`contact`CustomerContact	CustomerContact	Contacto del cliente para esta orden.
`createdAt`DateTime	DateTime	Fecha y hora de captura, con su desfase horario.
`createdBy`UserSummary	UserSummary	Usuario que capturó la orden.
`creditTerm`CreditTerm	CreditTerm	Término de crédito.
`currency`String	String	Clave de la moneda de la orden, p. ej. `MXN`.
`customer`Customer	Customer	Cliente de la orden.
`deliveryAddress`CustomerAddress	CustomerAddress	Lugar de entrega.
`deliveryDate`Date	Date	Fecha de vencimiento de la orden; es el mismo dato que `dueDate`.
`deliveryOn`Date	Date	Fecha en que se entregó la orden.
`discount`Money	Money	Descuento total.
`dueDate`Date	Date	Fecha de vencimiento de la orden.
`exchangeRate`Decimal	Decimal	Tipo de cambio de la orden.
`fhprox`Date	Date	Fecha de entrega comprometida con el cliente.
`folio`String	String	Folio visible en la aplicación y en los documentos, p. ej. `OV00512`.
`id`ID	ID	Identificador de la orden; úsalo con `order(id:)`.
`incoterm`String	String	Clave SAT del incoterm, en órdenes de comercio exterior.
`invoiceRequested`Boolean	Boolean	`true` si el cliente pidió factura; `false` si se entrega con remisión.
`invoiceStatus`String	String	Estatus de facturación; vacío mientras la orden no se factura.
`lines`(after: String, first: Int)OrderLineConnection!	OrderLineConnection!	Partidas de la orden por número de partida, paginadas con cursores igual que las listas.20 por omisión, hasta 100 por página.
`notes`String	String	Comentarios de la orden. Al desconfirmar una orden de venta con `cancelOrder`, el motivo se agrega aquí.
`observ`String	String	Observaciones de la orden.
`openBalance`Money	Money	Saldo por cobrar de la orden.
`origin`OrderOrigin!	OrderOrigin!	Dónde se capturó la orden.
`payments`[OrderPayment!]	[OrderPayment!]	Cobros aplicados a la orden, del más reciente al más antiguo. Requiere «Ventas» en la llave; sin él llega `null`.
`paymentsTotals`[OrderPaymentTotal!]	[OrderPaymentTotal!]	Total cobrado por moneda de la cuenta bancaria. Requiere «Ventas» en la llave; sin él llega `null`.
`pdfUrl`(formatId: ID!, legendId: ID)String	String	Liga al PDF de la orden con el formato (`formatId`) y la leyenda opcional (`legendId`) de `orderPrintOptions`. Está firmada y vence a los 10 minutos. Requiere «Ventas» en la llave; sin él llega `null`.
`priceLevel`Int	Int	Nivel de precios aplicado.
`priceStructure`PriceStructure	PriceStructure	La estructura de precios de las partidas, cuando todas las que tienen una usan la misma; `null` si ninguna tiene o si hay varias distintas. Requiere «Cliente» en la llave; sin él llega `null`.
`project`Project	Project	Proyecto al que se carga la orden.
`purchaseOrder`String	String	Orden de compra del cliente.
`rawOrigin`String	String	Clave del origen tal como la guarda AdvantaCloud; útil cuando `origin` es `UNKNOWN`.
`rawShipmentStatus`String	String	Clave del estatus de embarque tal como la guarda AdvantaCloud.
`rawStatus`String	String	Clave del estatus tal como la guarda AdvantaCloud; útil cuando `status` es `UNKNOWN`.
`reference`String	String	Referencia libre de la orden.
`saleClassifier`CatalogOption	CatalogOption	Clasificador de venta.
`saleType`SaleType	SaleType	Tipo de venta.
`salesperson`Employee	Employee	Vendedor asignado.
`shipment`OrderShipment!	OrderShipment!	Avance del embarque de la orden.
`shipmentClassifier`String	String	Clasificador de embarque.
`shippingCost`Money	Money	Costo de envío.
`shippingMethod`ShippingMethod	ShippingMethod	Forma de embarque.
`status`OrderStatus!	OrderStatus!	Estatus de la orden.
`subtotal`Money	Money	Importe antes de impuestos.
`tags`[String!]!	[String!]!	Etiquetas de la orden.
`tax`Money	Money	Impuestos.
`total`Money	Money	Total de la orden.
`totalWeight`Quantity	Quantity	Peso total de las partidas.
`warehouse`Warehouse	Warehouse	Almacén que surte la orden.

Dónde se usa

Seguir sus relaciones en el explorador

Schema del 26 oct 2026 · Descargar schema.graphql¿Algo no cuadra? Repórtalo en ayuda.advanta.mx