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.

Fetch Credits
fetchCredits
GET /billing/{tenantLocator}/credits/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorquerylocator?optional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:credits   Permissions:read,list
CreditListResponse
required
listCompleted boolean
CreditResponse
required
locator locator
currency string
creditState string
amount number
creditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | writeOff
createdAt datetime

optional
accountLocator locator?
realizedAt datetime?
reversalReason string?
reversedAt datetime?
Fetch Shortfall Credit
fetchShortfallCredit
GET /billing/{tenantLocator}/shortfallCredits/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:shortfall-credits   Permission:read
ShortfallCreditListResponse
required
listCompleted boolean
ShortfallCreditResponse
required
locator locator
accountLocator locator
parentCreditLocator locator
currency string
shortfallCreditState Enum draft | distributed | reversed
amount number
creditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | writeOff
createdAt datetime
createdBy uuid
targets CreditItem[]

optional
reversalReason string?
Fetch Multiple Shortfall Credits
fetchMultipleShortfallCredits
GET /billing/{tenantLocator}/shortfallCredits/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    accountLocatorquerylocator?optional
    extendedqueryboolean?optional
    Security Group:shortfall-credits   Permissions:read,list
Fetch Credits for an Invoice
fetchCreditsForAnInvoice
GET /billing/{tenantLocator}/invoices/{locator}/credits/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    includeReversedqueryboolean?optional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:invoices   Permissions:read,list