POST api/payments/preview/single

preview checks for single entity

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Payments	Collection of PaymentRequestViewModel	None.
Password	string	None.
AsOfDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "payments": [
    {
      "invoiceId": 1,
      "isSeparateCheck": true,
      "paymentType": 3,
      "paymentAmount": 4.0
    },
    {
      "invoiceId": 1,
      "isSeparateCheck": true,
      "paymentType": 3,
      "paymentAmount": 4.0
    }
  ],
  "password": "sample string 1",
  "asOfDate": "2025-10-29T04:44:29.9249005-04:00"
}

application/xml, text/xml

Sample:

<SinglePreviewViewodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Checks">
  <AsOfDate>2025-10-29T04:44:29.9249005-04:00</AsOfDate>
  <Password>sample string 1</Password>
  <Payments xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Invoices">
    <d2p1:PaymentRequestViewModel>
      <d2p1:InvoiceId>1</d2p1:InvoiceId>
      <d2p1:IsSeparateCheck>true</d2p1:IsSeparateCheck>
      <d2p1:PaymentAmount>4</d2p1:PaymentAmount>
      <d2p1:PaymentType>3</d2p1:PaymentType>
    </d2p1:PaymentRequestViewModel>
    <d2p1:PaymentRequestViewModel>
      <d2p1:InvoiceId>1</d2p1:InvoiceId>
      <d2p1:IsSeparateCheck>true</d2p1:IsSeparateCheck>
      <d2p1:PaymentAmount>4</d2p1:PaymentAmount>
      <d2p1:PaymentType>3</d2p1:PaymentType>
    </d2p1:PaymentRequestViewModel>
  </Payments>
</SinglePreviewViewodel>

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

Response Information

Resource Description

SinglePreviewResponseViewModel

Name	Description	Type	Additional information
ChecksFileName		string	None.
Errors		Collection of SingleErrorViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "checksFileName": "sample string 1",
  "errors": [
    {
      "invoiceId": 1,
      "errors": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "invoiceId": 1,
      "errors": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SinglePreviewResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Payments">
  <ChecksFileName>sample string 1</ChecksFileName>
  <Errors>
    <SingleErrorViewModel>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Errors>
      <InvoiceId>1</InvoiceId>
    </SingleErrorViewModel>
    <SingleErrorViewModel>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Errors>
      <InvoiceId>1</InvoiceId>
    </SingleErrorViewModel>
  </Errors>
</SinglePreviewResponseViewModel>