Credit Distribution API

Credit Distributions are used to apply customer credits from a Credit Balance to invoices or for disbursements.

Fetch

Fetch Credit Distribution

fetchCreditDistribution

GET /billing/{tenantLocator}/creditDistributions/{locator}

Request Parameters:

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

Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:read

Fetch Credit Distributions for an Invoice

fetchCreditDistributionsForAnInvoice

GET /billing/{tenantLocator}/invoices/{locator}/creditDistributions/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:CreditDistributionResponse[]
Security Group:invoices   Permissions:read,list

Fetch Multiple Credit Distributions

fetchMultipleCreditDistributions

GET /billing/{tenantLocator}/creditDistributions/list

Request Parameters:

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

Response:CreditDistributionResponse[]
Security Group:credit-distributions   Permissions:read,list

CreditDistributionResponse

required
locator locator
currency string
creditDistributionState Enum draft | validated | executed | reversed | discarded
amount number
createdAt datetime
createdBy uuid
shortfallCreditLocators locator[]
sources CreditItem[]
targets CreditItem[]

optional
accountLocator locator?
executedAt datetime?
reversalReason string?
reversedAt datetime?
validationResult ValidationResult?

Creation and Update

Create Credit Distribution

createCreditDistribution

POST /billing/{tenantLocator}/creditDistributions

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:CreditDistributionCreateRequest
Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

CreditDistributionCreateRequest

required
amount number
sources CreditItem[]
targets CreditItem[]

optional
accountLocator locator?
currency string?

Update Credit Distribution

updateCreditDistribution

PATCH /billing/{tenantLocator}/creditDistributions/{locator}

Request Parameters:

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

Request:CreditDistributionUpdateRequest
Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

CreditDistributionUpdateRequest

required
addSources CreditItem[]
addTargets CreditItem[]
removeSources locator[]
removeTargets locator[]

optional
accountLocator locator?
currency string?
amount number?

Create Or Replace Credit Distribution

createOrReplaceCreditDistribution

PUT /billing/{tenantLocator}/creditDistributions/{locator}

Request Parameters:

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

Request:CreditDistributionPutRequest
Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

CreditDistributionPutRequest

required
amount number
sources CreditItem[]
targets CreditItem[]

optional
accountLocator locator?
currency string?

Execution

Validate Credit Distribution

validateCreditDistribution

PATCH /billing/{tenantLocator}/creditDistributions/{locator}/validate

Request Parameters:

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

Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

Execute Credit Distribution

executeCreditDistribution

PATCH /billing/{tenantLocator}/creditDistributions/{locator}/execute

Request Parameters:

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

Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

Reversal

Reverse Credit Distribution

reverseCreditDistribution

PATCH /billing/{tenantLocator}/creditDistributions/{locator}/reverse

Request Parameters:

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

Request:CreditDistributionReverseRequest
Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

CreditDistributionReverseRequest

required
reversalType string

Reset and Discard

Reset Credit Distribution

resetCreditDistribution

PATCH /billing/{tenantLocator}/creditDistributions/{locator}/reset

Request Parameters:

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

Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

Discard Credit Distribution

discardCreditDistribution

PATCH /billing/{tenantLocator}/creditDistributions/{locator}/discard

Request Parameters:

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

Response:CreditDistributionResponse
Security Group:credit-distributions   Permission:write

Invoices

Fetch Invoices Targeted By a Credit Distribution

fetchInvoicesTargetedByACreditDistribution

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

Request Parameters:

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

Response:InvoiceResponse[]
Security Group:credit-distributions   Permissions:read,list