Get Orden de compra

Usa esto cuando necesites el estado actual de un orden de compra, como su saldo y sus pagos, mediante su _id.


The following endpoint can be used to retrieve the details of a orden de compra within the Hyfin application.


Punto Final

The following endpoint can be used to retrieve a orden de compra. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/invoice/{_id}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
_id
String
El id que asignamos a esta orden de compra. Omítelo al crear una orden de compra y envíalo al actualizar una.
externalId
String
Tu propio id para esta orden de compra, desde tu software. Envía de nuevo el mismo externalId para actualizar esta orden de compra en lugar de agregar una nueva. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
invoiceNumber
String
El número asignado desde el sistema de origen y que se muestra al cliente en la orden de compra. Dos orden de compra de un sitio pueden compartir un número, y un pago aplicado por número se asigna a la primera coincidencia encontrada, así que manténgalo único dentro del sitio.
totals
Los montos totales de orden de compra. Cuando se proporcionan lines, total se valida contra ellas y debe ser igual a la suma de cada lines[].total, más taxes, menos discounts. Una solicitud cuyos totales no concuerden es rechazada. Si omite lines, no se realiza esta verificación.
term
El plazo de la orden de compra, por su _id de Hyfin o su externalId. Envíe cualquiera de los dos. Establece la fecha de vencimiento y agrega los descuentos por pago anticipado y los cargos por mora del plazo. Por defecto usa el plazo de orden de compra del cliente, si existe.
lines
Una lista de elementos de línea en la orden de compra. Requerido si no se pasa la description.
invoiceDate
La fecha de la orden de compra. Se devuelve como marca de tiempo a la medianoche UTC de esa fecha. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
customerMemo
String
Una nota presentada al cliente en la parte inferior de la orden de compra.
internalMemo
String
Un memo agregado en la parte inferior de la orden de compra. Solo visible para el personal interno, nunca se muestra a los clientes.
webhookUrl
String
La URL a la que se envía una publicación cuando se realizan ciertas acciones en orden de compra. Se envía un webhook cuando un pago alcanza un nuevo estado, y cuando un mensaje de texto, correo electrónico o mensaje de WhatsApp se envía, se entrega, se lee, se retrasa o falla, o cuando el cliente hace clic en el enlace de pago.
createdAt
La fecha en que se creó la orden de compra. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
attachmentRefs
Una lista de adjuntos.
customerUrl
String
El enlace para el cliente para ver y pagar la orden de compra. Es el mismo enlace que el cliente recibe cuando se le envía la orden de compra.
send
A quién se envía orden de compra, por canal. Un canal que incluyas se usa tal como lo indiques, y una lista vacía ([]) desactiva ese canal. Un canal que omitas conserva los destinatarios que orden de compra ya tiene, o se llena con los contactos del cliente, según el control de notificaciones del cliente, cuando aún no tiene ninguno. En una creación, omite send para que los contactos del cliente decidan cada canal cuando se envíe orden de compra. En una actualización, omitirlo conserva los destinatarios ya elegidos. Una lectura devuelve send.to como null hasta que se hayan elegido destinatarios. billTo.emails y billTo.sms siguen siendo la anulación de quién recibe esos canales, pero nunca reactivan un canal que send desactivó.
onHold
Boolean
Indica si la primera cuota no pagada está retenida, de modo que su solicitud de pago no se envía hasta que se libere la retención. En una lectura es true cuando esa cuota está retenida y false en caso contrario. En una escritura, establécelo en true para retener esa cuota, o en false en una actualización para liberarla. Omítelo para dejar la retención como está. La retención pertenece a la cuota, no a orden de compra.
false libera una retención que tú o el comercio colocaron. No libera la retención que recibe orden de compra cuando no llega a nadie y no se cobrará automáticamente: send.to desactiva todos los canales, o todas las direcciones del cliente son de no contactar y no hay una anulación billTo. Esa orden de compra permanece retenida y la escritura aun así se realiza correctamente, también cuando tú mismo proporcionas installments o estableces installments[].onHold en false. Asígnale un destinatario para que se envíe.
Una escritura que envíe tanto onHold como installments[].onHold en la primera cuota no pagada debe darles el mismo valor. De lo contrario se rechaza con un 400 y el mensaje "Invalid on_hold, it conflicts with on_hold on the first unpaid installment. Send one of them, or the same value in both". Un valor que no sea booleano se rechaza con "Invalid on_hold, must be a boolean".
customer
String
El _id del cliente
billToCustomer
String
El _id del cliente que recibe y paga la orden de compra.
billTo
Reemplazos opcionales para la sección Facturar a de la orden de compra. Si se proporciona billToCustomer, este objeto se combinará con la información del cliente y se puede usar para reemplazar campos específicos. Si no se proporciona billToCustomer, los campos de este objeto se usarán como la información de Facturar a en la orden de compra.
soldTo
Opciones adicionales para la sección de Vendido a / Cliente de la orden de compra.
payments
String [ ]
Los _ids de los pagos asociados con esta orden de compra.
deleted
Boolean
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.
Sample Response
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "externalId": "439772921",
  "invoiceNumber": "12345",
  "totals": {
    "taxes": 285,
    "discounts": 0,
    "total": 3285
  },
  "customer": "61f32dc2f62bdc6a48951255",
  "billToCustomer": "61f32dc2f62bdc6a48951255",
  "billTo": {
    "name": "John Doe",
    "attn": "",
    "address": {},
    "emails": [],
    "sms": []
  },
  "soldTo": {
    "name": "John Doe",
    "attn": "",
    "address": {}
  },
  "term": {
    "_id": "61f32dc2f62bdc6a48940a12",
    "externalId": "E3680754-8F2B-42CE-A451-792AAD4A7840"
  },
  "lines": [
    {
      "name": "Mens Large T-shirt",
      "description": "",
      "qty": 2,
      "unitPrice": 1500,
      "total": 3000,
      "item": "62166eda3a8c0517866b9b46"
    }
  ],
  "invoiceDate": "2022-12-01T00:00:00.000Z",
  "dueDate": "2022-12-01T00:00:00.000Z",
  "expireAt": "2023-01-01",
  "poNumber": "",
  "customerMemo": "Thank you for your business!",
  "internalMemo": "",
  "payments": [
    "62166eda3a8c0517866b9c23"
  ],
  "attachmentRefs": {
    "internal": [],
    "external": [],
    "sourceDocument": null
  },
  "webhookUrl": "https://yourcompany.com/webhook",
  "customerUrl": "https://site.url/L-KA39TI45JLMN",
  "createdAt": "2025-05-30T19:19:44.143Z",
  "deleted": false
}


		

Ver también