GET v1/Cash

Description

Base Url

https://api-zion.wsohosting.com/


Rest Call Syntax


GET CashManagement/v1/Cash

GET CashManagement/v1/Cash

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

ActivityId

integer

DateType

EndDate

date

IsReceived

boolean

LedgerAccountId

integer

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PositionId

integer

StartDate

date




Response Information



PagedList Of Cash

Name

Description

Type

Additional Information

Items

Collection of Cash

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "actionCodeBaseId": 1,
      "actionCodeId": 2,
      "amount": 3.0,
      "cashId": 4,
      "currencyCode": "sample string 5",
      "fxReceiveDate": 6.1,
      "fxSettleDate": 7.1,
      "fxTradeDate": 8.1,
      "isReceived": true,
      "ledgerAccountId": 10,
      "ledgerAccount": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "name": "sample string 11",
      "notes": "sample string 12",
      "portfolioId": 13,
      "positionId": 14,
      "receiveDate": "2024-10-08T05:32:19.5359125-05:00",
      "reconciledDate": "2024-10-08T05:32:19.5359125-05:00",
      "reconciledUser": "sample string 17",
      "reconcileIssuer": 18,
      "reconcileNotes": "sample string 19",
      "reviewColumn": 20,
      "settleDate": "2024-10-08T05:32:19.5359125-05:00",
      "tradeDate": "2024-10-08T05:32:19.5359125-05:00",
      "tranId": 23,
      "unscheduled": true,
      "isBorrowerTransaction": true,
      "issuerId": 27,
      "addId": "sample string 28",
      "addNode": "sample string 29",
      "addDate": "2024-10-08T05:32:19.5384953-05:00",
      "lastChangeId": "sample string 31",
      "lastChangeNode": "sample string 32",
      "lastChangeDate": "2024-10-08T05:32:19.5384953-05:00",
      "udfs": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "links": [
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        },
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        }
      ]
    },
    {
      "actionCodeBaseId": 1,
      "actionCodeId": 2,
      "amount": 3.0,
      "cashId": 4,
      "currencyCode": "sample string 5",
      "fxReceiveDate": 6.1,
      "fxSettleDate": 7.1,
      "fxTradeDate": 8.1,
      "isReceived": true,
      "ledgerAccountId": 10,
      "ledgerAccount": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "name": "sample string 11",
      "notes": "sample string 12",
      "portfolioId": 13,
      "positionId": 14,
      "receiveDate": "2024-10-08T05:32:19.5359125-05:00",
      "reconciledDate": "2024-10-08T05:32:19.5359125-05:00",
      "reconciledUser": "sample string 17",
      "reconcileIssuer": 18,
      "reconcileNotes": "sample string 19",
      "reviewColumn": 20,
      "settleDate": "2024-10-08T05:32:19.5359125-05:00",
      "tradeDate": "2024-10-08T05:32:19.5359125-05:00",
      "tranId": 23,
      "unscheduled": true,
      "isBorrowerTransaction": true,
      "issuerId": 27,
      "addId": "sample string 28",
      "addNode": "sample string 29",
      "addDate": "2024-10-08T05:32:19.5384953-05:00",
      "lastChangeId": "sample string 31",
      "lastChangeNode": "sample string 32",
      "lastChangeDate": "2024-10-08T05:32:19.5384953-05:00",
      "udfs": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "links": [
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        },
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        }
      ]
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ]
}

application/xml, text/xml

Sample:
<PagedListOfCash xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <Cash>
      <ActionCodeBaseId>1</ActionCodeBaseId>
      <ActionCodeId>2</ActionCodeId>
      <AddDate>2024-10-08T05:32:19.5384953-05:00</AddDate>
      <AddId>sample string 28</AddId>
      <AddNode>sample string 29</AddNode>
      <Amount>3</Amount>
      <CashId>4</CashId>
      <CurrencyCode>sample string 5</CurrencyCode>
      <FXReceiveDate>6.1</FXReceiveDate>
      <FXSettleDate>7.1</FXSettleDate>
      <FXTradeDate>8.1</FXTradeDate>
      <IsBorrowerTransaction>true</IsBorrowerTransaction>
      <IsReceived>true</IsReceived>
      <IssuerId>27</IssuerId>
      <LastChangeDate>2024-10-08T05:32:19.5384953-05:00</LastChangeDate>
      <LastChangeId>sample string 31</LastChangeId>
      <LastChangeNode>sample string 32</LastChangeNode>
      <LedgerAccount>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </LedgerAccount>
      <LedgerAccountId>10</LedgerAccountId>
      <Links>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
      </Links>
      <Name>sample string 11</Name>
      <Notes>sample string 12</Notes>
      <PortfolioId>13</PortfolioId>
      <PositionId>14</PositionId>
      <ReceiveDate>2024-10-08T05:32:19.5359125-05:00</ReceiveDate>
      <ReconcileIssuer>18</ReconcileIssuer>
      <ReconcileNotes>sample string 19</ReconcileNotes>
      <ReconciledDate>2024-10-08T05:32:19.5359125-05:00</ReconciledDate>
      <ReconciledUser>sample string 17</ReconciledUser>
      <ReviewColumn>20</ReviewColumn>
      <SettleDate>2024-10-08T05:32:19.5359125-05:00</SettleDate>
      <TradeDate>2024-10-08T05:32:19.5359125-05:00</TradeDate>
      <TranId>23</TranId>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
      <Unscheduled>true</Unscheduled>
    </Cash>
    <Cash>
      <ActionCodeBaseId>1</ActionCodeBaseId>
      <ActionCodeId>2</ActionCodeId>
      <AddDate>2024-10-08T05:32:19.5384953-05:00</AddDate>
      <AddId>sample string 28</AddId>
      <AddNode>sample string 29</AddNode>
      <Amount>3</Amount>
      <CashId>4</CashId>
      <CurrencyCode>sample string 5</CurrencyCode>
      <FXReceiveDate>6.1</FXReceiveDate>
      <FXSettleDate>7.1</FXSettleDate>
      <FXTradeDate>8.1</FXTradeDate>
      <IsBorrowerTransaction>true</IsBorrowerTransaction>
      <IsReceived>true</IsReceived>
      <IssuerId>27</IssuerId>
      <LastChangeDate>2024-10-08T05:32:19.5384953-05:00</LastChangeDate>
      <LastChangeId>sample string 31</LastChangeId>
      <LastChangeNode>sample string 32</LastChangeNode>
      <LedgerAccount>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </LedgerAccount>
      <LedgerAccountId>10</LedgerAccountId>
      <Links>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
      </Links>
      <Name>sample string 11</Name>
      <Notes>sample string 12</Notes>
      <PortfolioId>13</PortfolioId>
      <PositionId>14</PositionId>
      <ReceiveDate>2024-10-08T05:32:19.5359125-05:00</ReceiveDate>
      <ReconcileIssuer>18</ReconcileIssuer>
      <ReconcileNotes>sample string 19</ReconcileNotes>
      <ReconciledDate>2024-10-08T05:32:19.5359125-05:00</ReconciledDate>
      <ReconciledUser>sample string 17</ReconciledUser>
      <ReviewColumn>20</ReviewColumn>
      <SettleDate>2024-10-08T05:32:19.5359125-05:00</SettleDate>
      <TradeDate>2024-10-08T05:32:19.5359125-05:00</TradeDate>
      <TranId>23</TranId>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
      <Unscheduled>true</Unscheduled>
    </Cash>
  </Items>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfCash>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.