GET
/
api
/
reports
/
receivable-aging-summary
{
  "query": {
    "as_date": "2025-06-30",
    "aging_days_before": 30,
    "aging_periods": 3,
    "number_format": {
      "divide_on1000": false,
      "negative_format": "mines",
      "show_zero": false,
      "format_money": "total",
      "precision": 2
    },
    "customers_ids": [],
    "branches_ids": [],
    "none_zero": false
  },
  "columns": [
    {
      "from_period": "2025-06-30",
      "to_period": "2025-05-31",
      "before_days": 0,
      "to_days": 30
    },
    {
      "from_period": "2025-05-31",
      "to_period": "2025-05-01",
      "before_days": 31,
      "to_days": 60
    },
    {
      "from_period": "2025-05-01",
      "to_period": null,
      "before_days": 61,
      "to_days": null
    }
  ],
  "data": {
    "customers": [
      {
        "customer_name": "business",
        "current": {
          "amount": 0,
          "formatted_amount": ""
        },
        "aging": [
          {
            "from_period": "2025-06-30",
            "to_period": "2025-05-31",
            "before_days": 0,
            "to_days": 30,
            "total": {
              "amount": 5000,
              "formatted_amount": "5,000.00"
            }
          },
          {
            "from_period": "2025-05-31",
            "to_period": "2025-05-01",
            "before_days": 31,
            "to_days": 60,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-01",
            "to_period": null,
            "before_days": 61,
            "to_days": null,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          }
        ],
        "total": {
          "amount": 5000,
          "formatted_amount": "$5,000.00"
        }
      },
      {
        "customer_name": "business",
        "current": {
          "amount": 0,
          "formatted_amount": ""
        },
        "aging": [
          {
            "from_period": "2025-06-30",
            "to_period": "2025-05-31",
            "before_days": 0,
            "to_days": 30,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-31",
            "to_period": "2025-05-01",
            "before_days": 31,
            "to_days": 60,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-01",
            "to_period": null,
            "before_days": 61,
            "to_days": null,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          }
        ],
        "total": {
          "amount": 0,
          "formatted_amount": "$0.00"
        }
      },
      {
        "customer_name": "asdsadasd, asd",
        "current": {
          "amount": 0,
          "formatted_amount": ""
        },
        "aging": [
          {
            "from_period": "2025-06-30",
            "to_period": "2025-05-31",
            "before_days": 0,
            "to_days": 30,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-31",
            "to_period": "2025-05-01",
            "before_days": 31,
            "to_days": 60,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-01",
            "to_period": null,
            "before_days": 61,
            "to_days": null,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          }
        ],
        "total": {
          "amount": 0,
          "formatted_amount": "$0.00"
        }
      },
      {
        "customer_name": "Ahmed Bouhuolia",
        "current": {
          "amount": 300000,
          "formatted_amount": "300,000.00"
        },
        "aging": [
          {
            "from_period": "2025-06-30",
            "to_period": "2025-05-31",
            "before_days": 0,
            "to_days": 30,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-31",
            "to_period": "2025-05-01",
            "before_days": 31,
            "to_days": 60,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          },
          {
            "from_period": "2025-05-01",
            "to_period": null,
            "before_days": 61,
            "to_days": null,
            "total": {
              "amount": 0,
              "formatted_amount": ""
            }
          }
        ],
        "total": {
          "amount": 300000,
          "formatted_amount": "$300,000.00"
        }
      }
    ],
    "total": {
      "current": {
        "amount": 300000,
        "formatted_amount": "$300,000.00"
      },
      "aging": [
        {
          "from_period": "2025-06-30",
          "to_period": "2025-05-31",
          "before_days": 0,
          "to_days": 30,
          "total": {
            "amount": 5000,
            "formatted_amount": "$5,000.00"
          }
        },
        {
          "from_period": "2025-05-31",
          "to_period": "2025-05-01",
          "before_days": 31,
          "to_days": 60,
          "total": {
            "amount": 0,
            "formatted_amount": "$0.00"
          }
        },
        {
          "from_period": "2025-05-01",
          "to_period": null,
          "before_days": 61,
          "to_days": null,
          "total": {
            "amount": 0,
            "formatted_amount": "$0.00"
          }
        }
      ],
      "total": {
        "amount": 305000,
        "formatted_amount": "$305,000.00"
      }
    }
  },
  "meta": {
    "organization_name": "BIGCAPITAL, INC",
    "base_currency": "USD",
    "date_format": "DD MMM yyyy",
    "is_cost_compute_running": false,
    "sheet_name": "A/R Aging Summary",
    "formatted_as_date": "2025/06/30",
    "formatted_date_range": "As 2025/06/30"
  }
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

​
accept
string
required

Query Parameters

​
agingDaysBefore
number

Number of days before the aging period starts

Example:

30

​
agingPeriods
number

Number of aging periods to calculate

Example:

4

​
precision
number

Number of decimal places to display

Example:

2

​
divideOn1000
boolean

Whether to divide the number by 1000

Example:

false

​
showZero
boolean

Whether to show zero values

Example:

true

​
formatMoney
enum<string>

How to format money values

Available options:
total,
always,
none
Example:

"total"

​
negativeFormat
enum<string>

How to format negative numbers

Available options:
parentheses,
mines
Example:

"parentheses"

​
noneZero
boolean

Whether to exclude zero values

Example:

false

​
customersIds
string[]

Array of customer IDs to include

Response

200
application/json

Receivable aging summary response

The response is of type any.