---
title: "partner/invoice-details"
method: GET
path: "/partner/invoice-details"
tags: ["Partner Endpoints"]
---

# partner/invoice-details

`GET /partner/invoice-details`

This endpoint is used to retrieve the invoice-details (number of transactions, rates, etc) for a given billing cycle. If no month/year is provided, the current month/year is used.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `VopayAccountID` string
- `month` string
- `year` string

## Response `200`

- object
  - `Success` boolean, required — True if the request was successful, false if it failed
  - `ErrorMessage` string, required — Contains a description of the error if the request failed
  - `InvoicePeriod` object, required — Invoice Period
    - `FromDate` string, required — Invoice Start Date
    - `ToDate` string, required — Invoice End Date
  - `InvoiceDetails` object, required — Invoice Details for for each account for the invoice period
    - `AccountID` object, required — Invoice details for the Account ID
      - `Currency` object, required — 3 character currency code of the invoice; ex: CAD
        - `Service` object, required — Service being billed; ex: EFTFunding
          - `description` string, required — Description of the service being billed
          - `quantity` integer, required — Number of transactions
          - `rate` number, required — Cost per transaction
          - `amount` number, required — Total cost of service (quantity x rate)

---

[API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/revisions/7033bd231ec7/schema)