Reports GET API Documentation

Purpose

This API retrieves an overview of account-related statistics for a specified date range and currency. It provides summarized daily metrics, including the number of new accounts, cancelled accounts, reactivated accounts, deleted accounts, and the net gain for each day.

Use Case

Businesses use this API to analyze account trends and performance over time. For example, a system administrator or financial analyst can generate a weekly or monthly overview to track new registrations, cancellations, and reactivations, helping to evaluate account retention, growth, and churn patterns within the organization.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
date_range	String	Specifies the date range for which the report should be generated.
currency	String	The currency code in which the account overview data is represented.

Request Body

No request body is required for this endpoint.

Response

The response returns a structured report containing account overview data grouped by date. Each record provides daily statistics, including total new, cancelled, reactivated, and deleted accounts, along with the net gain (calculated as the difference between new and cancelled accounts). This enables tracking of account changes over the specified time range, helping organizations understand trends in account activity and overall customer engagement.

Response Body

                JSON
              

                      {
  "report": {
    "accounts": {
      "account_overview": [
        {
          "net_gain": "<NET_GAIN>",
          "new": "<NEW_ACCOUNTS>",
          "cancelled": "<CANCELLED_ACCOUNTS>",
          "reactivated": "<REACTIVATED_ACCOUNTS>",
          "deleted": "<DELETED_ACCOUNTS>",
          "date": "<DATE>"
        }
      ]
    }
  }
}

                    

Attribute	Type	Description
report	Object	Contains the overall report data.
report.accounts	Object	Holds account-related report sections.
report.accounts.account_overview	Array	List of account overview records by date.
report.accounts.account_overview.net_gain	String	Net gain in account count (new minus cancelled) for the specified date.
report.accounts.account_overview.new	String	Number of newly created accounts for the specified date.
report.accounts.account_overview.cancelled	String	Number of accounts cancelled on the specified date.
report.accounts.account_overview.reactivated	String	Number of previously cancelled accounts reactivated on the specified date.
report.accounts.account_overview.deleted	String	Number of accounts permanently deleted on the specified date.
report.accounts.account_overview.date	String	The date for which the account statistics apply.

Purpose

This API retrieves summarized order statistics within a given date range and currency. It provides a daily overview of order activities, including total orders, new orders, cancelled orders, reactivated orders, changed orders, deleted orders, and the resulting net gain in order count and value.

Use Case

This endpoint is used by business analysts, sales teams, or administrators to monitor daily order performance and activity trends. By analyzing the metrics, teams can identify fluctuations in order volume, cancellations, and reactivations, which helps in forecasting sales performance and optimizing order management operations over specific reporting periods.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
currency	String	The currency code for which the report should be generated.
date_range	String	The date range for which the report should be fetched.

Request Body

No request body is required for this endpoint.

Response

The response provides a detailed order overview for each day within the specified date range. For each date, it shows the total order value and various categorized counts such as new, cancelled, reactivated, changed, and deleted orders. Each category also includes both the count and total monetary value (amount). Additionally, the net gain section summarizes the daily difference between new and cancelled orders, providing a snapshot of order flow and growth trends over time.

Response Body

                JSON
              

                      {
  "report": {
    "orders": {
      "order_overview": [
        {
          "date": "<DATE>",
          "order_total": "<ORDER_TOTAL>",
          "new": {
            "amount": "<NEW_ORDER_AMOUNT>",
            "count": "<NEW_ORDER_COUNT>"
          },
          "cancelled": {
            "amount": "<CANCELLED_ORDER_AMOUNT>",
            "count": "<CANCELLED_ORDER_COUNT>"
          },
          "reactivated": {
            "amount": "<REACTIVATED_ORDER_AMOUNT>",
            "count": "<REACTIVATED_ORDER_COUNT>"
          },
          "changed": {
            "amount": "<CHANGED_ORDER_AMOUNT>",
            "count": "<CHANGED_ORDER_COUNT>"
          },
          "deleted": {
            "amount": "<DELETED_ORDER_AMOUNT>",
            "count": "<DELETED_ORDER_COUNT>"
          },
          "net_gain": {
            "amount": "<NET_GAIN_AMOUNT>",
            "count": "<NET_GAIN_COUNT>"
          }
        }
      ]
    }
  }
}

                    

