---
title: "Return details of the finance batch for a given batchid."
method: GET
path: "/Ams/{ClientID}/FinanceBatchDetails"
tags: ["Ams"]
---

# Return details of the finance batch for a given batchid.

`GET /Ams/{ClientID}/FinanceBatchDetails`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/{ClientID}/FinanceBatchDetails`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/FinanceBatchDetails/get.ts> (a function with typed inputs; its response is checked against the schema)

Return details of the finance batch for a given batchid.

## Path parameters

- `ClientID` integer, required

## Query parameters

- `BatchId` string
- `PageSize` integer
- `PageNumber` integer
- `OffSet` integer
- `UsingRedis` boolean
- `AppInitTime` string, date-time
- `ServerID` string
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- FinanceBatchDetailsResponse: FinanceBatchDetailsResponse
  - `FinanceBatchDetailsList` FinanceBatchDetailData[]
    - `InvoiceNo` integer
    - `InvoiceType` string
    - `NameOnInvoiceLast` string
    - `NameOnInvoiceFirst` string
    - `NameOnInvoiceMiddle` string
    - `NameOnInvoiceSuffix` string
    - `OriginalInvoicePaymentOption` string
    - `PaymentTerms` string
    - `Organization` string
    - `Address1` string
    - `Address2` string
    - `City` string
    - `State` string
    - `Province` string
    - `PostalCode` string
    - `Country` string
    - `EmailAddress` string
    - `Phone` string
    - `OutstandingBalance` number, double
    - `OriginalInvoiceBillingAddress1` string
    - `OriginalInvoiceBillingAddress2` string
    - `OriginalInvoiceBillingCity` string
    - `OriginalInvoiceBillingState` string
    - `OriginalInvoiceBillingProvince` string
    - `OriginalInvoiceBillingPostalCode` string
    - `OriginalInvoiceBillingCountry` string
    - `OriginalInvoiceBillingPhone` string
    - `OriginalInvoiceNameOnCard` string
    - `OriginalInvoiceCardNumber` string
    - `OriginalInvoiceCardType` string
    - `OriginalInvoiceCardExpMonth` string
    - `OriginalInvoiceCardExpYear` string
    - `OriginalInvoiceComments` string
    - `OriginalInvoiceInternalNotes` string
    - `DateInvoiceLastSent` string, date-time
    - `LineItemID` integer
    - `LineItemRelatedTo` integer
    - `LineItemType` string
    - `LineItemDescription` string
    - `GLCodeItemName` string
    - `QBClassItemName` string
    - `LineItemDate` string, date-time
    - `LineItemAmount` number, double
    - `LineItemQuantity` integer
    - `LineTotal` number, double
    - `LineItemTaxVATRate` number, double
    - `LineItemNotesVisible` string
    - `LineItemNotesInternal` string
    - `PaymentOption` string
    - `PaymentCheckReferenceNumber` string
    - `PaymentBillingAddress1` string
    - `PaymentBillingAddress2` string
    - `PaymentBillingCity` string
    - `PaymentBillingState` string
    - `PaymentBillingProvince` string
    - `PaymentBillingPostalCode` string
    - `PaymentBillingCountry` string
    - `PaymentBillingPhone` string
    - `PaymentNameOnCard` string
    - `PaymentEmailAddress` string
    - `PaymentCardNumber` string
    - `PaymentCardType` string
    - `PaymentCardExpMonth` string
    - `PaymentCardExpYear` string
    - `EnteredBy` string
    - `Account` string
    - `OriginalInvoiceBillingOrganization` string
    - `PaymentBillingOrganization` string
    - `PO` string
    - `WebSiteMemberID` integer
    - `ConstituentID` string
    - `PaymentProcessorAccountID` integer
    - `PaymentProcessor` string
    - `PaymentProcessorAccountNickname` string
    - `LineItemDateEntered` string, date-time
  - `BatchId` string
  - `PageSize` integer
  - `PageNumber` integer
  - `OffSet` integer
  - `UsingRedis` boolean
  - `AppInitTime` string, date-time
  - `ServerID` string
  - `ClientID` integer
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)