POST api/batches/debit-memo-inquiry

Returns debit memos

Request Information

URI Parameters

None.

Body Parameters

DebitMemoInquiryFilterViewModel

Name	Type	Additional information
EntityIds	Collection of integer	None.
ManagementCompanyIds	Collection of integer	None.
BankCodeIds	Collection of integer	None.
BatchStatusIds	Collection of integer	None.
PayeeIds	Collection of integer	None.
PaymentTypeIds	Collection of integer	None.
JournalEntryIdFrom	integer	None.
JournalEntryIdTo	integer	None.
BatchIdFrom	integer	None.
BatchIdTo	integer	None.
BatchDateFrom	date	None.
BatchDateTo	date	None.
BatchCreatedDateFrom	date	None.
BatchCreatedDateTo	date	None.
BatchTotalFrom	decimal number	None.
BatchTotalTo	decimal number	None.
VoucherId	integer	None.
ReferenceNumber	string	None.
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Request Formats

application/json, text/json

Sample:

{
  "entityIds": [
    1,
    2
  ],
  "managementCompanyIds": [
    1,
    2
  ],
  "bankCodeIds": [
    1,
    2
  ],
  "batchStatusIds": [
    1,
    2
  ],
  "payeeIds": [
    1,
    2
  ],
  "paymentTypeIds": [
    1,
    2
  ],
  "journalEntryIdFrom": 1,
  "journalEntryIdTo": 1,
  "batchIdFrom": 1,
  "batchIdTo": 1,
  "batchDateFrom": "2024-10-14T08:24:58.384934-04:00",
  "batchDateTo": "2024-10-14T08:24:58.384934-04:00",
  "batchCreatedDateFrom": "2024-10-14T08:24:58.384934-04:00",
  "batchCreatedDateTo": "2024-10-14T08:24:58.384934-04:00",
  "batchTotalFrom": 1.0,
  "batchTotalTo": 1.0,
  "voucherId": 1,
  "referenceNumber": "sample string 1",
  "pageSize": 2,
  "pageNumber": 3,
  "sortInformation": {
    "sortBy": "sample string 1",
    "isSortAscending": true
  }
}

application/xml, text/xml

Sample:

<DebitMemoInquiryFilterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.DebitMemo">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">3</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">2</PageSize>
  <SortInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.SortInformation" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <d2p1:IsSortAscending>true</d2p1:IsSortAscending>
    <d2p1:SortBy>sample string 1</d2p1:SortBy>
  </SortInformation>
  <BankCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BankCodeIds>
  <BatchCreatedDateFrom>2024-10-14T08:24:58.384934-04:00</BatchCreatedDateFrom>
  <BatchCreatedDateTo>2024-10-14T08:24:58.384934-04:00</BatchCreatedDateTo>
  <BatchDateFrom>2024-10-14T08:24:58.384934-04:00</BatchDateFrom>
  <BatchDateTo>2024-10-14T08:24:58.384934-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>
  <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>
  <PayeeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PayeeIds>
  <PaymentTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PaymentTypeIds>
  <ReferenceNumber>sample string 1</ReferenceNumber>
  <VoucherId>1</VoucherId>
</DebitMemoInquiryFilterViewModel>

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 'DebitMemoInquiryFilterViewModel'.

Response Information

Resource Description

BaseSearchResultModel of DebitMemoBatchInquiryViewModel

