PUT api/checks/void

Void checks by ids

Request Information

URI Parameters

None.

Body Parameters

CheckVoidViewModel
NameDescriptionTypeAdditional information
CheckIds

Collection of integer

None.
VoidInvoices

boolean

Required
VoidDate

date

Required
VoidNote

string

Required

Request Formats

application/json, text/json

Sample: 
{
  "checkIds": [
    1,
    2
  ],
  "voidInvoices": true,
  "voidDate": "2025-04-03T17:36:41.9341854-04:00",
  "voidNote": "sample string 3"
}

application/xml, text/xml

Sample: 
<CheckVoidViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Checks">
  <CheckIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CheckIds>
  <VoidDate>2025-04-03T17:36:41.9341854-04:00</VoidDate>
  <VoidInvoices>true</VoidInvoices>
  <VoidNote>sample string 3</VoidNote>
</CheckVoidViewModel>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.