Query Payments

GET

vendors/payments

https://provider.api-compliance.acc.co.nz/api/v2/claims/vendors/payments

This API allows for a vendor to check the payment remittance numbers for the specified vendor ID.

The API will return details including:

  • Vendor ID
  • Payment reference
  • Payment date
  • Total payment amount

 

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.

GET

payments/summary/{paymentReference}

https://provider.api-compliance.acc.co.nz/api/v2/claims/vendors/payments/summary/{paymentReference}

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.

GET

payments/details/{paymentReference}

https://provider.api-compliance.acc.co.nz/api/v2/claims/vendors/payments/details/{paymentReference}

This API allows for a vendor to check the payment details for a payment remittance under a specified vendor ID.

A payment remittance may contain multiple invoices.

The API will return information for each invoice line item including:

  • Vendor ID
  • Payment reference
  • Invoice number
  • Invoice date
  • ACC45 number
  • Claim number
  • Client name
  • Service date
  • Service code
  • Provider ID
  • Facility
  • Amount invoiced
  • Amount paid
  • Reason for declined payments

 

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.