pirateship-reports

PirateShip-Reports

A JavaScript class that provides an interface for retrieving and searching a list of reports from the Pirate Ship API.

Usage

To use this class, create an instance and pass in the necessary cookies for making API requests. The class has several methods for searching the reports and retrieving information about them.

Available Public Functions

1. getAllReports: returns all the reports.
2. searchByTransactionType: returns the reports that match the specified transaction type.
3. searchByPaymentId: returns the reports that match the specified payment ID.
4. searchByReportId: returns the reports that match the specified report ID.
5. searchByShipmentId: returns the reports that match the specified shipment ID.
6. searchByReconciliationRunId: returns the reports that match the specified reconciliation run ID.
7. searchByBatchId: returns the reports that match the specified batch ID.
8. searchByTitle: returns the reports that match the specified title.
9. searchByAmount: returns the reports that match the specified amount.
10. searchByBalance: returns the reports that match the specified balance.
11. getReportsOnDate: returns the reports that were created on the specified date.
12. getByTimePeriod: returns the reports that were created within the specified time period (in days).
13. getByDateRange: returns the reports that were created within the specified date range.
14. getReportsSorted: returns the reports sorted by the specified field and in the specified order.
15. getTotalCount: returns the total number of reports.

Author

Waleed Judah