API Documentation
      Back to home
      1. Knowledge Base
      2. API Documentation

      [API Endpoint] Get Client Financials

      Overview

      This API endpoint allows you to obtain a list of invoices for your registered client in PabauCRM.

      Endpoint

      GET /OAuth2/financials/get_financials.php

      Route

      GET /OAuth2/financials/get_financials.php?api_key=your_api_key&company=your_company_id&section=financials

      Parameters

      Below are a list of the attributes you can currently pass into Pabau.

      Our API endpoint expects five parameters:

      • api_key(string)

      • company(int)

      • section(string)

      • user_id(int) - Can be obtained via https://support.pabau.com/knowledge/api-endpoint-employees

      • contact_id(int) - Can be obtained via https://support.pabau.com/knowledge/api-endpoint-get-clients

      Sample response:

      {
        "success": true,
        "total": 24,
        "sales": [
          {
            "id": "26833415",
            "total_amount": "GBP 111.20",
            "purchase_date": "29\/04\/2020",
            "items": "Acne Set"
          }
        ]
      }