Saltar al contenido principal

Cancelar una factura

Descripción general​

Puedes cancelar una factura para que el cliente ya no pueda pagarla. Es útil cuando la factura contiene un error. La cancelación exige dos condiciones:

  • Estado de la factura: Sin pagar
  • Vistas de la página de pago: 0

Si la factura pertenece a otro proyecto y la clave está restringida a un proyecto, el método responde con Restricted project. Si no tienes ninguna factura con ese identificador —Invoice not found. Si la factura se encuentra pero no se cumplen las condiciones de cancelación —Invoice cannot be canceled.

Solicitud​

curl -X POST https://api.bitsby.app/invoices/cancel \
-H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
-F "invoiceId=ade9550d-3dc7-4fd3-b94e-3b4c12aaaa0c"

Parámetros de la solicitud​

ParámetroTipo de datoDescripciónEjemplo¿Obligatorio?
invoiceIdUUIDID de la factura en formato UUIDade9550d-3dc7-4fd3-b94e-3b4c12aaaa0csí

Ejemplo de respuesta​

{
"result":"success",
"data":"Invoice canceled"
}