Attribute	Type	Description
report	Object	Contains the full report data.
report.orders	Object	Contains order-related report sections.
report.orders.order_overview	Array	List of order overview records, each representing a specific date.
report.orders.order_overview.date	String	The date for which order data is summarized.
report.orders.order_overview.order_total	String	The total value of all orders for the specified date.
report.orders.order_overview.new	Object	Contains metrics for newly created orders.
report.orders.order_overview.new.amount	String	The total monetary value of new orders for the date.
report.orders.order_overview.new.count	String	The number of new orders created on the date.
report.orders.order_overview.cancelled	Object	Contains metrics for cancelled orders.
report.orders.order_overview.cancelled.amount	String	The total value of cancelled orders.
report.orders.order_overview.cancelled.count	String	The number of cancelled orders.
report.orders.order_overview.reactivated	Object	Contains metrics for reactivated orders.
report.orders.order_overview.reactivated.amount	String	The total value of reactivated orders.
report.orders.order_overview.reactivated.count	String	The number of reactivated orders.
report.orders.order_overview.changed	Object	Contains metrics for modified orders.
report.orders.order_overview.changed.amount	String	The total value of changed orders.
report.orders.order_overview.changed.count	String	The number of changed orders.
report.orders.order_overview.deleted	Object	Contains metrics for deleted orders.
report.orders.order_overview.deleted.amount	String	The total value of deleted orders.
report.orders.order_overview.deleted.count	String	The number of deleted orders.
report.orders.order_overview.net_gain	Object	Contains daily net gain information.
report.orders.order_overview.net_gain.amount	String	The net monetary gain (difference between new and cancelled order amounts).
report.orders.order_overview.net_gain.count	String	The net order count gain (difference between new and cancelled order counts).

Purpose

This API retrieves a summarized invoice overview report within a specified date range and currency. It provides daily breakdowns of invoice totals and categorized counts for various invoice statuses, such as new, cancelled, reactivated, voided, amended, and net gains.

Use Case

This API is used to generate invoice performance analytics for a given time period. It helps finance teams and administrators monitor invoice trends, track cancellations or amendments, and measure net revenue changes. For instance, a business may use this endpoint to analyze invoice activity for the past week or month filtered by a specific currency.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
date_range	String	Specifies the date range for which the report should be generated.
currency	String	The currency code in which the account overview data is represented.

Request Body

No request body is required for this endpoint.

Response

The response contains an invoice report object, which includes an array of daily invoice overview summaries. Each summary provides the total amount of invoices for that date and the breakdown of invoice activities by status — such as new, cancelled, reactivated, voided, amended, and net gain with their respective amounts and counts.

