Cm3WriteOff

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. Will also be the invoice number of the Write-Off transaction.
WriteOffAmount	Decimal	Yes	Amount to be written off, including VAT. Cannot exceed the current open invoice amount. Will also be the amount of the Write-Off transaction. Will automatically be in the currency of the original invoice.
WriteOffAmountVat	Decimal	Yes	The VAT amount of the WriteOffAmount. Cannot exceed the original invoice vat amount minus the total creditnote vat amount (if applicable). Will automatically be in the currency of the original invoice.
WriteOffReason	Enum	Yes	One of the predefined reasons for write-off. Must be one of the following: 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	Description of the WriteOff
TotalWriteOff	Boolean	No	When true, Buckaroo will automatically calculate the current open amount and VAT amount on the invoice and use those as the WriteOffAmount and WriteOffAmountVat, overwriting the values provided in the request. When false or not provided, the amounts provided in the request are used.

Request

{
	"Services": {
		"ServiceList": [
			{
				"Name": "CreditManagement3",
				"Action": "Cm3WriteOff",
				"Parameters": [
					{
						"Name": "OriginalInvoiceNumber",
						"Value": "INV0001"
					},
					{
						"Name": "WriteOffAmount",
						"Value": "1.00"
					},
					{
						"Name": "WriteOffAmountVat",
						"Value": "0.21"
					},
					{
						"Name": "WriteOffReason",
						"Value": "2"
					},
					{
						"Name": "WriteOffDescription",
						"Value": "Write-off of 1.00 EUR due to bankruptcy"
					},
					{
						"Name": "TotalWriteOff",
						"Value": "False"
					}
				]
			}
		]
	}
}

Response (success)

{
	"Key": "xxxxxxxxxxxxxxxxxxxxx",
	"Status": {
		"Code": {
			"Code": 190,
			"Description": "Success"
		},
		"SubCode": {
			"Code": "S001",
			"Description": "Transaction successfully processed"
		},
		"DateTime": "2025-02-19T17:43:37"
	},
	"ServiceCode": "CreditManagement3",
	"IsTest": true
}

Response (validation error)

{
  "Key": "xxxxxxxxxxxxxxxxxxxxx",
  "Status": {
    "Code": { "Code": 490, "Description": "Failed" },
    "SubCode": { "Code": "SXXX", "Description": "WriteOffAmount exceeds the open invoice amount" },
    "DateTime": "2025-02-13T15:19:00"
  },
  "ServiceCode": "CreditManagement3",
  "IsTest": false
}

Push parameters

Parameter	Description
AmountWriteOffs	The current total write-off amount, adjusted for any WriteOffrefunds.
IsWrittenOff	Indicates whether any write-off has been applied to the invoice.

Example push

],
    "DebtorFileGuid": null,
    "DebtorFilePayLink": null,
    "DebtorFileNumber": null,
    "OriginalInvoiceNumber": null,
    "AmountWriteOffs": 3.4000,
    "IsWrittenOff": false
  }
}