POST api/debitmemo/search

GET api/debitmemo/getInvoiceLinkByBatchIds/search

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SuperEntityId	Super Entity Id	integer	None.
VendorId	Vendor Id	integer	None.
MinBatchId	Minimum Batch Id	integer	None.
MaxBatchId	Maximum Batch Id	integer	None.
MinBatchAmount	Minimum Batch Amount	decimal number	None.
MaxBatchAmount	Maximum Batch Amount	decimal number	None.
MinPaymentDate	Minimum Payment Date	date	None.
MaxPaymentDate	Maximum Payment Date	date	None.
ReferenceNumber	Reference Number	string	None.
Statuses	Statuses	Collection of integer	None.
BankCodeId	Bank Code Id	integer	None.
InvoiceId	Invoice Id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "superEntityId": 1,
  "vendorId": 1,
  "minBatchId": 1,
  "maxBatchId": 1,
  "minBatchAmount": 1.0,
  "maxBatchAmount": 1.0,
  "minPaymentDate": "2025-04-03T17:41:46.7624511-04:00",
  "maxPaymentDate": "2025-04-03T17:41:46.7624511-04:00",
  "referenceNumber": "sample string 1",
  "statuses": [
    1,
    2
  ],
  "bankCodeId": 1,
  "invoiceId": 1
}

application/xml, text/xml

Sample:

<DebitMemoSearchParametersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BankCodeId>1</BankCodeId>
  <InvoiceId>1</InvoiceId>
  <MaxBatchAmount>1</MaxBatchAmount>
  <MaxBatchId>1</MaxBatchId>
  <MaxPaymentDate>2025-04-03T17:41:46.7624511-04:00</MaxPaymentDate>
  <MinBatchAmount>1</MinBatchAmount>
  <MinBatchId>1</MinBatchId>
  <MinPaymentDate>2025-04-03T17:41:46.7624511-04:00</MinPaymentDate>
  <ReferenceNumber>sample string 1</ReferenceNumber>
  <Statuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Statuses>
  <SuperEntityId>1</SuperEntityId>
  <VendorId>1</VendorId>
</DebitMemoSearchParametersViewModel>

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

Response Information

Resource Description

Collection of DebitMemoBatchSearchResult

Name	Description	Type	Additional information
EntityNumber	Entity Number	string	None.
BankCode	Bank Code	string	None.
ReferenceNumber	Reference Number	string	None.
BatchNumber	Batch Number	integer	None.
VendorCode	Vendor Code	string	None.
VendorName	Vendor Name	string	None.
BatchDate	Batc Date	date	None.
Status	Status	string	None.
BatchAmount	Batch Amount	decimal number	None.
PaymentType	Pyament Type	string	None.
DisplayBatchNumber	Display Batch Number	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "entityNumber": "sample string 1",
    "bankCode": "sample string 2",
    "referenceNumber": "sample string 3",
    "batchNumber": 4,
    "vendorCode": "sample string 5",
    "vendorName": "sample string 6",
    "batchDate": "2025-04-03T17:41:46.7780885-04:00",
    "status": "sample string 8",
    "batchAmount": 9.0,
    "paymentType": "sample string 10",
    "displayBatchNumber": "sample string 11"
  },
  {
    "entityNumber": "sample string 1",
    "bankCode": "sample string 2",
    "referenceNumber": "sample string 3",
    "batchNumber": 4,
    "vendorCode": "sample string 5",
    "vendorName": "sample string 6",
    "batchDate": "2025-04-03T17:41:46.7780885-04:00",
    "status": "sample string 8",
    "batchAmount": 9.0,
    "paymentType": "sample string 10",
    "displayBatchNumber": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDebitMemoBatchSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <DebitMemoBatchSearchResult>
    <BankCode>sample string 2</BankCode>
    <BatchAmount>9</BatchAmount>
    <BatchDate>2025-04-03T17:41:46.7780885-04:00</BatchDate>
    <BatchNumber>4</BatchNumber>
    <DisplayBatchNumber>sample string 11</DisplayBatchNumber>
    <EntityNumber>sample string 1</EntityNumber>
    <PaymentType>sample string 10</PaymentType>
    <ReferenceNumber>sample string 3</ReferenceNumber>
    <Status>sample string 8</Status>
    <VendorCode>sample string 5</VendorCode>
    <VendorName>sample string 6</VendorName>
  </DebitMemoBatchSearchResult>
  <DebitMemoBatchSearchResult>
    <BankCode>sample string 2</BankCode>
    <BatchAmount>9</BatchAmount>
    <BatchDate>2025-04-03T17:41:46.7780885-04:00</BatchDate>
    <BatchNumber>4</BatchNumber>
    <DisplayBatchNumber>sample string 11</DisplayBatchNumber>
    <EntityNumber>sample string 1</EntityNumber>
    <PaymentType>sample string 10</PaymentType>
    <ReferenceNumber>sample string 3</ReferenceNumber>
    <Status>sample string 8</Status>
    <VendorCode>sample string 5</VendorCode>
    <VendorName>sample string 6</VendorName>
  </DebitMemoBatchSearchResult>
</ArrayOfDebitMemoBatchSearchResult>