GET admin/cashup?start={start}&end={end}&moduleId={moduleId}&supplierUid={supplierUid}&limitUser={limitUser}

Request Information

URI Parameters

Name	Type	Additional information
start	date	Required
end	date	Required
moduleId	integer	Required
supplierUid	string	Required
limitUser	boolean	Required

Body Parameters

None.

Response Information

Resource Description

CashupGET

Name	Type	Additional information
EndDate	date	None.
Organisations	Collection of CashupOrganisationGET	None.
StartDate	date	None.
Supplier	string	None.
TotalAmount	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "endDate": "2024-11-28T06:48:58.4073113+00:00",
  "organisations": [
    {
      "id": 1,
      "name": "sample string 2",
      "sites": [
        {
          "id": 1,
          "name": "sample string 2",
          "transactions": [
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            },
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            }
          ]
        },
        {
          "id": 1,
          "name": "sample string 2",
          "transactions": [
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            },
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            }
          ]
        }
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "sites": [
        {
          "id": 1,
          "name": "sample string 2",
          "transactions": [
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            },
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            }
          ]
        },
        {
          "id": 1,
          "name": "sample string 2",
          "transactions": [
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            },
            {
              "amount": 1.0,
              "count": 2,
              "transactionType": "sample string 3"
            }
          ]
        }
      ]
    }
  ],
  "startDate": "2024-11-28T06:48:58.4073113+00:00",
  "supplier": "sample string 3",
  "totalAmount": 4.0
}

application/xml, text/xml

Sample:

<CashupGET xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/myPortalApi.Models.Admin.Cashup">
  <EndDate>2024-11-28T06:48:58.4073113+00:00</EndDate>
  <Organisations>
    <CashupOrganisationGET>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Sites>
        <CashupSiteGET>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Transactions>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
          </Transactions>
        </CashupSiteGET>
        <CashupSiteGET>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Transactions>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
          </Transactions>
        </CashupSiteGET>
      </Sites>
    </CashupOrganisationGET>
    <CashupOrganisationGET>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Sites>
        <CashupSiteGET>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Transactions>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
          </Transactions>
        </CashupSiteGET>
        <CashupSiteGET>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Transactions>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
            <CashupTransactionGET>
              <Amount>1</Amount>
              <Count>2</Count>
              <TransactionType>sample string 3</TransactionType>
            </CashupTransactionGET>
          </Transactions>
        </CashupSiteGET>
      </Sites>
    </CashupOrganisationGET>
  </Organisations>
  <StartDate>2024-11-28T06:48:58.4073113+00:00</StartDate>
  <Supplier>sample string 3</Supplier>
  <TotalAmount>4</TotalAmount>
</CashupGET>