POST Finance/CreateRefund

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedCreateRefundRequest
NameDescriptionTypeAdditional information
AccountTypeId

integer

None.

ReferralDocumentId

integer

None.

FinancialDate

date

None.

Notes

string

None.

Amount

decimal number

None.

CreatedBy

string

None.

SecurityKey

string

None.

PolicyId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountTypeId": 1,
  "ReferralDocumentId": 2,
  "FinancialDate": "2025-05-13T22:31:53.510492+02:00",
  "Notes": "sample string 4",
  "Amount": 5.0,
  "CreatedBy": "sample string 6",
  "SecurityKey": "sample string 7",
  "PolicyId": 8
}

application/xml, text/xml

Sample:
<SecurityTokenVerifiedCreateRefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>8</PolicyId>
  <SecurityKey>sample string 7</SecurityKey>
  <AccountTypeId>1</AccountTypeId>
  <Amount>5</Amount>
  <CreatedBy>sample string 6</CreatedBy>
  <FinancialDate>2025-05-13T22:31:53.510492+02:00</FinancialDate>
  <Notes>sample string 4</Notes>
  <ReferralDocumentId>2</ReferralDocumentId>
</SecurityTokenVerifiedCreateRefundRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfInt32
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": 3
}

application/xml, text/xml

Sample:
<ResponseOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity>3</Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfint>