Get Orden de compra
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
El identificador único de la orden de compra del sistema/base de datos fuente. Si detectamos un registro con el mismo external_id, se actualizará; de lo contrario, se añadirá.
_id
String
The id of the orden de compra, assigned by the system.
invoice_number
String
El número único asignado por el sistema fuente y mostrado al cliente en la orden de compra.
reference_number
String
The unique reference number assigned to the orden de compra by the system. It is also the code in the customer-facing link.
internal
Boolean
Whether the orden de compra is internal to the merchant and was never sent to a customer.
notifications
The notifications sent to the customer for this orden de compra, most recent last.
totals
The total amounts on the orden de compra. When lines are supplied, total is validated against them and must equal the sum of every lines[].total, plus tax, minus discounts. A request whose totals do not reconcile is rejected. Omit lines and no such check is made.
customer
Una referencia al registro del cliente. Omita este campo para recibir un enlace a la orden de compra.
invoice_term_name
String
El nombre del plazo de la orden de compra para la orden de compra. Se establece por defecto en el plazo de la orden de compra del cliente si existe, a menos que se pase null.
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 solicitud no se enviará hasta esa fecha. El valor predeterminado es hoy si se deja en blanco. 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
Default = true
payments
Una lista de pagos realizados en la orden de compra.
webhook_url
String
La URL a la que se enviará la publicación cuando se realicen ciertas acciones en la orden de compra. Se enviarán notificaciones cuando un texto/correo electrónico falle, un cliente haga clic en un enlace o realice un pago.
attachments
String [ ]
Una lista de URL de adjuntos.
created_at
Date
La fecha en que se creó la orden de compra.
updated_at
Date
La fecha en que se actualizó por última vez la orden de compra.
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"
}