El endpoint permite a la compañía generar un débito automático basado en un acuerdo de pago previamente establecido. Para ello, se envía un objeto denominado billingRecord que agrupa todos los detalles necesarios para procesar la transacción. A continuación se explica cada uno de los campos incluidos:
agreementId: Identificador único del acuerdo de pago relacionado con el débito. Este campo vincula la transacción al contrato específico establecido con el tercero.
billingDate: Fecha en la que se efectúa el débito. Indica el momento exacto en que se registra la operación.
cutoffDate: Fecha límite para el corte del período de facturación.
invoiceNumber: Número de factura generado de manera única para la transacción, facilitando su seguimiento y referencia en auditorías o consultas posteriores.
amount: Monto a debitar, expresado en la moneda correspondiente, que representa el valor de la transacción.
description: Detalle o descripción del débito, que puede incluir información contextual o referencial sobre el servicio o concepto facturado. Este campo es opcional.
Ejemplo del body
{
"billingRecord": {
"agreementId": "{{id-agreement-payment}}",
"billingDate": "2024-07-31T00:00:00.000Z",
"cutoffDate": "2024-07-31T00:00:00.000Z",
"invoiceNumber": "{{$randomUUID}}",
"amount": 9000,
"description": "{{$randomJobDescriptor}}"
}
}
Respuesta
{
"message": "Solicitud de cobro creada exitosamente",
"id": "d14ad237-8675-47ac-ae46-90e6f21b5ccd"
}