POST api/charges/run/manual

Runs the Collection Charges process manually

Request Information

URI Parameters

None.

Body Parameters

Collection of ChargeActionModel
NameDescriptionTypeAdditional information
AdjustedCodeId

integer

None.

Amount

decimal number

None.

ChargeCode

ChargeCodeModel

None.

ChargeDate

date

None.

ResidentId

integer

None.

ReferenceId

string

None.

Message

string

None.

HttpCode

HttpStatusCode

None.

Resident

ResidentModel

None.

Logs

Collection of CollectionsLog

None.

IsValid

boolean

None.

ConcatenatedErrorMessage

string

None.

Errors

Collection of string

None.

Warnings

Collection of string

None.

HasWarnings

boolean

None.

ConcatenatedWarningMessage

string

None.

Response Information

Resource Description

Ok if the operations was successful, otherwise BadRequest.

Collection of ActionResponseViewModel
NameDescriptionTypeAdditional information
ReferenceId

string

None.

ProcessStatusId

ProcessStatusEnum

None.

Messages

Collection of string

None.

HttpCode

HttpStatusCode

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "referenceId": "sample string 1",
    "processStatusId": 2,
    "messages": [
      "sample string 1",
      "sample string 2"
    ],
    "httpCode": 100
  },
  {
    "referenceId": "sample string 1",
    "processStatusId": 2,
    "messages": [
      "sample string 1",
      "sample string 2"
    ],
    "httpCode": 100
  }
]

application/xml, text/xml

Sample:
<ArrayOfActionResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
  <ActionResponseViewModel>
    <HttpCode>Continue</HttpCode>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <ProcessStatusId>Queued</ProcessStatusId>
    <ReferenceId>sample string 1</ReferenceId>
  </ActionResponseViewModel>
  <ActionResponseViewModel>
    <HttpCode>Continue</HttpCode>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <ProcessStatusId>Queued</ProcessStatusId>
    <ReferenceId>sample string 1</ReferenceId>
  </ActionResponseViewModel>
</ArrayOfActionResponseViewModel>