ZUzuper

Get Customer Finance Stats

Changed on

Returns financial summary stats for a customer: approved estimate value, invoiced amount, collected amount, bad debt, and derived rates. collected_amount is computed from PaymentTransaction rows (SUCCESS and PARTIALLY_REFUNDED) scoped to the exact invoice/estimate ids involved, net of surcharge and refunds. Also returns the raw payment transaction list.

get/customers/{customer_uid}/finance/stats

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/customers/{customer_uid}/finance/stats
  • Auth
    API key in header x-api-key

Path parameters

customer_uidstring required

Response

200

typestring

Example response

{
  "type": "success"
}

Changes