Disbursements API
GET /billing/{tenantLocator}/disbursements/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:read
GET /billing/{tenantLocator}/disbursements/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| offset | query | int? | optional |
| count | query | int? | optional |
| accountLocator | query | locator? | optional |
Response:DisbursementResponse[]
Security Group:disbursements  Permissions:read,list
DisbursementResponse
¶requiredlocator locatorcurrency stringdisbursementState Enum draft | validated | approved | executed | reversed | rejected | discardedamount numbertype stringdata map<string,object>createdAt datetimecreatedBy uuidsources CreditItem[]optionalaccountLocator locator?externalCashTransactionLocator locator?disbursementNumber string?validationResult ValidationResult?
POST /billing/{tenantLocator}/disbursementsRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
Request:DisbursementCreateRequest
Response:DisbursementResponse
Security Group:disbursements  Permission:write
DisbursementCreateRequest
¶requiredamount numbertype stringuseDefaultFinancialInstrument booleandata map<string,object>sources CreditItem[]optionalaccountLocator locator?financialInstrumentLocator locator?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 | locator | required |
Request:DisbursementUpdateRequest
Response:DisbursementResponse
Security Group:disbursements  Permission:write
DisbursementUpdateRequest
¶requiredaddSources CreditItem[]removeData map<string,object>removeSources locator[]setData map<string,object>optionalaccountLocator locator?financialInstrumentLocator locator?currency string?amount number?transactionMethod Enum? ach | cash | eft | standard | wiretransactionNumber string?type string?useDefaultFinancialInstrument boolean?
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 | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
DisbursementUpdateReplaceDataRequest
¶requiredamount numbertype stringuseDefaultFinancialInstrument booleandata map<string,object>sources CreditItem[]optionalaccountLocator locator?financialInstrumentLocator locator?currency string?transactionMethod Enum? ach | cash | eft | standard | wiretransactionNumber string?
PATCH /billing/{tenantLocator}/disbursements/{locator}/validateRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
PATCH /billing/{tenantLocator}/disbursements/{locator}/approveRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
PATCH /billing/{tenantLocator}/disbursements/{locator}/executeRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
PATCH /billing/{tenantLocator}/disbursements/{locator}/rejectRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
PATCH /billing/{tenantLocator}/disbursements/{locator}/resetRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
PATCH /billing/{tenantLocator}/disbursements/{locator}/reverseRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write
PATCH /billing/{tenantLocator}/disbursements/{locator}/discardRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write