GET Reporting/v1/Enterprise/GetDepositsReport?SiteID={SiteID}&DateFrom={DateFrom}&DateTo={DateTo}

Gets the Deposits Report data for given sites.

Request Information

URI Parameters

Name	Type	Description	Additional information
SiteID	integer	Site ID which the report will be run on	None.
DateFrom	date	Date which the report will start from	None.
DateTo	date	Date which the report will end till	None.

Body Parameters

ReportingEnterpriseRequestCommandSingleSite

Name	Type	Description	Additional information
SiteID	integer	Site ID which the report will be run on	None.
DateFrom	date	Date which the report will start from	None.
DateTo	date	Date which the report will end till	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteID": 1,
  "DateFrom": "2024-11-21T06:21:01.2182453+00:00",
  "DateTo": "2024-11-21T06:21:01.2182453+00:00"
}

application/xml, text/xml

Sample:

<ReportingEnterpriseRequestCommandSingleSite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
  <DateFrom>2024-11-21T06:21:01.2182453+00:00</DateFrom>
  <DateTo>2024-11-21T06:21:01.2182453+00:00</DateTo>
  <SiteID>1</SiteID>
</ReportingEnterpriseRequestCommandSingleSite>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SpfReportsDepositsDto

Name	Type	Additional information
DepositID	integer	None.
Name	string	None.
PhoneNo	string	None.
Amount	decimal number	None.
PaymentMethod	string	None.
DepositDate	date	None.
ReservationDate	date	None.
Redeemed	boolean	None.
Notes	string	None.
TakenUserID	integer	None.
ZReportIn	integer	None.
ZReportOut	integer	None.
Terminal	string	None.
ActionedUserID	integer	None.
Status	integer	None.
ActionDate	date	None.
SiteID	integer	None.
RefundMethod	string	None.
Username	string	None.
TakenSession	string	None.
TakenOrderArea	string	None.
TakenSalesArea	string	None.
IsActioned	integer	None.
Occurence	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DepositID": 1,
    "Name": "sample string 1",
    "PhoneNo": "sample string 2",
    "Amount": 1.0,
    "PaymentMethod": "sample string 3",
    "DepositDate": "2024-11-21T06:21:01.2182453+00:00",
    "ReservationDate": "2024-11-21T06:21:01.2182453+00:00",
    "Redeemed": true,
    "Notes": "sample string 4",
    "TakenUserID": 1,
    "ZReportIn": 1,
    "ZReportOut": 1,
    "Terminal": "sample string 5",
    "ActionedUserID": 1,
    "Status": 1,
    "ActionDate": "2024-11-21T06:21:01.2182453+00:00",
    "SiteID": 1,
    "RefundMethod": "sample string 6",
    "Username": "sample string 7",
    "TakenSession": "sample string 8",
    "TakenOrderArea": "sample string 9",
    "TakenSalesArea": "sample string 10",
    "IsActioned": 1,
    "Occurence": 1
  },
  {
    "DepositID": 1,
    "Name": "sample string 1",
    "PhoneNo": "sample string 2",
    "Amount": 1.0,
    "PaymentMethod": "sample string 3",
    "DepositDate": "2024-11-21T06:21:01.2182453+00:00",
    "ReservationDate": "2024-11-21T06:21:01.2182453+00:00",
    "Redeemed": true,
    "Notes": "sample string 4",
    "TakenUserID": 1,
    "ZReportIn": 1,
    "ZReportOut": 1,
    "Terminal": "sample string 5",
    "ActionedUserID": 1,
    "Status": 1,
    "ActionDate": "2024-11-21T06:21:01.2182453+00:00",
    "SiteID": 1,
    "RefundMethod": "sample string 6",
    "Username": "sample string 7",
    "TakenSession": "sample string 8",
    "TakenOrderArea": "sample string 9",
    "TakenSalesArea": "sample string 10",
    "IsActioned": 1,
    "Occurence": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpfReportsDepositsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.Enterprise.Core.Models.StoredProcedures">
  <SpfReportsDepositsDto>
    <ActionDate>2024-11-21T06:21:01.2182453+00:00</ActionDate>
    <ActionedUserID>1</ActionedUserID>
    <Amount>1</Amount>
    <DepositDate>2024-11-21T06:21:01.2182453+00:00</DepositDate>
    <DepositID>1</DepositID>
    <IsActioned>1</IsActioned>
    <Name>sample string 1</Name>
    <Notes>sample string 4</Notes>
    <Occurence>1</Occurence>
    <PaymentMethod>sample string 3</PaymentMethod>
    <PhoneNo>sample string 2</PhoneNo>
    <Redeemed>true</Redeemed>
    <RefundMethod>sample string 6</RefundMethod>
    <ReservationDate>2024-11-21T06:21:01.2182453+00:00</ReservationDate>
    <SiteID>1</SiteID>
    <Status>1</Status>
    <TakenOrderArea>sample string 9</TakenOrderArea>
    <TakenSalesArea>sample string 10</TakenSalesArea>
    <TakenSession>sample string 8</TakenSession>
    <TakenUserID>1</TakenUserID>
    <Terminal>sample string 5</Terminal>
    <Username>sample string 7</Username>
    <ZReportIn>1</ZReportIn>
    <ZReportOut>1</ZReportOut>
  </SpfReportsDepositsDto>
  <SpfReportsDepositsDto>
    <ActionDate>2024-11-21T06:21:01.2182453+00:00</ActionDate>
    <ActionedUserID>1</ActionedUserID>
    <Amount>1</Amount>
    <DepositDate>2024-11-21T06:21:01.2182453+00:00</DepositDate>
    <DepositID>1</DepositID>
    <IsActioned>1</IsActioned>
    <Name>sample string 1</Name>
    <Notes>sample string 4</Notes>
    <Occurence>1</Occurence>
    <PaymentMethod>sample string 3</PaymentMethod>
    <PhoneNo>sample string 2</PhoneNo>
    <Redeemed>true</Redeemed>
    <RefundMethod>sample string 6</RefundMethod>
    <ReservationDate>2024-11-21T06:21:01.2182453+00:00</ReservationDate>
    <SiteID>1</SiteID>
    <Status>1</Status>
    <TakenOrderArea>sample string 9</TakenOrderArea>
    <TakenSalesArea>sample string 10</TakenSalesArea>
    <TakenSession>sample string 8</TakenSession>
    <TakenUserID>1</TakenUserID>
    <Terminal>sample string 5</Terminal>
    <Username>sample string 7</Username>
    <ZReportIn>1</ZReportIn>
    <ZReportOut>1</ZReportOut>
  </SpfReportsDepositsDto>
</ArrayOfSpfReportsDepositsDto>