Write-Offs API

Endpoint Index

Action	Endpoint
Fetch a Write-Off	GET /billing/{tenantLocator}/writeOffs/{locator}
Fetch Multiple Write-Offs	GET /billing/{tenantLocator}/writeOffs/list
Reverse a Write-Off	PATCH /billing/{tenantLocator}/writeOffs/{locator}/reverse

Fetch a Write-Off

fetchWriteOff

GET /billing/{tenantLocator}/writeOffs/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:WriteOffResponse
Security Group:write-offs   Permission:read

Fetch Multiple Write-Offs

fetchMultipleWriteOffs

GET /billing/{tenantLocator}/writeOffs/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
accountLocator	query	string?	optional
extended	query	boolean?	optional

Response:WriteOffListResponse
Security Group:write-offs   Permissions:read,list

WriteOffListResponse

required
listCompleted boolean
items WriteOffResponse[]

WriteOffResponse

required
locator string
accountLocator string
currency string
writeOffState Enum draft | distributed | reversed
amount number
creditType Enum writeOff | shortfallWriteOff
createdAt datetime
createdBy uuid
targets CreditItem[]

optional
reversalReason string?
reversedAt datetime?

Write-Off an Invoice

writeOffInvoice

PATCH /billing/{tenantLocator}/invoices/{locator}/writeOff

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:WriteOffResponse
Security Group:invoices   Permission:write

Create Write-Off

writeOff

POST /billing/{tenantLocator}/writeOffs

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:WriteOffRequest
Response:WriteOffResponse
Security Group:write-offs   Permission:write

WriteOffRequest

required
accountLocator string
targets WriteOffTarget[]

WriteOffTarget

required
containerLocator string
containerType Enum account | invoice | invoiceItem | subpayment

optional
amount number?

Reverse a Write-Off

reverseWriteOff

PATCH /billing/{tenantLocator}/writeOffs/{locator}/reverse

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:WriteOffResponse
Security Group:write-offs   Permission:write

See Also

• Write-Offs Feature Guide