Credit Distribution API

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

Action	Endpoint
Fetch Credit Distribution	GET/billing/{tenantLocator}/creditDistributions/{locator}
Fetch Credit Distributions For An Invoice	GET/billing/{tenantLocator}/invoices/{locator}/creditDistributions/list
Fetch Multiple Credit Distributions	GET/billing/{tenantLocator}/creditDistributions/list
Create Credit Distribution	POST/billing/{tenantLocator}/creditDistributions
Update Credit Distribution	PATCH/billing/{tenantLocator}/creditDistributions/{locator}
Create Or Replace Credit Distribution	PUT/billing/{tenantLocator}/creditDistributions/{locator}
Validate Credit Distribution	PATCH/billing/{tenantLocator}/creditDistributions/{locator}/validate
Execute Credit Distribution	PATCH/billing/{tenantLocator}/creditDistributions/{locator}/execute
Reverse Credit Distribution	PATCH/billing/{tenantLocator}/creditDistributions/{locator}/reverse
Reset Credit Distribution	PATCH/billing/{tenantLocator}/creditDistributions/{locator}/reset
Discard Credit Distribution	PATCH/billing/{tenantLocator}/creditDistributions/{locator}/discard
Fetch Invoices Targeted By ACredit Distribution	GET/billing/{tenantLocator}/creditDistributions/{locator}/invoices/list

Fetch

Fetch Credit Distribution

Fetch Credit DistributionfetchCreditDistribution

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

Parameters

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

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

read

Fetch Credit Distributions For An Invoice

Fetch Credit Distributions For An InvoicefetchCreditDistributionsForAnInvoice

GET/billing/{tenantLocator}/invoices/{locator}/creditDistributions/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:CreditDistributionListResponse

Security Group:invoices

Permissions:

read,list

Fetch Multiple Credit Distributions

Fetch Multiple Credit DistributionsfetchMultipleCreditDistributions

GET/billing/{tenantLocator}/creditDistributions/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:CreditDistributionListResponse

Security Group:credit-distributions

Permissions:

read,list

CreditDistributionListResponse

Required properties

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

CreditDistributionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`currency`	`string`
`creditDistributionState`	`Enum draft \| validated \| executed \| reversed \| discarded`
`amount`	`number`
`createdAt`	`datetime`
`createdBy`	`uuid`
`shortfallCreditLocators`	`ulid[]`
`sources`	`CreditItem[]`
`targets`	`CreditItem[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`executedAt`	`datetime?`
`reversalReason`	`string?`
`reversedAt`	`datetime?`
`validationResult`	`ValidationResult?`

Creation and Update

Create Credit Distribution

Create Credit DistributioncreateCreditDistribution

POST/billing/{tenantLocator}/creditDistributions

Parameters

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

Request:CreditDistributionCreateRequest

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

CreditDistributionCreateRequest

Required properties

Property	Type	Description
`amount`	`number`
`sources`	`CreditItem[]`
`targets`	`CreditItem[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`currency`	`string?`

Update Credit Distribution

Update Credit DistributionupdateCreditDistribution

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

Parameters

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

Request:CreditDistributionUpdateRequest

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

CreditDistributionUpdateRequest

Required properties

Property	Type	Description
`addSources`	`CreditItem[]`
`addTargets`	`CreditItem[]`
`removeSources`	`ulid[]`
`removeTargets`	`ulid[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`currency`	`string?`
`amount`	`number?`

Create Or Replace Credit Distribution

Create Or Replace Credit DistributioncreateOrReplaceCreditDistribution

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

Parameters

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

Request:CreditDistributionPutRequest

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

CreditDistributionPutRequest

Required properties

Property	Type	Description
`amount`	`number`
`sources`	`CreditItem[]`
`targets`	`CreditItem[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`currency`	`string?`

Execution

Validate Credit Distribution

Validate Credit DistributionvalidateCreditDistribution

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

Parameters

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

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

Execute Credit Distribution

Execute Credit DistributionexecuteCreditDistribution

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

Parameters

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

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

Reversal

Reverse Credit Distribution

Reverse Credit DistributionreverseCreditDistribution

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

Parameters

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

Request:CreditDistributionReverseRequest

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

CreditDistributionReverseRequest

Required properties

Property	Type	Description
`reversalType`	`string`

Reset and Discard

Reset Credit Distribution

Reset Credit DistributionresetCreditDistribution

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

Parameters

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

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

Discard Credit Distribution

Discard Credit DistributiondiscardCreditDistribution

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

Parameters

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

Response:CreditDistributionResponse

Security Group:credit-distributions

Permission:

write

Invoices

Fetch Invoices Targeted By ACredit Distribution

Fetch Invoices Targeted By A Credit DistributionfetchInvoicesTargetedByACreditDistribution

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

Parameters

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

Response:InvoiceListResponse

Security Group:credit-distributions

Permissions:

read,list

Credit Distribution API

On this page