Bulk Payments (aka Batch Payments)
| Name | Type | Path |
|---|---|---|
| GetBatchPayments | GET | /api/BatchPayment |
| Get batch payments with a search filter | ||
| GetBatchPayment | GET | /api/BatchPayment/{idOrCode} |
| Get a batch payment by id or by document number. | ||
| CreateBatchPayment | POST | /BatchPayment/{idOrCode}/allocations |
| Add allocations to the batch payment | ||
| AddBatchPaymentAllocations | POST | /api/BatchPayment/{idOrCode}/allocations |
| Add allocations to the batch payment | ||
| UpdateBatchPayment | PATCH | /api/BatchPayment/{batchPaymentId} |
| Update a batch payment | ||
| ReplaceBatchPaymentAllocations | PUT | /api/BatchPayment/{idOrCode}/allocations |
| Replaces all allocations in the batch payment | ||
| DeleteBatchPaymentAllocation | DELETE | /api/BatchPayment/{idOrCode}/allocations/{allocationId} |
| Delete an allocation in the batch payment |
Further Bulk payment information:
- Creating
- Updating
- Abandoning
- Submitting
- Amending
- Processing
- Posting
- Unposting
- Adding allocations
- Updating all allocations
- Removing allocations
POST /api/batchpayment
{
"bankAccountId": "MITGBP",
"description": "API 3",
"allocations": [
{
"docId": "PIN1",
"allocAmountCurrency": 100
},
{
"DocId": "PIN2",
"AllocAmountCurrency": 200
}
]
}
This creates a new Bulk Payment for the specified bank account, allocating the specified invoices and amounts for payment.
Reference: POST /api/BatchPayment
Updated September 2025