Retrieve an account's financial summary

Returns the account’s invoice totals, under account.financial_summary.

GET /accounts/{account_id}/financial_summary

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/accounts/ACC0001/financial_summary" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "account": {
    "name": "<string>",
    "financial_summary": {
      "total_due": "<string>",
      "total_grand": "<string>",
      "total_paid": "<string>",
      "invoice_count": 123,
      "total_due_invoice_count": 123,
      "total_overdue_amount": "<string>",
      "total_overdue_invoice_count": 123,
      "collected_this_month": "<string>"
    }
  }
}

Returns the account’s name beside financial_summary, under account. Money values are strings; the invoice counts are integers.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

account_id · string · required

The account's id, such as ACC0001. Not its uuid.

Response

200 - application/json

The summary, under account.

account · object

The account's name and its invoice totals.

Show child attributes