BaseSearchResultViewModelOfDebitMemoBatchInquiryViewModel

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

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "batchId": 1,
      "batchStatus": "sample string 2",
      "batchDate": "2024-10-14T08:24:58.384934-04:00",
      "createdDate": "2024-10-14T08:24:58.384934-04:00",
      "entityName": "sample string 5",
      "managementCompanyName": "sample string 6",
      "bankCodeName": "sample string 7",
      "paymentType": "sample string 8",
      "referenceNumber": "sample string 9",
      "journalEntryIds": [
        1,
        2
      ],
      "userName": "sample string 10",
      "batchTotal": 11.0,
      "payeeName": "sample string 12",
      "details": [
        {
          "voucherId": 1,
          "invoiceNumber": "sample string 2",
          "invoiceDescription": "sample string 3",
          "createdDate": "2024-10-14T08:24:58.384934-04:00",
          "amount": 5.0,
          "paidAmount": 6.0
        },
        {
          "voucherId": 1,
          "invoiceNumber": "sample string 2",
          "invoiceDescription": "sample string 3",
          "createdDate": "2024-10-14T08:24:58.384934-04:00",
          "amount": 5.0,
          "paidAmount": 6.0
        }
      ],
      "history": [
        {
          "historyStatus": "sample string 1",
          "userName": "sample string 2",
          "historyNote": "sample string 3",
          "createdOn": "2024-10-14T08:24:58.384934-04:00"
        },
        {
          "historyStatus": "sample string 1",
          "userName": "sample string 2",
          "historyNote": "sample string 3",
          "createdOn": "2024-10-14T08:24:58.384934-04:00"
        }
      ]
    },
    {
      "batchId": 1,
      "batchStatus": "sample string 2",
      "batchDate": "2024-10-14T08:24:58.384934-04:00",
      "createdDate": "2024-10-14T08:24:58.384934-04:00",
      "entityName": "sample string 5",
      "managementCompanyName": "sample string 6",
      "bankCodeName": "sample string 7",
      "paymentType": "sample string 8",
      "referenceNumber": "sample string 9",
      "journalEntryIds": [
        1,
        2
      ],
      "userName": "sample string 10",
      "batchTotal": 11.0,
      "payeeName": "sample string 12",
      "details": [
        {
          "voucherId": 1,
          "invoiceNumber": "sample string 2",
          "invoiceDescription": "sample string 3",
          "createdDate": "2024-10-14T08:24:58.384934-04:00",
          "amount": 5.0,
          "paidAmount": 6.0
        },
        {
          "voucherId": 1,
          "invoiceNumber": "sample string 2",
          "invoiceDescription": "sample string 3",
          "createdDate": "2024-10-14T08:24:58.384934-04:00",
          "amount": 5.0,
          "paidAmount": 6.0
        }
      ],
      "history": [
        {
          "historyStatus": "sample string 1",
          "userName": "sample string 2",
          "historyNote": "sample string 3",
          "createdOn": "2024-10-14T08:24:58.384934-04:00"
        },
        {
          "historyStatus": "sample string 1",
          "userName": "sample string 2",
          "historyNote": "sample string 3",
          "createdOn": "2024-10-14T08:24:58.384934-04:00"
        }
      ]
    }
  ],
  "totalCount": 1
}

application/xml, text/xml

Sample:

