Ir al contenido principal

Cómo usar los registros de webhook

Envía pedidos a sistemas contables de terceros usando registros de webhook

Actualizado hace más de 2 semanas

🔐 Permisos de rol necesarios: Registries (Registros)

🔓 Permisos de rol opcionales: Save Searches (Guardar búsquedas), See Bulk Action (Ver acción masiva), Data Export (Exportar datos), Generate Reports (Generar informes)

Los registros de webhook te permiten enviar automáticamente los datos de los pedidos a sistemas contables de terceros, simplificando el seguimiento financiero y garantizando la coherencia.

Crear registro nuevo

  1. En el panel de Ventrata, ve a Supplier Settings (Configuración de proveedor) > Registries (Registros).

    Registries (Registros)

  2. Pulsa el botón + New Registry (+ Nuevo registro).

    New Registry (Nuevo registro)

  3. Selecciona Webhook Registry (Registro de webhook).

    Webhook Registry (Registro de webhook)

  4. Introduce un nombre para el registro.

    Registry Name (Nombre del registro)

  5. Selecciona los destinos en los que se utilizará el registro.

    Destinations (Destinos)

  6. Introduce la URL de destino del webhook a la que se enviarán los pedidos.

    Order URL (URL de pedido)

  7. Selecciona los tipos de asientos de libro mayor que se incluirán.

    Order Sale Types (Tipos de venta del pedido)

  8. Selecciona las columnas por las que se agruparán los asientos de libro mayor.

    Order Ledger Columns (Columnas del libro mayor del pedido)

  9. Selecciona las columnas de totales, que son SUM(X) de la columna correspondiente.

    Order Ledger Aggregates (Agregados del libro mayor del pedido)

  10. Pulsa el botón Create Registry (Crear registro).

    Create Registry (Crear registro)


Puntos finales de webhook

Se proporcionan dos puntos finales, ambos con los mismos parámetros de fecha desde/hasta y que trabajan sobre el mismo conjunto de datos.

ledger_summary

Este punto final genera un informe resumido que muestra los flujos de efectivo contables.

https://api.ventrata.com/reporting/webhook_registry/ledger_summary

Cada vez que se confirma, actualiza o cancela un pedido, el /ledger_summary, el punto final de solicitud se enviará a la URL de pedido del webhook. La solicitud será un HTTP POST y el cuerpo se formateará del siguiente modo:

{
"order_id": "2e7f2d6f-0473-4935-8cfb-c11b2caa6dab",
"idempotency_key": "5ffd8c8c-19d5-4999-8c9b-475dabeb45f5",
"ledger_entries": [
{
"ledger_code": null,
"currency": "EUR",
"quantity": 0,
"debit": "38.0",
"credit": "0.0",
"description": "Cashflow"
},
{
"ledger_code": null,
"currency": "EUR",
"quantity": 2,
"debit": "0.0",
"credit": "22.0",
"description": "Museum General Admission"
},
{
"ledger_code": null,
"currency": "EUR",
"quantity": 2,
"debit": "0.0",
"credit": "16.0",
"description": "Museum Child Ticket"
}
]
}

El objeto siempre contendrá las siguientes claves:

Clave

Descripción

order_id

un ID único que identifica el pedido (UUID)

registry_data

esta clave se eliminó

idempotency_key

una clave única para esta solicitud; si la solicitud falla se volverá a intentar con la misma idempotency_key

ledger_entries

una lista de entradas del libro mayor para este pedido

Cada entrada del libro mayor se define como:

Parámetro del libro mayor

Descripción

ledger_code

el código de libro mayor de la entrada

currency

este campo y cualquier otra columna incluida en Order Ledger Columns (Columnas del libro mayor del pedido); en este ejemplo solo incluimos la moneda

quantity

un número entero positivo para ingresos entradas del libro mayor

debit

incrementa el valor de los activos, cuentas de gastos y pérdidas

credit

incrementa el valor de los pasivos, el patrimonio, ingresos y las cuentas de ganancias

description

es la descripción legible para humanos de cada línea


ledger_report

Este endpoint genera un informe basado en el Order Ledger Aggregates (Agregados del libro mayor del pedido) campo.

https://api.ventrata.com/reporting/webhook_registry/ledger_report

Cuando el /ledger_report endpoint de webhook es llamado, genera un informe que incluye las columnas seleccionadas en el Order Ledger Columns (Columnas del libro mayor del pedido) y Order Ledger Aggregates (Agregados del libro mayor del pedido) campos; consulte Crear registro nuevo.

La solicitud será un HTTP POST y devuelve un array de objetos:

[
{
"destination": "Krno",
"test": false,
"deferred": false,
"redeemed": false,
"noshow": true,
"upgraded": false,
"code": "1C",
"reseller": null,
"reseller_band": null,
"reseller_channel": null,
"reseller_tags": null,
"unit": "Adult",
"option": "24 Hours",
"product": "Krno City Loops Hop on Hop off",
"product_tags": null,
"package_product": null,
"package_option": null,
"promotion": null,
"promotion_tags": null,
"package_promotion": null,
"package_promotion_tags": null,
"ledger_code_account_type": "revenue",
"date": "2024-11-15",
"travel_date": "2024-11-13",
"redemption_date": null,
"order": "WXDAPPSQ",
"order_channel": "Terminals",
"order_source": "terminal",
"currency": "CZK",
"sale_type": "individual",
"quantity": -2,
"size": -2,
"revenue_total": "1400",
"discount_total": "0.0",
"adjustment_total": "0.0",
"commission_adjustment_total": "0.0",
"total": "1400",
"commission_total": "0.0",
"wholesale_total": "0.0",
"tax_total": "0.0",
},
{

¿Ha quedado contestada tu pregunta?