Invoice, Query Invoices and Query Payments

payments/summary

GET

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 ConnectedLearn 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

Operations

When using the API Key custom token in the Operations portion for any selected API below, set NAME to 'apikey', VALUE to My Apps, Consumer Key value, and select the HEADER option before clicking SET.

Basic HTTP authentication

Set

OAuth 2 authentication

Set

API Key custom token

Set

Working...

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 200

    Ok

  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error