Cm3WriteOff

Perform this action to write off an open invoice amount.

Endpoints in different environments:

https://testcheckout.buckaroo.nl/json/DataRequest for test invoices;

https://checkout.buckaroo.nl/json/DataRequest for live invoices

Parameters

Parameter	Type	Required	Description
OriginalInvoiceNumber	String	Yes	Invoice number of the original invoice. Also used as the invoice number of the resulting V376 transaction.
WriteOffAmount	Decimal	Yes	Amount to write off, including VAT. Cannot exceed the current open invoice amount.
WriteOffAmountVat	Decimal	Yes	VAT portion of WriteOffAmount. Cannot exceed the original invoice VAT minus credit note VAT.
WriteOffReason	Enum	Yes	One of the predefined reasons for the write-off. Pass the corresponding number: General Liquidation To DCA After DCA Bankruptcy Small amounts Debt restructuring general Debt restructuring by law Amicable debt settlement of natural persons Fraud DeceasedDebtor MinorDebtor Technical
WriteOffDescription	String	No	Free-text description. Also used as the description of the resulting V376 transaction.
TotalWriteOff	Boolean	No	When true, auto-calculates the open amount and VAT, overriding WriteOffAmount and WriteOffAmountVat. When false or not provided, the amounts provided in the request are used.

Request

{
  "Services": {
    "ServiceList": [
      {
        "Name": "CreditManagement3",
        "Action": "Cm3WriteOff",
        "Parameters": [
          {
            "Name": "OriginalInvoiceNumber",
            "Value": "TESTINV2000008"
          },
          {
            "Name": "WriteOffAmount",
            "Value": "10.00"
          },
          {
            "Name": "WriteOffAmountVat",
            "Value": "0.00"
          },
          {
            "Name": "WriteOffReason",
            "Value": "1"
          },
          {
            "Name": "WriteOffDescription",
            "Value": "Full writeoff"
          },
          {
            "Name": "TotalWriteOff",
            "Value": "False"
          }
        ]
      }
    ]
  }
}

Response (success)

{
    "Key": "71FDB18F848148A4A27D6FC91462345",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
        },
        "DateTime": "2026-08-03T08:34:13"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "ServiceCode": "CreditManagement3",
    "IsTest": true,
    "ConsumerMessage": null
}

Response (validation error)

{
  "Key": "569CE970B52D46D1A20ACDD79D982345",
  "Status": {
    "Code": {
      "Code": 491,
      "Description": "Validation failure"
    },
    "SubCode": {
      "Code": "C000",
      "Description": "Validation failure"
    },
    "DateTime": "2026-08-03T08:36:46"
  },
  "RequiredAction": null,
  "Services": null,
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": {
    "ChannelErrors": [],
    "ServiceErrors": [],
    "ActionErrors": [],
    "ParameterErrors": [
      {
        "Service": "CreditManagement3",
        "Action": "Cm3WriteOff",
        "Name": "WriteOffAmount",
        "Error": "ParameterInvalid",
        "ErrorMessage": "WriteOff amount should have positive value and not exceed the open invoice amount."
      }
    ],
    "CustomParameterErrors": []
  },
  "ServiceCode": null,
  "IsTest": true,
  "ConsumerMessage": null
}

Push parameters

A WriteOff pushes a Cm3WriteOff event to communicate the write-off, and a ChangedTransactionStatus event to communicate the creation of the write-off transaction.

Parameter	Description
AmountWriteOffs	Basic parameter. Running total of write-offs net of refunds (sum of all write-offs minus write-off refunds).
IsWrittenOff	Basic parameter. True when the open amount is 0 and at least one write-off exists; false otherwise.
WriteOffReason	Event parameter. Reason provided for the write-off. Included for both partial and full write-offs.

Example push

{
  "Invoice": {
    "InvoiceKey": "0948B3022CCA41E78B9857CB4DCCxxxx",
    "InvoiceNumber": "TESTINV2000007",
    "WebsiteKey": "7Cnv8r2345",
    "DebtorCode": "JohnSmith123",
    "DebtorGuid": "087EBCB0D2B9418B87B0CDD8DECxxxx",
    "SchemeKey": "d5gj5t",
    "IsTest": true,
    "Type": "RegularInvoice",
    "Culture": "nl-NL",
    "InvoiceDate": "2018-06-05T00:00:00",
    "DueDate": "2019-04-18T00:00:00",
    "InvoiceStatusCode": 10,
    "PreviousStepIndex": 0,
    "PreviousStepDateTime": "0001-01-01T00:00:00",
    "InvoicePayLink": "https://testcheckout.buckaroo.nl/html/?brq_paydirect_inv=xxx",
    "Event": "Cm3WriteOff",
    "EventCategory": "FinancialChange",
    "EventDateTime": "2026-08-03T08:30:34.8621435",
    "EventParameters": [
      {
        "Key": "TransactionKey",
        "Value": "39C880B202D9446EA10EAC29CBBA2345"
      },
      {
        "Key": "TransactionStatusCode",
        "Value": "190"
      },
      {
        "Key": "WriteOffReason",
        "Value": "Bankruptcy"
      }
    ],
    "Currency": "EUR",
    "AmountDebit": 10.0000,
    "AmountCredit": 0.0000,
    "AmountAdminCosts": 0.0000,
    "AmountCreditNotes": 0.0,
    "AmountPaid": 10.0,
    "AmountAdminCostsPaid": 0.0,
    "AmountPendingSlow": 0.0,
    "OpenAmount": 0.0000,
    "OpenAmountAdminCosts": 0.0000,
    "OpenAmountInclAdminCosts": 0.0000,
    "IsPaid": true,
    "CustomParameters": [],
    "AdditionalParameters": [],
    "DebtorFileGuid": null,
    "DebtorFilePayLink": null,
    "DebtorFileNumber": null,
    "OriginalInvoiceNumber": null,
    "AmountWriteOffs": 10.0000,
    "IsWrittenOff": true
  }
}