Write-Offs API

Action	Endpoint
Fetch a Write-Off	GET/billing/{tenantLocator}/writeOffs/{locator}
Fetch Multiple Write-Offs	GET/billing/{tenantLocator}/writeOffs/list
Write-Off an Invoice	PATCH/billing/{tenantLocator}/invoices/{locator}/writeOff
Create Write-Off	POST/billing/{tenantLocator}/writeOffs
Reverse a Write-Off	PATCH/billing/{tenantLocator}/writeOffs/{locator}/reverse

Fetch a Write-Off

Fetch a Write-OfffetchWriteOff

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:WriteOffResponse

Security Group:write-offs

Permission:

read

Fetch Multiple Write-Offs

Fetch Multiple Write-OffsfetchMultipleWriteOffs

GET/billing/{tenantLocator}/writeOffs/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`accountLocator`	query	`ulid?`	No
`extended`	query	`boolean?`	No

Response:WriteOffListResponse

Security Group:write-offs

Permissions:

read,list

WriteOffListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`WriteOffResponse[]`

WriteOffResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`currency`	`string`
`writeOffState`	`Enum draft \| distributed \| reversed`
`amount`	`number`
`creditType`	`Enum writeOff \| shortfallWriteOff`
`createdAt`	`datetime`
`createdBy`	`uuid`
`targets`	`CreditItem[]`

Optional properties

Property	Type	Description
`reversalReason`	`string?`
`reversedAt`	`datetime?`

Write-Off an Invoice

Write-Off an InvoicewriteOffInvoice

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:WriteOffResponse

Security Group:invoices

Permission:

write

Create Write-Off

Create Write-OffwriteOff

POST/billing/{tenantLocator}/writeOffs

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:WriteOffRequest

Response:WriteOffResponse

Security Group:write-offs

Permission:

write

WriteOffRequest

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`targets`	`WriteOffTarget[]`

WriteOffTarget

Required properties

Property	Type	Description
`containerLocator`	`ulid`
`containerType`	`Enum invoice \| account \| subpayment \| invoiceItem`

Optional properties

Property	Type	Description
`amount`	`number?`

Reverse a Write-Off

Reverse a Write-OffreverseWriteOff

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:WriteOffResponse

Security Group:write-offs

Permission:

write

Write-Offs API

Fetch a Write-Off

Fetch Multiple Write-Offs

Write-Off an Invoice

Create Write-Off

Reverse a Write-Off

See Also

On this page