<BaseSearchResultViewModelOfDebitMemoBatchInquiryViewModelKec41dVB xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.DebitMemo">
    <d2p1:DebitMemoBatchInquiryViewModel>
      <d2p1:BankCodeName>sample string 7</d2p1:BankCodeName>
      <d2p1:BatchDate>2024-10-14T08:24:58.384934-04:00</d2p1:BatchDate>
      <d2p1:BatchId>1</d2p1:BatchId>
      <d2p1:BatchStatus>sample string 2</d2p1:BatchStatus>
      <d2p1:BatchTotal>11</d2p1:BatchTotal>
      <d2p1:CreatedDate>2024-10-14T08:24:58.384934-04:00</d2p1:CreatedDate>
      <d2p1:Details>
        <d2p1:DebitMemoInvoiceViewModel>
          <d2p1:Amount>5</d2p1:Amount>
          <d2p1:CreatedDate>2024-10-14T08:24:58.384934-04:00</d2p1:CreatedDate>
          <d2p1:InvoiceDescription>sample string 3</d2p1:InvoiceDescription>
          <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
          <d2p1:PaidAmount>6</d2p1:PaidAmount>
          <d2p1:VoucherId>1</d2p1:VoucherId>
        </d2p1:DebitMemoInvoiceViewModel>
        <d2p1:DebitMemoInvoiceViewModel>
          <d2p1:Amount>5</d2p1:Amount>
          <d2p1:CreatedDate>2024-10-14T08:24:58.384934-04:00</d2p1:CreatedDate>
          <d2p1:InvoiceDescription>sample string 3</d2p1:InvoiceDescription>
          <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
          <d2p1:PaidAmount>6</d2p1:PaidAmount>
          <d2p1:VoucherId>1</d2p1:VoucherId>
        </d2p1:DebitMemoInvoiceViewModel>
      </d2p1:Details>
      <d2p1:EntityName>sample string 5</d2p1:EntityName>
      <d2p1:History>
        <DebitMemoHistoryInquiryViewModel>
          <CreatedOn>2024-10-14T08:24:58.384934-04:00</CreatedOn>
          <HistoryNote>sample string 3</HistoryNote>
          <HistoryStatus>sample string 1</HistoryStatus>
          <UserName>sample string 2</UserName>
        </DebitMemoHistoryInquiryViewModel>
        <DebitMemoHistoryInquiryViewModel>
          <CreatedOn>2024-10-14T08:24:58.384934-04:00</CreatedOn>
          <HistoryNote>sample string 3</HistoryNote>
          <HistoryStatus>sample string 1</HistoryStatus>
          <UserName>sample string 2</UserName>
        </DebitMemoHistoryInquiryViewModel>
      </d2p1:History>
      <d2p1:JournalEntryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:JournalEntryIds>
      <d2p1:ManagementCompanyName>sample string 6</d2p1:ManagementCompanyName>
      <d2p1:PayeeName>sample string 12</d2p1:PayeeName>
      <d2p1:PaymentType>sample string 8</d2p1:PaymentType>
      <d2p1:ReferenceNumber>sample string 9</d2p1:ReferenceNumber>
      <d2p1:UserName>sample string 10</d2p1:UserName>
    </d2p1:DebitMemoBatchInquiryViewModel>
    <d2p1:DebitMemoBatchInquiryViewModel>
      <d2p1:BankCodeName>sample string 7</d2p1:BankCodeName>
      <d2p1:BatchDate>2024-10-14T08:24:58.384934-04:00</d2p1:BatchDate>
      <d2p1:BatchId>1</d2p1:BatchId>
      <d2p1:BatchStatus>sample string 2</d2p1:BatchStatus>
      <d2p1:BatchTotal>11</d2p1:BatchTotal>
      <d2p1:CreatedDate>2024-10-14T08:24:58.384934-04:00</d2p1:CreatedDate>
      <d2p1:Details>
        <d2p1:DebitMemoInvoiceViewModel>
          <d2p1:Amount>5</d2p1:Amount>
          <d2p1:CreatedDate>2024-10-14T08:24:58.384934-04:00</d2p1:CreatedDate>
          <d2p1:InvoiceDescription>sample string 3</d2p1:InvoiceDescription>
          <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
          <d2p1:PaidAmount>6</d2p1:PaidAmount>
          <d2p1:VoucherId>1</d2p1:VoucherId>
        </d2p1:DebitMemoInvoiceViewModel>
        <d2p1:DebitMemoInvoiceViewModel>
          <d2p1:Amount>5</d2p1:Amount>
          <d2p1:CreatedDate>2024-10-14T08:24:58.384934-04:00</d2p1:CreatedDate>
          <d2p1:InvoiceDescription>sample string 3</d2p1:InvoiceDescription>
          <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
          <d2p1:PaidAmount>6</d2p1:PaidAmount>
          <d2p1:VoucherId>1</d2p1:VoucherId>
        </d2p1:DebitMemoInvoiceViewModel>
      </d2p1:Details>
      <d2p1:EntityName>sample string 5</d2p1:EntityName>
      <d2p1:History>
        <DebitMemoHistoryInquiryViewModel>
          <CreatedOn>2024-10-14T08:24:58.384934-04:00</CreatedOn>
          <HistoryNote>sample string 3</HistoryNote>
          <HistoryStatus>sample string 1</HistoryStatus>
          <UserName>sample string 2</UserName>
        </DebitMemoHistoryInquiryViewModel>
        <DebitMemoHistoryInquiryViewModel>
          <CreatedOn>2024-10-14T08:24:58.384934-04:00</CreatedOn>
          <HistoryNote>sample string 3</HistoryNote>
          <HistoryStatus>sample string 1</HistoryStatus>
          <UserName>sample string 2</UserName>
        </DebitMemoHistoryInquiryViewModel>
      </d2p1:History>
      <d2p1:JournalEntryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:JournalEntryIds>
      <d2p1:ManagementCompanyName>sample string 6</d2p1:ManagementCompanyName>
      <d2p1:PayeeName>sample string 12</d2p1:PayeeName>
      <d2p1:PaymentType>sample string 8</d2p1:PaymentType>
      <d2p1:ReferenceNumber>sample string 9</d2p1:ReferenceNumber>
      <d2p1:UserName>sample string 10</d2p1:UserName>
    </d2p1:DebitMemoBatchInquiryViewModel>
  </Items>
  <TotalCount>1</TotalCount>
</BaseSearchResultViewModelOfDebitMemoBatchInquiryViewModelKec41dVB>