Receipts

Receipts endpoint wrapper class

Possible requests:

  • get_by_query: get receipts that respect passed in query parameters

  • get_by_id: get receipt with a given ID

  • get_by_date: get receipts for a given date

  • get_by_dates: get receipts between two dates

class loyverse.endpoints.receipts.Receipts(api: loyverse.api.Api)
get_by_query(receipt_numbers: list = None, since_receipt_number: str = None, before_receipt_number: str = None, store_id: str = None, order: str = None, source: str = None, updated_at_min: datetime.datetime = None, updated_at_max: datetime.datetime = None, created_at_min: datetime.datetime = None, created_at_max: datetime.datetime = None, limit: int = 250, cursor: str = None) → dict

Retrieves receipts that respect the specific query criteria passed in. A detailed description of the query parameters is available here.

Parameters

  • receipt_numbers (list) – filter receipts by receipt numbers

  • since_receipt_number (str) – return only receipts after this receipt number

  • before_receipt_number (str) – return only receipts before this receipt number

  • store_id (str) – filter receipts by store id

  • order (str) – filter receipts by order

  • source (str) – filter receipts by source (e.g. My app)

  • updated_at_min (datetime) – filter receipts updated after this date (includes timezone info)

  • updated_at_max (datetime) – filter receipts updated before this date (includes timezone info)

  • created_at_min (datetime) – filter receipts created after this date (includes timezone info)

  • created_at_max (datetime) – filter receipts created before this date (includes timezone info)

  • limit (int) – maximum number of receipts to return per request (1 to 250)

  • cursor (str) – token to get continuation of return list for requests exceeding limits

Returns

formatted receipts information (JSON)

Return type

response (dict)

get_by_id(receipt_id: str) → dict

Retrieves the receipts information for a specific receipt ID

Parameters

receipt_id (str) – string uniquely identifying the receipt to be retrieved

Returns

formatted receipt information (JSON)

Return type

response (dict)

get_by_date(date: datetime.datetime) → dict

Retrieve receipts information for a specific day

Parameters

date (datetime) – datetime object representing day in question (including time zone info)

Returns

formatted receipts information (JSON)

Return type

response (dict)

get_by_dates(start_date: datetime.datetime, end_date: datetime.datetime = None) → dict

Retrieves receipts information for a specific date interval.

Parameters

  • start_date (datetime) – start date, including time-zone info

  • end_date (datetime) – end date, including time-zone info (if not provided, defaults to UTC now)

Returns

formatted receipts information (JSON)

Return type

response (dict)

static to_dataframes(response: dict)

Formats receipts API return data into three dataframes (receipts, items, payments)

Parameters

response (dict) – receipt endpoint response

Returns

receipt level information items_df (pandas.Dataframe): receipt items information payments_df (pandas.Dataframe): receipt payments information

Return type

receipt_df (pandas.Dataframe)