Eliminar o liquidar desde proveedor

curl --request DELETE \
  --url https://api.cobrix.co/api/v1/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "DELETE_FROM_PROVIDER"
}
'

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'DELETE_FROM_PROVIDER'})
};

fetch('https://api.cobrix.co/api/v1/invoices/{invoiceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cobrix.co/api/v1/invoices/{invoiceId}"

payload = { "reason": "DELETE_FROM_PROVIDER" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

API pública de documentos de cobro

Eliminar o liquidar desde proveedor

Sin reason o con DELETE_FROM_PROVIDER, anula el documento y los checkouts pendientes, responde HTTP 204 y encola el webhook asíncrono invoice.canceled. El payload del evento refleja invoice.status=DELETE_FROM_PROVIDER e invoice.payment.status=canceled. Con PAID_FROM_PROVIDER, aplica exactamente el saldo abierto usando provider_payment_id y, después de persistir el pago y el saldo cero, encola exactamente un invoice.paid. Ese payload conserva invoice.status=PAID_FROM_PROVIDER, reporta invoice.payment.status=APPROVED y devuelve el identificador recibido en invoice.payment.provider_id. Rechaza documentos con pagos parciales o estados incompatibles. Requiere public_invoices:write.

DELETE

invoices

{invoiceId}

curl --request DELETE \
  --url https://api.cobrix.co/api/v1/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "DELETE_FROM_PROVIDER"
}
'

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'DELETE_FROM_PROVIDER'})
};

fetch('https://api.cobrix.co/api/v1/invoices/{invoiceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cobrix.co/api/v1/invoices/{invoiceId}"

payload = { "reason": "DELETE_FROM_PROVIDER" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

Authorizations

Authorization

string

header

required

Llave cbx_live con scope de documentos públicos.

Path Parameters

invoiceId

string<uuid>

required

Body

application/json

reason

enum<string>

default:DELETE_FROM_PROVIDER

Available options:

DELETE_FROM_PROVIDER,

PAID_FROM_PROVIDER

provider_payment_id

string

Referencia requerida operacionalmente al informar PAID_FROM_PROVIDER.

Required string length: 1 - 255

Response

Operación completada sin cuerpo