Obter relações comerciais de pessoa pelo documento.

Retorna as relações comerciais associadas ao documento (CPF) fornecido. Retorna um código de status HTTP 200 (OK) se a consulta for bem-sucedida.

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Respostas

🟢200Relações comerciais obtidas com sucesso.

application/json

Body

Relações comerciais da pessoa.

businessRelationshipDataList

array[object (BusinessRelationshipDataDto) {14}]

opcional

Lista de objetos detalhando as relações comerciais da pessoa.

additionalDetails

object (BusinessRelationshipAdditionalDetailsDto)

opcional

Objeto que contém detalhes adicionais do relacionamento.

creationDate

string <date-time>

opcional

Dados de criação do registro.

isCurrentlyActive

boolean

opcional

Indica se o relacionamento está ativo.

lastUpdateDate

string <date-time>

opcional

Data da última atualização do registro.

relatedEntityName

string

opcional

Nome da entidade relacionada.

relatedEntityTaxIdCountry

string

opcional

País de identificação fiscal da entidade relacionada.

relatedEntityTaxIdNumber

string

opcional

Número de identificação fiscal da entidade relacionada.

relatedEntityTaxIdType

string

opcional

Tipo de identificação fiscal da entidade relacionada.

relationshipEndDate

string <date-time>

opcional

relationshipLevel

string

opcional

Nível de relacionamento.

relationshipName

string

opcional

Nome do relacionamento.

relationshipStartDate

string <date-time>

opcional

Data de início do relacionamento.

relationshipSubtype

string

opcional

Subtipo de relacionamento.

relationshipType

string

opcional

Tipo de relacionamento.

nextPageId

string

opcional

Número de identificação da próxima página.

totalClients

integer <int32>

opcional

Número total de clientes.

totalEmployments

integer <int32>

opcional

Número total de funcionários da pessoa.

totalOwnerships

integer <int32>

opcional

Número total de empresas de propriedade da pessoa.

totalPartners

integer <int32>

opcional

Número total de parceiros.

totalRelationships

integer <int32>

opcional

Número total de relacionamentos pessoais.

totalSuppliers

integer <int32>

opcional

Número total de fornecedores.

Exemplo

{
    "businessRelationshipDataList": [
        {
            "additionalDetails": {},
            "creationDate": "2019-08-24T14:15:22Z",
            "isCurrentlyActive": true,
            "lastUpdateDate": "2019-08-24T14:15:22Z",
            "relatedEntityName": "string",
            "relatedEntityTaxIdCountry": "string",
            "relatedEntityTaxIdNumber": "string",
            "relatedEntityTaxIdType": "string",
            "relationshipEndDate": "2019-08-24T14:15:22Z",
            "relationshipLevel": "string",
            "relationshipName": "string",
            "relationshipStartDate": "2019-08-24T14:15:22Z",
            "relationshipSubtype": "string",
            "relationshipType": "string"
        }
    ],
    "nextPageId": "string",
    "totalClients": 0,
    "totalEmployments": 0,
    "totalOwnerships": 0,
    "totalPartners": 0,
    "totalRelationships": 0,
    "totalSuppliers": 0
}

Obter relações comerciais de pessoa pelo documento.

Requisição

Exemplos de Requisição

Respostas