VOvopay
Partner Endpoints

partner/invoices

Changed on

This endpoint is used to retrieve the list of invoices issued to your partner account. Results can be narrowed by invoice period, currency and a free-text search.

get/partner/invoices

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/invoices
  • Auth
    none declared

Query parameters

AccountIDstring required

Your partner account ID

Keystring required

API key for the partner account

Signaturestring required

Hashed signature for the request

FromDatestring

Only return invoices whose period starts on or after this date (yyyy-mm-dd)

ToDatestring

Only return invoices whose period ends on or before this date (yyyy-mm-dd)

Currencystring

Only return invoices in this currency (3 character code; ex: CAD, USD)

SearchTextstring

Only return invoices whose InvoiceNumber, InvoiceDate or Total contains this text

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "PartnerInvoices": {
    "0": {
      "InvoiceID": "1234",
      "InvoiceNumber": "VP-000123",
      "InvoiceType": "recurring",
      "InvoiceDate": "2021-10-31",
      "DueDate": "2021-11-15",
      "PaymentStatus": "pending",
      "FromDate": "2021-10-01",
      "ToDate": "2021-10-31",
      "TaxType": "GST",
      "TaxRate": "5.00",
      "TaxTotal": "61.73",
      "Subtotal": "1234.56",
      "Total": "1296.29",
      "CurrencyShortForm": "CAD"
    }
  }
}

Changes