MUmultigest
Reports

Get Socios Monthly Statement

Per-sócio monthly P&L statement.

Returns one entry per sócio:

  • valor_mes — share for the target month
  • valor_acumulado — cumulative shares from (start_ano, start_mes) to (ano, mes) PLUS Z_Partners.valor_inicial
  • total_withdrawn — sign-aware sum of MovimentosSocios-linked movements up to (ano, mes); withdrawals are typically negative
  • total_available = valor_acumulado + total_withdrawn
  • by_pv — per-PV breakdown of the same four values

Percentage normalization stays per-PV (active sócios' percentages sum to the divisor, not 100). Closed-vehicle movements paid before datafecho are re-attributed to the closure month at the closure PV. Both rules match the legacy get_socio_report_complete_month semantics.

get/api/reports/socios/monthly-statement

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/reports/socios/monthly-statement
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Query parameters

mesinteger required
anointeger required
partner_idinteger nullable
ponto_venda_idinteger[]
start_anointeger

Cumulative window start year

start_mesinteger

Cumulative window start month

Headers

x-api-tokenstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 21 revisions of this API.