Payment Based Reports
This page provides descriptions of payment-related reports that can be downloaded via the endpoints mentioned above. Below report types are only applicable for fleet organizations.
¶ REPORT_TYPE_PAYMENTS_ORDER
The “Payment_Order” report type in the Generate Reports API is a critical tool for suppliers in Fleet sectors, offering payment-related information that is crucial for financial management and analysis. This report type serves as a path parameter in the Generate Report API, allowing users to access essential information related to financial transactions within the system.
Columns
| Column Name | Description |
|---|---|
| Transaction UUID | A unique identifier for each transaction. |
| Driver UUID | A unique identifier for the driver associated with the transaction. |
| Driver FirstName | The first name of the driver. This column provides a personal identifier for the driver involved in the transaction. |
| Driver Surname | The surname (last name) of the driver. This, along with DriverFirstName, helps in fully identifying the driver. |
| Trip UUID | A unique identifier for the trip associated with the transaction. This is important for tracking the origin of financial transactions. |
| Description | A brief description of the transaction. This provides context and details about Trip Completed Order, Fare Adjustment Order, Tip Order, Settlement Order. |
| Organization Name | The name of the organization involved in the transaction. |
| Organization Alias | An alternate name or short form for the organization. |
| Processed At | The timestamp indicates when the transaction was processed. |
| Earnings | The total earnings from the transaction. This column is essential for financial analysis and reporting. |
| Payouts | The amount paid out to the driver or organization. This ensures transparency in the payout process. |
| Cash Collected | The amount of cash collected during the transaction. |
| Transferred to Bank Account | The amount transferred to the driver’s or organization’s bank account. |
| Fare Details | Detailed information about the fare for the trip. This includes fare breakdowns and any applicable charges. |
| Taxes | The amount of taxes applied to the transaction. This is important for understanding the tax implications and total cost of the transaction. |
Note:
- These columns include dynamic fields that may change based on specific conditions.
- Based on location, the columns may vary to include region-specific data.
¶ REPORT_TYPE_PAYMENTS_DRIVER
The “Payment Driver” report type in the Generate API is a crucial tool for managing payment information related to drivers in Fleet operations. This report serves as a comprehensive record of financial transactions and earnings for individual drivers, providing valuable information into their performance and payment status.
Columns
| Column Name | Description |
|---|---|
| Driver UUID | A unique identifier for the driver associated with the trip. This helps in linking the trip to a specific driver. |
| Driver FirstName | The first name of the driver. This column provides a personal identifier for the driver involved in the trip. |
| Driver Surname | The surname (last name) of the driver. |
| Total Earnings | The total earnings accumulated by the driver over the reporting period. |
| Refunds and Expenses | The total amount of refunds processed for the driver. |
| Payouts | The amount paid out to the driver, which might include cash or other forms of compensation. |
| Cash Collected | The total amount of cash collected by the driver. This provides information about cash flow handled by the driver. |
| Fare | Detailed information about the fares earned by the driver, including base fare, distance fare, and any additional charges. |
| Taxes | The amount of taxes applied to the driver’s earnings. |
Note
- These columns include dynamic fields that may change based on specific conditions.
- Based on location, the columns may vary to include region-specific data.
¶ REPORT_TYPE_PAYMENTS_ORGANIZATION
The “Payments Organization” report type within the Generate API is a valuable tool designed specifically for Fleet operations. This report focuses on providing detailed payment information related to organizations, offering insights into financial transactions and earnings for better financial management and decision-making.
Columns
| Column Name | Description |
|---|---|
| Organization UUID | A unique identifier for each organization. |
| Organization Name | The name of the organization. This column provides a clear identifier for the organization involved in the transactions. |
| Organization Alias | An alternate name or short form for the organization. |
| Driver First Name | The first name of the driver associated with the organization. This provides a personal identifier for drivers linked to the organization. |
| Driver Surname | The surname (last name) of the driver. |
| Start Of Period Balance | The balance at the start of the reporting period. |
| End Of Period Balance | The balance at the end of the reporting period. This helps in understanding the financial changes over the period. |
| Total Earnings | The total earnings accumulated by the organization during the reporting period. |
| NetFare | The net fare earned by the organization, excluding any refunds or expenses. This provides a clear picture of the organization’s actual earnings. |
| RefundsAndExpenses | The total amount of refunds and expenses processed for the organization. |
| Payouts | The amount paid out to the driver, which might include cash or other forms of compensation. This helps in tracking all forms of payments made to the driver. |
| Cash Collected | The total amount of cash collected by the driver. This provides information about cash flow handled by the driver. |
| Taxes | The amount of taxes applied to the organization’s earnings. |
Note
- These columns include dynamic fields that may change based on specific conditions.
¶ FAQ
- Can we use Get Transactions API to fetch transaction information similar to payment transaction report?
- Yes, we have the option to utilize this endpoint. However, its primary purpose is to furnish transaction information in real-time. Moreover, this endpoint imposes stringent rate limits and restricts the query time range to 15 minutes with a look-back of 24 hours, as per our internal architecture. Additionally, while the breakdown in the response of this endpoint may lack the granularity found in the Payment Transaction Report, it does offer fundamental transaction information that aligns with the data in the payment transaction report.