Credits API

Credits are added to the system to as desired to credit customer accounts.

Currently the only credits supported (other than payments and credit distributions) are write-offs to resolve invoice payment shortfalls within the tolerance threshold.

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

Fetch CreditsfetchCredits

GET/billing/{tenantLocator}/credits/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	query	`ulid?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:CreditListResponse

Security Group:credits

Permissions:

read,list

CreditListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`CreditResponse[]`

CreditResponse

Required properties

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

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`realizedAt`	`datetime?`
`reversalReason`	`string?`
`reversedAt`	`datetime?`

Fetch Shortfall Credit

Fetch Shortfall CreditfetchShortfallCredit

GET/billing/{tenantLocator}/shortfallCredits/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:ShortfallCreditResponse

Security Group:shortfall-credits

Permission:

read

ShortfallCreditListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ShortfallCreditResponse[]`

ShortfallCreditResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`parentCreditLocator`	`ulid`
`currency`	`string`
`shortfallCreditState`	`Enum draft \| distributed \| reversed`
`amount`	`number`
`creditType`	`Enum creditDistribution \| disbursement \| payment \| subpayment \| shortfallWriteOff \| writeOff`
`createdAt`	`datetime`
`createdBy`	`uuid`
`targets`	`CreditItem[]`

Optional properties

Property	Type	Description
`reversalReason`	`string?`

Fetch Multiple Shortfall Credits

Fetch Multiple Shortfall CreditsfetchMultipleShortfallCredits

GET/billing/{tenantLocator}/shortfallCredits/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`accountLocator`	query	`ulid?`	No
`extended`	query	`boolean?`	No

Response:ShortfallCreditListResponse

Security Group:shortfall-credits

Permissions:

read,list

Fetch Credits For An Invoice

Fetch Credits For An InvoicefetchCreditsForAnInvoice

GET/billing/{tenantLocator}/invoices/{locator}/credits/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`includeReversed`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:CreditListResponse

Security Group:invoices

Permissions:

read,list

Credits API

Fetch Credits

Fetch Shortfall Credit

Fetch Multiple Shortfall Credits

Fetch Credits For An Invoice

On this page