​
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 Método: POST

​
Parâmetros do Caminho

ParâmetroTipoObrigatórioDescrição
partnerIdStringSimIdentificador exclusivo do parceiro, necessário para acessar a API.

​
Parâmetros de Dados do Formulário

ParâmetroTipoObrigatórioPadrãoDescrição
fileArquivoSim-Arquivo PDF do precatório a ser processado.
CORRECAO_MONETARIAStringNãofalseDefine se a correção monetária deve ser aplicada (true ou false).
CALCULAR_IMPOSTOSStringNãofalseDefine se os impostos devem ser calculados sobre o valor (true ou false).
DESTACAR_HONORARIOSStringNãofalseIndica se os honorários serão destacados na resposta (true ou false).
CREDOR_FULL_DATAStringNãofalseDefine se deve buscar os dados do credor (true ou false).
ADVOGADO_FULL_DATAStringNãofalseDefine se deve buscar os dados do advogado (true ou false).

​
Exemplo de Requisição

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) 
{
  "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

CampoTipo de dado.Descrição
content.processoPrecatorioNumeroStringNúmero do processo do precatório no formato padronizado.
content.processoPrecatorioNumeroRawStringNúmero do processo do precatório sem formatação, contendo apenas dígitos.
content.processoOriginarioStringNúmero do processo originário do caso, formatado.
content.processoOriginarioRawStringNúmero do processo originário sem formatação.
content.processoExecucaoCumprimentoSentencaStringNúmero do processo de execução ou cumprimento de sentença, formatado.
content.processoExecucaoCumprimentoSentencaRawStringNúmero do processo de execução ou cumprimento de sentença sem formatação.
content.numeroRequisicaoStringNúmero da requisição do precatório no tribunal.
content.esferaStringEsfera judicial em que o processo se encontra, como “FEDERAL”, “ESTADUAL” ou “MUNICIPAL”.
content.naturezaStringNatureza do processo, como “COMUM”, “ALIMENTAR” ou “COMUM_TRIBUTARIO”.
content.assuntoStringAssunto 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.incidentesStringDetalhes sobre incidentes processuais, se houver, ou “Sem Incidente” se não aplicável.
content.varaStringVara judicial responsável pelo caso, incluindo especialização, se aplicável.
content.cidadeStringCidade em que o processo foi registrado ou está sendo julgado.
content.estadoStringEstado da federação onde o processo está sendo conduzido.
content.advogadoPatrono.nomeStringNome do advogado principal que representa o caso.
content.advogadoPatrono.oabStringOAB do advogado principal que representa o caso.
content.advogadoPatrono.oabRawStringOAB sem formatação do advogado principal que representa o caso.
content.advogadoPatrono.cpfStringCPF do advogado principal que representa o caso.
content.advogadoPatrono.cpfRawStringCPF sem formatação do advogado principal que representa o caso.
content.requerentePrincipalStringNome do requerente principal do processo.
content.tribunalStringTribunal responsável pelo julgamento ou homologação do precatório, como “TRF1”, “TRF2”, “TRF3”, “TRF4”, “TRF5”, “TRF6”, “TJSP”.
content.devedor.nomeStringNome do devedor do processo.
content.devedor.siglaStringSigla do devedor do processo.
content.devedor.esferaStringEsfera judicial do devedor do processo (ex: “FEDERAL”).
content.dataExpedicaoData (String)Data e hora de expedição do precatório no formato ISO 8601.
content.dataCadastroData (String)Data e hora de cadastro do precatório no sistema, em formato ISO 8601.
content.valorTotalRequisitadoNúmero (Float)Valor total requisitado no precatório.
content.especieRequisicaoStringEspécie de requisição, como “ORIGINAL” ou “SUPLEMENTAR”.
content.superpreferencialBooleanIndica se o precatório é superpreferencial (true) ou não (false).
content.dataTransitoJulgadoEmbargosData (String)Data em que o trânsito em julgado dos embargos ocorreu, se aplicável, no formato ISO 8601.
content.dataAjuizamentoProcessoConhecimentoData (String)Data de ajuizamento do processo de conhecimento.
content.dataTransitoJulgadoProcessoConhecimentoData (String)Data de trânsito em julgado do processo de conhecimento.
content.dataDecursoPrazoConcordanciaComValorRequisitadoData (String)Data limite para concordância com o valor requisitado, se aplicável.
content.honorariosContratuaisDestacadosBooleanIndica se os honorários contratuais são destacados (true) ou não (false).
content.honorariosSucumbenciaisDestacadosBooleanIndica se os honorários sucumbenciais são destacados (true) ou não (false).
content.loa.anoOrcamentoStringAno de orçamento do processo.
content.loa.inicioData (String)Data de início do orçamento.
content.loa.fimData (String)Data de fim do orçamento.
content.loa.limitePagamentoData (String)Datas de limite de pagamento.
content.credores.idStringID do Credor do processo.
content.credores.tipoStringTipo do Credor do processo (ex: “BENEFICIARIO”, “HONORÁRIOS”).
content.credores.cpfCnpjStringCPF/CNPJ formatado do Credor do processo.
content.credores.cpfCnpjRawStringCPF/CNPJ sem formatação do Credor do processo.
content.credores.tipoPessoaStringTipo de pessoa do processo (ex: PF/PJ).
content.credores.nomeStringNome do Credor do processo.
content.credores.dataNascimentoData (String)Data de nascimento do Credor do processo (se aplicável).
content.credores.idadeStringIdade do Credor do processo.
content.credores.preferenciaPorStringPreferência do Credor (ex: “IDOSO”, “DOENÇA”).
content.credores.doencaGraveBooleanSe o Credor é portador de Doença Grave.
content.credores.portadorDeficienciaBooleanSe o Credor é portador de Deficiência.
content.credores.idosoBooleanSe o Credor é Idoso.
content.credores.dataBaseData (String)Data base do processo.
content.credores.valorPrincipalNúmero (Float)Valor principal do Processo sem os juros.
content.credores.valorJurosNúmero (Float)Valor de juros do Processo.
content.credores.impostos.pss.incideArray de objetosSe incide cobrança de PSS.
content.credores.impostos.pss.dataBaseData (String)Data base do PSS.
content.credores.impostos.pss.valorInicialPSSNúmero (Float)Valor inicial do PSS.
content.credores.impostos.iR_RRA.incideBooleanSe incide cobrança de RRA.
content.credores.impostos.iR_RRA.mesesExeAnteriorStringQuantidade de meses do RRA.
content.warningsStringLista de avisos sobre o processo ou a extração, se aplicável.
content.errorsStringLista de erros ocorridos na extração dos dados, se aplicável.

​
Códigos de Status HTTP

CódigoSignificadoDescrição
200OKRequisição processada com sucesso.
400Bad RequestParâmetros ausentes ou inválidos.
401UnauthorizedpartnerId inválido ou sem permissões para acessar o recurso.
500Internal Server ErrorErro interno ao processar o arquivo PDF.