Credits API
Credits are added to the system to as desired to credit customer accounts.
Note
Currently the only credits supported (other than payments and credit distributions) are write-offs to resolve invoice payment shortfalls within the tolerance threshold.
GET /billing/{tenantLocator}/credits/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
accountLocator | query | locator? | optional |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:CreditListResponse
Security Group:credits  Permissions:read,list
CreditListResponse
¶requiredlistCompleted booleanitems CreditResponse[]
CreditResponse
¶requiredlocator locatorcurrency stringcreditState stringamount numbercreditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | writeOffcreatedAt datetimeoptionalaccountLocator locator?realizedAt datetime?reversalReason string?reversedAt datetime?
GET /billing/{tenantLocator}/shortfallCredits/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:ShortfallCreditResponse
Security Group:shortfall-credits  Permission:read
ShortfallCreditListResponse
¶requiredlistCompleted booleanitems ShortfallCreditResponse[]
ShortfallCreditResponse
¶requiredlocator locatoraccountLocator locatorparentCreditLocator locatorcurrency stringshortfallCreditState Enum draft | distributed | reversedamount numbercreditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | writeOffcreatedAt datetimecreatedBy uuidtargets CreditItem[]optionalreversalReason string?
GET /billing/{tenantLocator}/shortfallCredits/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:ShortfallCreditListResponse
Security Group:shortfall-credits  Permissions:read,list
GET /billing/{tenantLocator}/invoices/{locator}/credits/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
includeReversed | query | boolean? | optional |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:CreditListResponse
Security Group:invoices  Permissions:read,list