Skip to main content
Vindicia Knowledge Center

AutoBill.writeOffInvoice

AutoBill.writeOffInvoice

AutoBill.writeOffInvoice

Marks an Invoice as writtenOff, the debt unable to be collected.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

autobill: the AutoBill associated with the Invoice to be written off.

invoiceId: the ID of the Invoice to write off.

Output

return: an object of type Return that indicates the success or failure of the call.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code

Return String

400

One of the following:

  • AutoBill not found.
  • Invoiced ID not provided.
  • Failed to write off invoice: error-description.

404

Invoice ID not found.

Example

$autobill = new AutoBill();
$autobill->setMerchantAutoBillId($abID); // for some $abID

$response = $autobill->writeOffInvoice('inv-bac');

// check $response

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top