GET Ledgers2?apikey={apikey}&NDC_Claim_ID={NDC_Claim_ID}

Gets the Ledgers for a specific Claim.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

The apikey used for authentication. Required.

string

Required

NDC_Claim_ID

The ID of the Claim to filter on.

string

Required

Response Information

Response Schema Document

Resource Description

A collection of the Ledgers found

Collection of Ledger2
NameDescriptionTypeAdditional information
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.

Response Formats

application/xml, text/xml

Sample:
<ArrayOfLedger2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <Ledger2>
    <Amount>7</Amount>
    <CheckNum>sample string 5</CheckNum>
    <ClaimDescription>sample string 9</ClaimDescription>
    <ClaimNumber>sample string 3</ClaimNumber>
    <ClaimTypeCode>sample string 8</ClaimTypeCode>
    <ClassDescription>sample string 11</ClassDescription>
    <ClassTypeCode>sample string 10</ClassTypeCode>
    <Date>2024-09-11T16:56:07.080977-05:00</Date>
    <Description>sample string 6</Description>
    <NDC_Claim_ID>sample string 1</NDC_Claim_ID>
    <NameOfParty>sample string 4</NameOfParty>
    <TransactionType>sample string 12</TransactionType>
  </Ledger2>
  <Ledger2>
    <Amount>7</Amount>
    <CheckNum>sample string 5</CheckNum>
    <ClaimDescription>sample string 9</ClaimDescription>
    <ClaimNumber>sample string 3</ClaimNumber>
    <ClaimTypeCode>sample string 8</ClaimTypeCode>
    <ClassDescription>sample string 11</ClassDescription>
    <ClassTypeCode>sample string 10</ClassTypeCode>
    <Date>2024-09-11T16:56:07.080977-05:00</Date>
    <Description>sample string 6</Description>
    <NDC_Claim_ID>sample string 1</NDC_Claim_ID>
    <NameOfParty>sample string 4</NameOfParty>
    <TransactionType>sample string 12</TransactionType>
  </Ledger2>
</ArrayOfLedger2>

application/json, text/json

Sample:
[
  {
    "NDC_Claim_ID": "sample string 1",
    "Date": "2024-09-11T16:56:07.080977-05:00",
    "ClaimNumber": "sample string 3",
    "NameOfParty": "sample string 4",
    "CheckNum": "sample string 5",
    "Description": "sample string 6",
    "Amount": 7.0,
    "ClaimTypeCode": "sample string 8",
    "ClaimDescription": "sample string 9",
    "ClassTypeCode": "sample string 10",
    "ClassDescription": "sample string 11",
    "TransactionType": "sample string 12"
  },
  {
    "NDC_Claim_ID": "sample string 1",
    "Date": "2024-09-11T16:56:07.080977-05:00",
    "ClaimNumber": "sample string 3",
    "NameOfParty": "sample string 4",
    "CheckNum": "sample string 5",
    "Description": "sample string 6",
    "Amount": 7.0,
    "ClaimTypeCode": "sample string 8",
    "ClaimDescription": "sample string 9",
    "ClassTypeCode": "sample string 10",
    "ClassDescription": "sample string 11",
    "TransactionType": "sample string 12"
  }
]