Perfect Gym api

Contract fees

This section provides an overview of contract fees.

Contract fee properties

Contract fee specyfic properties are described here.

Name Type Description
id long Unique identifier of contract.
timestamp long Timestamp. Indicates when resource was last modified.
signDate string Contract sign date.
startDate string Contract start date.
cancelDate string Contract cancel date.
endDate string Contract end date.
isActive bool Indicates if contract is marked as active.
isDeleted bool Indicates if resource is deleted.
administarationFee decimal Contract administaration fee.
freezFee decimal Contract freez fee.
joiningFee decimal Contract joining fee.
membershipFee decimal Contract membership fee.
totalFee decimal Contract total fee.
paidTransactions array An array of [ContractFeeDetails][Fee details] objects representing fee details.
pendingTransactions array An array of [ContractFeeDetails][Fee details] objects representing fee details.

Retrieve detailed information about specific user contract fees alt text

GET Contracts/Contract/Fees

Returns detailed contract fees informations.

Parameters

Name Type Description
contractId long Required. Contract identifier.

Example request

In this example we fetch contract fees with id = 10358 detailed information.

curl -i 
     -X GET 
     -H "Authorization: Bearer  $ACCESS_TOKEN"  
     http://yoursubdomain.perfectgym.com/Api/Contracts/Contract/Fees?contractId=10358       

Example response

Status: 200 OK
{
  "elements": [
    {
      "id": 10358,
      "timestamp": 350287,
      "signUpDate": "2016-01-26T00:00:00",
      "startDate": "2016-01-26T00:00:00",
      "cancelDate": "",
      "endDate": "",
      "administarationFee": 12,
      "freezFee": 0,
      "joiningFee": 5,
      "membershipFee": 100,
      "totalFee": 1217,
      "paidTransactions": [
        {
          "amount": 12,
          "amountToSettle": 0,
          "date": "2017-10-29T10:07:14",
          "type": "AdminFee"
        },
        {
          "amount": 5,
          "amountToSettle": 0,
          "date": "2017-10-29T10:07:14",
          "type": "JoiningFee"
        }
      ],
      "pendingTransactions": [
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2017-10-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2017-11-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2017-12-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-01-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-02-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-03-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-04-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-05-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-06-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-07-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-08-01T00:00:00",
          "type": "Membership"
        },
        {
          "amount": 100,
          "amountToSettle": -100,
          "date": "2018-09-01T00:00:00",
          "type": "Membership"
        }
      ],
      "status": "Current",
      "isCurrent": true,
      "isActive": true,
      "isDeleted": false
    }
  ]
}
Perfect Gym api