Lista de Campos – Consulta GRU | ||||||||
Descrição | Parâmetro* | Tipo | Formato | Regra | Entrada | Saída | Exemplo – Entrada | Exemplo – Saída |
Agente Arrecadador | agenteArrecadador | Alfanumérico | 001: Banco do Brasil; 009: Tesouro Nacional. |
n/a | X | n/a | “001” ou “009” | |
Autenticação Bancária | numAutBancaria | Alfanumérico | Varchar(20) | n/a | X | X | “7213C01B7DC613B2” | “7213C01B7DC613B2” |
Competência | dataCompetencia | Alfanumérico | MMYYYY | n/a | X | X | “062016” | “06/2016” |
Contribuinte | codigoRecolhedor | Alfanumérico | 99999999999999 | O contribuinte pode ser um CPF, CNPJ ou Unidade Gestora. | X | X | “00000000018” | “00000000018” |
Código de Recolhimento | recolhimento | Alfanumérico | 99999 | Consulta por único item. | X | X | “10000” | “10000” |
99999,99999,...,99999 | Consulta por lista de itens. | X | X | “10000,10001,10002” | “10000” | |||
99999-99999 | Intervalo a ser pesquisado. | X | X | “10000-10002” | “10000” | |||
Código de Recolhimento Contabilizado | recolhimentoContabilizado | Alfanumérico | 99999 | Consulta por único item. | X | X | “10000” | “10000” |
99999,99999,...,99999 | Consulta por lista de itens. | X | X | “10000,10001,10002” | “10000” | |||
99999-99999 | Intervalo a ser pesquisado. | X | X | “10000-10002” | “10000” | |||
Código do Serviço | servico | Numérico | 99999 | n/a | X | X | n/a | “100” |
Código do Tipo de Serviço | tipoServico | Alfanumérico | 9999 | n/a | X | X | n/a | “0100” |
Data de Geração | dtCriacaoSISGRU | Data | DD/MM/YYYY-DD/MM/YYYY | Intervalo de datas. | X | X | “01/01/2016-30/01/2016” | “01/01/2016 04:34” |
Data de Pagamento | dtEmissao | Data | DD/MM/YYYY-DD/MM/YYYY | Campo obrigatório. Intervalo inferior ou igual a 30 dias. | X | X | “01/01/2016-30/01/2016” | “01/01/2016” |
Data de Processamento da RA | dtContabilizacaoSiafi | Data | DD/MM/YYYY-DD/MM/YYYY | Intervalo de datas. | X | n/a | “01/01/2016 04:34” | |
Data de Retificação | dtRetificacao | Data | DD/MM/YYYY-DD/MM/YYYY | Intervalo de datas. | X | X | “01/01/2016-30/01/2016” | “01/01/2016 04:34” |
Data de Transferência | dtTransferencia | Data | DD/MM/YYYY-DD/MM/YYYY | Intervalo de datas. | X | X | “01/01/2016-30/01/2016” | “01/01/2016” |
Data de Vencimento | dataVencimento | Data | DD/MM/YYYY | X | X | “01/01/2016” | “01/01/2016” | |
Documento de Origem (OB/GR/PT/PP/PL) | grOrigem | Alfanumérico | UUUUUUYYYY[OB|GR|PT|PP|PL]999999 | “UUUUUU” = unidade gestora; YYYY = exercício financeiro. |
X | X | “1705002016GR000111” | “1705002016GR000111” |
Espécie de GRU | especieGR | Alfanumérico | 1: Cobrança; 2: Simples; 3: Judicial; 4: Depósito; 5: DOC/TED; 7: Digital. |
Aceita consulta por item ou por lista de itens, separados por vírgula. | X | X | “1” ou “1,2,3” | “1” |
Espécie de Ingresso | especieIngresso | Alfanumérico | 1: Receita Primária Fonte Tesouro; 2: Receita Primária Fonte Própria; 3: Receita Financeira Fonte Tesouro; 4: Receita Financeira Fonte Própria; 5: Operação Interna Fonte Tesouro; 6: Estorno de Despesa; 7: Operação Interna Fonte Própria; 9: Depósitos Diversos. |
Aceita consulta por item ou por lista de itens, separados por vírgula. | X | X | “6” ou “6, 7, 9” | “6” |
GRU Retificada | gruRetificada | Alfanumérico | YYYYUUUUUU9999999999 | YYYY = exercício financeiro; “UUUUUU” = unidade gestora. | X | n/a | “20161705010000000001” | |
Código de Identificação do Pagamento | codigoPagamento | Alfanumérico | 9999999999 | n/a | X | X | n/a | “1000000000” |
Forma de Pagamento | meioPagamento | Alfanumérico | 01: Dinheiro; 02: Cheque; 03: Outros; 04: Débito em Conta (em desuso); 05: Cartão de Crédito/Saldo em Carteira Digital; 06: Pix. |
Aceita consulta por item ou por lista de itens, separados por vírgula. | X | X | “01” ou “01,02,03” | “01” |
Número Identificador do Registro de GRU | id | Alfanumérico | YYYYUUUUUU9999999999 | YYYY = exercício financeiro; “UUUUUU” = unidade gestora. | X | X | “20161705010000000001” | “20161705010000000001” |
Número de Referência | numReferencia | Alfanumérico | 9999999999 | Consulta por único item. | X | X | “10000” | “10000” |
9999999999,9999999999,...,9999999999 | Consulta por lista de itens. | X | X | “10000,10001,10002” | “10000” | |||
9999999999-9999999999 | Intervalo a ser pesquisado. | X | X | “10000-10010” | “10000” | |||
Número da Transação na Instituição Financeira | numeroTransacaoPSP | Alfanumérico | 9999999999 | n/a | X | X | n/a | “1000000000” |
Observação | observacao | Alfanumérico | Varchar(234) | Texto livre. | X | - | - | |
Origem da Arrecadação | origemArrecadacao | Alfanumérico | 1: Banco do Brasil; 3: Intra-SIAFI (GRU Eletrônica); 4: Sistema de Pagamentos Brasileiro – SPB; 5: GRU Digital (BB) - em desuso; 6: Credenciamento; 7: Arrecadação de GRU via Pix. |
n/a | X | X | “4” | “4” |
Origem da GRU | origemGRU | Numérico | 1. Boleto; 2. Intrasiafi Ou Spb; 3. Débito Em Conta; 4. Picpay; 5. PagoParcelado; 6. Mercado Pago; 7. Arrecadação Gru via Pix. |
n/a | X | X | n/a | “100” |
Processo | dsProcesso | Alfanumérico | Varchar(20) | De livre formação pela UG. | X | n/a | “000.000.001/2016” | |
RA Retificada/ Restituída/ Cancelada | numRAVinculada | Alfanumérico | YYYYRn999999 | YYYY = exercício financeiro. Rn pode ser RA, R1 até R9, RX, RY ou RZ. 999999 é o número atribuído pelo SIAFI. |
X | n/a | “2016RA000001” | |
RA de Contabilização | numeroRa | Alfanumérico | YYYYRn999999 | YYYY = exercício financeiro. Rn pode ser RA, R1 até R9, RX, RY ou RZ. 999999 é o número atribuído pelo SIAFI. |
X | X | “2016RA000001” | “2016RA000001” |
Situação | situacao | Alfanumérico | 02: Contabilizado; 03: Pendente de Contabilização; 04: Restituído (em desuso); 05: Pendente de Restituição (em desuso); 06: Retificado; 07: Pendente de Retificação; 08: Cancelado. |
Aceita consulta por item ou por lista de itens, separados por vírgula. | X | X | “02” ou “02,03,04” | “02” |
Tipo de Contribuinte | tipoRecolhedor | Alfanumérico | 1: CPF; 2: CNPJ; 4: Unidade Gestora. |
n/a | X | n/a | “1” | |
Tipo de GRU | tipoRegistroGRU | Alfanumérico | 1: Arrecadação; 2: Retificação; 3: Restituição; 4: Cancelamento de Restituição. |
Aceita consulta por item ou por lista de itens, separados por vírgula. | X | X | “1” ou “1,2,3” | “1” |
UG Arrecadadora | ugArrecadadora | Alfanumérico | Campo obrigatório se a UG do usuário que realiza a consulta for diferente de 170500 (STN/CGTES) ou se o acesso for via token de Sistema Externo. | |||||
999999 | Consulta por único item. | X | X | “170500” | “170500” | |||
999999,999999,...,999999 | Consulta por lista de itens. | X | X | “170500,170501,170502” | “170500” | |||
999999-999999 | Intervalo a ser pesquisado. | X | X | “170500-170502” | “170500” | |||
UG Emitente da RA | ugEmitente | Alfanumérico | Campo obrigatório se o nível de acesso do usuário que realiza a consulta for diferente de 9 no SIAFI Operacional. | |||||
999999 | Consulta por único item. | X | X | “170500” | “170500” | |||
999999,999999,...,999999 | Consulta por lista de itens. | X | X | “170500,170501,170502” | “170500” | |||
999999-999999 | Intervalo a ser pesquisado. | X | X | “170500-170502” | “170500” | |||
Valor Principal | vlPrincipal | Numérico | 999999999999999.99 | X | n/a | “100.00” | ||
Valor Total | vlTotal | Numérico | 999999999.99 | Consulta por único valor. | X | X | “100.00” | “100.00” |
<999999999.99 | Consulta por intervalo menor que valor. | X | X | “<100.00” | “99.00” | |||
>999999999.99 | Consulta por intervalo maior que valor. | X | X | “>100.00” | “101.00” | |||
999999999.99-999999999.99 | Consulta por intervalo de valores. | X | X | “100.00-100.01” | “100.00” | |||
Valor de Descontos e Abatimentos | vlDesconto | Numérico | 999999999.99 | X | n/a | “100.00” | ||
Valor de Juros e Encargos | vlJuros | Numérico | 999999999.99 | X | n/a | “100.00” | ||
Valor de Mora e Multa | vlMulta | Numérico | 999999999.99 | X | n/a | “100.00” | ||
Valor de Outras Deduções | vlOutradeducao | Numérico | 999999999.99 | X | n/a | “100.00” | ||
Valor de Outros Acréscimos | vlAcrescimo | Numérico | 999999999.99 | X | n/a | “100.00” |
*O nome dos parâmetros é sensível a maiúsculas e minúsculas.