POST Policy/GetDetailedCreditMemo

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SecurityKey		string	None.
DocumentId		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SecurityKey": "sample string 1",
  "DocumentId": 2
}

application/xml, text/xml

Sample:

<SecurityTokenVerifiedDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <DocumentId>2</DocumentId>
  <SecurityKey>sample string 1</SecurityKey>
</SecurityTokenVerifiedDocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfCreditMemo

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	CreditMemo	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "DocumentId": 1,
    "FinancialDateTime": "2025-05-13T23:26:28.7605807+02:00",
    "CustomerAccountId": 3,
    "CustomerAccount": "sample string 4",
    "CreatedDateTime": "2025-05-13T23:26:28.7605807+02:00",
    "Createdby": "sample string 6",
    "TotalAmount": 7.0,
    "InternalComments": "sample string 8",
    "IsVoided": true,
    "ModifiedDateTime": "2025-05-13T23:26:28.7605807+02:00"
  }
}

application/xml, text/xml

Sample:

<ResponseOfCreditMemolP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:CreatedDateTime>2025-05-13T23:26:28.7605807+02:00</d2p1:CreatedDateTime>
    <d2p1:Createdby>sample string 6</d2p1:Createdby>
    <d2p1:CustomerAccount>sample string 4</d2p1:CustomerAccount>
    <d2p1:CustomerAccountId>3</d2p1:CustomerAccountId>
    <d2p1:DocumentId>1</d2p1:DocumentId>
    <d2p1:FinancialDateTime>2025-05-13T23:26:28.7605807+02:00</d2p1:FinancialDateTime>
    <d2p1:InternalComments>sample string 8</d2p1:InternalComments>
    <d2p1:IsVoided>true</d2p1:IsVoided>
    <d2p1:ModifiedDateTime>2025-05-13T23:26:28.7605807+02:00</d2p1:ModifiedDateTime>
    <d2p1:TotalAmount>7</d2p1:TotalAmount>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfCreditMemolP_S41WJs>