Get PFM

This endpoint allows to get customer PFM information.

Request

GET <API base url>/customers/{id}/pfm

URL query parameters

Name	Type	Required	Description
from	date	yes	Filter by start date
to	date	no	Filter by end date
cardIds	string[]	no	Filter by card identifiers
timelineType	string	no	Group by day or month
categories	string[]	no	Filter by categories

Response

On success:

{
  "value": required {
    "totals" required {
      "all": required {
        "volume": required {
          "value": required number,
          "share": optional number
        },
        "count": required {
          "value": required number,
          "share": optional number
        }
      },
      "categories": required {
        "<category 1>": required {
          "volume": required {
            "value": required number,
            "share": optional number
          },
          "count": required {
            "value": required number,
            "share": optional number
          }
        },
        "<category 2>": ...
      }
    },
    "timeline": optional array of {
      "date": required string (date in format YYYY-MM-DD),
      "all": required {
        "volume": required {
          "value": required number,
          "share": optional number
        },
        "count": required {
          "value": required number,
          "share": optional number
        }
      },
      "categories": required {
        "<category 1>": required {
          "volume": required {
            "value": required number,
            "share": optional number
          },
          "count": required {
            "value": required number,
            "share": optional number
          }
        },
        "<category 2>": ...
      }
    }
  }
}