Disbursements API
Fetch
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/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
accountLocator | query | locator? | optional |
extended | query | boolean? | optional |
Response:PaymentListResponse
Security Group:disbursements  Permissions:read,list
DisbursementListResponse
¶requiredlistCompleted booleanitems DisbursementResponse[]
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?
Lifecycle
POST /billing/{tenantLocator}/disbursements
Request 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}/validate
Request 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}/approve
Request 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}/execute
Request 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}/reject
Request 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}/reset
Request 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}/reverse
Request 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}/discard
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | 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 | locator | required |
disbursementNumber | query | string | required |
Response:DisbursementResponse
Security Group:disbursements  Permission:write