Reports Module SDK Documentation

Getting Account Overview Report

Function: get_account_overview()

Purpose

This SDK function retrieves the account overview report within a specified date range and currency. The report provides insights into account activity over time, including key metrics such as net gains, new accounts, cancellations, reactivations, and deletions. It helps administrators and analysts monitor business performance, track account health trends, and evaluate growth or churn within the selected period.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This function is typically used by business intelligence or finance teams to analyze recent account activity and understand how many new accounts were created, how many were cancelled or reactivated, and the overall net gain during a specified period. By setting parameters such as currency and date range, the user can generate a customized overview report that provides quick insights into account performance trends.

                Python
              

                      def get_account_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "{{currency_code}}"
        date_range = "{{date_range}}"
        param_filters = {"currency": currency, "date_range": date_range}
        response = exsited_sdk.reports.get_account_overview(param_filters=param_filters)
        print(response)
    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

                Python
              

                      {
    "report": {
        "accounts": {
            "accountOverview": [
                {
                    "netGain": "{{net_gain_value}}",
                    "new": "{{new_accounts_count}}",
                    "cancelled": "{{cancelled_accounts_count}}",
                    "reactivated": "{{reactivated_accounts_count}}",
                    "deleted": "{{deleted_accounts_count}}",
                    "date": "{{date_1}}"
                },
                {
                    "netGain": "{{net_gain_value}}",
                    "new": "{{new_accounts_count}}",
                    "cancelled": "{{cancelled_accounts_count}}",
                    "reactivated": "{{reactivated_accounts_count}}",
                    "deleted": "{{deleted_accounts_count}}",
                    "date": "{{date_2}}"
                },
                {
                    "netGain": "{{net_gain_value}}",
                    "new": "{{new_accounts_count}}",
                    "cancelled": "{{cancelled_accounts_count}}",
                    "reactivated": "{{reactivated_accounts_count}}",
                    "deleted": "{{deleted_accounts_count}}",
                    "date": "{{date_3}}"
                }
            ]
        }
    }
}

                    

Getting Invoice Overview Report

Function: get_invoice_overview()

Purpose

This API endpoint retrieves an overview summary of invoices within a specified date range and currency. It provides daily aggregated statistics such as total invoice amounts, new invoices, cancelled, reactivated, voided, amended, and net gain counts and amounts. This helps users monitor invoice activity trends and performance over time.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This method is typically used by financial administrators or accountants who need to analyze recent invoice trends in a given currency over a specific date range. For example, a user may want to see all invoice activity (new, cancelled, amended, etc.) for the past week to identify financial patterns or irregularities. The SDK makes it easy to fetch this data programmatically using simple parameters.

                Python
              

                      def get_invoice_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "CURRENCY_CODE"
        date_range = "DATE_RANGE"
        param_filters = {"currency": currency, "date_range": date_range}
        response = exsited_sdk.reports.get_invoice_overview(param_filters=param_filters)
        print(response)
    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

                Python
              

                      InvoiceOverviewResponseDTO(
    report=InvoiceOverviewReportDTO(
        invoices=InvoiceOverviewInvoicesDTO(
            invoiceOverview=[
                InvoiceOverviewEntryDTO(
                    date='DATE_1',
                    invoiceTotal='TOTAL_AMOUNT',
                    new=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    cancelled=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    reactivated=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    voided=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    amended=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    netGain=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT')
                ),
                InvoiceOverviewEntryDTO(
                    date='DATE_2',
                    invoiceTotal='TOTAL_AMOUNT',
                    new=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    cancelled=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    reactivated=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    voided=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    amended=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    netGain=InvoiceOverviewStatDTO(amount='AMOUNT', count='COUNT')
                )
            ]
        )
    )
)

                    

Getting Order Overview Report

Function: get_order_overview()

Purpose

This API endpoint retrieves an overview summary of orders within a specified date range and currency. It provides daily aggregated statistics such as total order amounts, number of new orders, cancelled, reactivated, changed, deleted, and net gain orders. This enables businesses to analyze order trends and overall sales performance across a specific period.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This method is useful for sales and operations teams who need to monitor order activity trends in real time. For example, a user may want to track the daily number and value of new orders, cancellations, or reactivations in the past week to assess sales performance and order lifecycle dynamics. Using the SDK, this information can be easily fetched by providing the desired currency and date range parameters, enabling automated daily reporting and analytics dashboards.

                Python
              

                      def get_order_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "CURRENCY_CODE"
        date_range = "DATE_RANGE"
        param_filters = {"currency": currency, "date_range": date_range}
        response = exsited_sdk.reports.get_order_overview(param_filters=param_filters)
        print(response)
    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

                Python
              

                      OrderOverviewResponseDTO(
    report=OrderOverviewReportDTO(
        orders=OrderOverviewOrdersDTO(
            orderOverview=[
                OrderOverviewEntryDTO(
                    date='DATE_1',
                    orderTotal='TOTAL_AMOUNT',
                    new=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    cancelled=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    reactivated=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    changed=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    deleted=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    netGain=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT')
                ),
                OrderOverviewEntryDTO(
                    date='DATE_2',
                    orderTotal='TOTAL_AMOUNT',
                    new=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    cancelled=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    reactivated=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    changed=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    deleted=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    netGain=OrderOverviewStatDTO(amount='AMOUNT', count='COUNT')
                )
            ]
        )
    )
)

                    

