EZezypay

List partner invoices

Changed on

Retrieve a list of partner invoices that occurred between two merchants.

get/partnerinvoices

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/partnerinvoices
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Query parameters

issuerMerchantIdstring required

Auto-generated identifier of the merchant who issued the partner invoice.

recipientMerchantIdstring required

Auto-generated identifier of the merchant who received the partner invoice.

statusstring

Filter by the status of the partner invoice. Supported values are: paid - Payment transaction for invoice completed successfully. past_due - Payment transaction for invoice failed or was unsuccessful.

fromstring date

Start date for range of partner invoices to view. Filter by date defined in the invoice date. Supported format is YYYY-MM-DD.

untilstring date

End date for range of partner invoices to view. Filter by date defined in the invoice date. Supported format is YYYY-MM-DD.

countryCodestring

Filter by two letter ISO 3166-1 alpha-2 country code of the issuing merchant.

partnerSubscriptionIdstring

Auto-generated identifier of the partner subscription associated to the invoice.

limitstring

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorstring

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Response

200

Example response

{
  "data": [
    {
      "id": "a1c3f193-678f-4068-9411-5d0af0a29853",
      "documentNumber": "IN0000000000000001",
      "date": "2019-04-04",
      "dueDate": "2019-04-04",
      "status": "PAID",
      "items": [
        {
          "description": "PNB_IBJL_Equipment_Leasing",
          "amount": {
            "currency": "NZD",
            "value": 20074.25
          },
          "id": "d0c8f41c-4c3e-48f7-a0d6-d5914dfb05a2",
          "type": "partner_subscription",
          "accountingCode": "EquipmentLeasing"
        }
      ],
      "amount": {
        "currency": "NZD",
        "value": 20074.25
      },
      "totalTax": {
        "currency": "NZD"
      },
      "issuerMerchant": {
        "id": "eab7bfc6-113a-4e51-aedd-f6a807420656",
        "name": "pnb_ibjl NameNZ",
        "legalName": "pnb_ibjl LegalNameNZ"
      },
      "recipientMerchant": {
        "id": "c74437ba-e204-46fc-9b16-0062f896e01e",
        "name": "high_st NameNZ",
        "legalName": "high_st LegalNameNZ"
      },
      "createdOn": "2019-03-10T20:23:35.160",
      "countryCode": "NZ",
      "partnerSubscriptionId": "315107b6-e341-45c6-ad47-8d0bce9e0b25"
    }
  ],
  "paging": {
    "totalCount": 1
  }
}

Changes