Response Body

                JSON
              

                      {
    "report": {
        "invoices": {
            "invoice_overview": [
                {
                    "date": "DATE",
                    "invoice_total": "INVOICE_TOTAL_AMOUNT",
                    "new": {
                        "amount": "NEW_INVOICE_AMOUNT",
                        "count": "NEW_INVOICE_COUNT"
                    },
                    "cancelled": {
                        "amount": "CANCELLED_INVOICE_AMOUNT",
                        "count": "CANCELLED_INVOICE_COUNT"
                    },
                    "reactivated": {
                        "amount": "REACTIVATED_INVOICE_AMOUNT",
                        "count": "REACTIVATED_INVOICE_COUNT"
                    },
                    "voided": {
                        "amount": "VOIDED_INVOICE_AMOUNT",
                        "count": "VOIDED_INVOICE_COUNT"
                    },
                    "amended": {
                        "amount": "AMENDED_INVOICE_AMOUNT",
                        "count": "AMENDED_INVOICE_COUNT"
                    },
                    "net_gain": {
                        "amount": "NET_GAIN_AMOUNT",
                        "count": "NET_GAIN_COUNT"
                    }
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
report	object	The parent container for the report data.
report.invoices	object	Contains invoice-related report data.
report.invoices.invoice_overview	array	A list of daily summaries showing invoice activities for each date.
report.invoices.invoice_overview[].date	string	The date of the report entry (in YYYY-MM-DD format).
report.invoices.invoice_overview[].invoice_total	string	The total amount of all invoices for the given date.
report.invoices.invoice_overview[].new	object	Summary of newly created invoices for the given date.
report.invoices.invoice_overview[].new.amount	string	Total amount of new invoices.
report.invoices.invoice_overview[].new.count	string	Number of new invoices created.
report.invoices.invoice_overview[].cancelled	object	Summary of cancelled invoices for the given date.
report.invoices.invoice_overview[].cancelled.amount	string	Total amount of cancelled invoices.
report.invoices.invoice_overview[].cancelled.count	string	Number of cancelled invoices.
report.invoices.invoice_overview[].reactivated	object	Summary of reactivated invoices for the given date.
report.invoices.invoice_overview[].reactivated.amount	string	Total amount of reactivated invoices.
report.invoices.invoice_overview[].reactivated.count	string	Number of reactivated invoices.
report.invoices.invoice_overview[].voided	object	Summary of voided invoices for the given date.
report.invoices.invoice_overview[].voided.amount	string	Total amount of voided invoices.
report.invoices.invoice_overview[].voided.count	string	Number of voided invoices.
report.invoices.invoice_overview[].amended	object	Summary of amended invoices for the given date.
report.invoices.invoice_overview[].amended.amount	string	Total amount of amended invoices.
report.invoices.invoice_overview[].amended.count	string	Number of amended invoices.
report.invoices.invoice_overview[].net_gain	object	Summary of net gain (new - cancelled + reactivated - voided + amended) for the given date.
report.invoices.invoice_overview[].net_gain.amount	string	Total net gain amount for the date.
report.invoices.invoice_overview[].net_gain.count	string	Net number of invoice transactions impacting the total.

Purpose

This API retrieves a summarized overview report of purchase invoices within a specified date range and currency. It provides daily breakdowns of purchase invoice totals and categorized metrics based on status, including new, cancelled, reactivated, voided, amended, and net gain.

Use Case

This API is primarily used by finance, procurement, or accounting teams to analyze supplier invoice trends over a specific period. It allows users to identify fluctuations in purchase invoices, such as newly created, cancelled, or amended invoices, helping organizations monitor supplier expenses, manage cash flow, and assess overall purchasing activity.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
date_range	String	Specifies the date range for which the report should be generated.
currency	String	The currency code in which the account overview data is represented.

Request Body

No request body is required for this endpoint.

Response

The response returns a structured report containing daily summaries of purchase invoice activities. Each entry includes the total purchase invoice amount for that day, as well as detailed metrics for different invoice statuses such as new, cancelled, reactivated, voided, amended, and net gain. These metrics include both the total monetary value (amount) and the number of occurrences (count) per category, allowing users to evaluate supplier billing performance over time.

Response Body

                JSON
              

                      {
    "report": {
        "purchase_invoices": {
            "purchase_invoice_overview": [
                {
                    "date": "DATE",
                    "purchase_invoice_total": "PURCHASE_INVOICE_TOTAL_AMOUNT",
                    "new": {
                        "amount": "NEW_PURCHASE_INVOICE_AMOUNT",
                        "count": "NEW_PURCHASE_INVOICE_COUNT"
                    },
                    "cancelled": {
                        "amount": "CANCELLED_PURCHASE_INVOICE_AMOUNT",
                        "count": "CANCELLED_PURCHASE_INVOICE_COUNT"
                    },
                    "reactivated": {
                        "amount": "REACTIVATED_PURCHASE_INVOICE_AMOUNT",
                        "count": "REACTIVATED_PURCHASE_INVOICE_COUNT"
                    },
                    "voided": {
                        "amount": "VOIDED_PURCHASE_INVOICE_AMOUNT",
                        "count": "VOIDED_PURCHASE_INVOICE_COUNT"
                    },
                    "amended": {
                        "amount": "AMENDED_PURCHASE_INVOICE_AMOUNT",
                        "count": "AMENDED_PURCHASE_INVOICE_COUNT"
                    },
                    "net_gain": {
                        "amount": "NET_GAIN_AMOUNT",
                        "count": "NET_GAIN_COUNT"
                    }
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
report	object	The root object containing report data.
report.purchase_invoices	object	Holds all purchase invoice report information.
report.purchase_invoices.purchase_invoice_overview	array	A list of daily summaries showing purchase invoice data for each date.
report.purchase_invoices.purchase_invoice_overview[].date	string	The date of the report entry (in YYYY-MM-DD format).
report.purchase_invoices.purchase_invoice_overview[].purchase_invoice_total	string	The total amount of all purchase invoices recorded for that date.
report.purchase_invoices.purchase_invoice_overview[].new	object	Summary of newly created purchase invoices for that date.
report.purchase_invoices.purchase_invoice_overview[].new.amount	string	Total amount of new purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].new.count	string	Number of new purchase invoices created.
report.purchase_invoices.purchase_invoice_overview[].cancelled	object	Summary of cancelled purchase invoices for that date.
report.purchase_invoices.purchase_invoice_overview[].cancelled.amount	string	Total amount of cancelled purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].cancelled.count	string	Number of cancelled purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].reactivated	object	Summary of reactivated purchase invoices for that date.
report.purchase_invoices.purchase_invoice_overview[].reactivated.amount	string	Total amount of reactivated purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].reactivated.count	string	Number of reactivated purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].voided	object	Summary of voided purchase invoices for that date.
report.purchase_invoices.purchase_invoice_overview[].voided.amount	string	Total amount of voided purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].voided.count	string	Number of voided purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].amended	object	Summary of amended purchase invoices for that date.
report.purchase_invoices.purchase_invoice_overview[].amended.amount	string	Total amount of amended purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].amended.count	string	Number of amended purchase invoices.
report.purchase_invoices.purchase_invoice_overview[].net_gain	object	Summary of the net gain (new - cancelled + reactivated - voided + amended) for that date.
report.purchase_invoices.purchase_invoice_overview[].net_gain.amount	string	Total net gain amount for the date.
report.purchase_invoices.purchase_invoice_overview[].net_gain.count	string	Net count of purchase invoice transactions impacting the total.

Purpose

This API provides a summarized daily overview of purchase orders within a defined date range and currency. It returns metrics for total purchase orders, as well as categorized statistics (new, cancelled, reactivated, changed, deleted, and net purchases). This report helps track purchase activity and supplier order trends over time.

Use Case

This endpoint is commonly used by procurement, inventory, and finance teams to analyze purchasing performance over a specific period. It allows users to monitor supplier order volumes, track cancellations or changes in orders, and calculate the overall net purchases. By integrating this data into dashboards or analytics reports, organizations can make informed purchasing decisions and optimize supplier relationships.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
date_range	String	Specifies the date range for which the report should be generated.
currency	String	The currency code in which the account overview data is represented.

Request Body

No request body is required for this endpoint.

Response

The response provides a detailed summary of purchase orders categorized by date. For each day, it includes the total value of purchase orders created, as well as separate sections for new, cancelled, reactivated, changed, deleted, and net purchase transactions. Each category contains both amount (monetary value) and count (number of transactions). This allows the user to understand how purchasing activities evolve daily and identify trends in procurement behavior across time periods.

Response Body

                JSON
              

                      {
    "report": {
        "purchase_orders": {
            "purchase_order_overview": [
                {
                    "date": "DATE",
                    "purchase_order_total": "PURCHASE_ORDER_TOTAL_AMOUNT",
                    "new": {
                        "amount": "NEW_PURCHASE_ORDER_AMOUNT",
                        "count": "NEW_PURCHASE_ORDER_COUNT"
                    },
                    "cancelled": {
                        "amount": "CANCELLED_PURCHASE_ORDER_AMOUNT",
                        "count": "CANCELLED_PURCHASE_ORDER_COUNT"
                    },
                    "reactivated": {
                        "amount": "REACTIVATED_PURCHASE_ORDER_AMOUNT",
                        "count": "REACTIVATED_PURCHASE_ORDER_COUNT"
                    },
                    "changed": {
                        "amount": "CHANGED_PURCHASE_ORDER_AMOUNT",
                        "count": "CHANGED_PURCHASE_ORDER_COUNT"
                    },
                    "deleted": {
                        "amount": "DELETED_PURCHASE_ORDER_AMOUNT",
                        "count": "DELETED_PURCHASE_ORDER_COUNT"
                    },
                    "net_purchases": {
                        "amount": "NET_PURCHASES_AMOUNT",
                        "count": "NET_PURCHASES_COUNT"
                    }
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
report	object	The root container holding the report data.
report.purchase_orders	object	Contains purchase order-related reporting information.
report.purchase_orders.purchase_order_overview	array	List of daily summaries for purchase order activities.
report.purchase_orders.purchase_order_overview[].date	string	The date of the summarized data (in YYYY-MM-DD format).
report.purchase_orders.purchase_order_overview[].purchase_order_total	string	The total value of all purchase orders recorded for that day.
report.purchase_orders.purchase_order_overview[].new	object	Summary of newly created purchase orders for that day.
report.purchase_orders.purchase_order_overview[].new.amount	string	Total amount of new purchase orders.
report.purchase_orders.purchase_order_overview[].new.count	string	Number of new purchase orders created.
report.purchase_orders.purchase_order_overview[].cancelled	object	Summary of cancelled purchase orders for that day.
report.purchase_orders.purchase_order_overview[].cancelled.amount	string	Total amount of cancelled purchase orders.
report.purchase_orders.purchase_order_overview[].cancelled.count	string	Number of cancelled purchase orders.
report.purchase_orders.purchase_order_overview[].reactivated	object	Summary of reactivated purchase orders for that day.
report.purchase_orders.purchase_order_overview[].reactivated.amount	string	Total amount of reactivated purchase orders.
report.purchase_orders.purchase_order_overview[].reactivated.count	string	Number of reactivated purchase orders.
report.purchase_orders.purchase_order_overview[].changed	object	Summary of changed purchase orders for that day.
report.purchase_orders.purchase_order_overview[].changed.amount	string	Total amount of changed purchase orders.
report.purchase_orders.purchase_order_overview[].changed.count	string	Number of changed purchase orders.
report.purchase_orders.purchase_order_overview[].deleted	object	Summary of deleted purchase orders for that day.
report.purchase_orders.purchase_order_overview[].deleted.amount	string	Total amount of deleted purchase orders.
report.purchase_orders.purchase_order_overview[].deleted.count	string	Number of deleted purchase orders.
report.purchase_orders.purchase_order_overview[].net_purchases	object	Summary of net purchases for that day after accounting for all changes.
report.purchase_orders.purchase_order_overview[].net_purchases.amount	string	Net total amount of purchase orders after adjustments.
report.purchase_orders.purchase_order_overview[].net_purchases.count	string	Net number of purchase orders after adjustments.

Purpose

This API retrieves an overview report of payments and refunds within a specified date range and currency. It provides a summary of new, deleted, and applied transactions for each day, helping users analyze payment and refund trends over a given period.

Use Case

This endpoint is useful for finance or accounting teams who need to monitor daily payment inflows and refund outflows. It helps in tracking transaction volume, identifying anomalies, and evaluating overall cash movement trends over a defined date range.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
date_range	String	Specifies the date range for which the report should be generated.
currency	String	The currency code in which the account overview data is represented.

Request Body

No request body is required for this endpoint.

Response

The response contains a report object that includes two main sections — payments and refunds. Each section lists daily transaction summaries within the requested date range. The payments array provides information about total payments applied, newly created payments, and deleted payments per day. The refunds array lists the daily summary of new and deleted refunds. This enables users to analyze transaction patterns and financial activities over time.

Response Body

                JSON
              

                      {
    "report": {
        "payment_and_refund_overview": {
            "payments": [
                {
                    "date": "DATE",
                    "payment_applied": "PAYMENT_APPLIED_AMOUNT",
                    "new": {
                        "amount": "NEW_PAYMENT_AMOUNT",
                        "count": "NEW_PAYMENT_COUNT"
                    },
                    "deleted": {
                        "amount": "DELETED_PAYMENT_AMOUNT",
                        "count": "DELETED_PAYMENT_COUNT"
                    }
                }
            ],
            "refunds": [
                {
                    "date": "DATE",
                    "new": {
                        "amount": "NEW_REFUND_AMOUNT",
                        "count": "NEW_REFUND_COUNT"
                    },
                    "deleted": {
                        "amount": "DELETED_REFUND_AMOUNT",
                        "count": "DELETED_REFUND_COUNT"
                    }
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
report	object	The root object containing the report data.
report.payment_and_refund_overview	object	Contains both payment and refund overview sections.
report.payment_and_refund_overview.payments	array	List of daily summaries for payments within the date range.
report.payment_and_refund_overview.payments.date	string	The date for the payment summary (format: YYYY-MM-DD).
report.payment_and_refund_overview.payments.payment_applied	string	Total amount of payments applied on that date.
report.payment_and_refund_overview.payments.new	object	Details of newly created payments for that date.
report.payment_and_refund_overview.payments.new.amount	string	Total amount of new payments created on that date.
report.payment_and_refund_overview.payments.new.count	string	Number of new payment transactions created on that date.
report.payment_and_refund_overview.payments.deleted	object	Details of deleted payments for that date.
report.payment_and_refund_overview.payments.deleted.amount	string	Total amount of deleted payments on that date.
report.payment_and_refund_overview.payments.deleted.count	string	Number of deleted payment transactions on that date.
report.payment_and_refund_overview.refunds	array	List of daily summaries for refunds within the date range.
report.payment_and_refund_overview.refunds.date	string	The date for the refund summary (format: YYYY-MM-DD).
report.payment_and_refund_overview.refunds.new	object	Details of newly created refunds for that date.
report.payment_and_refund_overview.refunds.new.amount	string	Total amount of new refunds created on that date.
report.payment_and_refund_overview.refunds.new.count	string	Number of new refund transactions created on that date.
report.payment_and_refund_overview.refunds.deleted	object	Details of deleted refunds for that date.
report.payment_and_refund_overview.refunds.deleted.amount	string	Total amount of deleted refunds on that date.
report.payment_and_refund_overview.refunds.deleted.count	string	Number of deleted refund transactions on that date.

Purpose

This API retrieves an overview report of purchase-related payments and refunds for a specified date range and currency. It provides summarized data of daily purchase payments and refunds, including new, deleted, and applied amounts. This helps users track and analyze vendor payment activities and refund trends within a selected period.

Use Case

This endpoint is primarily used by finance and procurement teams to review daily purchase payment and refund activities. It helps in monitoring cash flow related to supplier transactions, identifying unusual payment behaviors, and managing vendor refund patterns effectively.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
date_range	String	Specifies the date range for which the report should be generated.
currency	String	The currency code in which the account overview data is represented.

Request Body

No request body is required for this endpoint.

Response

The response provides a report object containing two main sections — purchase_payments and purchase_refunds. The purchase_payments section lists daily summaries showing total applied purchase payments, newly created payments, and deleted payments. The purchase_refunds section provides daily summaries for new and deleted refunds. This data helps visualize vendor-related financial transactions and cash flow patterns over the selected reporting period.

Response Body

                JSON
              

                      {
    "report": {
        "purchase_payment_and_refund_overview": {
            "purchase_payments": [
                {
                    "date": "DATE",
                    "purchase_payment_applied": "PURCHASE_PAYMENT_APPLIED_AMOUNT",
                    "new": {
                        "amount": "NEW_PURCHASE_PAYMENT_AMOUNT",
                        "count": "NEW_PURCHASE_PAYMENT_COUNT"
                    },
                    "deleted": {
                        "amount": "DELETED_PURCHASE_PAYMENT_AMOUNT",
                        "count": "DELETED_PURCHASE_PAYMENT_COUNT"
                    }
                }
            ],
            "purchase_refunds": [
                {
                    "date": "DATE",
                    "new": {
                        "amount": "NEW_PURCHASE_REFUND_AMOUNT",
                        "count": "NEW_PURCHASE_REFUND_COUNT"
                    },
                    "deleted": {
                        "amount": "DELETED_PURCHASE_REFUND_AMOUNT",
                        "count": "DELETED_PURCHASE_REFUND_COUNT"
                    }
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
report	object	The root object containing the report data.
report.purchase_payment_and_refund_overview	object	Contains both purchase payment and refund overview sections.
report.purchase_payment_and_refund_overview.purchase_payments	array	List of daily summaries for purchase payments within the specified date range.
report.purchase_payment_and_refund_overview.purchase_payments.date	string	The date of the purchase payment summary (format: YYYY-MM-DD).
report.purchase_payment_and_refund_overview.purchase_payments.purchase_payment_applied	string	Total amount of purchase payments applied on that date.
report.purchase_payment_and_refund_overview.purchase_payments.new	object	Details of newly created purchase payments for that date.
report.purchase_payment_and_refund_overview.purchase_payments.new.amount	string	Total amount of new purchase payments created on that date.
report.purchase_payment_and_refund_overview.purchase_payments.new.count	string	Number of new purchase payment transactions created on that date.
report.purchase_payment_and_refund_overview.purchase_payments.deleted	object	Details of deleted purchase payments for that date.
report.purchase_payment_and_refund_overview.purchase_payments.deleted.amount	string	Total amount of deleted purchase payments on that date.
report.purchase_payment_and_refund_overview.purchase_payments.deleted.count	string	Number of deleted purchase payment transactions on that date.
report.purchase_payment_and_refund_overview.purchase_refunds	array	List of daily summaries for purchase refunds within the date range.
report.purchase_payment_and_refund_overview.purchase_refunds.date	string	The date of the purchase refund summary (format: YYYY-MM-DD).
report.purchase_payment_and_refund_overview.purchase_refunds.new	object	Details of newly created purchase refunds for that date.
report.purchase_payment_and_refund_overview.purchase_refunds.new.amount	string	Total amount of new purchase refunds created on that date.
report.purchase_payment_and_refund_overview.purchase_refunds.new.count	string	Number of new purchase refund transactions created on that date.
report.purchase_payment_and_refund_overview.purchase_refunds.deleted	object	Details of deleted purchase refunds for that date.
report.purchase_payment_and_refund_overview.purchase_refunds.deleted.amount	string	Total amount of deleted purchase refunds on that date.
report.purchase_payment_and_refund_overview.purchase_refunds.deleted.count	string	Number of deleted purchase refund transactions on that date.

Retrieve Account Report: /reports/accounts/account_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Order Report: /reports/orders/order_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Invoice Report: /reports/invoices/invoice_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Invoice Report: /reports/purchase_invoices/purchase_invoice_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Order Report: /reports/purchase_orders/purchase_order_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Payments Report: /reports/transactions/payment_and_refund_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Payments Report: /reports/purchase_transactions/purchase_payment_and_refund_overview

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body