Get partnerships
GET
https://evo-integracao-api.w12app.com.br/api/v1/partnership
🌐 API Reference/Partnership
Obtener Alianzas/Convenios
Descripción
OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.
🔑 Parámetros de Consulta (Query Params)
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| status | int32 | No | Filtra alianzas por estado: 0 Ambas, 1 Activas, 2 Inactivas. |
| description | string | No | Nombre o descripción de la alianza (búsqueda parcial). |
| dtCreated | date-time | No | Fecha de creación de la alianza en formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ). |
📤 Estructura de la Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
idPartnership | int32 | Identificador único de la alianza. |
description | string | Descripción o nombre de la alianza. |
isBlockedFlag | boolean | Indica si la alianza está bloqueada. |
isInactiveFlag | boolean | Indica si la alianza está inactiva. |
company | object | Datos de la empresa asociada a la alianza. Ver más abajo. |
isRecurringDiscountFlag | boolean | Indica si el descuento es recurrente. |
discount | number | Valor del descuento aplicado en la alianza. |
discountType | int32 | Tipo de descuento configurado (porcentaje o valor fijo). |
advancedDiscount | number | Valor de descuento avanzado configurado para la alianza. |
🧩 Estructura del Objeto company
| Campo | Tipo | Descripción |
|---|---|---|
agreementCompanyId | int32 | Identificador de la empresa asociada en el contrato/alianza. |
branchId | int32 | Identificador de la sucursal asociada a la empresa. |
corporateName | string | Razón social de la empresa. |
tradeName | string | Nombre comercial de la empresa. |
cnpj | string | CNPJ de la empresa. |
postalCode | string | Código postal de la empresa. |
streetAddress | string | Calle y dirección de la empresa. |
number | string | Número de la dirección. |
complement | string | Complemento de la dirección. |
neighborhood | string | Barrio de la empresa. |
city | string | Ciudad de la empresa. |
state | string | Estado (UF) de la empresa. |
businessEmail | string | Correo electrónico comercial. |
financialEmail | string | Correo financiero. |
responsibleName | string | Nombre del responsable de la empresa. |
isDeletedFlag | boolean | Indica si el registro de la empresa fue eliminado. |
deletionDate | date-time | Fecha de eliminación del registro, si aplica. |
employeeDeletionId | int32 | Identificador del empleado responsable de la eliminación. |
openingDate | date-time | Fecha de apertura de la empresa. |
size | string | Tamaño/porte de la empresa. |
economicActivityDescription | string | Descripción de la actividad económica de la empresa. |
legalNatureDescription | string | Descripción de la naturaleza jurídica de la empresa. |
phone | string | Teléfono de contacto de la empresa. |
registrationStatus | int32 | Estado del registro de la empresa. |
category | int32 | Categoría de la empresa asociada. |
fpasContributor | boolean | Indica si la empresa es contribuyente FPAS. |
remarks | string | Observaciones adicionales sobre la empresa. |
Solicitud
Parámetros de consulta
Respuestas
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/partnership?status=undefined&description=undefined&dtCreated=undefined'Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
[
{
"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
}
]Modificado en 2026-05-15 13:34:34