Payment

Payment - Reverse Payment

HTTP Request

POST /api/payment/reverse/{principalPositionType}

📋 Description: Initiates a reversal of a payment transaction based on the specified principal position type, facilitating accurate financial adjustments within the Nakisa Portfolio Management Suite for effective portfolio and asset management.

Parameters

Name

In

Type

Required

Description

principalPositionType

path

string

true

Type of the principal position

body

body

JournalPostingRequest

true

Request body containing the payment reversal details, including transaction identifiers and relevant asset information, necessary for processing reversals in the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "reversal": true,
 3  "reversalReason": {
 4    "id": 0,
 5    "displayId": "string"
 6  },
 7  "documentDate": "2019-08-24",
 8  "postingDate": "2019-08-24",
 9  "activationGroupRevisionId": 0,
10  "unitId": 0,
11  "journalId": 0,
12  "comments": "string",
13  "type": "PAYMENT",
14  "allowedReverseOnReclassification": true,
15  "revertRevisionInProcess": true,
16  "revertInActiveRevisionInProcess": true
17}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PostingResultDto

Example Responses

 1{
 2  "postingResults": [
 3    {
 4      "unitId": 0,
 5      "journalId": 0,
 6      "success": true,
 7      "errorMessage": "string",
 8      "skipped": true,
 9      "retryable": true
10    }
11  ],
12  "successForAllPostings": true,
13  "retryable": true,
14  "errorMessage": "string"
15}

Payment - Post Payment

HTTP Request

POST /api/payment/post/{principalPositionType}

📋 Description: Submits a payment request for a specified principal position type within the Nakisa Portfolio Management Suite, facilitating financial transactions related to portfolio assets and real estate properties.

Parameters

Name

In

Type

Required

Description

principalPositionType

path

string

true

Type of the principal position

body

body

JournalPostingRequest

true

Request body containing payment transaction details, including asset identifiers and financial metrics, relevant for portfolio and real estate property management analytics.

Body Parameters

 1{
 2  "reversal": true,
 3  "reversalReason": {
 4    "id": 0,
 5    "displayId": "string"
 6  },
 7  "documentDate": "2019-08-24",
 8  "postingDate": "2019-08-24",
 9  "activationGroupRevisionId": 0,
10  "unitId": 0,
11  "journalId": 0,
12  "comments": "string",
13  "type": "PAYMENT",
14  "allowedReverseOnReclassification": true,
15  "revertRevisionInProcess": true,
16  "revertInActiveRevisionInProcess": true
17}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PostingResultDto

Example Responses

 1{
 2  "postingResults": [
 3    {
 4      "unitId": 0,
 5      "journalId": 0,
 6      "success": true,
 7      "errorMessage": "string",
 8      "skipped": true,
 9      "retryable": true
10    }
11  ],
12  "successForAllPostings": true,
13  "retryable": true,
14  "errorMessage": "string"
15}