Obter Procuração
Este serviço retorna as procurações eletrônicas entre um outorgante titular e seu respectivo procurador. Para cada procuração eletrônica encontrada, as seguintes informações são retornadas: quantidade de sistemas na procuração, nome do sistema e a data de expiração.
Obter Procuração
idSistema: PROCURACOES
idServico: OBTERPROCURACAO41
versaoSistema: "1"
Dados de Entrada
Objeto "dados":
Campo | Descrição | Tipo | Obrigatório | Exemplo |
---|---|---|---|---|
outorgante | Número identificador de pessoa física ou jurídica do outorgante. | Texto(11 ou 14) | SIM | "99999999999" ou "9999999999999" |
tipoOutorgante | Identificador de pessoa física ou jurídica. | Texto(1) | SIM | "1" ou "2" |
outorgado | Número identificador de pessoa física ou jurídica do procurador. | Texto(11 ou 14) | SIM | "99999999999" ou "9999999999999" |
tipoOutorgado | Identificador de pessoa física ou jurídica. | Texto(1) | SIM | "1" ou "2" |
Exemplo: conteúdo body json de entrada
{
"contratante": {
"numero": "99999999999999",
"tipo": 2
},
"autorPedidoDados": {
"numero": "99999999999999",
"tipo": 2
},
"contribuinte": {
"numero": "99999999999",
"tipo": 1
},
"pedidoDados": {
"idSistema": "PROCURACOES",
"idServico": "OBTERPROCURACAO41",
"versaoSistema": "1",
"dados": "{ \"outorgante\":\"99999999999999\", \"tipoOutorgante\": \"2\", \"outorgado\":\"99999999999\", \"tipoOutorgado\":\"1\" }"
}
}
Dados de Saída
Campo | Descrição | Tipo | Exemplo |
---|---|---|---|
status | Status HTTP retornado no acionamento do serviço. | Numérico(3) | "200" |
mensagens | Mensagem explicativa retornada no acionamento do serviço. É um array composto de Código e texto da mensagem. O campo Código é uma string que representa um código interno do negócio. | Lista de Texto | [{"codigo": "[xxxxx]", "texto": "xxxxx" }, {"codigo": "[xxxxx]", "texto": "xxxxx"}] |
dados | Estrutura de dados de retorno. | Lista de Texto | [{\"dtexpiracao\":\"20260607\", \"nrsistemas\":1, \"sistemas\":[\"TODOS\"]}] |
Objeto "dados":
Campo | Descrição | Tipo | Exemplo |
---|---|---|---|
dtexpiracao | Data de expiração. Formato aaaammdd | Texto(8) | "20260607" |
nrsistemas | Quantidade de sistemas contidos na lista | Inteiro | 3 |
sistemas | Lista de sistemas contidos na procuração. | Lista de Texto | [\"Declarações - DIRPF\",\"Meu Imposto de Renda\",\"Opção de Impressão do IRPF\"] |
Exemplo: conteúdo payload json de saída
{
"contratante": {
"numero": "99999999999",
"tipo": 1
},
"autorPedidoDados": {
"numero": "99999999999999",
"tipo": 2
},
"contribuinte": {
"numero": "99999999999",
"tipo": 1
},
"pedidoDados": {
"idSistema": "PROCURACOES",
"idServico": "OBTERPROCURACAO41",
"versaoSistema": "1",
"dados": "{ \"outorgante\":\"99999999999\", \"tipoOutorgante\": \"1\", \"outorgado\":\"99999999999999\", \"tipoOutorgado\":\"2\" }"
},
"status": 200,
"dados": "[{\"dtexpiracao\":\"20230414\", \"nrsistemas\":2,\"sistemas\":[\"Caixa Postal - Mensagens\",\"Caixa Postal - Termo de Opção pelo Domicílio Tributário Eletrônico\"]},{\"dtexpiracao\":\"20221231\", \"nrsistemas\":3,\"sistemas\":[\"Declarações - DIRPF\",\"Meu Imposto de Renda\",\"Opção de Impressão do IRPF\"]}]",
"mensagens": [
{
"codigo": "[Sucesso-PROCURACOES]",
"texto": "Requisição efetuada com sucesso."
},
{
"codigo": "[Aviso-PROCURACOES-20001]",
"texto": "Uma ou mais procurações foram retornadas com sucesso."
}
]
}