POST api/batches/charge-credit-inquiry

Returns charge and credit batches

Request Information

URI Parameters

None.

Body Parameters

ChargeCreditBatchInquiryRequestViewModel

Name	Type	Additional information
BatchIdFrom	integer	None.
BatchIdTo	integer	None.
BatchTotalFrom	decimal number	None.
BatchTotalTo	decimal number	None.
JournalEntryIdFrom	integer	None.
JournalEntryIdTo	integer	None.
BatchDateFrom	date	None.
BatchDateTo	date	None.
EntityIds	Collection of integer	None.
ManagementCompanyIds	Collection of integer	None.
BatchTypeIds	Collection of integer	None.
BatchStatusIds	Collection of integer	None.
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Request Formats

application/json, text/json

Sample:

{
  "batchIdFrom": 1,
  "batchIdTo": 1,
  "batchTotalFrom": 1.0,
  "batchTotalTo": 1.0,
  "journalEntryIdFrom": 1,
  "journalEntryIdTo": 1,
  "batchDateFrom": "2025-04-03T17:56:24.864432-04:00",
  "batchDateTo": "2025-04-03T17:56:24.864432-04:00",
  "entityIds": [
    1,
    2
  ],
  "managementCompanyIds": [
    1,
    2
  ],
  "batchTypeIds": [
    1,
    2
  ],
  "batchStatusIds": [
    1,
    2
  ],
  "pageSize": 1,
  "pageNumber": 2,
  "sortInformation": {
    "sortBy": "sample string 1",
    "isSortAscending": true
  }
}

application/xml, text/xml

Sample:

<ChargeCreditBatchInquiryRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <PageNumber>2</PageNumber>
  <PageSize>1</PageSize>
  <SortInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.SortInformation">
    <d2p1:IsSortAscending>true</d2p1:IsSortAscending>
    <d2p1:SortBy>sample string 1</d2p1:SortBy>
  </SortInformation>
  <BatchDateFrom>2025-04-03T17:56:24.864432-04:00</BatchDateFrom>
  <BatchDateTo>2025-04-03T17:56:24.864432-04:00</BatchDateTo>
  <BatchIdFrom>1</BatchIdFrom>
  <BatchIdTo>1</BatchIdTo>
  <BatchStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BatchStatusIds>
  <BatchTotalFrom>1</BatchTotalFrom>
  <BatchTotalTo>1</BatchTotalTo>
  <BatchTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BatchTypeIds>
  <EntityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityIds>
  <JournalEntryIdFrom>1</JournalEntryIdFrom>
  <JournalEntryIdTo>1</JournalEntryIdTo>
  <ManagementCompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ManagementCompanyIds>
</ChargeCreditBatchInquiryRequestViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ChargeCreditBatchInquiryRequestViewModel'.

Response Information

Resource Description

BaseSearchResultModel of ChargeCreditBatchInquiryViewModel

BaseSearchResultViewModelOfChargeCreditBatchInquiryViewModel

Name	Description	Type	Additional information
Items		Collection of ChargeCreditBatchInquiryViewModel	None.
TotalCount		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "batchId": 1,
      "batchStatus": "sample string 2",
      "subBatchType": "sample string 3",
      "batchDescription": "sample string 4",
      "batchDate": "2025-04-03T17:56:24.864432-04:00",
      "entity": "sample string 6",
      "managementCompany": "sample string 7",
      "userName": "sample string 8",
      "journalEntryId": 1,
      "total": 9.0,
      "details": [
        {
          "accountNumber": "sample string 1",
          "residentName": "sample string 2",
          "residentStatus": "sample string 3",
          "createdDate": "2025-04-03T17:56:24.864432-04:00",
          "chargeCode": "sample string 5",
          "adjustedCode": "sample string 6",
          "amount": 7.0,
          "creditId": 8
        },
        {
          "accountNumber": "sample string 1",
          "residentName": "sample string 2",
          "residentStatus": "sample string 3",
          "createdDate": "2025-04-03T17:56:24.864432-04:00",
          "chargeCode": "sample string 5",
          "adjustedCode": "sample string 6",
          "amount": 7.0,
          "creditId": 8
        }
      ],
      "summary": [
        {
          "chargeCode": "sample string 1",
          "glAccount": "sample string 2",
          "glSubAccount": "sample string 3",
          "amount": 4.0
        },
        {
          "chargeCode": "sample string 1",
          "glAccount": "sample string 2",
          "glSubAccount": "sample string 3",
          "amount": 4.0
        }
      ]
    },
    {
      "batchId": 1,
      "batchStatus": "sample string 2",
      "subBatchType": "sample string 3",
      "batchDescription": "sample string 4",
      "batchDate": "2025-04-03T17:56:24.864432-04:00",
      "entity": "sample string 6",
      "managementCompany": "sample string 7",
      "userName": "sample string 8",
      "journalEntryId": 1,
      "total": 9.0,
      "details": [
        {
          "accountNumber": "sample string 1",
          "residentName": "sample string 2",
          "residentStatus": "sample string 3",
          "createdDate": "2025-04-03T17:56:24.864432-04:00",
          "chargeCode": "sample string 5",
          "adjustedCode": "sample string 6",
          "amount": 7.0,
          "creditId": 8
        },
        {
          "accountNumber": "sample string 1",
          "residentName": "sample string 2",
          "residentStatus": "sample string 3",
          "createdDate": "2025-04-03T17:56:24.864432-04:00",
          "chargeCode": "sample string 5",
          "adjustedCode": "sample string 6",
          "amount": 7.0,
          "creditId": 8
        }
      ],
      "summary": [
        {
          "chargeCode": "sample string 1",
          "glAccount": "sample string 2",
          "glSubAccount": "sample string 3",
          "amount": 4.0
        },
        {
          "chargeCode": "sample string 1",
          "glAccount": "sample string 2",
          "glSubAccount": "sample string 3",
          "amount": 4.0
        }
      ]
    }
  ],
  "totalCount": 1
}

