POST api/payments/preview

Preview bulk entities

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceSelectionId	InvoiceSelectionEnum	None.
AsOfDate	date	None.
VendorTypeId	integer	None.
ManagementCompanyId	integer	None.
SpecialHandlingId	integer	None.
BankCodes	Collection of integer	None.
EntityIds	Collection of integer	None.
PayeeId	integer	None.
UserId	integer	None.
InvoiceIds	Collection of integer	None.
Password	string	None.
UseAutomatedRestriction	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "invoiceSelectionId": 1,
  "asOfDate": "2025-10-29T04:44:27.0599882-04:00",
  "vendorTypeId": 1,
  "managementCompanyId": 1,
  "specialHandlingId": 1,
  "bankCodes": [
    1,
    2
  ],
  "entityIds": [
    1,
    2
  ],
  "payeeId": 1,
  "userId": 1,
  "invoiceIds": [
    1,
    2
  ],
  "password": "sample string 2",
  "useAutomatedRestriction": true
}

application/xml, text/xml

Sample:

<PaymentSearchParametersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Payments">
  <AsOfDate>2025-10-29T04:44:27.0599882-04:00</AsOfDate>
  <BankCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BankCodes>
  <EntityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityIds>
  <InvoiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </InvoiceIds>
  <InvoiceSelectionId>All</InvoiceSelectionId>
  <ManagementCompanyId>1</ManagementCompanyId>
  <Password>sample string 2</Password>
  <PayeeId>1</PayeeId>
  <SpecialHandlingId>1</SpecialHandlingId>
  <UseAutomatedRestriction>true</UseAutomatedRestriction>
  <UserId>1</UserId>
  <VendorTypeId>1</VendorTypeId>
</PaymentSearchParametersViewModel>

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

Response Information

Resource Description

PreviewResponseViewModel

Name	Type	Additional information
PrintedChecks	integer	None.
ExportedChecks	integer	None.
ExcludedInvoices	integer	None.
ChecksFileName	string	None.
Errors	Collection of string	None.
PrintedInvoices	integer	None.
ExportedInvoices	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "printedChecks": 1,
  "exportedChecks": 2,
  "excludedInvoices": 3,
  "checksFileName": "sample string 4",
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "printedInvoices": 5,
  "exportedInvoices": 6
}

application/xml, text/xml

Sample:

<PreviewResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Payments">
  <ChecksFileName>sample string 4</ChecksFileName>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <ExcludedInvoices>3</ExcludedInvoices>
  <ExportedChecks>2</ExportedChecks>
  <ExportedInvoices>6</ExportedInvoices>
  <PrintedChecks>1</PrintedChecks>
  <PrintedInvoices>5</PrintedInvoices>
</PreviewResponseViewModel>