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} , {_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 de la orden de compra. Este campo es generado automáticamente por el sistema y no es necesario al crear una nueva orden de compra, pero es necesario al actualizar una orden de compra existente.
invoiceNumber
String
El número único asignado por el sistema fuente y mostrado al cliente en la orden de compra.
totals
Los importes totales en la orden de compra. Validados contra la suma de los elementos de línea encontrados en lines.
invoiceTermName
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.
invoiceDate
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
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 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.
createdAt
Date
La fecha en que se creó la orden de compra.
updatedAt
Date
La fecha en que se actualizó por última vez la orden de compra.
attachmentRefs
Una lista de adjuntos.
customer
String
El _id del cliente
billToCustomer
String
El _id del cliente a facturar.
billTo
Opciones adicionales para la sección de Facturar a de la orden de compra. Si se proporciona billToCustomer, este objeto se fusionará con la información del cliente y se podrá utilizar para anular campos específicos. Si no se proporciona billToCustomer, los campos de este objeto se utilizará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",
"invoiceNumber": "12345",
"description": "",
"customerMemo": "",
"internalMemo": "",
"dueDate": "2021-10-01",
"totals": {
"taxes": 285,
"total": 3000
},
"customer": {
"_id": "61f32dc2f62bdc6a48951255",
"firstName": "John",
"lastName": "Doe",
"mobilePhone": "111-222-3333",
"email": "johndoe@abc.com"
},
"lines": [
{
"description": "",
"product": {
"_id": "62166eda3a8c0517866b9b46",
"name": "Mens Large T-shirt",
"unitPrice": 1500
},
"unitPrice": 1500,
"qty": 2,
"total": 3000
}
],
"payments": [
{
"_id": "62166eda3a8c0517866b9r23",
"paymentType": "payment_card",
"paymentSubType": "amex",
"displayName": "AMEX ****** 3422",
"last4": "3422",
"amount": 3000,
"paidOn": "2021-03-15T16:32:11Z",
"status": "captured",
"deleted": false
}
],
"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"
}
],
"webhookUrl": "https://yourcompany.com/webhook",
"createdAt": "2025-05-30T19:19:44.143Z",
"updatedAt": "2025-05-30T19:19:44.143Z"
}