Obter Parcerias

Descrição

Esse endpoint recupera a lista de parcerias cadastradas no sistema. É possível aplicar filtros por status, nome da parceria e data de criação.

🔑 Parâmetros de Consulta (Query Params)

Suporta filtros opcionais através de parâmetros de consulta (query parameters) para refinar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
status	int32	Não	Filtra parcerias por status: `0` Ambas, `1` Ativas, `2` Inativas.
description	string	Não	Nome ou descrição da parceria (busca parcial).
dtCreated	date-time	Não	Data de criação da parceria no formato ISO 8601 `(YYYY-MM-DDTHH:mm:ssZ)`.

📤 Estrutura da Resposta

A resposta retorna uma lista de parcerias cadastradas, contendo informações gerais da parceria, regras de desconto e os dados completos da empresa conveniada.

Campo	Tipo	Descrição
`idPartnership`	int32	Identificador único da parceria.
`description`	string	Descrição ou nome da parceria.
`isBlockedFlag`	boolean	Indica se a parceria está bloqueada.
`isInactiveFlag`	boolean	Indica se a parceria está inativa.
`company`	object	Dados da empresa conveniada associada à parceria. Veja mais abaixo.
`isRecurringDiscountFlag`	boolean	Indica se o desconto é recorrente.
`discount`	number	Valor do desconto aplicado na parceria.
`discountType`	int32	Tipo de desconto configurado (ex.: percentual ou valor fixo).
`advancedDiscount`	number	Valor de desconto avançado configurado para a parceria.

🧩 Estrutura do Objeto `company`

Campo	Tipo	Descrição
`agreementCompanyId`	int32	Identificador da empresa conveniada no contrato/parceria.
`branchId`	int32	Identificador da filial associada à empresa conveniada.
`corporateName`	string	Razão social da empresa.
`tradeName`	string	Nome fantasia da empresa.
`cnpj`	string	CNPJ da empresa.
`postalCode`	string	CEP do endereço da empresa.
`streetAddress`	string	Logradouro do endereço da empresa.
`number`	string	Número do endereço da empresa.
`complement`	string	Complemento do endereço.
`neighborhood`	string	Bairro do endereço da empresa.
`city`	string	Cidade do endereço da empresa.
`state`	string	Estado (UF) do endereço da empresa.
`businessEmail`	string	E-mail comercial da empresa.
`financialEmail`	string	E-mail financeiro da empresa.
`responsibleName`	string	Nome do responsável pela empresa.
`isDeletedFlag`	boolean	Indica se o cadastro da empresa foi excluído.
`deletionDate`	date-time	Data de exclusão do cadastro da empresa, se aplicável.
`employeeDeletionId`	int32	Identificador do colaborador responsável pela exclusão.
`openingDate`	date-time	Data de abertura da empresa.
`size`	string	Porte da empresa.
`economicActivityDescription`	string	Descrição da atividade econômica da empresa.
`legalNatureDescription`	string	Descrição da natureza jurídica da empresa.
`phone`	string	Telefone de contato da empresa.
`registrationStatus`	int32	Status cadastral da empresa.
`category`	int32	Categoria da empresa conveniada.
`fpasContributor`	boolean	Indica se a empresa é contribuinte FPAS.
`remarks`	string	Observações adicionais sobre a empresa conveniada.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

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

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "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

Obter Parcerias#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto company#