Dividend#

Allows you to generate a dividend report for a given dividend.

Endpoints:#


GET Dividend/GetList#

Description:

Retrieves a list of dividends.

Query Parameters:

customerIssuerId
integer Required
Nullable
The unique identifier of the customer issuer.
isPDF
boolean Optional
Non-nullable
Generates a PDF.
true = generates a downloadable pdf.
false = does not generate a downloadable pdf.

Example Request:

curl --silent --location '{{baseurl}}/api/v1/Dividend/GetList?customerIssuerId=1' \
--header 'Authorization: Bearer <YOUR TOKEN>'

200 Response:

[
  {
    "dividendId": 2042,
    "type": "Cash",
    "security": "Preferred",
    "payable": "8/20/2018",
    "recordDate": "1/11/2019",
    "ratio": "1 for $3.00",
    "oustandingShares": 250,
    "outstandingSharesFormat": "250",
    "distributionAmount": 750,
    "distributionAmountFormat": "$750.00",
    "fractionalType": "Rounded Down",
    "cashPerShare": null,
    "cashPerShareFormat": ""
  },
  {
    "dividendId": 4055,
    "type": "Stock",
    "security": "Common",
    "payable": "3/24/2020",
    "recordDate": "3/24/2020",
    "ratio": "1 for 1.6434",
    "oustandingShares": 6463100,
    "outstandingSharesFormat": "6,463,100",
    "distributionAmount": 10621438,
    "distributionAmountFormat": "10,621,438",
    "fractionalType": "Pay in Cash",
    "cashPerShare": 2,
    "cashPerShareFormat": "$2.00"
  }
]

POST Dividend/GenerateDividendDetails#

Description:

Generates a detailed report for a given dividend.

Request Body:

dividendId
integer Required
Non-nullable
SOLO System Dividend/Control Id
isPDF
boolean Optional
Non-nullable
Generates a PDF.
true = generates a downloadable pdf.
false = does not generate a downloadable pdf.

Example Request:

curl --silent --location --request POST '{{baseurl}}/api/v1/Dividend/GenerateDividendDetails' \
--header 'Authorization: Bearer <YOUR TOKEN>' \
--header 'Content-Type: application/json' \
--data '{"dividendId": 1}'

200 Response:

{
  "downloadUrl": "{{baseurl}}/Api/v1/Report/DownloadReport/CfDJ8G2a_F-j-rtGiUBjbT5isV0jFreDl552uI6YQ5enntFyUqg4WgDtMO56PfG50Xk9e_wz9a-38A-nBKdxZvJSz5vM_ZAoTdzvM5mqfRch1N-YGT5ErhQ1yQpYRbGdXS2_VB4Uw_JBLLmaZsyCWZMC4WObnXnlCIOGzAFtBMuFs6AT/dividend-4059.pdf/CfDJ8G2a_F-j-rtGiUBjbT5isV30kJSZsZcu3cvfJwPljBGj-yrKmvV4Z6EiH0tssHVmtnfQ2omDWfnWJdzZ88wBe9KOGS6qS5GJdFzwt3fa2-T9Gd6YpF7pscWQvREwSOyep2YnaWtm-dXP_eHyM-8FVvo"
}