Get Partnerships/Agreements

Description

This endpoint retrieves the list of partnerships/agreements registered in the system. It is possible to apply filters by status, partnership name, and creation date.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters

Supports optional filters through query parameters to refine the results.

Parameter	Type	Required	Description
status	int32	No	Filters partnerships by status: `0` Both, `1` Active, `2` Inactive.
description	string	No	Name or description of the partnership (partial search).
dtCreated	date-time	No	Creation date of the partnership in ISO 8601 format `(YYYY-MM-DDTHH:mm:ssZ)`.

📤 Response Structure

The response returns a list of registered partnerships, containing general information about the partnership, discount rules, and complete data of the associated company.

Field	Type	Description
`idPartnership`	int32	Unique identifier of the partnership.
`description`	string	Description or name of the partnership.
`isBlockedFlag`	boolean	Indicates if the partnership is blocked.
`isInactiveFlag`	boolean	Indicates if the partnership is inactive.
`company`	object	Data of the associated company linked to the partnership. See more below.
`isRecurringDiscountFlag`	boolean	Indicates if the discount is recurring.
`discount`	number	Value of the discount applied to the partnership.
`discountType`	int32	Type of discount configured (e.g., percentage or fixed amount).
`advancedDiscount`	number	Value of advanced discount configured for the partnership.

🧩 Structure of `company` Object

Field	Type	Description
`agreementCompanyId`	int32	Identifier of the associated company in the contract/partnership.
`branchId`	int32	Identifier of the branch associated with the company.
`corporateName`	string	Corporate name of the company.
`tradeName`	string	Trade name of the company.
`cnpj`	string	CNPJ of the company.
`postalCode`	string	Postal code of the company's address.
`streetAddress`	string	Street address of the company.
`number`	string	Number of the company's address.
`complement`	string	Address complement.
`neighborhood`	string	Neighborhood of the company's address.
`city`	string	City of the company's address.
`state`	string	State (UF) of the company's address.
`businessEmail`	string	Business email of the company.
`financialEmail`	string	Financial email of the company.
`responsibleName`	string	Name of the person responsible for the company.
`isDeletedFlag`	boolean	Indicates if the company's registration has been deleted.
`deletionDate`	date-time	Date of deletion of the company's registration, if applicable.
`employeeDeletionId`	int32	Identifier of the staff member responsible for the deletion.
`openingDate`	date-time	Date of opening of the company.
`size`	string	Size of the company.
`economicActivityDescription`	string	Description of the company's economic activity.
`legalNatureDescription`	string	Description of the company's legal nature.
`phone`	string	Contact phone of the company.
`registrationStatus`	int32	Registration status of the company.
`category`	int32	Category of the associated company.
`fpasContributor`	boolean	Indicates if the company is an FPAS contributor.
`remarks`	string	Additional remarks about the associated company.

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

[
    {
        "idPartnership": 0,
        "description": "string",
        "isBlockedFlag": true,
        "isInactiveFlag": true,
        "company": {
            "agreementCompanyId": 0,
            "branchId": 0,
            "corporateName": "string",
            "tradeName": "string",
            "cnpj": "string",
            "postalCode": "string",
            "streetAddress": "string",
            "number": "string",
            "complement": "string",
            "neighborhood": "string",
            "city": "string",
            "state": "string",
            "businessEmail": "string",
            "financialEmail": "string",
            "responsibleName": "string",
            "isDeletedFlag": true,
            "deletionDate": "2019-08-24T14:15:22.123Z",
            "employeeDeletionId": 0,
            "openingDate": "2019-08-24T14:15:22.123Z",
            "size": "string",
            "economicActivityDescription": "string",
            "legalNatureDescription": "string",
            "phone": "string",
            "registrationStatus": 0,
            "category": 0,
            "fpasContributor": true,
            "remarks": "string"
        },
        "isRecurringDiscountFlag": true,
        "discount": 0,
        "discountType": 0,
        "advancedDiscount": 0
    }
]

🟠400Bad Request

Get partnerships

Get Partnerships/Agreements#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of company Object#