Get Credit


The following endpoint can be used to retrieve the details of a credit within the Hyfin application, including how much of it has been applied and how much can still be applied.


Punto Final

The following endpoint can be used to retrieve a credit. You must replace the {base_url} , {site_id} and {_id} variables with the appropriate values. The credit's external id can be used in place of its _id .

GET
{base_url}/api/v4/site/{site_id}/credit/{_id}

A credit sent through Add/Update Invoice is stored as a credit, not an invoice. Reading it with Get Invoice returns the error record_is_credit with the credit's _id in credit ; read it with this endpoint instead.

Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
_id
String
El id del crédito. Este campo lo genera automáticamente el sistema y no es obligatorio al crear un nuevo crédito. Se requiere _id o externalId al actualizar un crédito existente.
externalId
String
El id único del crédito del sistema o base de datos de origen. Obligatorio al crear un crédito sin _id. Si detectamos un crédito con el mismo externalId, se actualizará; de lo contrario, se agregará. No puede coincidir con el externalId de una orden de compra en el mismo sitio.
code
String
El código del crédito generado por el sistema.
creditNumber
String
El número de crédito que se muestra al cliente (el "N.º de crédito"). De forma predeterminada es el código.
kind
String
El tipo de crédito. Solo se puede crear creditNote a través de la API.
Default = creditNote | One of creditNote
status
String
El estado del crédito. Un crédito creado a través de la API se emite de inmediato y se puede aplicar a las órdenes de compra del cliente. Un crédito anulado ya no se puede aplicar.
One of issued, voided
site
String
El _id del sitio
customer
String
El _id del cliente
billToCustomer
String
El _id del cliente a facturar.
creditDate
La fecha del crédito, devuelta como marca de tiempo. Por defecto es la fecha en que se creó el crédito. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
poNumber
String
El número de orden de compra del crédito.
description
String
Una descripción breve del crédito, como el motivo o la autorización de devolución.
customerMemo
String
Una nota para el cliente.
lines
Las partidas del crédito. Se requiere al menos una partida, y el total de cada partida debe ser igual a su subtotal más su impuesto.
amount
Number
El valor nominal del crédito: subtotal + taxes - discounts. Se calcula a partir de las partidas si se omite. Este es un número entero de centavos, por lo que 1035 significa $10.35.
subtotal
Number
La suma de los subtotales de las partidas. Este es un número entero de centavos, por lo que 1035 significa $10.35.
taxes
Number
El impuesto del crédito. Este es un número entero de centavos, por lo que 1035 significa $10.35.
discounts
Number
Cualquier descuento del crédito, como un monto positivo. Este es un número entero de centavos, por lo que 1035 significa $10.35.
applied
Number
El monto del crédito aplicado hasta ahora a órdenes de compra. Este es un número entero de centavos, por lo que 1035 significa $10.35.
reserved
Number
El monto retenido por pagos que aún están en curso. Este es un número entero de centavos, por lo que 1035 significa $10.35.
remaining
Number
El monto aún no aplicado: amount - applied. Este es un número entero de centavos, por lo que 1035 significa $10.35.
spendable
Number
El monto que se puede aplicar en este momento: lo que queda, menos lo retenido por pagos en curso. Cero para un crédito anulado. Este es un número entero de centavos, por lo que 1035 significa $10.35.
isExhausted
Boolean
Indica si el crédito está totalmente aplicado.
lastAppliedAt
Cuándo se aplicó el crédito por última vez a una orden de compra. 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-DDTHH:mm:ss.SSSZ
linesSynthesized
Boolean
Indica si el sistema creó la única línea del crédito porque el crédito se envió mediante invoice/addUpdate sin líneas.
isReady
Boolean
Indica si el crédito se puede aplicar.
voidedAt
Cuándo se anuló el crédito. 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-DDTHH:mm:ss.SSSZ
deleted
Boolean
Envíe true para anular el crédito. Un crédito que se ha aplicado a una orden de compra no se puede anular. Un crédito anulado no se puede actualizar ni volver a crear con el mismo id. El indicador permanece en false en el registro; status indica voided.
createdAt
Cuándo se creó el crédito. 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-DDTHH:mm:ss.SSSZ
updatedAt
Cuándo se actualizó el crédito por última vez. 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-DDTHH:mm:ss.SSSZ
Sample Response
			
{
  "_id": "6717a2c4e1f0a93b2c5d8e11",
  "externalId": "CM-88123",
  "code": "P5XU4MK7QZ2X",
  "creditNumber": "CM-88123",
  "kind": "creditNote",
  "status": "issued",
  "site": "6201825a0cf5e23261a08646",
  "customer": "649dc5bb468bd5b5d863c7d1",
  "billToCustomer": null,
  "creditDate": "2026-10-01T00:00:00.000Z",
  "poNumber": "PO-552",
  "description": "Return RMA 7781",
  "customerMemo": null,
  "amount": 15000,
  "subtotal": 15000,
  "taxes": 0,
  "discounts": 0,
  "applied": 5000,
  "reserved": 0,
  "remaining": 10000,
  "spendable": 10000,
  "isExhausted": false,
  "lastAppliedAt": "2026-10-08T15:20:11.000Z",
  "linesSynthesized": false,
  "isReady": true,
  "voidedAt": null,
  "deleted": false,
  "createdAt": "2026-10-01T14:02:37.000Z",
  "updatedAt": "2026-10-08T15:20:11.000Z",
  "lines": [
    {
      "name": "Returned: Cabinet Knob K-12",
      "qty": 10,
      "unitPrice": 1250,
      "subtotal": 12500,
      "total": 12500,
      "description": null,
      "item": null,
      "glAccount": null,
      "isTaxable": false,
      "taxRates": []
    },
    {
      "name": "Returned: Drawer Pull P-40",
      "qty": 2,
      "unitPrice": 1250,
      "subtotal": 2500,
      "total": 2500,
      "description": null,
      "item": null,
      "glAccount": null,
      "isTaxable": false,
      "taxRates": []
    }
  ]
}