Write Off Invoices Action

Write off partially paid or unpaid invoices to manage pending debts and to maintain accurate financial records. This action calls the Posted Invoice List Write-Off (POST) API.

This action is available in API version 64.0 and later.

Special Access Rules

The Write Off Invoices action is available in Enterprise, Developer, and Unlimited Editions where Billing is enabled. To use this action, you need the Billing Operations User and Credit Memo Operations User permission sets.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/writeOffInvoices

Formats: JSON, XML

HTTP Methods: GET

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Notes: You can also call the associated Connect REST API endpoint or InvoiceWriteOff Apex methods. See Posted Invoice List Write-Off (POST) API or InvoiceWriteOff Namespace.

Inputs

Input	Type	Description
`writeOffInvoiceInputList`	Apex-defined	Required. A collection of Apex input records that contain details about the invoices to be written off. See InvoiceWriteOff Namespace for the list of input parameters.

Outputs

Output	Type	Description
`writeOffInvoiceResponseList`	Apex-defined	A collection of Apex output records that contain details about the invoices that were written off. See InvoiceWriteOff Namespace for the list of output parameters.

Example

GET

This sample request is for the Write Off Invoices action.

1{
2  "inputs": [
3    {
4      "apexClass": "InvoiceWriteOff__WriteOffInvoiceInputList",
5      "bytelength": 0,
6      "configuration": false,
7      "defaultValue": null,
8      "description": "A collection of Apex WriteOffInvoiceInputList records that contain details about the invoices to be written-off.",
9      "label": "WriteOffInvoiceInputList",
10      "maxOccurs": 1,
11      "name": "writeOffInvoiceInputList",
12      "picklistValues": null,
13      "placeholderText": null,
14      "required": true,
15      "sObjectType": null,
16      "setupReferenceType": null,
17      "toolingType": null,
18      "type": null
19    }
20  ]
21}

This sample response is for the Write Off Invoices action.

1{
2  "outputs": [
3    {
4      "additionalAttributes": null,
5      "apexClass": "InvoiceWriteOff__WriteOffInvoiceResponseList",
6      "description": "A collection Apex WriteOffInvoiceResponseList records that contain details about the invoices that were written off.",
7      "label": "WriteOffInvoiceResponseList",
8      "maxOccurs": 1,
9      "name": "writeOffInvoiceResponseList",
10      "picklistValues": null,
11      "sobjectType": null,
12      "type": null
13    }
14  ]
15}