application/xml, text/xml

Sample:

<BaseSearchResultViewModelOfChargeCreditBatchInquiryViewModelDmR41roR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Items>
    <ChargeCreditBatchInquiryViewModel>
      <BatchDate>2025-04-03T17:56:24.864432-04:00</BatchDate>
      <BatchDescription>sample string 4</BatchDescription>
      <BatchId>1</BatchId>
      <BatchStatus>sample string 2</BatchStatus>
      <Details>
        <ChargeCreditBatchDetailViewModel>
          <AccountNumber>sample string 1</AccountNumber>
          <AdjustedCode>sample string 6</AdjustedCode>
          <Amount>7</Amount>
          <ChargeCode>sample string 5</ChargeCode>
          <CreatedDate>2025-04-03T17:56:24.864432-04:00</CreatedDate>
          <CreditId>8</CreditId>
          <ResidentName>sample string 2</ResidentName>
          <ResidentStatus>sample string 3</ResidentStatus>
        </ChargeCreditBatchDetailViewModel>
        <ChargeCreditBatchDetailViewModel>
          <AccountNumber>sample string 1</AccountNumber>
          <AdjustedCode>sample string 6</AdjustedCode>
          <Amount>7</Amount>
          <ChargeCode>sample string 5</ChargeCode>
          <CreatedDate>2025-04-03T17:56:24.864432-04:00</CreatedDate>
          <CreditId>8</CreditId>
          <ResidentName>sample string 2</ResidentName>
          <ResidentStatus>sample string 3</ResidentStatus>
        </ChargeCreditBatchDetailViewModel>
      </Details>
      <Entity>sample string 6</Entity>
      <JournalEntryId>1</JournalEntryId>
      <ManagementCompany>sample string 7</ManagementCompany>
      <SubBatchType>sample string 3</SubBatchType>
      <Summary>
        <ChargeCreditBatchSummaryViewModel>
          <Amount>4</Amount>
          <ChargeCode>sample string 1</ChargeCode>
          <GLAccount>sample string 2</GLAccount>
          <GLSubAccount>sample string 3</GLSubAccount>
        </ChargeCreditBatchSummaryViewModel>
        <ChargeCreditBatchSummaryViewModel>
          <Amount>4</Amount>
          <ChargeCode>sample string 1</ChargeCode>
          <GLAccount>sample string 2</GLAccount>
          <GLSubAccount>sample string 3</GLSubAccount>
        </ChargeCreditBatchSummaryViewModel>
      </Summary>
      <Total>9</Total>
      <UserName>sample string 8</UserName>
    </ChargeCreditBatchInquiryViewModel>
    <ChargeCreditBatchInquiryViewModel>
      <BatchDate>2025-04-03T17:56:24.864432-04:00</BatchDate>
      <BatchDescription>sample string 4</BatchDescription>
      <BatchId>1</BatchId>
      <BatchStatus>sample string 2</BatchStatus>
      <Details>
        <ChargeCreditBatchDetailViewModel>
          <AccountNumber>sample string 1</AccountNumber>
          <AdjustedCode>sample string 6</AdjustedCode>
          <Amount>7</Amount>
          <ChargeCode>sample string 5</ChargeCode>
          <CreatedDate>2025-04-03T17:56:24.864432-04:00</CreatedDate>
          <CreditId>8</CreditId>
          <ResidentName>sample string 2</ResidentName>
          <ResidentStatus>sample string 3</ResidentStatus>
        </ChargeCreditBatchDetailViewModel>
        <ChargeCreditBatchDetailViewModel>
          <AccountNumber>sample string 1</AccountNumber>
          <AdjustedCode>sample string 6</AdjustedCode>
          <Amount>7</Amount>
          <ChargeCode>sample string 5</ChargeCode>
          <CreatedDate>2025-04-03T17:56:24.864432-04:00</CreatedDate>
          <CreditId>8</CreditId>
          <ResidentName>sample string 2</ResidentName>
          <ResidentStatus>sample string 3</ResidentStatus>
        </ChargeCreditBatchDetailViewModel>
      </Details>
      <Entity>sample string 6</Entity>
      <JournalEntryId>1</JournalEntryId>
      <ManagementCompany>sample string 7</ManagementCompany>
      <SubBatchType>sample string 3</SubBatchType>
      <Summary>
        <ChargeCreditBatchSummaryViewModel>
          <Amount>4</Amount>
          <ChargeCode>sample string 1</ChargeCode>
          <GLAccount>sample string 2</GLAccount>
          <GLSubAccount>sample string 3</GLSubAccount>
        </ChargeCreditBatchSummaryViewModel>
        <ChargeCreditBatchSummaryViewModel>
          <Amount>4</Amount>
          <ChargeCode>sample string 1</ChargeCode>
          <GLAccount>sample string 2</GLAccount>
          <GLSubAccount>sample string 3</GLSubAccount>
        </ChargeCreditBatchSummaryViewModel>
      </Summary>
      <Total>9</Total>
      <UserName>sample string 8</UserName>
    </ChargeCreditBatchInquiryViewModel>
  </Items>
  <TotalCount>1</TotalCount>
</BaseSearchResultViewModelOfChargeCreditBatchInquiryViewModelDmR41roR>