POST api/checks/Manual

Generate ManualCheck.

Request Information

URI Parameters

None.

Body Parameters

CreateManualCheckViewModel
NameDescriptionTypeAdditional information
invoiceId

integer

Required

checkAmount

decimal number

Required

checkGlDate

date

Required

ExternalCheckNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "invoiceId": 1,
  "checkAmount": 2.0,
  "checkGlDate": "2024-10-14T08:21:55.7259111-04:00",
  "externalCheckNumber": "sample string 4"
}

application/xml, text/xml

Sample:
<CreateManualCheckViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Checks">
  <ExternalCheckNumber>sample string 4</ExternalCheckNumber>
  <checkAmount>2</checkAmount>
  <checkGlDate>2024-10-14T08:21:55.7259111-04:00</checkGlDate>
  <invoiceId>1</invoiceId>
</CreateManualCheckViewModel>

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

Response Information

Resource Description

CreateManualCheckModelResponseViewModel

ManualCheckModelResponseViewModel
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Message

string

None.

InvoiceId

integer

None.

CheckId

integer

None.

CheckNumber

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "invoiceId": 3,
  "checkId": 4,
  "checkNumber": 5
}

application/xml, text/xml

Sample:
<ManualCheckModelResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Checks">
  <CheckId>4</CheckId>
  <CheckNumber>5</CheckNumber>
  <InvoiceId>3</InvoiceId>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
</ManualCheckModelResponseViewModel>