GET api/v1/Kupa?token={token}&page={page}&startDate={startDate}&endDate={endDate}&deposited={deposited}

שליפה של התקבולים שהתקבלו ונמצאים בקופה או שהופקדו לבנק

Request Information

URI Parameters

NameDescriptionType/Additional information
token

string

Required

page

int32

Default value is 0

startDate

The StartDate for a filter on the PaymentDate (= the date of the check or the date of the credit card deposit). If the PaymentDate is null (e.g. for cash receivables) then Caspit uses the receipt date (if not deposied) or the deposit date (if deposited).
Default is null.

date
endDate

The EndDate for a filter on the PaymentDate (= the date of the check or the date of the credit card deposit). If the PaymentDate is null (e.g. for cash receivables) then Caspit uses the receipt date (if not deposied) or the deposit date (if deposited)
Default is null.

date
deposited

If true fetch only payments that were depsoited to the bank.
If false then fetch only payments that were not deposited to the bank.
Default is false.

boolean

Default value is False

Body Parameters

None.

Response Description

A list of CaspitKupaLine

CaspitResponse

A generic object used to return information from Caspit

Response Formats

application/json, text/json

Sample:
{
  "CurrentPage": 1,
  "TotalCount": 2,
  "TotalPages": 3.1,
  "PrevPageUrl": "sample string 4",
  "NextPageUrl": "sample string 5",
  "Results": [
    {},
    {}
  ]
}

application/xml, text/xml

Sample:
<CaspitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.caspit.biz/2013/03">
  <CurrentPage>1</CurrentPage>
  <NextPageUrl>sample string 5</NextPageUrl>
  <PrevPageUrl>sample string 4</PrevPageUrl>
  <Results>
    <CaspitBase />
    <CaspitBase />
  </Results>
  <TotalCount>2</TotalCount>
  <TotalPages>3.1</TotalPages>
</CaspitResponse>