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.

Endpoint Index

Action	Endpoint
Fetch Credits	GET /billing/{tenantLocator}/credits/list
Fetch Shortfall Credit	GET /billing/{tenantLocator}/shortfallCredits/{locator}
Fetch Multiple Shortfall Credits	GET /billing/{tenantLocator}/shortfallCredits/list

Fetch Credits

fetchCredits

GET /billing/{tenantLocator}/credits/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	query	string?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:CreditListResponse
Security Group:credits   Permissions:read,list

CreditListResponse

required
listCompleted boolean
items CreditResponse[]

CreditResponse

required
locator string
currency string
creditState Enum discarded | draft | posted | reversed | validated | executed | distributed | approved | rejected | requested | executing | failed | cancelled
amount number
creditType Enum creditDistribution | disbursement | payment | shortfallWriteOff | subpayment | writeOff
createdAt datetime

optional
accountLocator string?
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	string	required

Response:ShortfallCreditResponse
Security Group:shortfall-credits   Permission:read

ShortfallCreditListResponse

required
listCompleted boolean
items ShortfallCreditResponse[]

ShortfallCreditResponse

required
locator string
accountLocator string
parentCreditLocator string
currency string
shortfallCreditState Enum draft | distributed | reversed
amount number
creditType Enum creditDistribution | disbursement | payment | shortfallWriteOff | subpayment | 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	string?	optional
extended	query	boolean?	optional

Response:ShortfallCreditListResponse
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	string	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