Validate Disbursement
validate_disbursementValidate a disbursement before posting to ensure accuracy of payment details, including amount, payouts, and bank account information.
Instructions
Validates a disbursement before creation. Use this to perform the validate disbursement action on Payments. Creates a new Payments and returns the created object on success (HTTP 201). Required parameters: company_id, amount, payouts, workflowsConfigured, bankAccountId, bankAccountType. Procore API: Construction Financials > Payments. Endpoint: POST /rest/v1.0/companies/{company_id}/payments/disbursements/validate
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| amount | Yes | JSON request body field — dollar amount of the disbursement times 100. Ex: $100.51 = 10051 | |
| payouts | Yes | JSON request body field — list of payouts in the disbursement. Each payout represents a payment to a business for an invoice. | |
| workflowsConfigured | Yes | JSON request body field — whether workflows template is configured or not | |
| name | No | JSON request body field — name of the disbursement | |
| status | No | JSON request body field — status of the disbursement | |
| bankAccountId | Yes | JSON request body field — uUID of the bank account | |
| bankAccountType | Yes | JSON request body field — type of the bank account |