Pavers API

Module: E-Receipts

A module containing the routes for dealing e-receipts
Since:
  • 01/11/2017
Author:
  • Dave

Members

<route> processReceipt

Route:
MethodPath
POST /api/v1/eReceipt
processes information from eReceipts and sends the email
Query Parameters:
Name Type Description
req.body.ema string email address
req.body.mcb integer mailing signup
req.body.json string json details
req.body.receiptLongNo string receipt number
Since:
  • 01/11/2017
Author:
  • Dave
See:
  • [EReceipts]APIInteraction.SendEReceipt.DoRequest
Example
/api/v1/eReceipt{POST}

<route> receiptLookup

Route:
MethodPath
GET /api/v1/eReceipt/lookup
Provides a way of lookup up sales based on the email address
Query Parameters:
Name Type Description
req.query.email string email address
Since:
  • 18/03/2019
Author:
  • Dave
See:
  • [EReceipts]APIInteraction.SendEReceipt.DoRequest
Example
/api/v1/eReceipt/lookup?email=

<route> sendEmails

Route:
MethodPath
GET /api/v1/eReceipt
creates and sends the emails
Since:
  • 08/11/2017
Author:
  • Dave
See:
  • [PaversAPI]controllers\TaskScheduler\eReceiptTaskSchedule.js
Example
/api/v1/eReceipt

<static> sendEmails

stored procedures for interacting with eReceipts
Properties:
Name Type Description
fetchUnsent function
updateEReceipt function
setEReceiptError function
Since:
  • 08/11/2017
Author:
  • Fabio
See:
  • [PaversAPI]controllers\EReceipts\sendEmails.js