---
title: "Retrieves a paginated list of customer payments, including allocations to specific invoices. Can filter by invoice or updated date."
method: GET
path: "/api/Payment"
tags: ["Payment"]
---

# Retrieves a paginated list of customer payments, including allocations to specific invoices. Can filter by invoice or updated date.

`GET /api/Payment`

## Query parameters

- `InvoiceTransactionID` integer
- `UpdatedAfter` string, date-time
- `pageSize` integer
- `pageNumber` integer

## Response `200`

Returns a paginated list of customer payments with allocations.

- PaymentList — Paginated collection of customer payments.
  - `TotalCount` integer — Total number of records matching the query across all pages.
  - `PageNumber` integer — The current page number (1-based).
  - `PageSize` integer — The number of records per page.
  - `Payments` Payment[] — The list of payments on this page.
    - `TransactionID` integer — Unique identifier for the payment transaction.
    - `AccountIDFK` integer — The Avaza account this payment belongs to.
    - `TransactionPrefix` string — The prefix used in the payment number.
    - `PaymentNumber` string — The full payment number including prefix.
    - `TransactionReference` string — External reference number (e.g. cheque number or bank reference).
    - `CustomerIDFK` integer — The customer company ID this payment is from.
    - `DateIssued` string, date-time — The date the payment was made.
    - `TransactionStatusCode` string — Current status of the payment.
    - `PaymentProviderCode` string — Code identifying the payment provider/method used.
    - `ExchangeRate` number, double — Exchange rate to the account's base currency.
    - `Balance` number, double — Unallocated balance remaining on the payment.
    - `CurrencyCode` string — ISO 3-character currency code for the payment.
    - `TotalAmount` number, double — Total payment amount.
    - `Notes` string — Additional notes on the payment.
    - `DateCreated` string, date-time — Date and time the record was created.
    - `DateUpdated` string, date-time — Date and time the record was last updated.
    - `PaymentAllocations` PaymentAllocation[] — List of allocations applying this payment against specific invoices.
      - `TransactionAllocationID` integer — Unique identifier for this payment allocation.
      - `InvoiceTransactionIDFK` integer — The invoice Transaction ID this payment is allocated against.
      - `PaymentTransactionIDFK` integer — The payment Transaction ID this allocation belongs to.
      - `AllocationDate` string, date-time — The date this allocation was applied.
      - `AllocationAmount` number, double — The amount allocated from the payment to the invoice.
    - `ViewPaymentURL` string — URL to view this payment in the Avaza web application.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.net/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/versions/1eeadf750514/schema)