> ## Documentation Index > Fetch the complete documentation index at: https://docs.precfy.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Post ## Endpoint de Processamento de Precatórios #### POST /api/partnerId/precatorio/parse Esse endpoint permite o envio de um arquivo PDF contendo o documento de precatório para extração de dados e realiza cálculos conforme os parâmetros fornecidos. ## Requisição #### URL: [https://api.precfy.com.br/precatorios/\{partnerId}/parse](https://api.precfy.com.br/precatorios/\{partnerId}/parse) Método: POST ### Parâmetros do Caminho | Parâmetro | Tipo | Obrigatório | Descrição | | --------- | ------ | ----------- | ------------------------------------------------------------------- | | partnerId | String | Sim | Identificador exclusivo do parceiro, necessário para acessar a API. | ### Parâmetros de Dados do Formulário | Parâmetro | Tipo | Obrigatório | Padrão | Descrição | | -------------------- | ------- | ----------- | ------ | ------------------------------------------------------------------------- | | file | Arquivo | Sim | - | Arquivo PDF do precatório a ser processado. | | CORRECAO\_MONETARIA | String | Não | false | Define se a correção monetária deve ser aplicada (true ou false). | | CALCULAR\_IMPOSTOS | String | Não | false | Define se os impostos devem ser calculados sobre o valor (true ou false). | | DESTACAR\_HONORARIOS | String | Não | false | Indica se os honorários serão destacados na resposta (true ou false). | | CREDOR\_FULL\_DATA | String | Não | false | Define se deve buscar os dados do credor (true ou false). | | ADVOGADO\_FULL\_DATA | String | Não | false | Define se deve buscar os dados do advogado (true ou false). | ### Exemplo de Requisição ```json theme={null} curl --location 'https://precfy-api.azurewebsites.net/api/{partnerId}/precatorio/parse' \ --form 'file=@"/Users/usuario/Downloads/precatório_exemplo.pdf"' \ --form 'CORRECAO_MONETARIA="true"' \ --form 'CALCULAR_IMPOSTOS="true"' \ --form 'DESTACAR_HONORARIOS="true"' \ --form 'CREDOR_FULL_DATA="true"' \ --form 'ADVOGADO_FULL_DATA="true"' ``` ### Response Exemplo de Resposta Sucesso (200 OK) ```json theme={null} { "success": true, "requestId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6", "partnerId": "12345a6789b0c1234d567e890f1g2h3i", "createdAt": "2024-10-29T12:34:56.789Z", "responseInSeconds": 0.54321, "cost": 1.0, "fileHash": "abc123def456ghi789jkl012mno345pqr678stu", "content": { "processoPrecatorioNumero": "1234567-89.2023.4.01.1234", "processoPrecatorioNumeroRaw": "12345678920234011234", "processoOriginario": "1234567-89.2023.4.01.1234", "processoOriginarioRaw": "12345678920234011234", "processoExecucaoCumprimentoSentenca": "1234567-89.2023.4.01.1234", "processoExecucaoCumprimentoSentencaRaw": "12345678920234011234", "numeroRequisicao": "2023.1234.567.000001", "esfera": "FEDERAL", "natureza": "COMUM", "assunto": "(02.03.01.00) - RESCISÃO DE CONTRATO ADMINISTRATIVO - DIREITO ADMINISTRATIVO", "incidentes": "Sem Incidente", "vara": "5ª VARA - SÃO PAULO - Especialização - Vara Cível", "cidade": "SÃO PAULO", "estado": "SP", "advogadoPatrono": { "nome": "JOÃO DA SILVA", "oab": "SP123456", "oabRaw": "SP123456", "cpf": "111.222.333-44", "cpfRaw": "11122233344" }, "requerentePrincipal": "MARIA DE SOUZA", "tribunal": "TRF3", "devedor": { "nome": "UNIÃO FEDERAL", "sigla": "UF", "esfera": "FEDERAL" }, "dataExpedicao": "2023-05-01T08:00:00Z", "dataCadastro": "2023-04-30T23:59:59Z", "valorTotalRequisitado": 12345678.9, "especieRequisicao": "ORIGINAL", "superpreferencial": true, "dataTransitoJulgadoEmbargos": "2023-03-15", "dataAjuizamentoProcessoConhecimento": "2020-06-20", "dataTransitoJulgadoProcessoConhecimento": "2023-01-10", "dataDecursoPrazoConcordanciaComValorRequisitado": null, "honorariosContratuaisDestacados": true, "honorariosSucumbenciaisDestacados": false, "loa": { "anoOrcamento": 2025, "inicio": "2023-05-01T00:00:00", "fim": "2024-04-30T23:59:59.999", "limitePagamento": "2025-12-31T23:59:59.999" }, "credores": [ { "id": 1, "tipo": "BENEFICIARIO", "cpfCnpj": "222.333.444-55", "cpfCnpjRaw": "22233344455", "tipoPessoa": "PF", "nome": "ANTONIO CARLOS", "dataNascimento": "1970-08-15", "idade": 53, "preferenciaPor": "IDOSO", "doencaGrave": null, "portadorDeficiencia": false, "idoso": true, "dataBase": "2022-12-01", "valorPrincipal": 12345678.9, "valorJuros": 0.0, "impostos": { "pss": { "incide": false, "dataBase": null, "valorInicialPSS": 0.0 }, "iR_RRA": { "incide": true, "mesesExeAnterior": 12 } }, "renuncia": false, "jurosFixados": null, "status": "REGULAR", "valorRequisitado": 12345678.9, "percentualCredor": 1.0 } ], "warnings": [] }, "errors": [] } ``` ### Detalhamento dos Campos do Response | Campo | Tipo de dado. | Descrição | | --------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `content.processoPrecatorioNumero` | String | Número do processo do precatório no formato padronizado. | | `content.processoPrecatorioNumeroRaw` | String | Número do processo do precatório sem formatação, contendo apenas dígitos. | | `content.processoOriginario` | String | Número do processo originário do caso, formatado. | | `content.processoOriginarioRaw` | String | Número do processo originário sem formatação. | | `content.processoExecucaoCumprimentoSentenca` | String | Número do processo de execução ou cumprimento de sentença, formatado. | | `content.processoExecucaoCumprimentoSentencaRaw` | String | Número do processo de execução ou cumprimento de sentença sem formatação. | | `content.numeroRequisicao` | String | Número da requisição do precatório no tribunal. | | `content.esfera` | String | Esfera judicial em que o processo se encontra, como "FEDERAL", "ESTADUAL" ou "MUNICIPAL". | | `content.natureza` | String | Natureza do processo, como "COMUM", "ALIMENTAR" ou "COMUM\_TRIBUTARIO". | | `content.assunto` | String | Assunto principal do caso, que pode incluir uma breve descrição, como por exemplo "DESAPROPRIAÇÃO POR INTERESSE SOCIAL PARA REFORMA AGRÁRIA"; "040104 - Aposentadoria Especial (Art. 57/8)". | | `content.incidentes` | String | Detalhes sobre incidentes processuais, se houver, ou "Sem Incidente" se não aplicável. | | `content.vara` | String | Vara judicial responsável pelo caso, incluindo especialização, se aplicável. | | `content.cidade` | String | Cidade em que o processo foi registrado ou está sendo julgado. | | `content.estado` | String | Estado da federação onde o processo está sendo conduzido. | | `content.advogadoPatrono.nome` | String | Nome do advogado principal que representa o caso. | | `content.advogadoPatrono.oab` | String | OAB do advogado principal que representa o caso. | | `content.advogadoPatrono.oabRaw` | String | OAB sem formatação do advogado principal que representa o caso. | | `content.advogadoPatrono.cpf` | String | CPF do advogado principal que representa o caso. | | `content.advogadoPatrono.cpfRaw` | String | CPF sem formatação do advogado principal que representa o caso. | | `content.requerentePrincipal` | String | Nome do requerente principal do processo. | | `content.tribunal` | String | Tribunal responsável pelo julgamento ou homologação do precatório, como "TRF1", "TRF2", "TRF3", "TRF4", "TRF5", "TRF6", "TJSP". | | `content.devedor.nome` | String | Nome do devedor do processo. | | `content.devedor.sigla` | String | Sigla do devedor do processo. | | `content.devedor.esfera` | String | Esfera judicial do devedor do processo (ex: "FEDERAL"). | | `content.dataExpedicao` | Data (String) | Data e hora de expedição do precatório no formato ISO 8601. | | `content.dataCadastro` | Data (String) | Data e hora de cadastro do precatório no sistema, em formato ISO 8601. | | `content.valorTotalRequisitado` | Número (Float) | Valor total requisitado no precatório. | | `content.especieRequisicao` | String | Espécie de requisição, como "ORIGINAL" ou "SUPLEMENTAR". | | `content.superpreferencial` | Boolean | Indica se o precatório é superpreferencial (`true`) ou não (`false`). | | `content.dataTransitoJulgadoEmbargos` | Data (String) | Data em que o trânsito em julgado dos embargos ocorreu, se aplicável, no formato ISO 8601. | | `content.dataAjuizamentoProcessoConhecimento` | Data (String) | Data de ajuizamento do processo de conhecimento. | | `content.dataTransitoJulgadoProcessoConhecimento` | Data (String) | Data de trânsito em julgado do processo de conhecimento. | | `content.dataDecursoPrazoConcordanciaComValorRequisitado` | Data (String) | Data limite para concordância com o valor requisitado, se aplicável. | | `content.honorariosContratuaisDestacados` | Boolean | Indica se os honorários contratuais são destacados (`true`) ou não (`false`). | | `content.honorariosSucumbenciaisDestacados` | Boolean | Indica se os honorários sucumbenciais são destacados (`true`) ou não (`false`). | | `content.loa.anoOrcamento` | String | Ano de orçamento do processo. | | `content.loa.inicio` | Data (String) | Data de início do orçamento. | | `content.loa.fim` | Data (String) | Data de fim do orçamento. | | `content.loa.limitePagamento` | Data (String) | Datas de limite de pagamento. | | `content.credores.id` | String | ID do Credor do processo. | | `content.credores.tipo` | String | Tipo do Credor do processo (ex: "BENEFICIARIO", "HONORÁRIOS"). | | `content.credores.cpfCnpj` | String | CPF/CNPJ formatado do Credor do processo. | | `content.credores.cpfCnpjRaw` | String | CPF/CNPJ sem formatação do Credor do processo. | | `content.credores.tipoPessoa` | String | Tipo de pessoa do processo (ex: PF/PJ). | | `content.credores.nome` | String | Nome do Credor do processo. | | `content.credores.dataNascimento` | Data (String) | Data de nascimento do Credor do processo (se aplicável). | | `content.credores.idade` | String | Idade do Credor do processo. | | `content.credores.preferenciaPor` | String | Preferência do Credor (ex: "IDOSO", "DOENÇA"). | | `content.credores.doencaGrave` | Boolean | Se o Credor é portador de Doença Grave. | | `content.credores.portadorDeficiencia` | Boolean | Se o Credor é portador de Deficiência. | | `content.credores.idoso` | Boolean | Se o Credor é Idoso. | | `content.credores.dataBase` | Data (String) | Data base do processo. | | `content.credores.valorPrincipal` | Número (Float) | Valor principal do Processo sem os juros. | | `content.credores.valorJuros` | Número (Float) | Valor de juros do Processo. | | `content.credores.impostos.pss.incide` | Array de objetos | Se incide cobrança de PSS. | | `content.credores.impostos.pss.dataBase` | Data (String) | Data base do PSS. | | `content.credores.impostos.pss.valorInicialPSS` | Número (Float) | Valor inicial do PSS. | | `content.credores.impostos.iR_RRA.incide` | Boolean | Se incide cobrança de RRA. | | `content.credores.impostos.iR_RRA.mesesExeAnterior` | String | Quantidade de meses do RRA. | | `content.warnings` | String | Lista de avisos sobre o processo ou a extração, se aplicável. | | `content.errors` | String | Lista de erros ocorridos na extração dos dados, se aplicável. | ### Códigos de Status HTTP | Código | Significado | Descrição | | ------ | --------------------- | ------------------------------------------------------------ | | 200 | OK | Requisição processada com sucesso. | | 400 | Bad Request | Parâmetros ausentes ou inválidos. | | 401 | Unauthorized | partnerId inválido ou sem permissões para acessar o recurso. | | 500 | Internal Server Error | Erro interno ao processar o arquivo PDF. |