POSPayments

Search for payments

Get payments.

get/pospayments

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/pospayments
  • Auth
    HTTP bearer

Query parameters

freetextstring

The free text that is used to search in paymentno, payment materials, etc.

notestring

Search based on notes.

fromdatestring

Get all payments after the given fromdate to now (or to todate if specified)

cashinteger

1 of you only want cash payments

invoiceinteger

1 of you only want invoice payments

todatestring

Get all payments before the given todate

productidinteger

Get payments of a specific product

discounttagidinteger

Get payments with an article discounted using a specific discount tag

paymentno_afterinteger

Get all payments with paymentno >= paymentno_after

updated_afterstring

Get all payments updated after the given date

useridinteger

filter on userid

customeridinteger

filter on customerid

customerPaymentSuminteger

Calculate total payment sum for customer, requires that customerid is provided

paymenttypeidinteger

Filter on paymenttype

sumnumber double

Deprecated: Use sumFrom and sumTo instead. Filter payments with exact sum match.

sumFromnumber double

Filter payments with sum greater than or equal to this value

sumTonumber double

Filter payments with sum less than or equal to this value

returnPaymentsOnlyboolean

Filter to only include payments where articles are being returned (i.e. quantity < 0)

paymentnostring

Filter on paymentno

paymentidinteger

Filter on payment

bamdeskdeviceinteger

1 = only get bamdeskdevice payments

fromPartnerStoresinteger

Includes payments from partner stores when not 0

paginationStartinteger

Determine the offset (in number of item) to fetch. This is usually a multiple of the pageLength.

paginationPageLengthinteger

Determine the number of items to fetch in one page.

sortOrder-1 | 1

Sorting order. If order is 1, items are retrieved in ascending order, if -1, in descending order.

sortFieldstring

Sort by field e.g. paymentno, date,.

cashRegisterIdnumber

Get payments with a specific cash register

status'initialized' | 'parked' | 'in_progress' | 'completed' | 'cancelled'

Get payments with a specific status

Response

Ok

countinteger nullable

The total number of items found by the query.

hasMoreboolean nullable

True if there are more payments than the given page length

totalcustomerpaymentsumnumber nullable

Total payment sum for customer, only set if customerid and customerPaymentSum query parameters are set

Changes

No recorded changes to this operation across all 1 revision of this API.