Get Member Contracts

Description

Allows obtaining a list of member contracts based on various filtering criteria, including registration and cancellation periods, contract types, and categories.

🔑 Query Parameters

Parameter	Type	Required	Description
`idMember`	int32	No	ID of the member to filter contracts.
`idMembership`	int32	No	ID of the contract type to filter results.
`memberName`	string	No	Name of the member to filter contracts.
`registerDateStart`	date-time	No	Start date of registration in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
`registerDateEnd`	date-time	No	End date of registration in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
`cancelDateStart`	date-time	No	Start date of cancellation in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
`cancelDateEnd`	date-time	No	End date of cancellation in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
`showTransfers`	boolean	No	Filters to show transferred contracts. Default value is `false`.
`showAggregators`	boolean	No	Filters to show aggregator contracts. Default value is `false`.
`showVips`	boolean	No	Filters to show VIP category contracts. Default value is `false`.
`contractType`	string	No	Filters by contract types, separated by commas. See the types table below.
`statusMemberMembership`	int32	No	Filters by contract statuses. `1` - Active, `2` - Canceled.
`take`	int32	No	Total number of records to be returned. Default value is `25`. Maximum allowed: `25`.
`skip`	int32	No	Total number of records to be skipped (for pagination). Default value is `0`.

🔷 Enum of `contractType`

Code	Description
1	Common
3	Plan Extension
4	Blockage Extension
5	Recurring Monthly
6	Monthly Recurring with Validity
7	Monthly Recurring with Automatic Renewal
8	Additional Dependent
9	Annual with Specific End Date
10	Additional Contract

📤 Response Structure

Field	Type	Description
idMember	int32	ID of the member.
name	string	Name of the member.
idMembership	int32	ID of the associated membership.
idMemberMemberShip	int32	ID of the member's link with the membership.
idBranch	int32	ID of the branch associated with the membership.
numMembers	int32	Total number of linked members (holder + dependents).
idSale	int32	ID of the sale related to the membership.
saleValue	number	Total sale value.
nameMembership	string	Name of the plan/membership.
membershipStart	date-time	Start date of the membership.
membershipEnd	date-time	End date of the membership.
registerCancelDate	date-time	Date of cancellation registration.
cancelDate	date-time	Effective cancellation date.
reasonCancellation	string	Reason for cancellation.
saleDate	date-time	Sale date.
cancellationFine	number	Cancellation fine amount (if applicable).
remainingValue	number	Remaining amount to be paid.
receivables	array	List of receivables related to the membership. See object `receivables[]`.
minPeriodStayMembership	int32	Minimum period of stay for the membership (in days).
membershipTrasnferData	object	Data about the membership transfer. See object `membershipTrasnferData`.
membershipSwapData	object	Data about the membership swap. See object `membershipSwapData`.
idMemberMigration	string	ID of the member after migration (if applicable).
idSaleMigration	string	ID of the sale generated by the migration.
idMembershipCategory	int32	ID of the membership category.
memberDocument	string	Document of the member related to the plan.
statusMemberMembership	int32	Status of the contract. `1` - Active, `2` - Canceled.

🧩 Structure of the `receivables` array of objects

Field	Type	Description
idReceivable	int32	ID of the receivable.
description	string	Description of the receivable.
ammount	number	Total amount to be received.
ammountPaid	number	Amount already paid.
currentInstallment	int32	Current installment.
totalInstallments	int32	Total number of installments.
tid	string	Transaction ID.
nsu	string	Transaction NSU.
authorization	string	Authorization code of the transaction.
canceled	boolean	Indicates if the receivable has been canceled.
cancellationDate	date-time	Date of cancellation of the receivable.
cancellationDescription	string	Reason/description for the cancellation.
registrationDate	date-time	Date of registration of the receivable.
dueDate	date-time	Due date of the installment.
receivingDate	date-time	Date of receipt/payment.
paymentType	object	Payment type used. See object `receivables[].paymentType`.

🧩 Structure of the `receivables[].paymentType` object

Field	Type	Description
id	int32	ID of the payment type.
name	string	Name of the payment type (e.g., Credit, Debit, PIX).

🧩 Structure of the `membershipTrasnferData` object

Field	Type	Description
flTransfer	boolean	Indicates if there was a membership transfer.
idMemberTransfer	int32	ID of the member to whom the membership was transferred.
idMemberMembershipTransfer	int32	ID of the transferred link.

🧩 Structure of the `membershipSwapData` object

Field	Type	Description
flMembershipSwapped	boolean	Indicates if the membership was swapped.
idMemberMembershipSource	int32	ID of the original membership before the swap.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "idMember": 0,
        "name": "string",
        "idMembership": 0,
        "idMemberMemberShip": 0,
        "idBranch": 0,
        "numMembers": 0,
        "idSale": 0,
        "saleValue": 0,
        "nameMembership": "string",
        "membershipStart": "2019-08-24T14:15:22.123Z",
        "membershipEnd": "2019-08-24T14:15:22.123Z",
        "registerCancelDate": "2019-08-24T14:15:22.123Z",
        "cancelDate": "2019-08-24T14:15:22.123Z",
        "reasonCancellation": "string",
        "saleDate": "2019-08-24T14:15:22.123Z",
        "cancellationFine": 0,
        "remainingValue": 0,
        "receivables": [
            {
                "idReceivable": 0,
                "description": "string",
                "ammount": 0,
                "ammountPaid": 0,
                "currentInstallment": 0,
                "totalInstallments": 0,
                "tid": "string",
                "nsu": "string",
                "authorization": "string",
                "canceled": true,
                "cancellationDate": "2019-08-24T14:15:22.123Z",
                "cancellationDescription": "string",
                "registrationDate": "2019-08-24T14:15:22.123Z",
                "dueDate": "2019-08-24T14:15:22.123Z",
                "receivingDate": "2019-08-24T14:15:22.123Z",
                "paymentType": {
                    "id": 0,
                    "name": "string"
                }
            }
        ],
        "minPeriodStayMembership": 0,
        "membershipTrasnferData": {
            "flTransfer": true,
            "idMemberTransfer": 0,
            "idMemberMembershipTransfer": 0
        },
        "membershipSwapData": {
            "flMembershipSwapped": true,
            "idMemberMembershipSource": 0
        },
        "idMemberMigration": "string",
        "idSaleMigration": "string",
        "idMembershipCategory": 0,
        "memberDocument": "string",
        "statusMemberMembership": 0
    }
]

🟠400Bad Request

Get summary of MemberMemberships (active, canceled, or specific types).

Get Member Contracts#

Description#

🔑 Query Parameters#

🔷 Enum of contractType#

📤 Response Structure#

🧩 Structure of the receivables array of objects#

🧩 Structure of the receivables[].paymentType object#

🧩 Structure of the membershipTrasnferData object#

🧩 Structure of the membershipSwapData object#

Request