Invoice, Query Invoices and Query Payments
GET
payments/summary/{paymentReference}
Description
This API allows for a vendor to check the payment summary for a payment remittance under a specified vendor ID.
A payment remittance may contain multiple invoices.
The API will return a summary of information for each invoice:
- Vendor ID
- Payment reference
- Invoice number
- Invoice date
- Invoice amount
- Payment amount
- GST payment amount
- Comments
- Payment date
- Bank account number
To learn more about the overall API process check out Get Connected, Learn More and our Release Notes.
Other API Query related solutions you may find of interest can be found in Potential Query API Solutions and Query APIs – Detail that may assist.
Resource Summary |
||
Security |
||
Type |
application/json |
|
URL |
https://provider.api-compliance.acc.co.nz/api/v2/claims/vendors/payments/summary/{paymentReference} | |
Supporting Documentation
Query Parameters
| Name | Values | Description |
|---|---|---|
|
vendorId
(required) |
vendorId |
|
| page |
page |
|
| pageSize |
pageSize |
Request Body
paymentReference paymentReference null true