POST api/credits/RunPrepaids

POST: api/credits/runPrepaids Runs Application of Prepaids Process.

Request Information

URI Parameters

None.

Body Parameters

PrepaidParamViewModel
NameDescriptionTypeAdditional information
RunDate

Required Run Date, used to calculate the previous work day to be used for Pay date, Gl Date

date

None.

BuildingIds

List of Building ids, can be null

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "runDate": "2024-10-14T08:25:31.6120915-04:00",
  "buildingIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<PrepaidParamViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuildingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BuildingIds>
  <RunDate>2024-10-14T08:25:31.6120915-04:00</RunDate>
</PrepaidParamViewModel>

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

Response Information

Resource Description

CreditChargeLinkViewModel

PrepaidProcessResultViewModel
NameDescriptionTypeAdditional information
Batches

Batches

Collection of ApplicationOfPrepaidsBatchViewModel

None.

Errors

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "batches": null,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PrepaidProcessResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Batches i:nil="true" />
  <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>
</PrepaidProcessResultViewModel>