GET Ledgers4?apikey={apikey}&NDC_Case_ID={NDC_Case_ID}

Gets the ledgers for a specific Case. ** 08/23/2016 - Added additional elements to response of Cases4, Claim4 **

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

The apikey used for authentication. Required.

string

Required

NDC_Case_ID

The ID of the Case to filter on. Required.

string

Required

Response Information

Response Schema Document

Resource Description

A collection of the Ledgers found

Collection of Ledger4
NameDescriptionTypeAdditional information
NDC_Case_ID

string

None.

NDC_Claim_ID

string

None.

Date

date

None.

ClaimNumber

string

None.

NameOfParty

string

None.

CheckNum

string

None.

Description

string

None.

Amount

decimal number

None.

ClaimTypeCode

string

None.

ClaimDescription

string

None.

ClassTypeCode

string

None.

ClassDescription

string

None.

TransactionType

string

None.

NDC_Creditor_ID

string

None.

MortgageDescription

string

None.

MortgagePayment_DT

string

None.

ACH_Flag

string

None.

Response Formats

application/xml, text/xml

Sample:
<ArrayOfLedger4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <Ledger4>
    <ACH_Flag>sample string 17</ACH_Flag>
    <Amount>8</Amount>
    <CheckNum>sample string 6</CheckNum>
    <ClaimDescription>sample string 10</ClaimDescription>
    <ClaimNumber>sample string 4</ClaimNumber>
    <ClaimTypeCode>sample string 9</ClaimTypeCode>
    <ClassDescription>sample string 12</ClassDescription>
    <ClassTypeCode>sample string 11</ClassTypeCode>
    <Date>2024-09-12T16:02:28.730431-05:00</Date>
    <Description>sample string 7</Description>
    <MortgageDescription>sample string 15</MortgageDescription>
    <MortgagePayment_DT>sample string 16</MortgagePayment_DT>
    <NDC_Case_ID>sample string 1</NDC_Case_ID>
    <NDC_Claim_ID>sample string 2</NDC_Claim_ID>
    <NDC_Creditor_ID>sample string 14</NDC_Creditor_ID>
    <NameOfParty>sample string 5</NameOfParty>
    <TransactionType>sample string 13</TransactionType>
  </Ledger4>
  <Ledger4>
    <ACH_Flag>sample string 17</ACH_Flag>
    <Amount>8</Amount>
    <CheckNum>sample string 6</CheckNum>
    <ClaimDescription>sample string 10</ClaimDescription>
    <ClaimNumber>sample string 4</ClaimNumber>
    <ClaimTypeCode>sample string 9</ClaimTypeCode>
    <ClassDescription>sample string 12</ClassDescription>
    <ClassTypeCode>sample string 11</ClassTypeCode>
    <Date>2024-09-12T16:02:28.730431-05:00</Date>
    <Description>sample string 7</Description>
    <MortgageDescription>sample string 15</MortgageDescription>
    <MortgagePayment_DT>sample string 16</MortgagePayment_DT>
    <NDC_Case_ID>sample string 1</NDC_Case_ID>
    <NDC_Claim_ID>sample string 2</NDC_Claim_ID>
    <NDC_Creditor_ID>sample string 14</NDC_Creditor_ID>
    <NameOfParty>sample string 5</NameOfParty>
    <TransactionType>sample string 13</TransactionType>
  </Ledger4>
</ArrayOfLedger4>

application/json, text/json

Sample:
[
  {
    "NDC_Case_ID": "sample string 1",
    "NDC_Claim_ID": "sample string 2",
    "Date": "2024-09-12T16:02:28.730431-05:00",
    "ClaimNumber": "sample string 4",
    "NameOfParty": "sample string 5",
    "CheckNum": "sample string 6",
    "Description": "sample string 7",
    "Amount": 8.0,
    "ClaimTypeCode": "sample string 9",
    "ClaimDescription": "sample string 10",
    "ClassTypeCode": "sample string 11",
    "ClassDescription": "sample string 12",
    "TransactionType": "sample string 13",
    "NDC_Creditor_ID": "sample string 14",
    "MortgageDescription": "sample string 15",
    "MortgagePayment_DT": "sample string 16",
    "ACH_Flag": "sample string 17"
  },
  {
    "NDC_Case_ID": "sample string 1",
    "NDC_Claim_ID": "sample string 2",
    "Date": "2024-09-12T16:02:28.730431-05:00",
    "ClaimNumber": "sample string 4",
    "NameOfParty": "sample string 5",
    "CheckNum": "sample string 6",
    "Description": "sample string 7",
    "Amount": 8.0,
    "ClaimTypeCode": "sample string 9",
    "ClaimDescription": "sample string 10",
    "ClassTypeCode": "sample string 11",
    "ClassDescription": "sample string 12",
    "TransactionType": "sample string 13",
    "NDC_Creditor_ID": "sample string 14",
    "MortgageDescription": "sample string 15",
    "MortgagePayment_DT": "sample string 16",
    "ACH_Flag": "sample string 17"
  }
]