Skip to navigation

Orden de compra editada

Se emite cuando se edita una orden con PATCH /purchase_orders/{id}: un borrador en lo que sea, una orden ya enviada solo en su metadata.

Payload

The payload of this webhook request is an object.
event_typestringRequiredformat: "^[a-z0-9_.-]+$"
Tipo exacto del evento enviado por Recurrente.
idstringRequired
ID de la orden de compra
statusenumRequired

draft no se ha enviado (o su factura no se certificó); open se envió y se debe; paid se pagó, con su link o afuera; void se anuló; uncollectible se dio por perdida, aunque su link sigue cobrando.

Allowed values:
api_versionstringRequired
connectedboolean or nullOptional

Presente como true cuando el evento proviene de una cuenta conectada.

account_idstring or nullOptional

ID de la cuenta conectada que originó el evento.

overduebooleanOptional

Abierta y con la fecha de vencimiento ya pasada. «Vencida» no es un estado.

referencestringOptional

Número de la orden con su prefijo, como lo ve el comprador

external_referencestring or nullOptional

Referencia inmutable del ERP; también se incluye en los webhooks

prefixstringOptional
numberintegerOptional
Consecutivo de la orden en tu cuenta
descriptionstring or nullOptional

Qué vende, como lo lee el comprador

checkout_urlstringOptional
Link donde el comprador paga la orden. No vence mientras la orden se deba.
metadatamap from strings to anyOptional

La metadata que tu integración le puso

currencystringOptional
total_in_centsintegerOptional
Total de la orden, en centavos
amount_paid_out_of_band_in_centsintegerOptional

Lo que se registró como pagado fuera de Recurrente, en centavos

amount_remaining_in_centsintegerOptional

Lo que el comprador todavía debe, en centavos. 0 si está pagada o anulada.

paymentslist of objectsOptional

Pagos registrados fuera de Recurrente, del más antiguo al más reciente

net_daysinteger or nullOptional

Días de crédito desde que se envió. null cuando la orden tiene una fecha de vencimiento propia.

issued_ondate or nullOptional

Fecha en que se envió. null en borrador.

due_ondate or nullOptional
Fecha de vencimiento
promised_ondate or nullOptional

Fecha en que el comprador prometió pagar, si la registraste en el dashboard

reminders_pausedbooleanOptional

Los recordatorios automáticos están en pausa

void_reasonstring or nullOptional

Por qué se anuló

customer_idstringOptional
ID del cliente comprador
buyer_namestringOptional

Nombre o razón social del comprador como se escribió en la orden (lo que envió buyer_name, o el nombre del cliente). Renombrar al cliente después no lo cambia.

buyer_emailstring or nullOptional

Correo al que se envía la orden

buyer_phonestring or nullOptional

WhatsApp al que se envía la orden

buyer_tax_idstring or nullOptional

NIT de la factura. null es consumidor final.

buyer_referencestring or nullOptional

El número con el que el comprador archiva su orden de compra

cc_emailslist of stringsOptional
Correos que reciben copia
tax_invoice_requestedbooleanOptional

La orden se envía con factura electrónica

tax_invoiceobject or nullOptional

La factura de la orden tal como está (el último intento de certificarla). null si no se ha intentado.

sent_atdatetime or nullOptional
paid_atdatetime or nullOptional
voided_atdatetime or nullOptional
uncollectible_atdatetime or nullOptional
created_atdatetimeOptional
updated_atdatetimeOptional

Response

200

Tu endpoint respondió exitosamente.