---
title: "Retrieve ledger lines"
method: GET
path: "/v3/reconciliation/ledgerLines"
tags: ["Reconciliation"]
---

# Retrieve ledger lines

`GET /v3/reconciliation/ledgerLines`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/v3/reconciliation/ledgerLines`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/v3/reconciliation/ledgerLines/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve ledger lines generated for a specific role. Example, retrieve all ledger lines that a reseller manager has against all resellers

## Query parameters

- `context` 'RESELLER_MANAGER', required
- `page` integer
- `size` integer
- `sortOrder` 'ASC' | 'DESC'
- `fromDate` number
- `toDate` number
- `reconciliationType` 'ITEM' | 'TAX' | 'DISCOUNT' | 'TERMINATION_FEE' | 'ADJUSTMENT' | 'RESELLER_MARKUP' | 'CHANNEL_MARKUP' | 'APPDIRECT_FEE'
- `operationType` 'CREDIT' | 'DEBIT'

## Response `200`

OK

- PagedLedgerLineDetailsWS, nullable: Represents a paged collection of LedgerLineDetailsWS
  - `links` Link[]: Resource links
    - `href` string
    - `rel` string
  - `page` PageMetadata
    - `number` number, required: Page number
    - `size` number, required: Size of the page to be returned
    - `totalElements` number, required: Total number of elements
    - `totalPages` number, required: Total number of pages
  - `content` LedgerLineDetailsWS[]
    - `id` number, nullable: Ledger line ID
    - `currency` 'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN': Supported currencies for the system
    - `amount` number, nullable: Ledger line amount. Decimal value
    - `customer` CustomerWS, nullable
      - `id` number, nullable: Customer ID
      - `uuid` string, nullable: Customer UUID
      - `username` string, nullable: Customer username
      - `email` string, nullable: Customer email
    - `issuerParty` PartyWS, nullable
      - `id` string, nullable: Party ID, if one is available for this party type
      - `uuid` string, nullable: Party UUID, if one is available for this party type
      - `type` 'CUSTOMER' | 'RESELLER' | 'CHANNEL' | 'VENDOR' | 'APPDIRECT', nullable: Party type
      - `name` string, nullable: Party name
      - `email` string, nullable: Party email
    - `recipientParty` PartyWS, nullable
      - `id` string, nullable: Party ID, if one is available for this party type
      - `uuid` string, nullable: Party UUID, if one is available for this party type
      - `type` 'CUSTOMER' | 'RESELLER' | 'CHANNEL' | 'VENDOR' | 'APPDIRECT', nullable: Party type
      - `name` string, nullable: Party name
      - `email` string, nullable: Party email
    - `type` 'CREDIT' | 'DEBIT'
    - `transferId` number, nullable: Transfer ID
    - `transferStatus` 'OPEN' | 'PENDING' | 'RECONCILED'
    - `reconciliationType` 'ITEM' | 'TAX' | 'DISCOUNT' | 'TERMINATION_FEE' | 'ADJUSTMENT' | 'RESELLER_MARKUP' | 'CHANNEL_MARKUP' | 'APPDIRECT_FEE'
    - `reconciliationDate` number, nullable: Reconciliation date
    - `createdOn` number, nullable: Ledger line created on date
    - `lastModified` number, nullable: Ledger line last modified
    - `payments` PaymentIdAndTypeWS[]: Payments made against the invoice that generated this ledger line
      - `id` number, nullable: Payment ID
      - `type` 'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS': The supported payment methods
    - `invoiceId` number, nullable: Invoice ID
    - `invoiceLineId` number, nullable: Invoice Line ID
    - `orderId` number, nullable: The purchase order ID related to the invoice that triggered this ledger line
    - `productId` number, nullable: The product ID that was sold and triggered the creation of the ledger line
    - `productName` string, nullable: The product name that was sold and triggered the creation of the ledger line
    - `editionId` number, nullable: Application edition ID
    - `editionName` string, nullable: Application edition name
    - `editionPricingItemId` number, nullable: Edition pricing item ID
    - `lineItemDescription` string, nullable: Item line description
    - `lineItemType` 'ITEM' | 'DISCOUNT' | 'TAX' | 'DELEGATED_INVOICE' | 'TERMINATION_FEE' | 'SUB_ACCOUNT', nullable

## Other responses

- `400`: Bad Request, typically bad query parameters
- `401`: Invalid authentication
- `403`: Invalid authorization

## Changes

- **2026-11-06** `1fc240f06971`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/v3/reconciliation/ledgerLines/get.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)