Get Orden de compra

Usa esto cuando necesites el estado actual de un orden de compra, como su saldo y sus pagos, mediante su external_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} , {external_id} and {site_id} variables with the appropriate values.

GET
{base_url}/api/v3.1/site/{site_id}/invoice/{external_id}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
external_id
String
Tu propio id para esta orden de compra, desde tu software. Envía de nuevo el mismo external_id 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.
_id
String
El id de orden de compra, asignado por el sistema.
invoice_number
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.
reference_number
String
El número de referencia único que el sistema asigna a orden de compra. También es el código en el enlace dirigido al cliente.
internal
Boolean
Indica si orden de compra es interno del comercio y nunca se envió a un cliente.
notifications
Las notificaciones enviadas al cliente para orden de compra, la más reciente al final.
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 tax, menos discounts. Una solicitud cuyos totales no concuerden es rechazada. Si omite lines, no se realiza esta verificación.
customer
Una referencia al registro del cliente.
invoice_term_name
String
El nombre de un plazo de orden de compra configurado para el sitio, como Net 30. Cuando se envía, la fecha de vencimiento se calcula a partir del plazo y la fecha de la orden de compra, y reemplaza cualquier due_date que envíe. Un nombre que no coincide con ningún plazo se rechaza con Invoice term "" not found. Cuando se omite en una orden de compra nueva, se usa el plazo de orden de compra del cliente si lo tiene.
lines
Una lista de elementos de línea en la orden de compra. Requerido si no se pasa la description.
description
String
Una breve descripción de los productos/servicios en la orden de compra. Requerido si no se pasan las lines.
invoice_date
Date
La fecha de la orden de compra. Si se establece en el futuro, la orden de compra no se envía por mensaje de texto ni por correo electrónico al cliente hasta esa fecha. Si se deja en blanco, se usa la fecha de hoy. Una fecha sin hora. Si se envía una hora o zona horaria con ella, se descarta, no se convierte, por lo que la fecha permanece tal como se escribió. Format = YYYY-MM-DD
customer_memo
String
Una nota presentada al cliente en la parte inferior de la orden de compra.
internal_memo
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.
active
Boolean
Esta bandera representa si el registro orden de compra está activo y disponible para ser utilizado o no.
Default = true
payments
Una lista de pagos realizados en la orden de compra.
webhook_url
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.
attachments
String [ ]
Una lista de URL de adjuntos.
created_at
Timestamp
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
updated_at
Timestamp
La fecha en que se actualizó por última vez la orden de compra. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Sample Response
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "external_id": "439772921",
  "invoice_number": "12345",
  "description": "",
  "customer_memo": "",
  "internal_memo": "",
  "due_date": "2021-10-01",
  "totals": {
    "tax": 2.85,
    "total": 32.85
  },
  "customer": {
    "external_id": "39772634",
    "first_name": "John",
    "last_name": "Doe",
    "mobile_phone": "111-222-3333",
    "email": "johndoe@abc.com"
  },
  "lines": [
    {
      "description": "",
      "product": {
        "external_id": "62331255",
        "name": "Mens Large T-shirt",
        "unit_price": 15
      },
      "unit_price": 15,
      "qty": 2,
      "total": 30
    }
  ],
  "payments": [
    {
      "external_id": "72345322",
      "reference_number": "N7E6NFU6WZZ5-PW3A",
      "gateway_transaction_id": "53912387124235234",
      "payment_type": "payment_card",
      "payment_sub_type": "amex",
      "display_name": "Amex",
      "amount": 30,
      "tip": 0,
      "tax": 0,
      "fee": 0,
      "paid_on": "2021-03-15T16:32:11Z",
      "status": "captured",
      "is_refund": false,
      "created_at": "2025-05-30T19:19:44.143Z",
      "updated_at": "2025-05-30T19:19:44.143Z"
    }
  ],
  "notifications": [
    {
      "error": false,
      "value": "test@test.com",
      "description": "Email to test@test.com sent",
      "at": "2021-03-15T13:32:11Z"
    },
    {
      "error": false,
      "value": "999-123-4567",
      "description": "Text to 999-123-4567 sent",
      "at": "2021-03-15T13:32:11Z"
    }
  ],
  "webhook_url": "https://yourcompany.com/webhook",
  "created_at": "2025-05-30T19:19:44.143Z",
  "updated_at": "2025-05-30T19:19:44.143Z"
}


		

Ver también