{
  "event": "document.accounted",
  "timestamp": "2024-04-15T09:00:00Z",
  "data": {
    "reference": "aaea7db4-647c-4d92-9f86-89e34a68e1aa",
    "beneficiary": {
      "reference": "616263a5-a677-4ad1-92ca-7e120adad8d4",
      "origin": "fiscal",
      "name": "Proveedor Ejemplo S.A.S",
      "identifier_type": "NIT",
      "identifier_number": "900123456",
      "is_deleted": false,
      "deleted_at": null,
      "contact_information": []
    },
    "document_number": "FC-2024-001",
    "type": "invoice",
    "issue_date": "2024-04-14T10:00:00Z",
    "expiration_date": "2024-04-30T10:00:00Z",
    "fiscal_reference": "e19d3e7867371a12fd53b67a56db087faa871c9797993d9bbf7806ae4e1466ea",
    "fiscal_metadata": {
      "final_notes": "Factura sujeta a retención en la fuente según artículo 383 del E.T."
    },
    "amount": 1190000,
    "amount_currency": "COP",
    "status": "approved",
    "payment_status": "pending",
    "accounting_entry": {
      "reference": "CAUS-2024-0042",
      "accounted_at": "2024-04-15T09:00:00Z",
      "invoice_number": "FC-2024-001",
      "causation_state": "done",
      "products": [
        {
          "description": "Servicio"
        }
      ]
    },
    "file_path": "https://storage.payana.cloud/documents/FC-2024-001.pdf",
    "is_archived": false,
    "purchase_order": "OC-2024-001",
    "tags": [],
    "created_at": "2024-04-14T10:00:00Z",
    "updated_at": "2024-04-15T09:00:00Z"
  }
}

Webhooks

Document Accounted

Se envía cuando un documento es causado (registrado contablemente) en Payana. El payload incluye reference, fiscal_reference, fiscal_metadata (p. ej. final_notes del XML) y accounting_entry con el detalle de la causación.

accounting_entry: siempre incluye reference y accounted_at del registro en Payana. Según la empresa y el motor de causación, el objeto se amplía con:

Asiento ERP (V2): registration_payload, summary, journal_entry (líneas del asiento y payment_lines) y advance_crossings.
Legacy: campos como causation_state, products, payments, etc.

Si no hay detalle adicional disponible, solo verás reference y accounted_at. Es null cuando el documento aún no fue causado.

El receptor debe responder con 200 para confirmar la recepción.

WEBHOOK

document.accounted

{
  "event": "document.accounted",
  "timestamp": "2024-04-15T09:00:00Z",
  "data": {
    "reference": "aaea7db4-647c-4d92-9f86-89e34a68e1aa",
    "beneficiary": {
      "reference": "616263a5-a677-4ad1-92ca-7e120adad8d4",
      "origin": "fiscal",
      "name": "Proveedor Ejemplo S.A.S",
      "identifier_type": "NIT",
      "identifier_number": "900123456",
      "is_deleted": false,
      "deleted_at": null,
      "contact_information": []
    },
    "document_number": "FC-2024-001",
    "type": "invoice",
    "issue_date": "2024-04-14T10:00:00Z",
    "expiration_date": "2024-04-30T10:00:00Z",
    "fiscal_reference": "e19d3e7867371a12fd53b67a56db087faa871c9797993d9bbf7806ae4e1466ea",
    "fiscal_metadata": {
      "final_notes": "Factura sujeta a retención en la fuente según artículo 383 del E.T."
    },
    "amount": 1190000,
    "amount_currency": "COP",
    "status": "approved",
    "payment_status": "pending",
    "accounting_entry": {
      "reference": "CAUS-2024-0042",
      "accounted_at": "2024-04-15T09:00:00Z",
      "invoice_number": "FC-2024-001",
      "causation_state": "done",
      "products": [
        {
          "description": "Servicio"
        }
      ]
    },
    "file_path": "https://storage.payana.cloud/documents/FC-2024-001.pdf",
    "is_archived": false,
    "purchase_order": "OC-2024-001",
    "tags": [],
    "created_at": "2024-04-14T10:00:00Z",
    "updated_at": "2024-04-15T09:00:00Z"
  }
}

Antes de procesar el evento, verifica la firma HMAC del request. Consulta Signature Verification en la introducción de la API.

Authorizations

api-key

string

header

required

API key provista por Payana.

Headers

X-Payana-Signature

string

required

X-Payana-Event

string

required

Allowed value: "document.accounted"

X-Payana-Timestamp

string<date-time>

required

Body

application/json

Webhook payload

event

string

required

Allowed value: "document.accounted"

timestamp

string<date-time>

required

data

object

required

Show child attributes

Response

200

Return 200 to acknowledge receipt

⌘I