Getting Purchase Invoice Overview Report

Function: get_purchase_invoice_overview()

Purpose

This API endpoint retrieves a summary report of purchase invoices for a specified date range and currency. It provides day-wise aggregated data on the total purchase invoice value and the number of invoices that were created, cancelled, reactivated, voided, amended, and the net gain within the selected period. This helps procurement and finance teams analyze supplier invoice activity and monitor trends in expenditure and invoice processing performance.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This method is ideal for finance and procurement departments that want to analyze supplier billing activity over a specific time frame. For instance, a company might want to understand how many new purchase invoices were generated and how many were cancelled or amended in the past week. By providing the currency and date range parameters, users can fetch detailed statistics for daily invoice activities and identify trends in purchase behavior. This helps in improving financial visibility, monitoring vendor performance, and identifying any anomalies in invoice management.

                Python
              

                      def get_purchase_invoice_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "CURRENCY_CODE"
        date_range = "DATE_RANGE"
        param_filters = {"currency": currency, "date_range": date_range}
        response = exsited_sdk.reports.get_purchase_invoice_overview(param_filters=param_filters)
        print(response)
    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

                Python
              

                      PurchaseInvoicesOverviewResponseDTO(
    report=PurchaseInvoicesOverviewReportDTO(
        purchaseInvoices=PurchaseInvoicesOverviewInvoicesDTO(
            purchaseInvoiceOverview=[
                PurchaseInvoicesOverviewEntryDTO(
                    date='DATE_1',
                    purchaseInvoiceTotal='TOTAL_AMOUNT',
                    new=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    cancelled=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    reactivated=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    voided=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    amended=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    netGain=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT')
                ),
                PurchaseInvoicesOverviewEntryDTO(
                    date='DATE_2',
                    purchaseInvoiceTotal='TOTAL_AMOUNT',
                    new=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    cancelled=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    reactivated=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    voided=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    amended=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT'),
                    netGain=PurchaseInvoicesOverviewStatDTO(amount='AMOUNT', count='COUNT')
                )
            ]
        )
    )
)

                    

Getting Purchase Order Overview Report

Function: get_purchase_order_overview()

Purpose

This SDK function retrieves a summarized overview of purchase orders within a specified date range and currency. It provides insights into the total purchase orders, newly created orders, cancelled, reactivated, changed, deleted orders, and net purchases for each date in the given period. This endpoint is primarily used for generating analytical reports and dashboards that help in monitoring purchase order trends and business purchasing performance over time.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This SDK method is used when the user needs to analyze purchase order trends over a specific period, categorized by daily summaries. For instance, a purchasing manager may wish to generate an overview report for the last seven days in Australian Dollars (AUD) to monitor how many new purchase orders were created, cancelled, or modified, and to view their total and net purchase values. The overview helps in identifying operational efficiency, supplier engagement trends, and financial movements in procurement activities.

                Python
              

                      def get_purchase_order_report_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "CURRENCY_CODE"
        date_range = "DATE_RANGE"
        param_filters = {"currency": currency, "date_range": date_range}

        response = exsited_sdk.reports.purchase_order_report_overview(param_filters=param_filters)
        print(response)

    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

                JSON
              

                      PurchaseOrderReportResponseDTO(
    report=PurchaseOrderReportDTO(
        purchaseOrders=PurchaseOrderOverviewDTO(
            purchaseOrderOverview=[
                PurchaseOrderEntryDTO(
                    date="DATE_PLACEHOLDER",
                    purchaseOrderTotal="TOTAL_AMOUNT_PLACEHOLDER",
                    new=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    cancelled=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    reactivated=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    changed=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    deleted=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    netPurchases=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER")
                ),
                ...
            ]
        )
    )
)

                    

Getting Payment and Refund Overview Report

Function: get_payment_and_refund_overview()

Purpose

