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

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)`.

Exemplo de Resposta

[
  {
    "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": "2025-07-30T15:51:51.503Z",
      "employeeDeletionId": 0,
      "openingDate": "2025-07-30T15:51:51.503Z",
      "size": "string",
      "economicActivityDescription": "string",
      "legalNatureDescription": "string",
      "phone": "string",
      "registrationStatus": 0,
      "category": 0,
      "fpasContributor": true,
      "remarks": "string"
    },
    "isRecurringDiscountFlag": true,
    "discount": 0,
    "discountType": 0,
    "advancedDiscount": 0
  }
]