Disbursements API
Endpoint Index
Action | Endpoint |
---|---|
Fetch Disbursement | GET /billing/{tenantLocator}/disbursements/{locator} |
Fetch Multiple Disbursements | GET /billing/{tenantLocator}/disbursements/list |
Create a Disbursement | POST /billing/{tenantLocator}/disbursements |
Update a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator} |
Update a Disbursement and Replace Extension Data | PUT /billing/{tenantLocator}/disbursements/{locator} |
Validate a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/validate |
Approve a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/approve |
Execute a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/execute |
Reject a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/reject |
Reset a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/reset |
Reverse a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/reverse |
Discard a Disbursement | PATCH /billing/{tenantLocator}/disbursements/{locator}/discard |
Fetch Disbursements with Number | GET /billing/{tenantLocator}/disbursements/numbers/{disbursementNumber} |
Set Disbursement Number | POST /billing/{tenantLocator}/disbursements/{locator}/number/set |
Fetch
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
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:DisbursementListResponse
Security Group:disbursements  Permissions:read,list
DisbursementListResponse
¶requiredlistCompleted booleanitems DisbursementResponse[]
DisbursementResponse
¶requiredlocator stringcurrency stringdisbursementState Enum draft | validated | approved | executed | reversed | rejected | discardedamount numbertype stringdata map<string,object>createdAt datetimecreatedBy uuidsources CreditItem[]optionalaccountLocator string?externalCashTransactionLocator string?disbursementNumber string?validationResult ValidationResult?
Lifecycle
POST /billing/{tenantLocator}/disbursements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:DisbursementCreateRequest
Response:DisbursementResponse
Security Group:disbursements  Permission:write
DisbursementUpdateReplaceDataRequest
¶requiredamount numbertype stringuseDefaultFinancialInstrument booleandata map<string,object>sources CreditItem[]optionalaccountLocator string?financialInstrumentLocator string?currency string?transactionMethod Enum? ach | cash | eft | standard | wiretransactionNumber string?
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
¶requiredaddSources CreditItem[]removeData map<string,object>removeSources string[]setData map<string,object>optionalaccountLocator string?financialInstrumentLocator string?currency string?amount number?transactionMethod Enum? ach | cash | eft | standard | wiretransactionNumber string?type string?useDefaultFinancialInstrument boolean?
PUT /billing/{tenantLocator}/disbursements/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
DisbursementUpdateReplaceDataRequest
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
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
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
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
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
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
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
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
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