Skip to content

caracol.creditnote.issued

Caracol stamped a credit note (nota de crédito) for a customer — Constanza generates reversal pólizas: revenue side (Dr 4102 Devoluciones sobre Ventas / Cr payment) and COGS reclass (Dr 1151 Inventario or Dr 5005 Merma / Cr 5001) per item returnsTo flag.

Senders

  • caracol

Receivers

  • constanza

Data schema

Each field maps to a type hint. | null indicates an optional field.

json
{
  "tenantId": "string",
  "creditNoteId": "string",
  "creditNoteUuid": "string | null",
  "creditNoteSerie": "string | null",
  "creditNoteFolio": "string | number | null",
  "creditNoteType": "\"devolution\" | \"adjustment\"",
  "relatedInvoiceId": "string",
  "relatedInvoiceUUID": "string | null",
  "relatedSaleId": "string | null",
  "originalSaleCategory": "\"normal\" | \"courtesy\" | \"sample\" | \"promotional\" | \"fiscal_adjustment\" | undefined",
  "branchId": "string",
  "thirdPartyId": "string | null",
  "thirdPartyName": "string | null",
  "thirdPartyRfc": "string | null",
  "subtotal": "number",
  "iva": "number",
  "total": "number",
  "paymentMethod": "string | null",
  "items": "CreditNoteIssuedItem[] — { productId, productName, quantity, unitCost, totalCost, returnsTo: 'inventory'|'merma' }",
  "reason": "string",
  "issuedAt": "string (ISO datetime)"
}

Example payload

The following is a synthetic payload that matches the schema. Production payloads are signed with HMAC-SHA256 and delivered to each receiver's registered webhook endpoint.

json
{
  "tenantId": "example-tenantId",
  "creditNoteId": "example-creditNoteId",
  "creditNoteUuid": "example-creditNoteUuid",
  "creditNoteSerie": "example-creditNoteSerie",
  "creditNoteFolio": "example-creditNoteFolio",
  "creditNoteType": "example-creditNoteType",
  "relatedInvoiceId": "example-relatedInvoiceId",
  "relatedInvoiceUUID": "example-relatedInvoiceUUID",
  "relatedSaleId": "example-relatedSaleId",
  "originalSaleCategory": "example-originalSaleCategory",
  "branchId": "example-branchId",
  "thirdPartyId": "example-thirdPartyId",
  "thirdPartyName": "example-thirdPartyName",
  "thirdPartyRfc": "example-thirdPartyRfc",
  "subtotal": 0,
  "iva": 0,
  "total": 0,
  "paymentMethod": "example-paymentMethod",
  "items": [],
  "reason": "example-reason",
  "issuedAt": "2026-04-17T12:00:00.000Z"
}

See also


Generated from ecosystem-sdk/packages/mcp-server/src/registry/events.json. Do not edit by hand.

Red Broom Software Ecosystem