POST Finance/CreateCreditMemo

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedCreateCreditMemoRequest

Name	Type	Additional information
AccountTypeId	integer	None.
ReferralDocumentId	integer	None.
FinancialDate	date	None.
Reason	string	None.
Amount	decimal number	None.
SecurityKey	string	None.
PolicyId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountTypeId": 1,
  "ReferralDocumentId": 2,
  "FinancialDate": "2025-12-01T08:49:39.6399388+02:00",
  "Reason": "sample string 4",
  "Amount": 5.0,
  "SecurityKey": "sample string 6",
  "PolicyId": 7
}

application/xml, text/xml

Sample:

<SecurityTokenVerifiedCreateCreditMemoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>7</PolicyId>
  <SecurityKey>sample string 6</SecurityKey>
  <AccountTypeId>1</AccountTypeId>
  <Amount>5</Amount>
  <FinancialDate>2025-12-01T08:49:39.6399388+02:00</FinancialDate>
  <Reason>sample string 4</Reason>
  <ReferralDocumentId>2</ReferralDocumentId>
</SecurityTokenVerifiedCreateCreditMemoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfInt32

Name	Type	Additional 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>