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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	query	locator?	optional
offset	query	int?	optional
count	query	int?	optional

Response:CreditResponse[]

Security Group:credits Permissions:read,list

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:

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

Response:ShortfallCreditResponse

Security Group:shortfall-credits Permission:read

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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
accountLocator	query	locator?	optional

Response:ShortfallCreditResponse[]

Security Group:shortfall-credits Permissions:read,list

Fetch Credits for an Invoice

¶

fetchCreditsForAnInvoice

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

Response:CreditResponse[]

Security Group:invoices Permissions:read,list