Write-Offs API
GET /billing/{tenantLocator}/writeOffs/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:WriteOffResponse
Security Group:write-offs  Permission:read
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 | locator? | optional |
extended | query | boolean? | optional |
Response:WriteOffListResponse
Security Group:write-offs  Permissions:read,list
WriteOffListResponse
¶requiredlistCompleted booleanitems WriteOffResponse[]
WriteOffResponse
¶requiredlocator locatoraccountLocator locatorcurrency stringwriteOffState Enum draft | distributed | reversedamount numbercreditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | writeOffcreatedAt datetimecreatedBy uuidtargets CreditItem[]optionalreversalReason string?
PATCH /billing/{tenantLocator}/invoices/{locator}/writeOff
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:WriteOffResponse
Security Group:invoices  Permission:write
PATCH /billing/{tenantLocator}/writeOffs/{locator}/reverse
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:WriteOffResponse
Security Group:write-offs  Permission:write