POST api/credits/RunBalanceWriteOff

POST: api/credits/RunBalanceWriteWriteOff Runs the Small Balance Write Off process for all entities in the market.

Request Information

URI Parameters

None.

Body Parameters

The model contains the post date and an optional list of entities

WriteOffParamsViewModel
NameDescriptionTypeAdditional information
RunDate

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

date

Required
EntityIds

List of Entity ids, if not provided the process will run for all entities.

Collection of integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "runDate": "2025-04-03T17:53:07.1344423-04:00",
  "entityIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<WriteOffParamsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <EntityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityIds>
  <RunDate>2025-04-03T17:53:07.1344423-04:00</RunDate>
</WriteOffParamsViewModel>

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

Response Information

Resource Description

WriteOffProcessResultDocumentationViewModel
NameDescriptionTypeAdditional information
CreditBatches

Credit Batches created by the process

Collection of ChargeCreditBatchViewModelOfCreditViewModel

None.
PrepayBatches

PrepayBatches created by the process containing the links between the credits and the charges

Collection of ApplicationOfPrepaidsBatchViewModel

None.
Errors

Contains any errors blocking or non-blocking that occurred during the process

Collection of string

None.