This SDK function retrieves a summarized overview of payments and refunds within a specified date range and currency. It provides aggregated financial insights by showing daily totals of new and deleted payments and refunds, as well as the total payment amount applied on each date. This endpoint helps finance and accounting teams analyze transaction flow, monitor refund trends, and assess overall payment activity over time.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This SDK method is used to generate a financial summary of payment and refund activities over a defined time period. For example, an accounting manager might want to retrieve an overview report for the last seven days to see how many payments were received, how much total amount was applied, and whether any refunds were issued or deleted. This report is particularly useful for tracking daily transaction patterns, validating cash flow, and identifying anomalies or changes in payment behavior.

                Python
              

                      def payment_and_refund_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "CURRENCY_CODE"
        date_range = "DATE_RANGE"
        param_filters = {"currency": currency, "date_range": date_range}

        response = exsited_sdk.reports.payment_and_refund_report_overview(param_filters=param_filters)
        print(response)

    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

                Python
              

                      PaymentAndRefundReportResponseDTO(
    report=PaymentAndRefundReportDTO(
        paymentAndRefundOverview=PaymentAndRefundOverviewDTO(
            payments=[
                PaymentEntryDTO(
                    date="DATE_PLACEHOLDER",
                    paymentApplied="PAYMENT_AMOUNT_PLACEHOLDER",
                    new=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    deleted=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER")
                ),
                ...
            ],
            refunds=[
                RefundEntryDTO(
                    date="DATE_PLACEHOLDER",
                    new=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    deleted=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER")
                ),
                ...
            ]
        )
    )
)

                    

Getting Purchase Payment and Refund Overview Report

Function: get_purchase_payment_and_refund_overview()

Purpose

This SDK function retrieves a summarized overview of all purchase-related payments and refunds for a specified date range and currency. It provides aggregated data showing the total purchase payments applied each day, along with the counts and amounts of newly created and deleted purchase payments and refunds. This endpoint helps procurement and finance teams to monitor supplier payment trends, track refund activities, and analyze the overall cash outflow pattern associated with purchase transactions.

Parameters

Parameter	Type	Description
currency	string	The currency code (example: “AUD”, “USD”) used to filter the report data.
date_range	string	The range of dates for which to retrieve the report (example: “LAST_7_DAYS”, “LAST_30_DAYS”, “CUSTOM”).

Use Case

This SDK method is used when financial teams need to analyze purchase-related financial activities such as payments made to suppliers and any refunds received or processed within a defined time window. For example, an accounts payable officer might use this report to track supplier payments for the last week, reviewing how much was paid out, how many transactions were created or deleted, and whether any refunds were processed during the same period. This information supports better financial planning, supplier reconciliation, and auditing of outgoing funds.

                Python
              

                      def purchase_payment_and_refund_overview():
    SDKConfig.PRINT_REQUEST_DATA = True
    SDKConfig.PRINT_RAW_RESPONSE = False

    token_file_path = "shared_token.json"
    file_token_mgr = FileTokenManager(token_file_path)

    exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
        request_token_dto=CommonData.get_request_token_dto(),
        file_token_mgr=file_token_mgr
    )

    try:
        currency = "CURRENCY_CODE"
        date_range = "DATE_RANGE"
        param_filters = {"currency": currency, "date_range": date_range}

        response = exsited_sdk.reports.purchase_payment_and_refund_report_overview(param_filters=param_filters)
        print(response)

    except ABException as ab:
        print(ab)
        print(ab.get_errors())
        print(ab.raw_response)

                    

Response

The response returns an aggregated daily breakdown of purchase payments and refunds. Each record includes the date, total payment amount applied, and statistical data representing new and deleted purchase payments as well as refunds. This data enables users to visualize financial outflows toward suppliers and track refund movements to maintain financial accuracy and compliance. It is particularly valuable for generating weekly or monthly payment analysis reports and validating the integrity of purchase transaction records.

                Python
              

                      PurchasePaymentAndRefundReportResponseDTO(
    report=PurchasePaymentAndRefundReportDTO(
        purchasePaymentAndRefundOverview=PurchasePaymentAndRefundOverviewDTO(
            purchasePayments=[
                PurchasePaymentEntryDTO(
                    date="DATE_PLACEHOLDER",
                    purchasePaymentApplied="AMOUNT_PLACEHOLDER",
                    new=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    deleted=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER")
                ),
                ...
            ],
            purchaseRefunds=[
                PurchaseRefundEntryDTO(
                    date="DATE_PLACEHOLDER",
                    new=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER"),
                    deleted=AmountCountDTO(amount="AMOUNT_PLACEHOLDER", count="COUNT_PLACEHOLDER")
                ),
                ...
            ]
        )
    )
)

                    