Services

Calculate charge distribution

Calculate the charge distribution according to the specified distribution key

post/charges/distributions/{id}/calculate

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/charges/distributions/{id}/calculate
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Distribution key ID

Request body

place_idstring uuid required

ID of the place for which to calculate the distribution

total_amountnumber float required

Total amount to distribute

calculation_datestring date

Calculation date

parametersobject

Additional parameters for the calculation

Response

Distribution calculation completed successfully

distribution_key_idstring uuid required

ID of the distribution key used

total_amountnumber float required

Total amount distributed

calculation_datestring date-time required

Date and time of the calculation

metadataobject

Calculation metadata

Changes

No recorded changes to this operation across all 1 revision of this API.