{"items":[{"type":"link","label":"Pessoas","link":"/open-api-docs/open-api-person","routeSlug":"/open-api-docs/open-api-person","content":{"contentType":"overview","meta":{"name":"Pessoas"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"open-api-person.json","url":"/_bundle/open-api-docs/open-api-person.json?download"},{"kind":"download","label":"open-api-person.yaml","url":"/_bundle/open-api-docs/open-api-person.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Pessoas (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A API de Pessoas (v1) tem como objetivo permitir o cadastro, consulta, ativação, desativação, exclusão e atualização dos registros de pessoas (clientes, fornecedores, transportadoras) no sistema da Conta Azul."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Por meio dessa funcionalidade, sistemas externos podem manter seus cadastros sincronizados, automatizar a gestão de perfis de pessoas e garantir que os dados estejam sempre atualizados entre plataformas."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clientes: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/articles/115007916448-Clientes-como-cadastrar"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/articles/115007916448-Clientes-como-cadastrar"},"children":[]}]}]}]}]}],"sectionId":"/open-api-docs/open-api-person"}],"sectionId":"/open-api-docs/open-api-person"}]}]}},{"type":"group","label":"v1","link":"/open-api-docs/open-api-person/v1","routeSlug":"/open-api-docs/open-api-person/v1","items":[{"label":"Retornar as pessoas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornapessoasporfiltros","routeSlug":"/open-api-docs/open-api-person/v1/retornapessoasporfiltros","metadata":{"seo":{"title":"Retornar as pessoas por filtro","description":"Permite consultar as pessoas cadastradas, com suporte a filtros como página, tamanho, ordenação, busca por nome, documento, email, tipo de perfil, entre outros. Essa funcionalidade facilita a listagem, o monitoramento de pessoas no sistema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retornaPessoasPorFiltros","name":"Retornar as pessoas por filtro","isWebhook":false,"pointer":"/paths/~1v1~1pessoas/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as pessoas por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar as pessoas cadastradas, com suporte a filtros como página, tamanho, ordenação, busca por nome, documento, email, tipo de perfil, entre outros. Essa funcionalidade facilita a listagem, o monitoramento de pessoas no sistema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_262","description":"Página"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_263","description":"Tamanho da página"},{"name":"tipo_ordenacao","in":"query","schemaId":"schema_264","description":"Tipo de ordenação"},{"name":"ordem_ordenacao","in":"query","schemaId":"schema_265","description":"Ordem de ordenação"},{"name":"busca","in":"query","schemaId":"schema_266","description":"Busca textual pelo documento ou nome do cliente/empresa"},{"name":"ids","in":"query","schemaId":"schema_266","description":"IDs das pessoas"},{"name":"documentos","in":"query","schemaId":"schema_266","description":"Documentos das pessoas (CPF/CNPJ)"},{"name":"paises","in":"query","schemaId":"schema_266","description":"Países das pessoas"},{"name":"cidades","in":"query","schemaId":"schema_266","description":"Cidades das pessoas"},{"name":"ufs","in":"query","schemaId":"schema_266","description":"Abreviações das unidades federativas (estados) das pessoas"},{"name":"codigos_pessoa","in":"query","schemaId":"schema_266","description":"Códigos de cadastro das pessoas"},{"name":"emails","in":"query","schemaId":"schema_266","description":"Emails das pessoas"},{"name":"tipos_pessoa","in":"query","schemaId":"schema_267","description":"Tipos de pessoa"},{"name":"nomes","in":"query","schemaId":"schema_266","description":"Nomes das pessoas, pode ser pessoa física, jurídica ou estrangeira"},{"name":"telefones","in":"query","schemaId":"schema_266","description":"Telefones das pessoas"},{"name":"data_criacao_inicio","in":"query","schemaId":"schema_266","description":"Data de início para filtrar pessoas criadas a partir dessa data, obrigatório se data_criacao_fim for preenchido"},{"name":"data_criacao_fim","in":"query","schemaId":"schema_266","description":"Data de fim para filtrar pessoas criadas até essa data, obrigatório se data_criacao_inicio for preenchido"},{"name":"data_alteracao_de","in":"query","schemaId":"schema_266","description":"Data de alteracao de (ISO 8601, São Paulo/GMT-3)"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_266","description":"Data de alteracao até (ISO 8601, São Paulo/GMT-3)"},{"name":"tipo_perfil","in":"query","schemaId":"schema_268","description":"Tipo de perfil da pessoa"},{"name":"com_endereco","in":"query","schemaId":"schema_269","description":"Indica se deve retornar pessoas com endereço"}],"pointer":"/paths/~1v1~1pessoas/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pessoas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_262"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_263"},{"name":"tipo_ordenacao","in":"query","schemaId":"schema_264"},{"name":"ordem_ordenacao","in":"query","schemaId":"schema_265"},{"name":"busca","in":"query","schemaId":"schema_266"},{"name":"ids","in":"query","schemaId":"schema_266"},{"name":"documentos","in":"query","schemaId":"schema_266"},{"name":"paises","in":"query","schemaId":"schema_266"},{"name":"cidades","in":"query","schemaId":"schema_266"},{"name":"ufs","in":"query","schemaId":"schema_266"},{"name":"codigos_pessoa","in":"query","schemaId":"schema_266"},{"name":"emails","in":"query","schemaId":"schema_266"},{"name":"tipos_pessoa","in":"query","schemaId":"schema_267"},{"name":"nomes","in":"query","schemaId":"schema_266"},{"name":"telefones","in":"query","schemaId":"schema_266"},{"name":"data_criacao_inicio","in":"query","schemaId":"schema_266"},{"name":"data_criacao_fim","in":"query","schemaId":"schema_266"},{"name":"data_alteracao_de","in":"query","schemaId":"schema_266"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_266"},{"name":"tipo_perfil","in":"query","schemaId":"schema_268"},{"name":"com_endereco","in":"query","schemaId":"schema_269"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/pessoas","href":"v1/retornapessoasporfiltros","openApiOperationId":"retornaPessoasPorFiltros","summary":"Retornar as pessoas por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoDePessoasPorFiltro"}},"schemaId":"components/schemas/ResumoDePessoasPorFiltro"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResumoDePessoasPorFiltro","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoDePessoasPorFiltro"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/retornapessoasporfiltros"}],"panels":[]}]},"httpPath":"/v1/pessoas"},{"label":"Criar uma nova pessoa","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/criarpessoa","routeSlug":"/open-api-docs/open-api-person/v1/criarpessoa","metadata":{"seo":{"title":"Criar uma nova pessoa","description":"Permite criar uma nova pessoa, informando dados como nome, tipo de pessoa (Física, Jurídica ou Estrangeira), documentos (CPF, CNPJ), email, perfis associados, endereços e outros parâmetros. Esse endpoint viabiliza a automação de cadastro de clientes, fornecedores e transportadoras."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarPessoa","name":"Criar uma nova pessoa","isWebhook":false,"pointer":"/paths/~1v1~1pessoas/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar uma nova pessoa","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite criar uma nova pessoa, informando dados como nome, tipo de pessoa (Física, Jurídica ou Estrangeira), documentos (CPF, CNPJ), email, perfis associados, endereços e outros parâmetros. Esse endpoint viabiliza a automação de cadastro de clientes, fornecedores e transportadoras."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriarPessoa"}},"schemaId":"components/schemas/CriarPessoa","pointer":"/paths/~1v1~1pessoas/post/requestBody","description":"Dados da pessoa a ser criada"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pessoas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriarPessoa"}},"responseCodes":["201","400","401","429","500"],"pointer":"/v1/pessoas","href":"v1/criarpessoa","openApiOperationId":"criarPessoa","summary":"Criar uma nova pessoa"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriarPessoa","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriarPessoa"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoCriacaoPessoa"}},"schemaId":"components/schemas/ResumoCriacaoPessoa"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ResumoCriacaoPessoa","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoCriacaoPessoa"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/criarpessoa"}],"panels":[]}]},"httpPath":"/v1/pessoas"},{"label":"Ativar pessoas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/ativarpessoasemlote","routeSlug":"/open-api-docs/open-api-person/v1/ativarpessoasemlote","metadata":{"seo":{"title":"Ativar pessoas em lote","description":"Permite ativar em lote um conjunto de pessoas previamente inativadas ou que estejam com status desativado. Essa funcionalidade é útil para reativar perfis inativos de forma massiva."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ativarPessoasEmLote","name":"Ativar pessoas em lote","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1ativar/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ativar pessoas em lote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite ativar em lote um conjunto de pessoas previamente inativadas ou que estejam com status desativado. Essa funcionalidade é útil para reativar perfis inativos de forma massiva."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote"}},"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote","pointer":"/paths/~1v1~1pessoas~1ativar/post/requestBody","description":"IDs das pessoas a serem ativadas"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pessoas/ativar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/pessoas/ativar","href":"v1/ativarpessoasemlote","openApiOperationId":"ativarPessoasEmLote","summary":"Ativar pessoas em lote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1ativar/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/ativarpessoasemlote"}],"panels":[]}]},"httpPath":"/v1/pessoas/ativar"},{"label":"Retornar dados da empresa conectada","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornaempresadacontaconectada","routeSlug":"/open-api-docs/open-api-person/v1/retornaempresadacontaconectada","metadata":{"seo":{"title":"Retornar dados da empresa conectada","description":"Permite consultar as informações cadastrais e de contato da empresa vinculada ao token de autenticação utilizado na requisição. Use este endpoint para exibir ou validar os dados da empresa parceira conectada à sua integração, como razão social e CNPJ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retornaEmpresaDaContaConectada","name":"Retornar dados da empresa conectada","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1conta-conectada/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar dados da empresa conectada","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar as informações cadastrais e de contato da empresa vinculada ao token de autenticação utilizado na requisição. Use este endpoint para exibir ou validar os dados da empresa parceira conectada à sua integração, como razão social e CNPJ."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pessoas/conta-conectada","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","429","500"],"pointer":"/v1/pessoas/conta-conectada","href":"v1/retornaempresadacontaconectada","openApiOperationId":"retornaEmpresaDaContaConectada","summary":"Retornar dados da empresa conectada"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Empresa"}},"schemaId":"components/schemas/Empresa"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1conta-conectada/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Empresa","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Empresa"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/retornaempresadacontaconectada"}],"panels":[]}]},"httpPath":"/v1/pessoas/conta-conectada"},{"label":"Excluir pessoas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/excluirpessoasemlote","routeSlug":"/open-api-docs/open-api-person/v1/excluirpessoasemlote","metadata":{"seo":{"title":"Excluir pessoas em lote","description":"Permite excluir pessoas em lote, a partir de seus identificadores."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"excluirPessoasEmLote","name":"Excluir pessoas em lote","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1excluir/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Excluir pessoas em lote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permite excluir pessoas em lote, a partir de seus identificadores."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParamDeletarPessoasEmLote"}},"schemaId":"components/schemas/ParamDeletarPessoasEmLote","pointer":"/paths/~1v1~1pessoas~1excluir/post/requestBody","description":"IDs das pessoas a serem deletadas"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pessoas/excluir","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ParamDeletarPessoasEmLote"}},"responseCodes":["204","400","401","429","500"],"pointer":"/v1/pessoas/excluir","href":"v1/excluirpessoasemlote","openApiOperationId":"excluirPessoasEmLote","summary":"Excluir pessoas em lote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ParamDeletarPessoasEmLote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParamDeletarPessoasEmLote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1excluir/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/excluirpessoasemlote"}],"panels":[]}]},"httpPath":"/v1/pessoas/excluir"},{"label":"Desativar pessoas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/desativarpessoasemlote","routeSlug":"/open-api-docs/open-api-person/v1/desativarpessoasemlote","metadata":{"seo":{"title":"Desativar pessoas em lote","description":"Permite inativar em lote pessoas, alterando seu status para \"inativo\". Útil para automações de limpeza de cadastros ou para perfis que não precisam mais estar ativos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"desativarPessoasEmLote","name":"Desativar pessoas em lote","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1inativar/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Desativar pessoas em lote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite inativar em lote pessoas, alterando seu status para \"inativo\". Útil para automações de limpeza de cadastros ou para perfis que não precisam mais estar ativos."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote"}},"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote","pointer":"/paths/~1v1~1pessoas~1inativar/post/requestBody","description":"IDs das pessoas a serem desativadas"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pessoas/inativar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/pessoas/inativar","href":"v1/desativarpessoasemlote","openApiOperationId":"desativarPessoasEmLote","summary":"Desativar pessoas em lote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParamAtualizarStatusPessoasEmLote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1inativar/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/desativarpessoasemlote"}],"panels":[]}]},"httpPath":"/v1/pessoas/inativar"},{"label":"Retornar a pessoa por legacyid","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornapessoaporlegacyid","routeSlug":"/open-api-docs/open-api-person/v1/retornapessoaporlegacyid","metadata":{"seo":{"title":"Retornar a pessoa por legacyid","description":"Esse endpoint existe para garantir compatibilidade entre a API antiga (V1 legada) e a API nova de Pessoas. Quando você faz requisições na API nova, cada pessoa passa a ter um UUID, que é o novo identificador usado pelo ERP e pelas integrações atuais. Ao mesmo tempo, algumas aplicações antigas ainda usam o id_legado, que era o identificador utilizado na API V1. Importante saber - Relação entre os IDs: uuid → ID novo da pessoa (padrão atual), id_legado → ID antigo, usado na primeira versão da API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retornaPessoaPorLegacyId","name":"Retornar a pessoa por legacyid","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1legado~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a pessoa por legacyid","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Esse endpoint existe para garantir compatibilidade entre a API antiga (V1 legada) e a API nova de Pessoas. Quando você faz requisições na API nova, cada pessoa passa a ter um UUID, que é o novo identificador usado pelo ERP e pelas integrações atuais. Ao mesmo tempo, algumas aplicações antigas ainda usam o id_legado, que era o identificador utilizado na API V1. Importante saber - Relação entre os IDs: uuid → ID novo da pessoa (padrão atual), id_legado → ID antigo, usado na primeira versão da API."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_266","description":"legacyId da pessoa","required":true}],"pointer":"/paths/~1v1~1pessoas~1legado~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pessoas/legado/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_266"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/pessoas/legado/{id}","href":"v1/retornapessoaporlegacyid","openApiOperationId":"retornaPessoaPorLegacyId","summary":"Retornar a pessoa por legacyid"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pessoa"}},"schemaId":"components/schemas/Pessoa"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1legado~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pessoa","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pessoa"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/retornapessoaporlegacyid"}],"panels":[]}]},"httpPath":"/v1/pessoas/legado/{id}"},{"label":"Retornar a pessoa por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornapessoaporid","routeSlug":"/open-api-docs/open-api-person/v1/retornapessoaporid","metadata":{"seo":{"title":"Retornar a pessoa por id","description":"Permite consultar os detalhes de uma pessoa específica pelo seu identificador (id). A resposta inclui campos completos como nome, tipo de pessoa, documentos, perfis, contatos, endereços e demais informações pertinentes ao cadastro."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retornaPessoaPorId","name":"Retornar a pessoa por id","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a pessoa por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os detalhes de uma pessoa específica pelo seu identificador (id). A resposta inclui campos completos como nome, tipo de pessoa, documentos, perfis, contatos, endereços e demais informações pertinentes ao cadastro."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_266","description":"id da pessoa","required":true}],"pointer":"/paths/~1v1~1pessoas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pessoas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_266"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/pessoas/{id}","href":"v1/retornapessoaporid","openApiOperationId":"retornaPessoaPorId","summary":"Retornar a pessoa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pessoa"}},"schemaId":"components/schemas/Pessoa"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pessoa","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pessoa"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/retornapessoaporid"}],"panels":[]}]},"httpPath":"/v1/pessoas/{id}"},{"label":"Atualizar uma pessoa por id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/atualizarpessoaporid","routeSlug":"/open-api-docs/open-api-person/v1/atualizarpessoaporid","metadata":{"seo":{"title":"Atualizar uma pessoa por id","description":"Permite substituir ou atualizar integralmente o cadastro de uma pessoa existente identificada por id. Indicada quando há necessidade de modificar vários campos de uma vez."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"atualizarPessoaPorId","name":"Atualizar uma pessoa por id","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualizar uma pessoa por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite substituir ou atualizar integralmente o cadastro de uma pessoa existente identificada por id. Indicada quando há necessidade de modificar vários campos de uma vez."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_266","description":"ID da pessoa a ser atualizada","required":true}],"pointer":"/paths/~1v1~1pessoas~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizarPessoa"}},"schemaId":"components/schemas/AtualizarPessoa","pointer":"/paths/~1v1~1pessoas~1{id}/put/requestBody","description":"Dados da pessoa a ser atualizada"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/pessoas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_266"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AtualizarPessoa"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/pessoas/{id}","href":"v1/atualizarpessoaporid","openApiOperationId":"atualizarPessoaPorId","summary":"Atualizar uma pessoa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AtualizarPessoa","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizarPessoa"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoAtualizacaoPessoa"}},"schemaId":"components/schemas/ResumoAtualizacaoPessoa"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResumoAtualizacaoPessoa","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoAtualizacaoPessoa"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/atualizarpessoaporid"}],"panels":[]}]},"httpPath":"/v1/pessoas/{id}"},{"label":"Atualizar parcialmente uma pessoa por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/atualizarparcialmentepessoa","routeSlug":"/open-api-docs/open-api-person/v1/atualizarparcialmentepessoa","metadata":{"seo":{"title":"Atualizar parcialmente uma pessoa por id","description":"Permite atualizar parcialmente o cadastro de uma pessoa existente (por exemplo: alterar email, telefone, tipo de perfil ou endereço) identificada por id. Essa abordagem garante menor impacto e maior controle na atualização dos dados."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"atualizarParcialmentePessoa","name":"Atualizar parcialmente uma pessoa por id","isWebhook":false,"pointer":"/paths/~1v1~1pessoas~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualizar parcialmente uma pessoa por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite atualizar parcialmente o cadastro de uma pessoa existente (por exemplo: alterar email, telefone, tipo de perfil ou endereço) identificada por id. Essa abordagem garante menor impacto e maior controle na atualização dos dados."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_266","description":"ID da pessoa a ser atualizada","required":true}],"pointer":"/paths/~1v1~1pessoas~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoParcialPessoa"}},"schemaId":"components/schemas/AtualizacaoParcialPessoa","pointer":"/paths/~1v1~1pessoas~1{id}/patch/requestBody","description":"Dados da pessoa a serem atualizados"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/pessoas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_266"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AtualizacaoParcialPessoa"}},"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/pessoas/{id}","href":"v1/atualizarparcialmentepessoa","openApiOperationId":"atualizarParcialmentePessoa","summary":"Atualizar parcialmente uma pessoa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AtualizacaoParcialPessoa","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoParcialPessoa"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1pessoas~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/atualizarparcialmentepessoa"}],"panels":[]}]},"httpPath":"/v1/pessoas/{id}"}],"content":{"contentType":"group","meta":{"name":"v1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"v1","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas a pessoas"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/pessoas","summary":"Retornar as pessoas por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/retornapessoasporfiltros","deprecated":false},{"title":"/v1/pessoas","summary":"Criar uma nova pessoa","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/criarpessoa","deprecated":false},{"title":"/v1/pessoas/ativar","summary":"Ativar pessoas em lote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/ativarpessoasemlote","deprecated":false},{"title":"/v1/pessoas/conta-conectada","summary":"Retornar dados da empresa conectada","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/retornaempresadacontaconectada","deprecated":false},{"title":"/v1/pessoas/excluir","summary":"Excluir pessoas em lote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/excluirpessoasemlote","deprecated":false},{"title":"/v1/pessoas/inativar","summary":"Desativar pessoas em lote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/desativarpessoasemlote","deprecated":false},{"title":"/v1/pessoas/legado/{id}","summary":"Retornar a pessoa por legacyid","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/retornapessoaporlegacyid","deprecated":false},{"title":"/v1/pessoas/{id}","summary":"Retornar a pessoa por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/retornapessoaporid","deprecated":false},{"title":"/v1/pessoas/{id}","summary":"Atualizar uma pessoa por id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/v1/atualizarpessoaporid","deprecated":false},{"title":"/v1/pessoas/{id}","summary":"Atualizar parcialmente uma pessoa por id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/v1/atualizarparcialmentepessoa","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AtualizacaoContatoCobrancaFaturamento":{"id":"components/schemas/AtualizacaoContatoCobrancaFaturamento","kind":"json-schema","title":"AtualizacaoContatoCobrancaFaturamento","data":{"description":"Modelo de atualização de contato para cobrança e faturamento de pessoa","type":"object","properties":{"emails":{"description":"Emails do contato de cobrança e faturamento","type":"array","items":{"type":"string"},"example":["carlos.oliveira@email.com","joao.silva@email.com"]},"whatsapp":{"description":"Telefone do contato de cobrança e faturamento","type":"string","example":"5511999999999"}}}},"components/schemas/AtualizacaoEnderecoPessoa":{"id":"components/schemas/AtualizacaoEnderecoPessoa","kind":"json-schema","title":"AtualizacaoEnderecoPessoa","data":{"description":"Modelo de atualização de endereço de pessoa","type":"object","required":["pais"],"properties":{"bairro":{"description":"Bairro do endereço","type":"string","maxLength":100,"example":"Centro"},"cep":{"description":"CEP do endereço","type":"string","example":"12345-678"},"cidade":{"description":"Cidade do endereço","type":"string","example":"São Paulo"},"complemento":{"description":"Complemento do endereço","type":"string","maxLength":200,"example":"Apto 45"},"estado":{"description":"Estado do endereço","type":"string","example":"SP"},"id":{"description":"ID do endereço","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"logradouro":{"description":"Logradouro do endereço","type":"string","maxLength":100,"example":"Rua das Flores"},"numero":{"description":"Número do endereço","type":"string","maxLength":10,"example":"123"},"pais":{"description":"País do endereço (Brasil se tipo_pessoa for Física ou Jurídica)","type":"string","example":"Brasil"}}}},"components/schemas/AtualizacaoInscricaoPessoa":{"id":"components/schemas/AtualizacaoInscricaoPessoa","kind":"json-schema","title":"AtualizacaoInscricaoPessoa","data":{"description":"Modelo de atualização de inscrição de pessoa","type":"object","properties":{"id":{"description":"ID da inscrição","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"indicador_inscricao_estadual":{"description":"Indicador de inscrição estadual: NAO CONTRIBUINTE, CONTRIBUINTE ou ISENTO","allOf":[{"$ref":"#/components/schemas/Indicador"}]},"inscricao_estadual":{"description":"Inscrição estadual","type":"string","maxLength":20,"example":"123456789"},"inscricao_municipal":{"description":"Inscrição municipal","type":"string","maxLength":20,"example":"123456789"},"inscricao_suframa":{"description":"Inscrição SUFRAMA","type":"string","maxLength":9,"minLength":8,"example":"123456789"}}}},"components/schemas/AtualizacaoOutroContatoPessoa":{"id":"components/schemas/AtualizacaoOutroContatoPessoa","kind":"json-schema","title":"AtualizacaoOutroContatoPessoa","data":{"description":"Modelo de atualização de outros contatos de pessoa","type":"object","required":["cargo","email","nome","telefone_celular","telefone_comercial"],"properties":{"cargo":{"description":"Cargo do contato","type":"string","maxLength":40,"example":"Gerente"},"email":{"description":"Email do contato","type":"string","maxLength":100,"example":"maria.silva@email.com"},"id":{"description":"ID do contato","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"nome":{"description":"Nome do contato","type":"string","maxLength":40,"example":"Maria Silva"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"(11) 98765-4321"},"telefone_comercial":{"description":"Telefone comercial do contato","type":"string","example":"(11) 1234-5678"}}}},"components/schemas/AtualizacaoParcialPessoa":{"id":"components/schemas/AtualizacaoParcialPessoa","kind":"json-schema","title":"AtualizacaoParcialPessoa","data":{"description":"Modelo de atualização parcial de pessoa","type":"object","properties":{"agencia_publica":{"description":"Indica se a pessoa é uma agência pública","type":"boolean","example":true},"ativo":{"description":"Indica se a pessoa está ativa","type":"boolean","example":true},"cnpj":{"description":"CNPJ da pessoa jurídica","type":"string","example":"12.345.678/0001-90"},"codigo":{"description":"Código da pessoa","type":"string","example":"CLI001"},"contato_cobranca_faturamento":{"description":"Contato de cobrança e faturamento","allOf":[{"$ref":"#/components/schemas/AtualizacaoContatoCobrancaFaturamento"}]},"cpf":{"description":"CPF da pessoa física","type":"string","example":"123.456.789-00"},"data_nascimento":{"description":"Data de nascimento da pessoa física","type":"string","example":"1990-01-01"},"email":{"description":"Emails da pessoa separados por vírgula","type":"string","example":"joao.silva@email.com, maria.silva@email.com"},"enderecos":{"description":"Lista de endereços","type":"array","items":{"$ref":"#/components/schemas/EnderecoAtualizacaoParcial"}},"inscricoes":{"description":"Lista de inscrições estaduais e municipais","type":"array","items":{"$ref":"#/components/schemas/InscricaoAtualizacaoParcial"}},"nome":{"description":"Nome da pessoa","type":"string","example":"João Silva"},"nome_empresa":{"description":"Nome fantasia da pessoa jurídica","type":"string","example":"Empresa LTDA"},"observacao":{"description":"Observações sobre a pessoa","type":"string","example":"Cliente preferencial"},"optante_simples_nacional":{"description":"Indica se a pessoa é optante pelo Simples Nacional","type":"boolean","example":true},"perfis":{"description":"Lista de perfis associados à pessoa","type":"array","items":{"$ref":"#/components/schemas/AtualizacaoTipoPerfil"}},"rg":{"description":"Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.","type":"string","example":"12.345.678-9"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"11987654321"},"telefone_comercial":{"description":"Telefone comercial da pessoa","type":"string","example":"1112345678"},"tipo_pessoa":{"description":"Tipo de pessoa: Física, Jurídica ou Estrangeira","allOf":[{"$ref":"#/components/schemas/TipoPessoa"}],"example":"Física"}}}},"components/schemas/AtualizacaoTipoPerfil":{"id":"components/schemas/AtualizacaoTipoPerfil","kind":"json-schema","title":"AtualizacaoTipoPerfil","data":{"description":"Modelo atualização de tipo de perfil","type":"object","required":["tipo_perfil"],"properties":{"tipo_perfil":{"description":"Tipo de perfil: Cliente, Fornecedor ou Transportadora","allOf":[{"$ref":"#/components/schemas/Perfil"}],"example":"Cliente"}}}},"components/schemas/AtualizarPessoa":{"id":"components/schemas/AtualizarPessoa","kind":"json-schema","title":"AtualizarPessoa","data":{"description":"Modelo de atualização de pessoa","type":"object","required":["codigo","data_nascimento","email","enderecos","nome","observacao","outros_contatos","perfis","telefone_celular","telefone_comercial","tipo_pessoa"],"properties":{"agencia_publica":{"description":"Indica se a pessoa é uma agência pública","type":"boolean","example":false},"ativo":{"description":"Indica se a pessoa está ativa","type":"boolean","example":true},"cnpj":{"description":"CNPJ da pessoa jurídica","type":"string","example":"12.345.678/0001-90"},"codigo":{"description":"Código da pessoa","type":"string","maxLength":20,"example":"CLI001"},"contato_cobranca_faturamento":{"description":"Contato de cobrança e faturamento","allOf":[{"$ref":"#/components/schemas/AtualizacaoContatoCobrancaFaturamento"}]},"cpf":{"description":"CPF da pessoa física","type":"string","example":"123.456.789-00"},"data_nascimento":{"description":"Data de nascimento da pessoa física","type":"string","example":"1990-01-01"},"email":{"description":"Emails da pessoa separados por vírgula","type":"string","maxLength":100,"example":"joao.silva@email.com, maria.silva@email.com"},"enderecos":{"description":"Lista de endereços","type":"array","items":{"$ref":"#/components/schemas/AtualizacaoEnderecoPessoa"}},"inscricoes":{"description":"Lista de inscrições estaduais e municipais","type":"array","items":{"$ref":"#/components/schemas/AtualizacaoInscricaoPessoa"}},"nome":{"description":"Nome da pessoa","type":"string","maxLength":200,"example":"João Silva"},"nome_fantasia":{"description":"Nome fantasia da pessoa jurídica","type":"string","maxLength":200,"example":"Empresa LTDA"},"observacao":{"description":"Observações sobre a pessoa","type":"string","maxLength":2000,"example":"Cliente preferencial"},"optante_simples":{"description":"Indica se a pessoa é optante pelo Simples Nacional","type":"boolean","example":false},"outros_contatos":{"description":"Lista de outros contatos da pessoa","type":"array","items":{"$ref":"#/components/schemas/AtualizacaoOutroContatoPessoa"}},"perfis":{"description":"Lista de perfis associados à pessoa","type":"array","items":{"$ref":"#/components/schemas/AtualizacaoTipoPerfil"}},"rg":{"description":"Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.","type":"string","maxLength":50,"example":"12.345.678-9"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"(11) 98765-4321"},"telefone_comercial":{"description":"Telefone comercial da pessoa","type":"string","example":"(11) 1234-5678"},"tipo_pessoa":{"description":"Tipo de pessoa: Física, Jurídica ou Estrangeira","allOf":[{"$ref":"#/components/schemas/TipoPessoa"}]}}}},"components/schemas/AtualizarStatusPessoasEmLote":{"id":"components/schemas/AtualizarStatusPessoasEmLote","kind":"json-schema","title":"AtualizarStatusPessoasEmLote","data":{"description":"Detalha quais IDs foram processados e qual foi o resultado para cada grupo (ativos/inativos)","type":"object","properties":{"ativos":{"description":"Lista de IDs das pessoas ativadas","type":"array","items":{"type":"string"},"example":["4BBDAE00-2242-4703-9310-9946D6C2D0A3"]},"inativos":{"description":"Lista de IDs das pessoas inativadas","type":"array","items":{"type":"string"},"example":["B6270060-3AB7-4E66-A99B-71084E385F47"]},"todos":{"description":"Lista de todos os IDs das pessoas fornecidos na requisição","type":"array","items":{"type":"string"},"example":["4BBDAE00-2242-4703-9310-9946D6C2D0A3","B6270060-3AB7-4E66-A99B-71084E385F47"]}}}},"components/schemas/ContatoCobrancaFaturamento":{"id":"components/schemas/ContatoCobrancaFaturamento","kind":"json-schema","title":"ContatoCobrancaFaturamento","data":{"description":"Modelo de contato para cobrança e faturamento de pessoa","type":"object","properties":{"emails":{"description":"Email do contato de cobrança e faturamento","type":"array","items":{"type":"string"},"example":["carlos.oliveira@email.com","joao.silva@email.com"]},"whatsapp":{"description":"Telefone do contato de cobrança e faturamento","type":"string","example":"5511999999999"}}}},"components/schemas/CriacaoContatoCobrancaFaturamento":{"id":"components/schemas/CriacaoContatoCobrancaFaturamento","kind":"json-schema","title":"CriacaoContatoCobrancaFaturamento","data":{"description":"Modelo de criação de contato para cobrança e faturamento de pessoa","type":"object","properties":{"emails":{"description":"Emails do contato de cobrança e faturamento","type":"array","items":{"type":"string"},"example":["carlos.oliveira@email.com","joao.silva@email.com"]},"whatsapp":{"description":"Telefone do contato de cobrança e faturamento","type":"string","example":"5511999999999"}}}},"components/schemas/CriacaoEnderecoPessoa":{"id":"components/schemas/CriacaoEnderecoPessoa","kind":"json-schema","title":"CriacaoEnderecoPessoa","data":{"description":"Modelo de criação de endereço de pessoa","type":"object","properties":{"bairro":{"description":"Bairro do endereço","type":"string","maxLength":100,"example":"Centro"},"cep":{"description":"CEP do endereço","type":"string","example":"12345-678"},"cidade":{"description":"Cidade do endereço","type":"string","example":"São Paulo"},"complemento":{"description":"Complemento do endereço","type":"string","maxLength":200,"example":"Apto 45"},"estado":{"description":"Estado do endereço","type":"string","example":"SP"},"logradouro":{"description":"Logradouro do endereço","type":"string","maxLength":100,"example":"Rua das Flores"},"numero":{"description":"Número do endereço","type":"string","maxLength":10,"example":"123"},"pais":{"description":"País do endereço (Brasil se tipo_pessoa for Física ou Jurídica)","type":"string","example":"Brasil"}}}},"components/schemas/CriacaoInscricaoPessoa":{"id":"components/schemas/CriacaoInscricaoPessoa","kind":"json-schema","title":"CriacaoInscricaoPessoa","data":{"description":"Modelo de criação de inscrição de pessoa","type":"object","properties":{"indicador_inscricao_estadual":{"description":"Indicador de inscrição estadual: NAO CONTRIBUINTE, CONTRIBUINTE ou ISENTO","allOf":[{"$ref":"#/components/schemas/Indicador"}],"example":"NAO CONTRIBUINTE"},"inscricao_estadual":{"description":"Inscrição estadual","type":"string","maxLength":20,"example":"123456789"},"inscricao_municipal":{"description":"Inscrição municipal","type":"string","maxLength":20,"example":"123456789"},"inscricao_suframa":{"description":"Inscrição SUFRAMA","type":"string","maxLength":9,"minLength":8,"example":"123456789"}}}},"components/schemas/CriacaoOutroContatoPessoa":{"id":"components/schemas/CriacaoOutroContatoPessoa","kind":"json-schema","title":"CriacaoOutroContatoPessoa","data":{"description":"Modelo de criação de outros contatos de pessoa","type":"object","required":["nome"],"properties":{"cargo":{"description":"Cargo do contato","type":"string","maxLength":40,"example":"Gerente"},"email":{"description":"Email do contato","type":"string","maxLength":100,"example":"maria.silva@email.com"},"nome":{"description":"Nome do contato","type":"string","maxLength":40,"example":"Maria Silva"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"11983899529"},"telefone_comercial":{"description":"Telefone comercial do contato","type":"string","example":"1138185004"}}}},"components/schemas/CriacaoPerfilPessoa":{"id":"components/schemas/CriacaoPerfilPessoa","kind":"json-schema","title":"CriacaoPerfilPessoa","data":{"description":"Modelo criação de perfil de pessoa","type":"object","required":["tipo_perfil"],"properties":{"tipo_perfil":{"description":"Tipo de perfil: Cliente, Fornecedor ou Transportadora","allOf":[{"$ref":"#/components/schemas/Perfil"}],"example":"Cliente"}}}},"components/schemas/CriarPessoa":{"id":"components/schemas/CriarPessoa","kind":"json-schema","title":"CriarPessoa","data":{"description":"Modelo de criação de pessoa","type":"object","required":["nome","tipo_pessoa"],"properties":{"agencia_publica":{"description":"Indica se a pessoa é uma agência pública","type":"boolean","example":true},"ativo":{"description":"Indica se a pessoa está ativa","type":"boolean","example":true},"cnpj":{"description":"CNPJ da pessoa jurídica","type":"string","example":"12.345.678/0001-90"},"codigo":{"description":"Código da pessoa","type":"string","maxLength":20,"example":"CLI001"},"contato_cobranca_faturamento":{"description":"Contato de cobrança e faturamento","allOf":[{"$ref":"#/components/schemas/CriacaoContatoCobrancaFaturamento"}]},"cpf":{"description":"CPF da pessoa física","type":"string","example":"123.456.789-00"},"data_nascimento":{"description":"Data de nascimento da pessoa física","type":"string","example":"1990-01-01"},"email":{"description":"Emails da pessoa separados por vírgula","type":"string","maxLength":100,"example":"joao.silva@email.com, maria.silva@email.com"},"enderecos":{"description":"Lista de endereços","type":"array","items":{"$ref":"#/components/schemas/CriacaoEnderecoPessoa"}},"inscricoes":{"description":"Lista de inscrições estaduais e municipais","type":"array","items":{"$ref":"#/components/schemas/CriacaoInscricaoPessoa"}},"nome":{"description":"Nome da pessoa","type":"string","maxLength":200,"example":"João Silva"},"nome_fantasia":{"description":"Nome fantasia da pessoa jurídica","type":"string","maxLength":200,"example":"Empresa LTDA"},"observacao":{"description":"Observações sobre a pessoa","type":"string","maxLength":2000,"example":"Cliente preferencial"},"optante_simples":{"description":"Indica se a pessoa é optante pelo Simples Nacional","type":"boolean","example":true},"outros_contatos":{"description":"Lista de outros contatos da pessoa","type":"array","items":{"$ref":"#/components/schemas/CriacaoOutroContatoPessoa"}},"perfis":{"description":"Lista de perfis associados à pessoa","type":"array","items":{"$ref":"#/components/schemas/CriacaoPerfilPessoa"}},"rg":{"description":"Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.","type":"string","maxLength":50,"example":"12.345.678-9"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"11983899529"},"telefone_comercial":{"description":"Telefone comercial da pessoa","type":"string","example":"1138185004"},"tipo_pessoa":{"description":"Tipo de pessoa: Física, Jurídica ou Estrangeira","allOf":[{"$ref":"#/components/schemas/TipoPessoa"}],"example":"Física"}}}},"components/schemas/Empresa":{"id":"components/schemas/Empresa","kind":"json-schema","title":"Empresa","data":{"description":"Modelo para empresa","type":"object","properties":{"data_fundacao":{"type":"string","example":"2012-01-01"},"documento":{"type":"string","example":"05206246000138"},"email":{"type":"string","example":"api@contaazul.com"},"id_empresa":{"type":"string","example":"123456"},"nome_fantasia":{"type":"string","example":"Conta Azul"},"razao_social":{"type":"string","example":"Conta Azul Software Ltda"}}}},"components/schemas/EnderecoAtualizacaoParcial":{"id":"components/schemas/EnderecoAtualizacaoParcial","kind":"json-schema","title":"EnderecoAtualizacaoParcial","data":{"description":"Modelo de endereço para atualização parcial","type":"object","properties":{"bairro":{"description":"Bairro do endereço","type":"string","example":"Centro"},"cep":{"description":"CEP do endereço","type":"string","example":"12345-678"},"cidade":{"description":"Cidade do endereço","type":"string","example":"São Paulo"},"complemento":{"description":"Complemento do endereço","type":"string","example":"Apto 45"},"estado":{"description":"Estado do endereço","type":"string","example":"SP"},"id":{"description":"ID do endereço","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"logradouro":{"description":"Logradouro do endereço","type":"string","example":"Rua das Flores"},"numero":{"description":"Número do endereço","type":"string","example":"123"},"pais":{"description":"País do endereço","type":"string","example":"Brasil"}}}},"components/schemas/EnderecoPessoa":{"id":"components/schemas/EnderecoPessoa","kind":"json-schema","title":"EnderecoPessoa","data":{"type":"object","properties":{"bairro":{"description":"Bairro do endereço","type":"string","example":"Centro"},"cep":{"description":"CEP do endereço","type":"string","example":"12345-678"},"cidade":{"description":"Cidade do endereço","type":"string","example":"São Paulo"},"complemento":{"description":"Complemento do endereço","type":"string","example":"Apto 45"},"estado":{"description":"Estado do endereço","type":"string","example":"SP"},"id":{"description":"ID do endereço","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"id_cidade":{"description":"ID da cidade","type":"integer","example":3550308},"logradouro":{"description":"Logradouro do endereço","type":"string","example":"Rua das Flores"},"numero":{"description":"Número do endereço","type":"string","example":"123"},"pais":{"description":"País do endereço","type":"string","example":"Brasil"}}}},"components/schemas/ErroAPI":{"id":"components/schemas/ErroAPI","kind":"json-schema","title":"ErroAPI","data":{"description":"Modelo de resposta para erros da API","type":"object","properties":{"error":{"description":"Mensagem de erro","type":"string","example":"Mensagem de erro detalhada"}}}},"components/schemas/Indicador":{"id":"components/schemas/Indicador","kind":"json-schema","title":"Indicador","data":{"description":"Enum de indicador de inscrição estadual","type":"string","enum":["NAO CONTRIBUINTE","CONTRIBUINTE","ISENTO"],"x-enum-varnames":["NO_CONTRIBUTOR","CONTRIBUTOR","IMMUNE_CONTRIBUTOR"]}},"components/schemas/InformacoesFiscais":{"id":"components/schemas/InformacoesFiscais","kind":"json-schema","title":"InformacoesFiscais","data":{"type":"object","properties":{"id":{"description":"ID da informação fiscal","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"indicador_inscricao_estadual":{"description":"Indicador de inscrição estadual","allOf":[{"$ref":"#/components/schemas/Indicador"}],"example":"NAO CONTRIBUINTE"},"inscricao_estadual":{"description":"Inscrição estadual","type":"string","example":"123456789"},"inscricao_municipal":{"description":"Inscrição municipal","type":"string","example":"12345678901234"},"inscricao_suframa":{"description":"Inscrição SUFRAMA","type":"string","example":"123456789"}}}},"components/schemas/InscricaoAtualizacaoParcial":{"id":"components/schemas/InscricaoAtualizacaoParcial","kind":"json-schema","title":"InscricaoAtualizacaoParcial","data":{"description":"Modelo de inscrição para atualização parcial","type":"object","properties":{"indicador_inscricao_estadual":{"description":"Indicador de inscrição estadual: NAO CONTRIBUINTE, CONTRIBUINTE ou ISENTO","allOf":[{"$ref":"#/components/schemas/Indicador"}],"example":"NAO CONTRIBUINTE"},"inscricao_estadual":{"description":"Inscrição estadual","type":"string","example":"123456789"},"inscricao_municipal":{"description":"Inscrição municipal","type":"string","example":"123456789"},"inscricao_suframa":{"description":"Inscrição SUFRAMA","type":"string","example":"123456789"}}}},"components/schemas/InscricaoPessoa":{"id":"components/schemas/InscricaoPessoa","kind":"json-schema","title":"InscricaoPessoa","data":{"description":"Modelo de inscrição de pessoa","type":"object","properties":{"id":{"description":"ID da inscrição","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"indicador_inscricao_estadual":{"description":"Indicador de inscrição estadual: NAO CONTRIBUINTE, CONTRIBUINTE ou ISENTO","allOf":[{"$ref":"#/components/schemas/Indicador"}],"example":"NAO CONTRIBUINTE"},"inscricao_estadual":{"description":"Inscrição estadual","type":"string","example":"123456789"},"inscricao_municipal":{"description":"Inscrição municipal","type":"string","example":"123456789"},"inscricao_suframa":{"description":"Inscrição SUFRAMA","type":"string","example":"123456789"}}}},"components/schemas/ItemResumoDePessoasPorFiltro":{"id":"components/schemas/ItemResumoDePessoasPorFiltro","kind":"json-schema","title":"ItemResumoDePessoasPorFiltro","data":{"description":"Item do resumo de pessoas por filtro","type":"object","properties":{"ativo":{"description":"Indica se a pessoa está ativa ou inativa","type":"boolean","example":true},"data_alteracao":{"description":"Data/hora da última alteração","type":"string","format":"date-time","example":"2024-01-15T10:30:00"},"data_criacao":{"description":"Data/hora de criação","type":"string","format":"date-time","example":"2024-01-15T10:30:00"},"documento":{"description":"Documento da pessoa (CPF/CNPJ)","type":"string","example":"123.456.789-00"},"email":{"description":"Email da pessoa","type":"string","example":"joao.silva@email.com"},"endereco":{"description":"Endereço da pessoa","allOf":[{"$ref":"#/components/schemas/EnderecoPessoa"}]},"id":{"description":"ID da pessoa","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"id_legado":{"description":"ID legado da pessoa","type":"integer","example":12345},"nome":{"description":"Nome da pessoa (física, jurídica ou estrangeira)","type":"string","example":"João Silva"},"observacoes_gerais":{"description":"Observações gerais sobre a pessoa","type":"string","example":"Cliente preferencial"},"perfis":{"description":"Perfis associados à pessoa (Cliente, Fornecedor, Transportadora)","type":"array","items":{"type":"string"},"example":["CLIENTE","FORNECEDOR","TRANSPORTADORA"]},"telefone":{"description":"Telefone da pessoa","type":"string","example":"(11) 1234-5678"},"tipo_pessoa":{"description":"Tipo de pessoa (Física, Jurídica ou Estrangeira)","type":"string","example":"FISICA"},"uuid_legado":{"description":"UUID legado da pessoa","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"}}}},"components/schemas/LembretesVencimento":{"id":"components/schemas/LembretesVencimento","kind":"json-schema","title":"LembretesVencimento","data":{"type":"object","properties":{"ativo":{"description":"Status do lembrete de vencimento","type":"boolean","example":true},"email":{"description":"Email do lembrete de vencimento","type":"string","example":"lembrete@email.com"},"id":{"description":"ID do lembrete de vencimento","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"}}}},"components/schemas/MensagensPagamentosAbertos":{"id":"components/schemas/MensagensPagamentosAbertos","kind":"json-schema","title":"MensagensPagamentosAbertos","data":{"type":"object","properties":{"numero":{"description":"Número de mensagens de pagamentos em aberto","type":"integer","example":10},"total":{"description":"Total de mensagens de pagamentos em aberto","type":"integer","example":10}}}},"components/schemas/OutrosContatos":{"id":"components/schemas/OutrosContatos","kind":"json-schema","title":"OutrosContatos","data":{"type":"object","properties":{"cargo":{"description":"Escritório do contato","type":"string","example":"Escritório Central"},"email":{"description":"Email do contato","type":"string","example":"maria.silva@email.com"},"id":{"description":"ID do contato","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"nome":{"description":"Nome do contato","type":"string","example":"Maria Silva"},"telefone_celular":{"description":"Celular do contato","type":"string","example":"11987654321"},"telefone_comercial":{"description":"Telefone comercial do contato","type":"string","example":"1112345678"}}}},"components/schemas/ParamAtualizarStatusPessoasEmLote":{"id":"components/schemas/ParamAtualizarStatusPessoasEmLote","kind":"json-schema","title":"ParamAtualizarStatusPessoasEmLote","data":{"description":"IDs das pessoas que serão inativadas/ativadas em lote","type":"object","required":["uuids"],"properties":{"uuids":{"description":"máximo de 10 IDs","type":"array","maxItems":10,"minItems":1,"items":{"type":"string"},"example":["4BBDAE00-2242-4703-9310-9946D6C2D0A3","B6270060-3AB7-4E66-A99B-71084E385F47"]}}}},"components/schemas/ParamDeletarPessoasEmLote":{"id":"components/schemas/ParamDeletarPessoasEmLote","kind":"json-schema","title":"ParamDeletarPessoasEmLote","data":{"description":"IDs das pessoas que serão deletadas em lote","type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"example":["4BBDAE00-2242-4703-9310-9946D6C2D0A3","B6270060-3AB7-4E66-A99B-71084E385F47"]}}}},"components/schemas/Perfil":{"id":"components/schemas/Perfil","kind":"json-schema","title":"Perfil","data":{"description":"Enum de perfil de pessoa","type":"string","enum":["Cliente","Fornecedor","Transportadora"],"x-enum-varnames":["CLIENT","PROVIDER","TRANSPORTER"]}},"components/schemas/PerfilPessoa":{"id":"components/schemas/PerfilPessoa","kind":"json-schema","title":"PerfilPessoa","data":{"description":"Modelo de perfil de pessoa","type":"object","properties":{"id":{"description":"ID do perfil","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"tipo_perfil":{"description":"Tipo de perfil: Cliente, Fornecedor ou Transportadora","type":"string","example":"Cliente"}}}},"components/schemas/Pessoa":{"id":"components/schemas/Pessoa","kind":"json-schema","title":"Pessoa","data":{"type":"object","properties":{"ativo":{"description":"Ativo","type":"boolean","example":true},"atrasos_pagamentos":{"description":"Atrasos nos pagamentos","type":"number","example":750.25},"atrasos_recebimentos":{"description":"Atrasos nos recebimentos","type":"number","example":1500.5},"codigo":{"description":"Código da pessoa","type":"string","example":"CLI001"},"contato_cobranca_faturamento":{"description":"Contato para cobrança e faturamento","allOf":[{"$ref":"#/components/schemas/ContatoCobrancaFaturamento"}]},"criado_em":{"description":"Data de criação da pessoa (ISO 8601, São Paulo/GMT-3)","type":"string","format":"date","example":"2024-01-15"},"data_alteracao":{"description":"Data de alteração da pessoa (ISO 8601, São Paulo/GMT-3)","type":"string","format":"date-time","example":"2024-01-15T10:30:00"},"data_nascimento":{"description":"Data de nascimento","type":"string","example":"1990-01-01"},"documento":{"description":"Documento da pessoa","type":"string","example":"123.456.789-00"},"email":{"description":"Emails da pessoa separados por vírgula","type":"string","example":"joao.silva@email.com, maria.silva@email.com"},"enderecos":{"description":"Endereços da pessoa","type":"array","items":{"$ref":"#/components/schemas/EnderecoPessoa"}},"id":{"description":"ID da pessoa","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"inscricoes":{"description":"Informações fiscais","type":"array","items":{"$ref":"#/components/schemas/InformacoesFiscais"}},"lembretes_vencimento":{"description":"Lembretes de vencimento","type":"array","items":{"$ref":"#/components/schemas/LembretesVencimento"}},"mensagem_pagamentos_abertos":{"description":"Mensagens de pagamentos em aberto","allOf":[{"$ref":"#/components/schemas/MensagensPagamentosAbertos"}]},"nome":{"description":"Nome da pessoa","type":"string","example":"João Silva"},"nome_empresa":{"description":"Nome da empresa","type":"string","example":"Empresa LTDA"},"observacao":{"description":"Observações gerais da pessoa","type":"string","example":"Observação geral"},"optante_simples_nacional":{"description":"Optante do Simples Nacional","type":"boolean","example":true},"orgao_publico":{"description":"Órgão público","type":"boolean","example":true},"outros_contatos":{"description":"Outros contatos","type":"array","items":{"$ref":"#/components/schemas/OutrosContatos"}},"pagamentos_mes_atual":{"description":"Pagamentos do mês atual","type":"number","example":2500},"perfis":{"description":"Perfis da pessoa","type":"array","items":{"$ref":"#/components/schemas/TipoPerfil"}},"pessoas_legado":{"description":"Pessoas legadas","type":"array","items":{"$ref":"#/components/schemas/PessoaLegada"}},"recebimentos_mes_atual":{"description":"Recebimentos do mês atual","type":"number","example":5000},"rg":{"description":"Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.","type":"string","example":"12.345.678-9"},"telefone_celular":{"description":"Celular da pessoa","type":"string","example":"(11) 98765-4321"},"telefone_comercial":{"description":"Telefone comercial da pessoa","type":"string","example":"(11) 1234-5678"},"tipo_pessoa":{"description":"Tipo de pessoa","type":"string","example":"FISICA"}}}},"components/schemas/PessoaLegada":{"id":"components/schemas/PessoaLegada","kind":"json-schema","title":"PessoaLegada","data":{"type":"object","properties":{"id":{"description":"ID da pessoa legada","type":"integer","example":12345},"perfil":{"description":"Perfil da pessoa legada","type":"string","example":"CLIENTE"},"uuid":{"description":"UUID da pessoa legada","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"}}}},"components/schemas/ResumoAtualizacaoPessoa":{"id":"components/schemas/ResumoAtualizacaoPessoa","kind":"json-schema","title":"ResumoAtualizacaoPessoa","data":{"description":"Resumo de atualização de pessoa","type":"object","properties":{"agencia_publica":{"description":"Indica se a pessoa é uma agência pública","type":"boolean","example":false},"ativo":{"description":"Indica se a pessoa está ativa","type":"boolean","example":true},"cnpj":{"description":"CNPJ da pessoa jurídica","type":"string","example":"12.345.678/0001-90"},"codigo":{"description":"Código da pessoa","type":"string","example":"CLI001"},"contato_cobranca_faturamento":{"description":"Contato para cobrança e faturamento","allOf":[{"$ref":"#/components/schemas/ContatoCobrancaFaturamento"}]},"cpf":{"description":"CPF da pessoa física","type":"string","example":"123.456.789-00"},"data_nascimento":{"description":"Data de nascimento da pessoa física","type":"string","example":"1990-01-01"},"email":{"description":"Emails da pessoa separados por vírgula","type":"string","example":"joao.silva@email.com, maria.silva@email.com"},"enderecos":{"description":"Lista de endereços","type":"array","items":{"$ref":"#/components/schemas/EnderecoPessoa"}},"estrangeiro":{"description":"Indica se a pessoa é estrangeira","type":"boolean","example":false},"id":{"description":"ID da pessoa","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"inscricoes":{"description":"Lista de inscrições","type":"array","items":{"$ref":"#/components/schemas/InscricaoPessoa"}},"nome":{"description":"Nome da pessoa","type":"string","example":"João Silva"},"nome_fantasia":{"description":"Nome fantasia da pessoa jurídica","type":"string","example":"Empresa LTDA"},"observacao":{"description":"Observações sobre a pessoa","type":"string","example":"Cliente preferencial"},"optante_simples":{"description":"Indica se a pessoa é optante pelo Simples Nacional","type":"boolean","example":false},"origem":{"description":"Origem da criação da pessoa","type":"string","example":"API"},"outros_contatos":{"description":"Lista de outros contatos","type":"array","items":{"$ref":"#/components/schemas/OutrosContatos"}},"perfis":{"description":"Lista de perfis","type":"array","items":{"$ref":"#/components/schemas/PerfilPessoa"}},"rg":{"description":"Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.","type":"string","example":"12.345.678-9"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"(11) 98765-4321"},"telefone_comercial":{"description":"Telefone comercial da pessoa","type":"string","example":"(11) 1234-5678"},"tipo_pessoa":{"description":"Tipo de pessoa: Física, Jurídica ou Estrangeira","type":"string","example":"FISICA"}}}},"components/schemas/ResumoCriacaoPessoa":{"id":"components/schemas/ResumoCriacaoPessoa","kind":"json-schema","title":"ResumoCriacaoPessoa","data":{"description":"Resumo de criação de pessoa","type":"object","properties":{"agencia_publica":{"description":"Indica se a pessoa é uma agência pública","type":"boolean","example":false},"ativo":{"description":"Indica se a pessoa está ativa","type":"boolean","example":true},"cnpj":{"description":"CNPJ da pessoa jurídica","type":"string","example":"12.345.678/0001-90"},"codigo":{"description":"Código da pessoa","type":"string","example":"CLI001"},"contato_cobranca_faturamento":{"description":"Contato para cobrança e faturamento","allOf":[{"$ref":"#/components/schemas/ContatoCobrancaFaturamento"}]},"cpf":{"description":"CPF da pessoa física","type":"string","example":"123.456.789-00"},"data_nascimento":{"description":"Data de nascimento da pessoa física","type":"string","example":"1990-01-01"},"email":{"description":"Emails da pessoa separados por vírgula","type":"string","example":"joao.silva@email.com, maria.silva@email.com "},"enderecos":{"description":"Lista de endereços","type":"array","items":{"$ref":"#/components/schemas/EnderecoPessoa"}},"estrangeiro":{"description":"Indica se a pessoa é estrangeira","type":"boolean","example":false},"id":{"description":"ID da pessoa","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"inscricoes":{"description":"Lista de inscrições","type":"array","items":{"$ref":"#/components/schemas/InscricaoPessoa"}},"nome":{"description":"Nome da pessoa","type":"string","example":"João Silva"},"nome_fantasia":{"description":"Nome fantasia da pessoa jurídica","type":"string","example":"Empresa LTDA"},"observacao":{"description":"Observações sobre a pessoa","type":"string","example":"Cliente preferencial"},"optante_simples":{"description":"Indica se a pessoa é optante pelo Simples Nacional","type":"boolean","example":false},"origem":{"description":"Origem da criação da pessoa","type":"string","example":"API"},"outros_contatos":{"description":"Lista de outros contatos","type":"array","items":{"$ref":"#/components/schemas/OutrosContatos"}},"perfis":{"description":"Lista de perfis","type":"array","items":{"$ref":"#/components/schemas/PerfilPessoa"}},"rg":{"description":"Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.","type":"string","example":"12.345.678-9"},"telefone_celular":{"description":"Telefone celular","type":"string","example":"11987654321"},"telefone_comercial":{"description":"Telefone comercial da pessoa","type":"string","example":"1112345678"},"tipo_pessoa":{"description":"Tipo de pessoa: Física, Jurídica ou Estrangeira","type":"string","example":"FISICA"}}}},"components/schemas/ResumoDePessoasPorFiltro":{"id":"components/schemas/ResumoDePessoasPorFiltro","kind":"json-schema","title":"ResumoDePessoasPorFiltro","data":{"description":"Resumo de pessoas por filtro","type":"object","properties":{"items":{"description":"Lista de itens do resumo de pessoas","type":"array","items":{"$ref":"#/components/schemas/ItemResumoDePessoasPorFiltro"}},"totalItems":{"description":"Total de itens encontrados","type":"integer","example":150}}}},"components/schemas/TipoPerfil":{"id":"components/schemas/TipoPerfil","kind":"json-schema","title":"TipoPerfil","data":{"type":"object","properties":{"tipo_perfil":{"description":"Tipo de perfil: Cliente, Fornecedor ou Transportadora","allOf":[{"$ref":"#/components/schemas/Perfil"}],"example":"Cliente"}}}},"components/schemas/TipoPessoa":{"id":"components/schemas/TipoPessoa","kind":"json-schema","title":"TipoPessoa","data":{"description":"Enum de tipo de pessoa","type":"string","enum":["Física","Jurídica","Estrangeira"],"x-enum-varnames":["NATURAL","LEGAL","FOREIGN_FILTER"]}},"schema_262":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"type":"integer","enum":[10,20,50,100,200,500,1000],"default":10},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"type":"string","enum":["NOME","EMAIL","DOCUMENTO","ATIVO"],"default":"NOME"},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"type":"string","enum":["ASC","DESC"],"default":"ASC"},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"string"},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"type":"string","enum":["Física","Jurídica","Estrangeira"],"default":"Física"},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"string","enum":["Cliente","Fornecedor","Transportadora"],"default":"Cliente"},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AtualizarStatusPessoasEmLote"}},"id":"schema_270"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer '"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-person","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/open-api-docs/open-api-person","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/open-api-docs/open-api-person.json?download"},{"url":"/_bundle/open-api-docs/open-api-person.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Pessoas","description":"A API de Pessoas (v1) tem como objetivo permitir o cadastro, consulta, ativação, desativação, exclusão e atualização dos registros de pessoas (clientes, fornecedores, transportadoras) no sistema da Conta Azul.\n\nPor meio dessa funcionalidade, sistemas externos podem manter seus cadastros sincronizados, automatizar a gestão de perfis de pessoas e garantir que os dados estejam sempre atualizados entre plataformas.\n\n---\n\nSe desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:\n\nClientes: [https://ajuda.contaazul.com/hc/pt-br/articles/115007916448-Clientes-como-cadastrar](https://ajuda.contaazul.com/hc/pt-br/articles/115007916448-Clientes-como-cadastrar)\n"}},"baseSlug":"/open-api-docs/open-api-person","routesMapping":{}}