Disbursements API

Fetch

Fetch Disbursement

fetchDisbursement

GET /billing/{tenantLocator}/disbursements/{locator}

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:read

Fetch Multiple Disbursements

fetchMultipleDisbursements

GET /billing/{tenantLocator}/disbursements/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:PaymentListResponse
Security Group:disbursements   Permissions:read,list

DisbursementListResponse

required
listCompleted boolean
items DisbursementResponse[]

DisbursementResponse

required
locator string
currency string
disbursementState Enum draft | validated | approved | executed | reversed | rejected | discarded
amount number
type string
data map<string,object>
createdAt datetime
createdBy uuid
sources CreditItem[]

optional
accountLocator string?
externalCashTransactionLocator string?
disbursementNumber string?
validationResult ValidationResult?

Lifecycle

Create a Disbursement

createDisbursement

POST /billing/{tenantLocator}/disbursements

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:DisbursementCreateRequest
Response:DisbursementResponse
Security Group:disbursements   Permission:write

DisbursementCreateRequest

required
amount number
type string
useDefaultFinancialInstrument boolean
data map<string,object>
sources CreditItem[]

optional
accountLocator string?
financialInstrumentLocator string?
currency string?
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?

Update a Disbursement

updateDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}

Request Parameters:

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

Request:DisbursementUpdateRequest
Response:DisbursementResponse
Security Group:disbursements   Permission:write

DisbursementUpdateRequest

required
addSources CreditItem[]
removeData map<string,object>
removeSources string[]
setData map<string,object>

optional
accountLocator string?
financialInstrumentLocator string?
currency string?
amount number?
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?
type string?
useDefaultFinancialInstrument boolean?

Update a Disbursement and Replace Extension Data

updateDisbursementReplaceData

Updates the disbursement and replaces all existing data extensions with the data.

PUT /billing/{tenantLocator}/disbursements/{locator}

Request Parameters:

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

Request:DisbursementUpdateReplaceDataRequest
Response:DisbursementResponse
Security Group:disbursements   Permission:write

DisbursementUpdateReplaceDataRequest

required
amount number
type string
useDefaultFinancialInstrument boolean
data map<string,object>
sources CreditItem[]

optional
accountLocator string?
financialInstrumentLocator string?
currency string?
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?

Validate a Disbursement

validateDisbursement

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

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Approve a Disbursement

approveDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/approve

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Execute a Disbursement

executeDisbursement

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

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Reject a Disbursement

rejectDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/reject

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Reset a Disbursement

resetDisbursement

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

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Reverse a Disbursement

reverseDisbursement

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

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Discard a Disbursement

discardDisbursement

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

Request Parameters:

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

Response:DisbursementResponse
Security Group:disbursements   Permission:write

Numbering

Fetch Disbursements with Number

fetchDisbursementsWithNumber

GET /billing/{tenantLocator}/disbursements/numbers/{disbursementNumber}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
disbursementNumber	path	string	required

Response:DisbursementResponse[]
Security Group:disbursements   Permissions:read,list

Set Disbursement Number

setDisbursementNumber

POST /billing/{tenantLocator}/disbursements/{locator}/number/set

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
disbursementNumber	query	string	required

Response:DisbursementResponse
Security Group:disbursements   Permission:write

See Also

• Disbursements Feature Guide