from pydantic import BaseModel, ConfigDict
from typing import Optional, List, Dict, Any
[documentos]
class BaseModelSiafi(BaseModel):
"""BaseModel customizado para SIAFI com configuração padrão."""
model_config = ConfigDict(extra='allow', coerce_numbers_to_str=True)
[documentos]
class AcrescimoModel(BaseModelSiafi):
"""Representa um acréscimo a ser contabilizado.
- Para acréscimo orçamentário, informar Empenho e Subitem.
- Para acréscimo extra-orçamentário, informar Fonte de Recurso e Categoria de Gasto.
Os dados empenho/subitem são mutuamente exclusivos com os de fonte/categoria.
Attributes:
cod_ctgo_gasto (Optional[str]): Código Categoria de Gastos. Permite número ou letra.
cod_font_recur (Optional[str]): Código Fonte de Recursos.
cod_sub_item_empe (Optional[int | str]): Código do Subitem do empenho.
indr_liquidado (Optional[bool]): Indica se está liquidado. Caso não seja informado, será preenchido como Verdadeiro.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_empe (Optional[str]): Número do empenho.
tp_acrescimo (Optional[str]): Tipo de Acréscimo a ser contabilizado. Pode ser: 'M' - Multa, 'J' - Juros de mora, 'E' - Encargos, 'O' - Outros Acréscimos.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor do acréscimo. Admite somente valores maiores que zero (15,2).
"""
cod_ctgo_gasto: Optional[str] = None
cod_font_recur: Optional[str] = None
cod_sub_item_empe: Optional[int | str] = None
indr_liquidado: Optional[bool] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_empe: Optional[str] = None
tp_acrescimo: Optional[str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class AlterarAmparoLegalRequestModel(BaseModelSiafi):
"""Parâmetros para alteração de Amparo Legal.
Parâmetro Tipo Ocorrência Restrição Observação
codAmparoLegal int [1..1] AmparoLegal Informar o código do Amparo Legal no qual deseja efetuar a operação.
orcAmparoLegalDados OrcAmparoLegalDadosModel [1..1] - O SIAFIWeb substituirá os dados do Amparo Legal pelos que estão sendo enviados na operação. Todos os parâmetros que possuírem dados devem ser enviados, mesmo que somente alguns deles tenham sido alterados. No caso de parâmetro opcional, caso não seja enviado ou enviado com conteúdo vazio, o SIAFIWeb entenderá que o respectivo campo no Amparo Legal deve ficar vazio após executar a operação.
motivo string [1..1] Motivo Motivo da alteração.
Attributes:
cod_amparo_legal (Optional[int]): Código do Amparo Legal a ser alterado.
orc_amparo_legal_dados (Optional['OrcAmparoLegalDadosModel']): Novos dados do Amparo Legal.
motivo (Optional[str]): Motivo da alteração.
"""
cod_amparo_legal: Optional[int] = None
orc_amparo_legal_dados: Optional['OrcAmparoLegalDadosModel'] = None
motivo: Optional[str] = None
[documentos]
class AlterarEmpenhoRequestModel(BaseModelSiafi):
"""Request para alteração de empenho.
Parâmetros:
ugEmitente (int): Código da UG emitente do empenho. Obrigatório.
anoEmpenho (int): Ano do empenho (AAAA). Obrigatório.
numEmpenho (int, obrigatório): Número do empenho (NumNE). Obrigatório.
txtLocalEntrega (str, opcional): Local de entrega.
txtDescricao (str, opcional): Descrição do empenho.
passivoAnterior (PassivoAnteriorModel, opcional): Dados de passivo anterior. Deve ser enviado caso o Empenho tenha passivo anterior.
itemEmpenho (List[ItemEmpenhoModel], opcional): Lista de itens do empenho.
registroAlteracao (RegistroAlteracaoModel): Registro de alteração. Obrigatório.
Attributes:
ug_emitente (Optional[int]): Código da UG emitente do empenho. Obrigatório.
ano_empenho (Optional[int]): Ano do empenho (AAAA). Obrigatório.
num_empenho (Optional[int]): Número do empenho (NumNE). Obrigatório.
txt_local_entrega (Optional[str]): Local de entrega. Opcional.
txt_descricao (Optional[str]): Descrição do empenho. Opcional. Representa a descrição do empenho.
passivo_anterior (Optional['PassivoAnteriorModelInput']): Dados de passivo anterior. Obrigatório se o empenho possuir passivo anterior.
item_empenho (Optional[List['ItemEmpenhoModelInput']]): Lista de itens do empenho. Opcional.
registro_alteracao (Optional['RegistroAlteracaoModel']): Registro de alteração. Obrigatório.
"""
ug_emitente: Optional[int] = None
ano_empenho: Optional[int] = None
num_empenho: Optional[int] = None
txt_local_entrega: Optional[str] = None
txt_descricao: Optional[str] = None
passivo_anterior: Optional['PassivoAnteriorModelInput'] = None
item_empenho: Optional[List['ItemEmpenhoModelInput']] = None
registro_alteracao: Optional['RegistroAlteracaoModel'] = None
[documentos]
class AlterarPreEmpenhoRequestModel(BaseModelSiafi):
"""Request para alteração de pré-empenho.
Parâmetros:
ugEmitente (int): Código da UG emitente do pré-empenho. Obrigatório.
anoPreEmpenho (int): Ano do pré-empenho (AAAA). Obrigatório.
numPreEmpenho (int): Número do pré-empenho (NumPE). Obrigatório.
codFavorecido (str, opcional): Código do favorecido.
operacao (OperacaoPreEmpenhoModel): Operação aplicada no pré-empenho. Obrigatório.
registroAlteracao (RegistroAlteracaoModel): Registro de alteração. Obrigatório.
Attributes:
ug_emitente (Optional[int]): Código da UG emitente do pré-empenho. Obrigatório.
ano_pre_empenho (Optional[int]): Ano do pré-empenho (AAAA). Obrigatório.
num_pre_empenho (Optional[int]): Número do pré-empenho (NumPE). Obrigatório.
cod_favorecido (Optional[str]): Código do favorecido.
operacao (Optional['OperacaoPreEmpenhoModel']): Operação aplicada no pré-empenho. Obrigatório.
registro_alteracao (Optional['RegistroAlteracaoModel']): Registro de alteração. Obrigatório.
"""
ug_emitente: Optional[int] = None
ano_pre_empenho: Optional[int] = None
num_pre_empenho: Optional[int] = None
cod_favorecido: Optional[str] = None
operacao: Optional['OperacaoPreEmpenhoModel'] = None
registro_alteracao: Optional['RegistroAlteracaoModel'] = None
[documentos]
class CLTModelOutput(BaseModelSiafi):
"""Schema para CLTModel-Output.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[int | str]): Número da Programação Financeira (string/int, 1-6)
item_CLT (Optional[List['ItemCLTModelOutput']]): Itens do Cancelamento de Liberação de Transferência
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[str] = None
numero_documento: Optional[int | str] = None
item_CLT: Optional[List['ItemCLTModelOutput']] = None
[documentos]
class CampoVariavelCPRModel(BaseModelSiafi):
"""Representa a configuração de um campo variável (classificação ou inscrição) para uma situação do CPR.
Attributes:
aba (Optional[str]): Aba do CPR à qual o campo pertence (ex: PCO, PSO, CREDITO).
campo (Optional[str]): Tipo de discriminação do campo.
indr_restricao_uso (Optional[str]): Tipo de restrição de uso do campo variável.
indr_tipo_classificacao (Optional[str]): Tipo de classificação do campo variável.
indr_tipo_dado_inscr (Optional[str]): Tipo de dado de inscrição do campo variável.
indr_tipo_restricao_mascara (Optional[str]): Tipo de restrição de máscara do campo.
mascara (Optional[str]): Código da máscara a ser aplicada ao campo.
rotulo (Optional[str]): Rótulo do campo a ser exibido na interface.
submascara (Optional[str]): Código da submáscara a ser aplicada ao campo.
"""
aba: Optional[str] = None
campo: Optional[str] = None
indr_restricao_uso: Optional[str] = None
indr_tipo_classificacao: Optional[str] = None
indr_tipo_dado_inscr: Optional[str] = None
indr_tipo_restricao_mascara: Optional[str] = None
mascara: Optional[str] = None
rotulo: Optional[str] = None
submascara: Optional[str] = None
[documentos]
class CelulaFinanceiraModel(BaseModelSiafi):
"""Schema para CelulaFinanceiraModel.
Attributes:
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
"""
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_recurso: Optional[str] = None
cod_sit: Optional[str] = None
[documentos]
class CelulaOrcamentariaModel(BaseModelSiafi):
"""Dados da célula orçamentária do empenho.
Parâmetros:
esfera (str): Esfera orçamentária. Obrigatório.
codPTRES (str, opcional): Código do Programa de Trabalho Resumido. Parâmetro mutuamente exclusivo com ptresDecodificado.
codFonteRec (str): Código da Fonte de Recurso. Obrigatório.
codNatDesp (int): Código da Natureza de Despesa. Obrigatório.
ugResponsavel (str, opcional): Código da UG responsável.
codPlanoInterno (str, opcional): Código do Plano Interno.
Observações:
- codPTRES e ptresDecodificado são mutuamente exclusivos.
- Para consultas, codPTRES é obrigatório.
Attributes:
esfera (Optional[str]): Esfera orçamentária. Obrigatório.
cod_PTRES (Optional[str]): Código do Programa de Trabalho Resumido. Parâmetro mutuamente exclusivo com ptresDecodificado.
cod_fonte_rec (Optional[str]): Código da Fonte de Recurso. Obrigatório.
cod_nat_desp (Optional[int]): Código da Natureza de Despesa. Obrigatório.
ug_responsavel (Optional[int | str]): Código da UG responsável.
cod_plano_interno (Optional[str]): Código do Plano Interno.
"""
esfera: Optional[str] = None
cod_PTRES: Optional[str] = None
cod_fonte_rec: Optional[str] = None
cod_nat_desp: Optional[int] = None
ug_responsavel: Optional[int | str] = None
cod_plano_interno: Optional[str] = None
[documentos]
class CentroCustoCadastroModel(BaseModelSiafi):
"""Representa um Centro de Custo para cadastro/alteração em um Documento Hábil (baseado em ns5:CentroCusto).
Attributes:
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
cod_centro_custo (Optional[str]): Código do Centro de Custo.
mes_referencia (Optional[str]): Mês de referência (1 a 12).
ano_referencia (Optional[str]): Ano de referência com 4 dígitos.
cod_ug_benef (Optional[int | str]): Código da UG beneficiária.
cod_SIORG (Optional[str]): Código SIORG do centro de custo.
rel_pco_item (Optional[List['RelComItemValorModel']]): Relação de itens PCO (Principal com Orçamento).
rel_outros_lanc (Optional[List['RelSemItemValorModel']]): Relação de outros lançamentos.
rel_outros_lanc_cronograma_patrimonial (Optional[List['RelSemItemValorModel']]): Relação de outros lançamentos do cronograma patrimonial.
rel_pso_item (Optional[List['RelComItemValorModel']]): Relação de itens PSO (Principal sem Orçamento).
rel_encargo (Optional[List['RelSemItemValorModel']]): Relação de encargos.
rel_acrescimo_deducao (Optional[List['RelComItemValorModel']]): Relação de valores de acréscimo de dedução.
rel_acrescimo_encargo (Optional[List['RelComItemValorModel']]): Relação de valores de acréscimo de encargo.
rel_acrescimo_dados_pag (Optional[List['RelComItemValorModel']]): Relação de valores de acréscimo de dados de pagamento.
rel_despesa_antecipada (Optional[List['RelComItemValorModel']]): Relação de despesas antecipadas.
rel_despesa_anular (Optional[List['RelComItemValorModel']]): Relação de despesas a anular.
"""
num_seq_item: Optional[int | str] = None
cod_centro_custo: Optional[str] = None
mes_referencia: Optional[str] = None
ano_referencia: Optional[str] = None
cod_ug_benef: Optional[int | str] = None
cod_SIORG: Optional[str] = None
rel_pco_item: Optional[List['RelComItemValorModel']] = None
rel_outros_lanc: Optional[List['RelSemItemValorModel']] = None
rel_outros_lanc_cronograma_patrimonial: Optional[List['RelSemItemValorModel']] = None
rel_pso_item: Optional[List['RelComItemValorModel']] = None
rel_encargo: Optional[List['RelSemItemValorModel']] = None
rel_acrescimo_deducao: Optional[List['RelComItemValorModel']] = None
rel_acrescimo_encargo: Optional[List['RelComItemValorModel']] = None
rel_acrescimo_dados_pag: Optional[List['RelComItemValorModel']] = None
rel_despesa_antecipada: Optional[List['RelComItemValorModel']] = None
rel_despesa_anular: Optional[List['RelComItemValorModel']] = None
[documentos]
class CentroCustoConsultaModel(BaseModelSiafi):
"""Representa um Centro de Custo para consulta em um Documento Hábil (baseado em ns8:CentroCusto).
Attributes:
cod_centro_custo (Optional[str]): Código do Centro de Custo.
mes_referencia (Optional[str]): Mês de referência (1 a 12).
ano_referencia (Optional[str]): Ano de referência com 4 dígitos.
cod_ug_benef (Optional[int | str]): Código da UG beneficiária.
cod_SIORG (Optional[str]): Código SIORG do centro de custo.
rel_pco_item (Optional[List['RelValorModel']]): Relação de itens PCO (Principal com Orçamento).
rel_outros_lanc (Optional[List['RelValorModel']]): Relação de outros lançamentos.
rel_outros_lanc_cronograma_patrimonial (Optional[List['RelValorModel']]): Relação de outros lançamentos do cronograma patrimonial.
rel_pso_item (Optional[List['RelValorModel']]): Relação de itens PSO (Principal sem Orçamento).
rel_encargo (Optional[List['RelValorModel']]): Relação de encargos.
rel_acrescimo_deducao (Optional[List['RelValorModel']]): Relação de valores de acréscimo de dedução.
rel_acrescimo_encargo (Optional[List['RelValorModel']]): Relação de valores de acréscimo de encargo.
rel_acrescimo_dados_pag (Optional[List['RelValorModel']]): Relação de valores de acréscimo de dados de pagamento.
rel_despesa_antecipada (Optional[List['RelValorModel']]): Relação de despesas antecipadas.
rel_despesa_anular (Optional[List['RelValorModel']]): Relação de despesas a anular.
"""
cod_centro_custo: Optional[str] = None
mes_referencia: Optional[str] = None
ano_referencia: Optional[str] = None
cod_ug_benef: Optional[int | str] = None
cod_SIORG: Optional[str] = None
rel_pco_item: Optional[List['RelValorModel']] = None
rel_outros_lanc: Optional[List['RelValorModel']] = None
rel_outros_lanc_cronograma_patrimonial: Optional[List['RelValorModel']] = None
rel_pso_item: Optional[List['RelValorModel']] = None
rel_encargo: Optional[List['RelValorModel']] = None
rel_acrescimo_deducao: Optional[List['RelValorModel']] = None
rel_acrescimo_encargo: Optional[List['RelValorModel']] = None
rel_acrescimo_dados_pag: Optional[List['RelValorModel']] = None
rel_despesa_antecipada: Optional[List['RelValorModel']] = None
rel_despesa_anular: Optional[List['RelValorModel']] = None
[documentos]
class ChavePixModelOutput(BaseModelSiafi):
"""Schema para ChavePixModel-Output.
Attributes:
tipo_chave (Optional[str]): Campo não documentado.
chave (Optional[str]): Campo não documentado.
"""
tipo_chave: Optional[str] = None
chave: Optional[str] = None
[documentos]
class CompensacaoModel(BaseModelSiafi):
"""Representa uma compensação financeira em um Documento Hábil.
Os elementos relDeducao e relEncargo são mutuamente exclusivos.
Attributes:
cod_sit (Optional[str]): Código da Situação do CPR.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
rel_deducao (Optional['RelSemItemModel']): Relação com um item de Dedução. Mutuamente exclusivo com relEncargo.
rel_encargo (Optional['RelSemItemModel']): Relação com um item de Encargo. Mutuamente exclusivo com relDeducao.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor da compensação (15,2).
"""
cod_sit: Optional[str] = None
num_class_A: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
rel_deducao: Optional['RelSemItemModel'] = None
rel_encargo: Optional['RelSemItemModel'] = None
txt_inscr_A: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class CompromissoBaixaModel(BaseModelSiafi):
"""Define um compromisso a ser baixado.
Attributes:
codigo_compromisso (Optional[int]): Identificador único do compromisso.
lista_documentos_baixa (Optional[List['DocumentoSIAFIModel']]): Lista de documentos usados na baixa.
tipo_motivo_baixa (Optional[str]): Motivo da baixa (CANCELAMENTO ou REALIZACAO).
"""
codigo_compromisso: Optional[int] = None
lista_documentos_baixa: Optional[List['DocumentoSIAFIModel']] = None
tipo_motivo_baixa: Optional[str] = None
[documentos]
class CompromissoEstornoModel(BaseModelSiafi):
"""Define um compromisso a ser estornado.
Attributes:
codigo_compromisso (Optional[int]): Identificador único do compromisso.
nova_data_emissao (Optional[str]): Nova data de emissão para estorno do compromisso.
observacao (Optional[str]): Observação/descrição do estorno.
"""
codigo_compromisso: Optional[int] = None
nova_data_emissao: Optional[str] = None
observacao: Optional[str] = None
[documentos]
class CompromissoModel(BaseModelSiafi):
"""Representa um compromisso financeiro no sistema.
Attributes:
cod_tipo_DARF (Optional[str]): Tipo do DARF.
codigo_compromisso (Optional[str]): Identificador único do compromisso.
data_pagamento_recebimento (Optional[str]): Data de pagamento ou recebimento.
data_vencimento (Optional[str]): Data de vencimento do compromisso.
doc_habil (Optional['DocumentoHabilChaveModel']): Chave de identificação de um documento hábil.
documento_origem (Optional[List['DocOrigemModel']]): Documento de origem.
documentos_SIAFI (Optional[List['DocumentoSIAFIModel']]): Lista de documentos do SIAFI (preenchida na consulta para Estorno).
exige_data_limite (Optional[bool]): Indica se a realização deste compromisso exige nova data de emissão.
exige_vinculacao (Optional[bool]): Indica se a realização deste compromisso exige informar uma vinculação.
itens_compromisso (Optional[List['ItemCompromissoModel']]): Lista de itens do compromisso.
tipo_compromisso (Optional[str]): Tipo do compromisso (LIQUIDO, ENCARGO, DEDUCAO, VARIACAO_PATRIMONIAL).
tipo_documento_realizacao (Optional[str]): Tipo do Documento de Realização do Compromisso.
valor_cancelado_fora_cpr (Optional[str]): Valor cancelado do compromisso fora do módulo de Contas a Pagar e Receber.
valor_realizado (Optional[str]): Valor já realizado.
valor_realizado_fora_cpr (Optional[str]): Valor realizado do compromisso fora do módulo de Contas a Pagar e Receber.
valor_realizavel (Optional[str]): Valor realizável do compromisso.
"""
cod_tipo_DARF: Optional[str] = None
codigo_compromisso: Optional[str] = None
data_pagamento_recebimento: Optional[str] = None
data_vencimento: Optional[str] = None
doc_habil: Optional['DocumentoHabilChaveModel'] = None
documento_origem: Optional[List['DocOrigemModel']] = None
documentos_SIAFI: Optional[List['DocumentoSIAFIModel']] = None
exige_data_limite: Optional[bool] = None
exige_vinculacao: Optional[bool] = None
itens_compromisso: Optional[List['ItemCompromissoModel']] = None
tipo_compromisso: Optional[str] = None
tipo_documento_realizacao: Optional[str] = None
valor_cancelado_fora_cpr: Optional[str] = None
valor_realizado: Optional[str] = None
valor_realizado_fora_cpr: Optional[str] = None
valor_realizavel: Optional[str] = None
[documentos]
class CompromissoRealizacaoModel(BaseModelSiafi):
"""Define um compromisso a ser realizado.
Attributes:
codigo_compromisso (Optional[int]): Identificador único do compromisso.
itens_compromisso (Optional[List['ItemCompromissoRealizacaoModel']]): Lista de itens de compromisso para realização.
nova_data_data_emissao (Optional[str]): Nova data de emissão para realização, se necessário.
"""
codigo_compromisso: Optional[int] = None
itens_compromisso: Optional[List['ItemCompromissoRealizacaoModel']] = None
nova_data_data_emissao: Optional[str] = None
[documentos]
class CompromissoRestabelecerModel(BaseModelSiafi):
"""Define um compromisso a ser restabelecido.
Attributes:
codigo_compromisso (Optional[int]): Identificador único do compromisso que será restabelecido.
"""
codigo_compromisso: Optional[int] = None
[documentos]
class ConfiguracaoCamposModel(BaseModelSiafi):
"""Agrupa a configuração de campos de classificação e inscrição para uma situação do CPR.
Attributes:
classificacao (Optional[List['CampoVariavelCPRModel']]): Lista de configurações para campos de classificação.
inscricao (Optional[List['CampoVariavelCPRModel']]): Lista de configurações para campos de inscrição.
"""
classificacao: Optional[List['CampoVariavelCPRModel']] = None
inscricao: Optional[List['CampoVariavelCPRModel']] = None
[documentos]
class CprCPBaixarCompromissoResponseModel(BaseModelSiafi):
"""Response wrapper para a operação cprCPBaixarCompromisso.
Attributes:
resultado_execucao (Optional[List['CprCPResultadoExecucaoModel']]): Resultado da execução da baixa.
"""
resultado_execucao: Optional[List['CprCPResultadoExecucaoModel']] = None
[documentos]
class CprCPBaixarModel(BaseModelSiafi):
"""Contém a lista de compromissos para baixa.
Attributes:
lista_compromissos (Optional[List['CompromissoBaixaModel']]): Lista de compromissos para baixa.
"""
lista_compromissos: Optional[List['CompromissoBaixaModel']] = None
[documentos]
class CprCPConsultaRespostaModel(BaseModelSiafi):
"""Resposta da consulta de compromissos, contendo a lista de resultados.
Attributes:
lista_compromissos (Optional[List['CompromissoModel']]): Lista de compromissos de uma consulta.
mensagem (Optional['schemas__cpr__MensagemModel']): Mensagem, se aplicável, relativo ao resultado da pesquisa.
numero_resultados (Optional[int]): Número de resultados da consulta.
"""
lista_compromissos: Optional[List['CompromissoModel']] = None
mensagem: Optional['schemas__cpr__MensagemModel'] = None
numero_resultados: Optional[int] = None
[documentos]
class CprCPDetalharLXRespostaModel(BaseModelSiafi):
"""Resultado do detalhamento de uma Lista de Credores PIX (LX).
Attributes:
ano_LX (Optional[int | str]): Ano da Lista LX.
cod_ug_emit (Optional[int]): UG Emitente da Lista LX.
doc_siafi_OB (Optional['DocumentoSIAFIResumidoModel']): Identifica a Ordem Bancária que a lista LX está associada.
doc_siafi_OP (Optional['DocumentoSIAFIResumidoModel']): Identifica a Ordem de Pagamento que a lista LX está associada.
item_LX (Optional[List['ItemLXDetalheModel']]): Representa a lista de itens LX detalhados.
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Mensagens de erro em caso de falha.
num_LX (Optional[int | str]): Número da lista LX.
prox_num_seq_paginacao (Optional[int | str]): Próximo sequencial para paginação, retornado quando há mais itens a serem detalhados.
qtd_total_itens_LX (Optional[int]): Quantidade total de itens na LX.
status (Optional[str]): Status da LX (ex: CRIADA, PAGA, CANCELADA).
tipo_pagto_LX (Optional[str]): Tipo de pagamento da lista de credores pix (LX).
vlr_total_LX (Optional[str]): Valor total da LX.
"""
ano_LX: Optional[int | str] = None
cod_ug_emit: Optional[int] = None
doc_siafi_OB: Optional['DocumentoSIAFIResumidoModel'] = None
doc_siafi_OP: Optional['DocumentoSIAFIResumidoModel'] = None
item_LX: Optional[List['ItemLXDetalheModel']] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
num_LX: Optional[int | str] = None
prox_num_seq_paginacao: Optional[int | str] = None
qtd_total_itens_LX: Optional[int] = None
status: Optional[str] = None
tipo_pagto_LX: Optional[str] = None
vlr_total_LX: Optional[str] = None
[documentos]
class CprCPDetalharOPResponseModel(BaseModelSiafi):
"""Response wrapper para a operação cprCPDetalharOP.
Attributes:
cpr_CP_detalhar_OP_resposta (Optional['CprCPDetalharOPRespostaModel']): Resultado da operação.
"""
cpr_CP_detalhar_OP_resposta: Optional['CprCPDetalharOPRespostaModel'] = None
[documentos]
class CprCPDetalharOPRespostaModel(BaseModelSiafi):
"""Resposta do detalhamento de uma Ordem de Pagamento (OP), com dados bancários, status e assinaturas.
Attributes:
cod_banco_pagador (Optional[int | str]): Código do Banco Pagador da OP.
cod_num_lista (Optional[str]): Parâmetro retornado quando a OP está associada a uma Lista.
cpf_gestor_financeiro (Optional[str]): CPF do Gestor Financeiro que assinou a OP.
cpf_liberacao_STN (Optional[str]): CPF do responsável da STN pela liberação do pagamento da OP em D+0.
cpf_ordenador_despesa (Optional[str]): CPF do Ordenador da Despesa que assinou a OP.
dados_pagamento_PIX (Optional['DadosPagamentoPIXModel']): Grupo de dados retornados quando a OP possuir um pagamento PIX associado.
data_assinatura_gest_fin (Optional[str]): Data/hora da assinatura do Gestor Financeiro.
data_assinatura_ord_desp (Optional[str]): Data/hora da assinatura do Ordenador da Despesa.
data_emissao (Optional[str]): Data de emissão da OP.
data_liberacao_STN (Optional[str]): Data/hora da assinatura do responsável da STN pela liberação do pagamento da OP em D+0.
data_processamento (Optional[str]): Data em que a OP foi ou será processada, a depender do seu status.
documento_habil (Optional[List['DocumentoHabilOPModel']]): Lista de documentos hábeis associados à OP.
documento_SIAFI (Optional[List['DocumentoSIAFIOPModel']]): Lista de documentos SIAFI associados à OP.
indr_processamento (Optional[str]): Indicador do Processamento da OP (SUCESSO ou ERRO).
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de retorno.
numero_OP (Optional[str]): Número do documento OP.
status (Optional[str]): Status da OP (ex: PENDENTE ASSINATURA, PAGA, CANCELADA).
txt_erro_processamento (Optional[str]): Caso o indicador de Processamento seja erro, descreve o motivo.
ug_pagadora (Optional[int | str]): UG pagadora do documento OP.
valor_documento (Optional[str]): Valor do documento OP.
"""
cod_banco_pagador: Optional[int | str] = None
cod_num_lista: Optional[str] = None
cpf_gestor_financeiro: Optional[str] = None
cpf_liberacao_STN: Optional[str] = None
cpf_ordenador_despesa: Optional[str] = None
dados_pagamento_PIX: Optional['DadosPagamentoPIXModel'] = None
data_assinatura_gest_fin: Optional[str] = None
data_assinatura_ord_desp: Optional[str] = None
data_emissao: Optional[str] = None
data_liberacao_STN: Optional[str] = None
data_processamento: Optional[str] = None
documento_habil: Optional[List['DocumentoHabilOPModel']] = None
documento_SIAFI: Optional[List['DocumentoSIAFIOPModel']] = None
indr_processamento: Optional[str] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
numero_OP: Optional[str] = None
status: Optional[str] = None
txt_erro_processamento: Optional[str] = None
ug_pagadora: Optional[int | str] = None
valor_documento: Optional[str] = None
[documentos]
class CprCPEstornarCompromissoResponseModel(BaseModelSiafi):
"""Response wrapper para a operação cprCPEstornarCompromisso.
Attributes:
resultado_execucao (Optional[List['CprCPResultadoExecucaoModel']]): Resultado da execução do estorno.
"""
resultado_execucao: Optional[List['CprCPResultadoExecucaoModel']] = None
[documentos]
class CprCPEstornarModel(BaseModelSiafi):
"""Contém a lista de compromissos para estorno.
Attributes:
lista_compromissos (Optional[List['CompromissoEstornoModel']]): Lista de compromissos para estorno.
"""
lista_compromissos: Optional[List['CompromissoEstornoModel']] = None
[documentos]
class CprCPExcluirLXRespostaModel(BaseModelSiafi):
"""Resposta da operação de exclusão de LX.
Attributes:
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Retorna mensagens de erro ou sucesso da requisição.
"""
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
[documentos]
class CprCPManterLXEntradaModel(BaseModelSiafi):
"""Parâmetros para incluir ou alterar uma Lista de Credores PIX (LX) e seus itens.
Attributes:
ano_LX (Optional[int | str]): Ano da Lista.
cod_ug_emit (Optional[int]): UG Emitente da Lista LX.
item_LX (Optional[List['ItemLXModel']]): Lista de itens a serem incluídos/alterados/excluídos. Limitado a 100 itens por chamada.
num_LX (Optional[int | str]): Número da lista. Obrigatório se a UG utiliza numeração manual.
tipo_pagto_LX (Optional[str]): Tipo de pagamento da lista (PAGAMENTOS DIVERSOS ou REPAGAMENTO_FOLHA).
"""
ano_LX: Optional[int | str] = None
cod_ug_emit: Optional[int] = None
item_LX: Optional[List['ItemLXModel']] = None
num_LX: Optional[int | str] = None
tipo_pagto_LX: Optional[str] = None
[documentos]
class CprCPManterLXRespostaModel(BaseModelSiafi):
"""Resposta da operação de manutenção de LX, retornando o resultado e possíveis erros.
Attributes:
ano_LX (Optional[int | str]): Ano da Lista LX.
cod_ug_emit (Optional[int]): UG Emitente da Lista LX.
item_LX (Optional[List['ItemLXErroModel']]): Retorna os erros ocorridos nos itens da lista.
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Retorna os erros ocorridos nos dados gerais da lista.
num_LX (Optional[int | str]): Número da lista LX que foi incluída ou alterada.
"""
ano_LX: Optional[int | str] = None
cod_ug_emit: Optional[int] = None
item_LX: Optional[List['ItemLXErroModel']] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
num_LX: Optional[int | str] = None
[documentos]
class CprCPRealizarTotalCompromissosResponseModel(BaseModelSiafi):
"""Response wrapper para a operação cprCPRealizarTotalCompromissos.
Attributes:
resultado_execucao (Optional[List['CprCPResultadoExecucaoModel']]): Resultado da execução da realização.
"""
resultado_execucao: Optional[List['CprCPResultadoExecucaoModel']] = None
[documentos]
class CprCPRealizarTotalModel(BaseModelSiafi):
"""Contém a lista de compromissos para realização total.
Attributes:
lista_compromissos (Optional[List['CompromissoRealizacaoModel']]): Lista de compromissos para realização.
"""
lista_compromissos: Optional[List['CompromissoRealizacaoModel']] = None
[documentos]
class CprCPRestabelecerCompromissoResponseModel(BaseModelSiafi):
"""Response wrapper para a operação cprCPRestabelecerCompromisso.
Attributes:
resultado_execucao (Optional[List['CprCPResultadoExecucaoModel']]): Resultado da execução do restabelecimento.
"""
resultado_execucao: Optional[List['CprCPResultadoExecucaoModel']] = None
[documentos]
class CprCPRestabelecerModel(BaseModelSiafi):
"""Contém a lista de compromissos para restabelecimento.
Attributes:
lista_compromissos (Optional[List['CompromissoRestabelecerModel']]): Lista de compromissos para restabelecimento.
"""
lista_compromissos: Optional[List['CompromissoRestabelecerModel']] = None
[documentos]
class CprCPResultadoExecucaoModel(BaseModelSiafi):
"""Resultado da execução de uma operação de compromisso (baixa, estorno, etc.).
Attributes:
codigo_compromisso (Optional[int]): Identificador único do compromisso processado.
doc_habil (Optional['DocumentoHabilChaveModel']): Chave de identificação do documento hábil relacionado.
resumo_processamento (Optional[List['ResumoProcessamentoModel']]): Lista de informações do processamento da opção executada.
"""
codigo_compromisso: Optional[int] = None
doc_habil: Optional['DocumentoHabilChaveModel'] = None
resumo_processamento: Optional[List['ResumoProcessamentoModel']] = None
[documentos]
class CprDAConsultarSitRespostaModel(BaseModelSiafi):
"""Resultado da consulta de Situação, com as situações encontradas e mensagens.
Attributes:
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de retorno.
situacao (Optional[List['SituacaoModel']]): Lista de situações encontradas.
"""
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
situacao: Optional[List['SituacaoModel']] = None
[documentos]
class CprDADetalharSitRespostaModel(BaseModelSiafi):
"""Resposta do detalhamento de uma Situação, com informações detalhadas e mensagens.
Attributes:
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de retorno.
situacao (Optional[List['SituacaoCPRModel']]): Lista de situações detalhadas.
"""
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
situacao: Optional[List['SituacaoCPRModel']] = None
[documentos]
class CprDhAlterarIncluirItensModel(BaseModelSiafi):
"""Parâmetros para alterar um Documento Hábil existente, permitindo alterar Dados Básicos e adicionar novos itens.
Attributes:
ano_DH (Optional[int | str]): Ano do Documento Hábil.
centro_custo (Optional[List['CentroCustoCadastroModel']]): Lista de centros de custo.
cod_tipo_DH (Optional[str]): Código do tipo do Documento Hábil.
cod_ug_emit (Optional[int]): Código da UG Emitente do DH. Se não informado, usa a UG do cabeçalho.
compensacao (Optional[List['CompensacaoModel']]): Lista de compensações.
credito (Optional[List['CreditoModel']]): Lista de créditos.
dados_basicos_alteracao (Optional['DadosBasicosAlteracaoModel']): Dados básicos a serem alterados.
dados_pgto (Optional[List['DadosPgtoModelInput']]): Lista de dados de pagamento (somente para Líquido com realização OB).
deducao (Optional[List['DeducaoModelInput']]): Lista de deduções.
despesa_anular (Optional[List['DespesaAnularModelInput']]): Lista de despesas a anular.
doc_contabilizacao (Optional[List['DocContabilizacaoModel']]): Lista de documentos de contabilização.
dt_emis (Optional[str]): Data de emissão do documento NS gerado pela alteração.
encargo (Optional[List['EncargoModelInput']]): Lista de encargos.
num_DH (Optional[int | str]): Número do Documento Hábil.
outros_lanc (Optional[List['OutrosLancModelInput']]): Lista de outros lançamentos.
pco (Optional[List['PcoModelInput']]): Lista de itens de Principal com Orçamento (PCO).
pso (Optional[List['PsoModel']]): Lista de itens de Principal sem Orçamento (PSO).
txt_motivo (Optional[str]): Motivo/Observação da alteração.
"""
ano_DH: Optional[int | str] = None
centro_custo: Optional[List['CentroCustoCadastroModel']] = None
cod_tipo_DH: Optional[str] = None
cod_ug_emit: Optional[int] = None
compensacao: Optional[List['CompensacaoModel']] = None
credito: Optional[List['CreditoModel']] = None
dados_basicos_alteracao: Optional['DadosBasicosAlteracaoModel'] = None
dados_pgto: Optional[List['DadosPgtoModelInput']] = None
deducao: Optional[List['DeducaoModelInput']] = None
despesa_anular: Optional[List['DespesaAnularModelInput']] = None
doc_contabilizacao: Optional[List['DocContabilizacaoModel']] = None
dt_emis: Optional[str] = None
encargo: Optional[List['EncargoModelInput']] = None
num_DH: Optional[int | str] = None
outros_lanc: Optional[List['OutrosLancModelInput']] = None
pco: Optional[List['PcoModelInput']] = None
pso: Optional[List['PsoModel']] = None
txt_motivo: Optional[str] = None
[documentos]
class CprDhAlterarLiquidarModel(BaseModelSiafi):
"""Parâmetros para alterar um Documento Hábil para liquidar todos os itens 'em liquidação'.
Attributes:
ano_DH (Optional[int | str]): Ano do Documento Hábil.
cod_tipo_DH (Optional[str]): Código do tipo do Documento Hábil.
cod_ug_emit (Optional[int]): Código da UG Emitente do DH. Se não informado, usa a UG do cabeçalho.
dt_ateste (Optional[str]): Data do ateste.
dt_emis (Optional[str]): Data de emissão do documento NS gerado pela alteração.
num_DH (Optional[int | str]): Número do Documento Hábil.
txt_motivo (Optional[str]): Motivo/Observação da alteração.
"""
ano_DH: Optional[int | str] = None
cod_tipo_DH: Optional[str] = None
cod_ug_emit: Optional[int] = None
dt_ateste: Optional[str] = None
dt_emis: Optional[str] = None
num_DH: Optional[int | str] = None
txt_motivo: Optional[str] = None
[documentos]
class CprDhCadastrarModel(BaseModelSiafi):
"""Parâmetros para cadastrar um novo Documento Hábil (DH) no CPR.
Attributes:
ano_DH (Optional[int | str]): Ano do Documento Hábil.
centro_custo (Optional[List['CentroCustoCadastroModel']]): Lista de centros de custo.
cod_tipo_DH (Optional[str]): Código do tipo do Documento Hábil.
cod_ug_emit (Optional[int]): Código da UG Emitente.
compensacao (Optional[List['CompensacaoModel']]): Lista de compensações.
credito (Optional[List['CreditoModel']]): Lista de créditos.
dados_basicos (Optional['DadosBasicosModel']): Dados básicos do Documento Hábil.
dados_pgto (Optional[List['DadosPgtoModelInput']]): Lista de dados de pagamento.
deducao (Optional[List['DeducaoModelInput']]): Lista de deduções.
despesa_anular (Optional[List['DespesaAnularModelInput']]): Lista de despesas a anular.
doc_contabilizacao (Optional[List['DocContabilizacaoModel']]): Lista de documentos de contabilização.
encargo (Optional[List['EncargoModelInput']]): Lista de encargos.
num_DH (Optional[int | str]): Número do Documento Hábil.
outros_lanc (Optional[List['OutrosLancModelInput']]): Lista de outros lançamentos.
pco (Optional[List['PcoModelInput']]): Lista de itens de Principal com Orçamento (PCO).
pso (Optional[List['PsoModel']]): Lista de itens de Principal sem Orçamento (PSO).
"""
ano_DH: Optional[int | str] = None
centro_custo: Optional[List['CentroCustoCadastroModel']] = None
cod_tipo_DH: Optional[str] = None
cod_ug_emit: Optional[int] = None
compensacao: Optional[List['CompensacaoModel']] = None
credito: Optional[List['CreditoModel']] = None
dados_basicos: Optional['DadosBasicosModel'] = None
dados_pgto: Optional[List['DadosPgtoModelInput']] = None
deducao: Optional[List['DeducaoModelInput']] = None
despesa_anular: Optional[List['DespesaAnularModelInput']] = None
doc_contabilizacao: Optional[List['DocContabilizacaoModel']] = None
encargo: Optional[List['EncargoModelInput']] = None
num_DH: Optional[int | str] = None
outros_lanc: Optional[List['OutrosLancModelInput']] = None
pco: Optional[List['PcoModelInput']] = None
pso: Optional[List['PsoModel']] = None
[documentos]
class CprDhCancelarModel(BaseModelSiafi):
"""Parâmetros para cancelar um Documento Hábil existente.
Attributes:
ano_DH (Optional[int | str]): Ano do Documento Hábil.
cod_tipo_DH (Optional[str]): Código do tipo do Documento Hábil.
cod_ug_emit (Optional[int]): Código da UG Emitente do DH. Se não informado, usa a UG do cabeçalho.
dt_emis (Optional[str]): Data de emissão.
num_DH (Optional[int | str]): Número do Documento Hábil.
txt_motivo_cancel (Optional[str]): Motivo do cancelamento.
"""
ano_DH: Optional[int | str] = None
cod_tipo_DH: Optional[str] = None
cod_ug_emit: Optional[int] = None
dt_emis: Optional[str] = None
num_DH: Optional[int | str] = None
txt_motivo_cancel: Optional[str] = None
[documentos]
class CprDhConsultarModel(BaseModelSiafi):
"""Modelo para consulta de Documento Hábil (DH) no CPR. Reutiliza a estrutura de CprDhCadastrar para os filtros.
Attributes:
ano_DH (Optional[int | str]): Ano do Documento Hábil.
centro_custo (Optional[List['CentroCustoConsultaModel']]): Filtro por centro de custo.
cod_tipo_DH (Optional[str]): Filtro por tipo de Documento Hábil.
cod_ug_emit (Optional[int]): Filtro por UG Emitente.
compensacao (Optional[List['CompensacaoModel']]): Filtro por compensação.
credito (Optional[List['CreditoModel']]): Filtro por crédito.
dados_basicos (Optional['DadosBasicosModel']): Filtro por dados básicos.
dados_pgto (Optional[List['DadosPgtoModelOutput']]): Filtro por dados de pagamento.
deducao (Optional[List['DeducaoModelOutput']]): Filtro por dedução.
despesa_anular (Optional[List['DespesaAnularModelOutput']]): Filtro por despesa a anular.
doc_contabilizacao (Optional[List['DocContabilizacaoModel']]): Filtro por documento de contabilização.
encargo (Optional[List['EncargoModelOutput']]): Filtro por encargo.
num_DH (Optional[int | str]): Filtro por número do Documento Hábil.
outros_lanc (Optional[List['OutrosLancModelOutput']]): Filtro por outros lançamentos.
pco (Optional[List['PcoModelOutput']]): Filtro por PCO.
pso (Optional[List['PsoModel']]): Filtro por PSO.
"""
ano_DH: Optional[int | str] = None
centro_custo: Optional[List['CentroCustoConsultaModel']] = None
cod_tipo_DH: Optional[str] = None
cod_ug_emit: Optional[int] = None
compensacao: Optional[List['CompensacaoModel']] = None
credito: Optional[List['CreditoModel']] = None
dados_basicos: Optional['DadosBasicosModel'] = None
dados_pgto: Optional[List['DadosPgtoModelOutput']] = None
deducao: Optional[List['DeducaoModelOutput']] = None
despesa_anular: Optional[List['DespesaAnularModelOutput']] = None
doc_contabilizacao: Optional[List['DocContabilizacaoModel']] = None
encargo: Optional[List['EncargoModelOutput']] = None
num_DH: Optional[int | str] = None
outros_lanc: Optional[List['OutrosLancModelOutput']] = None
pco: Optional[List['PcoModelOutput']] = None
pso: Optional[List['PsoModel']] = None
[documentos]
class CprDhDetalharRespostaModel(BaseModelSiafi):
"""Resposta do detalhamento de um Documento Hábil, contendo os dados do DH e mensagens.
Attributes:
documento_habil (Optional['CprDhConsultarModel']): Dados do DH Detalhado.
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de retorno.
"""
documento_habil: Optional['CprDhConsultarModel'] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
[documentos]
class CprDhRespostaModel(BaseModelSiafi):
"""Resposta padrão para operações de Documento Hábil (cadastrar, alterar, cancelar).
Attributes:
ano_DH (Optional[int | str]): Ano do Documento Hábil processado.
cod_tipo_DH (Optional[str]): Código do tipo do Documento Hábil processado.
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de retorno.
num_DH (Optional[int | str]): Número do Documento Hábil processado.
num_ns (Optional[List[str]]): Lista de Notas de Sistema (NS) geradas.
num_qtd_comp_atualizado (Optional[int | str]): Quantidade de Compromissos atualizados.
"""
ano_DH: Optional[int | str] = None
cod_tipo_DH: Optional[str] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
num_DH: Optional[int | str] = None
num_ns: Optional[List[str]] = None
num_qtd_comp_atualizado: Optional[int | str] = None
[documentos]
class CreditoModel(BaseModelSiafi):
"""Representa um lançamento de crédito em um Documento Hábil.
Attributes:
cod_ctgo_gasto (Optional[str]): Código Categoria de Gastos.
cod_font_recur (Optional[int | str]): Código Fonte de Recursos.
cod_sit (Optional[str]): Código da Situação do CPR.
indr_liquidado (Optional[bool]): Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor do crédito (15,2).
"""
cod_ctgo_gasto: Optional[str] = None
cod_font_recur: Optional[int | str] = None
cod_sit: Optional[str] = None
indr_liquidado: Optional[bool] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class CronBaixaPatrimonialModel(BaseModelSiafi):
"""Define o cronograma de baixa patrimonial com suas parcelas.
Attributes:
parcela (Optional[List['ParcelaModel']]): Lista de parcelas do cronograma.
"""
parcela: Optional[List['ParcelaModel']] = None
[documentos]
class DRFDevolucaoModel(BaseModelSiafi):
"""Schema para DRFDevolucaoModel.
Attributes:
numero_documento (Optional[int | str]): Campo não documentado.
documento_origem (Optional['DocumentoOrigemModel']): Campo não documentado.
item_DRF (Optional[List['ItemDRFDevolucaoModel']]): Campo não documentado.
"""
numero_documento: Optional[int | str] = None
documento_origem: Optional['DocumentoOrigemModel'] = None
item_DRF: Optional[List['ItemDRFDevolucaoModel']] = None
[documentos]
class DRFModel(BaseModelSiafi):
"""Schema para DRFModel.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[int | str]): Número da Programação Financeira (string/int, 1-6)
item_DRF (Optional[List['ItemDRFModel']]): Itens da Devolução de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[str] = None
numero_documento: Optional[int | str] = None
item_DRF: Optional[List['ItemDRFModel']] = None
[documentos]
class DadosBasicosAlteracaoModel(BaseModelSiafi):
"""Define os dados básicos que podem ser alterados em um Documento Hábil.
Attributes:
dt_venc (Optional[str]): Nova data de vencimento.
cod_ug_pgto (Optional[int | str]): Novo código da UG de pagamento.
vlr (Optional[float]): Novo valor.
txt_info_adic (Optional[str]): Novas informações adicionais.
txt_processo (Optional[str]): Novo número do processo.
dt_ateste (Optional[str]): Nova data de ateste.
dt_pgto_receb (Optional[str]): Nova data de pagamento/recebimento.
doc_origem (Optional[List['DocOrigemModel']]): Novos documentos de origem.
doc_relacionado (Optional[List['DocRelacionadoModel']]): Novos documentos relacionados.
tramite (Optional[List['TramiteModel']]): Novos trâmites.
"""
dt_venc: Optional[str] = None
cod_ug_pgto: Optional[int | str] = None
vlr: Optional[float] = None
txt_info_adic: Optional[str] = None
txt_processo: Optional[str] = None
dt_ateste: Optional[str] = None
dt_pgto_receb: Optional[str] = None
doc_origem: Optional[List['DocOrigemModel']] = None
doc_relacionado: Optional[List['DocRelacionadoModel']] = None
tramite: Optional[List['TramiteModel']] = None
[documentos]
class DadosBasicosModel(BaseModelSiafi):
"""Representa os dados básicos de um Documento Hábil.
Attributes:
cod_credor_devedor (Optional[str]): Código do credor/devedor (CPF, CNPJ, etc.).
cod_ug_pgto (Optional[int | str]): Código da UG de pagamento.
doc_origem (Optional[List['DocOrigemModel']]): Lista de documentos de origem.
doc_relacionado (Optional[List['DocRelacionadoModel']]): Lista de documentos hábeis relacionados.
dt_ateste (Optional[str]): Data do ateste.
dt_emis (Optional[str]): Data de emissão.
dt_pgto_receb (Optional[str]): Data de pagamento/recebimento.
dt_venc (Optional[str]): Data de vencimento.
tramite (Optional[List['TramiteModel']]): Lista de trâmites do documento.
txt_info_adic (Optional[str]): Texto de informações adicionais (memorando).
txt_obser (Optional[str]): Texto de observação.
txt_processo (Optional[str]): Número do processo.
vlr (Optional[float]): Valor do documento (15,2).
vlr_taxa_cambio (Optional[float]): Taxa de câmbio (6,4).
"""
cod_credor_devedor: Optional[str] = None
cod_ug_pgto: Optional[int | str] = None
doc_origem: Optional[List['DocOrigemModel']] = None
doc_relacionado: Optional[List['DocRelacionadoModel']] = None
dt_ateste: Optional[str] = None
dt_emis: Optional[str] = None
dt_pgto_receb: Optional[str] = None
dt_venc: Optional[str] = None
tramite: Optional[List['TramiteModel']] = None
txt_info_adic: Optional[str] = None
txt_obser: Optional[str] = None
txt_processo: Optional[str] = None
vlr: Optional[float] = None
vlr_taxa_cambio: Optional[float] = None
[documentos]
class DadosBasicosSituacaoModel(BaseModelSiafi):
"""Representa os dados básicos de uma Situação do CPR.
Attributes:
aba_permitida (Optional[List[str]]): Lista de abas permitidas para esta situação.
cod_tipo_DH (Optional[List[str]]): Lista de tipos de Documento Hábil permitidos.
codigo (Optional[str]): Código da Situação.
descricao (Optional[str]): Descrição detalhada da situação.
erro_validacao (Optional[List['schemas__cpr__MensagemModel']]): Lista de erros de validação da situação.
indr_estado (Optional[str]): Estado da situação.
indr_estado_validacao (Optional[str]): Estado de validação da situação.
tipo_situacao (Optional[str]): Código do tipo de situação.
titulo (Optional[str]): Título da situação.
"""
aba_permitida: Optional[List[str]] = None
cod_tipo_DH: Optional[List[str]] = None
codigo: Optional[str] = None
descricao: Optional[str] = None
erro_validacao: Optional[List['schemas__cpr__MensagemModel']] = None
indr_estado: Optional[str] = None
indr_estado_validacao: Optional[str] = None
tipo_situacao: Optional[str] = None
titulo: Optional[str] = None
[documentos]
class DadosItemLXModel(BaseModelSiafi):
"""Representa os dados de um item em uma Lista de Credores PIX (LX).
Attributes:
cod_favorecido (Optional[str]): CPF ou CNPJ do favorecido.
domicilio_bancario (Optional['DomBancarioFavorecidoModel']): Domicílio bancário do favorecido. Mutuamente exclusivo com 'txtChavePix'.
nome_favorecido (Optional[str]): Nome do favorecido.
txt_chave_pix (Optional[str]): Chave PIX do favorecido. Mutuamente exclusivo com 'domicilioBancario'.
vlr_item (Optional[str]): Valor do item (15,2).
"""
cod_favorecido: Optional[str] = None
domicilio_bancario: Optional['DomBancarioFavorecidoModel'] = None
nome_favorecido: Optional[str] = None
txt_chave_pix: Optional[str] = None
vlr_item: Optional[str] = None
[documentos]
class DadosPagamentoPIXModel(BaseModelSiafi):
"""Detalhes de um pagamento PIX associado a uma Ordem de Pagamento.
Attributes:
cod_end_to_end_id (Optional[str]): Código identificador fim-a-fim que rastreia o pagamento PIX com o BACEN.
situacao (Optional[str]): Situação do pagamento PIX (EFETIVADO, REJEITADO, etc.).
txt_erro_processamento (Optional[str]): Descrição do erro, se a situação for REJEITADO.
data_liquidacao_pagto (Optional[str]): Data da liquidação, se a situação for EFETIVADO.
txt_chave_pix (Optional[str]): Chave PIX utilizada no pagamento.
cod_ispb_banco (Optional[str]): Código ISPB do banco recebedor do pagamento PIX.
num_agencia (Optional[int | str]): Número da agência do recebedor do pagamento PIX.
num_conta (Optional[str]): Número da conta bancária do recebedor do pagamento PIX.
tipo_conta (Optional[str]): Tipo da conta do recebedor do pagamento PIX (CACC, SVGS, etc.).
cod_favorecido (Optional[str]): CPF ou CNPJ do recebedor do pagamento PIX.
nome_favorecido (Optional[str]): Nome do recebedor do pagamento PIX.
"""
cod_end_to_end_id: Optional[str] = None
situacao: Optional[str] = None
txt_erro_processamento: Optional[str] = None
data_liquidacao_pagto: Optional[str] = None
txt_chave_pix: Optional[str] = None
cod_ispb_banco: Optional[str] = None
num_agencia: Optional[int | str] = None
num_conta: Optional[str] = None
tipo_conta: Optional[str] = None
cod_favorecido: Optional[str] = None
nome_favorecido: Optional[str] = None
[documentos]
class DadosPgtoModelOutput(BaseModelSiafi):
"""Representa os dados de pagamento em um Documento Hábil.
Attributes:
acrescimo (Optional[List['AcrescimoModel']]): Lista de acréscimos.
cod_credor_devedor (Optional[str]): Código do credor/devedor.
item_recolhimento (Optional[List['ItemRecolhimentoModel']]): Lista de itens de recolhimento.
predoc (Optional['PredocModelOutput']): Dados do pré-documento (Pré-doc).
vlr (Optional[float]): Valor do pagamento (15,2).
"""
acrescimo: Optional[List['AcrescimoModel']] = None
cod_credor_devedor: Optional[str] = None
item_recolhimento: Optional[List['ItemRecolhimentoModel']] = None
predoc: Optional['PredocModelOutput'] = None
vlr: Optional[float] = None
[documentos]
class DadosRelatorioEmpenhoModel(BaseModelSiafi):
"""Dados do relatório PDF do empenho (em base64).
Attributes:
ug_emitente (Optional[int]): UG emitente do empenho. Parâmetro: ugEmitente, Tipo: int, Ocorrência: [1..1], Restrição: UG.
ano_empenho (Optional[int]): Ano do empenho. Parâmetro: anoEmpenho, Tipo: int, Ocorrência: [1..1], Restrição: Ano.
num_empenho (Optional[int]): Número do empenho. Parâmetro: numEmpenho, Tipo: int, Ocorrência: [1..1], Restrição: NumNE.
relatorio_base64 (Optional[str]): Relatório em PDF codificado em base64. Parâmetro: relatorioBase64, Tipo: base64Binary, Ocorrência: [1..1]. O relatório retornado refere-se à última versão do empenho. O conteúdo é codificado em Base64 (https://docs.oracle.com/javase/8/docs/api/java/util/Base64.html). O sistema consumidor deve decodificar para PDF.
"""
ug_emitente: Optional[int] = None
ano_empenho: Optional[int] = None
num_empenho: Optional[int] = None
relatorio_base64: Optional[str] = None
[documentos]
class DeducaoModelOutput(BaseModelSiafi):
"""Representa um lançamento de dedução em um Documento Hábil.
Attributes:
acrescimo (Optional[List['AcrescimoModel']]): Lista de acréscimos.
cod_sit (Optional[str]): Código da Situação do CPR.
cod_ug_pgto (Optional[int | str]): Código da UG de pagamento.
dt_pgto_receb (Optional[str]): Data de pagamento/recebimento.
dt_venc (Optional[str]): Data de vencimento.
indr_liquidado (Optional[bool]): Indica se está liquidado. Se não informado, será True.
item_recolhimento (Optional[List['ItemRecolhimentoModel']]): Lista de itens de recolhimento.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_class_C (Optional[int | str]): Informação de classificação do item da Situação.
num_class_D (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
predoc (Optional['PredocModelOutput']): Dados do pré-documento (Pré-doc).
rel_credito (Optional[List['RelSemItemModel']]): Relação com itens de crédito.
rel_pco_item (Optional[List['RelComItemModel']]): Relação com itens de PCO.
rel_pso_item (Optional[List['RelComItemModel']]): Relação com itens de PSO.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_D (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor da dedução (15,2).
"""
acrescimo: Optional[List['AcrescimoModel']] = None
cod_sit: Optional[str] = None
cod_ug_pgto: Optional[int | str] = None
dt_pgto_receb: Optional[str] = None
dt_venc: Optional[str] = None
indr_liquidado: Optional[bool] = None
item_recolhimento: Optional[List['ItemRecolhimentoModel']] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_class_C: Optional[int | str] = None
num_class_D: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
predoc: Optional['PredocModelOutput'] = None
rel_credito: Optional[List['RelSemItemModel']] = None
rel_pco_item: Optional[List['RelComItemModel']] = None
rel_pso_item: Optional[List['RelComItemModel']] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class DespesaAnularItemModel(BaseModelSiafi):
"""Representa um item de despesa a anular dentro de um Documento Hábil.
Attributes:
cod_sub_item_empe (Optional[str]): Código do Subitem do empenho.
indr_liquidado (Optional[bool]): Indica se está liquidado.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_class_C (Optional[int | str]): Informação de classificação do item da Situação.
num_empe (Optional[str]): Número do empenho.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
rel_encargo (Optional[List['RelSemItemValorModel']]): Relação com itens de encargo.
rel_pco_item (Optional[List['RelComItemValorModel']]): Relação com itens de PCO.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor a anular (15,2).
"""
cod_sub_item_empe: Optional[str] = None
indr_liquidado: Optional[bool] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_class_C: Optional[int | str] = None
num_empe: Optional[str] = None
num_seq_item: Optional[int | str] = None
rel_encargo: Optional[List['RelSemItemValorModel']] = None
rel_pco_item: Optional[List['RelComItemValorModel']] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class DespesaAnularModelOutput(BaseModelSiafi):
"""Representa um lançamento de despesa a anular em um Documento Hábil.
Attributes:
cod_sit (Optional[str]): Código da Situação do CPR.
cod_ug_empe (Optional[int | str]): Código da UG do empenho.
despesa_anular_item (Optional[List['DespesaAnularItemModel']]): Lista de itens de despesa a anular.
num_class_D (Optional[int | str]): Informação de classificação do item da Situação.
num_class_E (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
txt_inscr_D (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_E (Optional[str]): Informação de inscrição do item da Situação.
"""
cod_sit: Optional[str] = None
cod_ug_empe: Optional[int | str] = None
despesa_anular_item: Optional[List['DespesaAnularItemModel']] = None
num_class_D: Optional[int | str] = None
num_class_E: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
txt_inscr_D: Optional[str] = None
txt_inscr_E: Optional[str] = None
[documentos]
class DocContabilizacaoModel(BaseModelSiafi):
"""Representa um documento de contabilização associado a um Documento Hábil.
Attributes:
ano_doc_cont (Optional[int | str]): Ano do Documento de Contabilização.
cod_tipo_doc_cont (Optional[str]): Código do Tipo de Documento Contábil.
cod_ug_emit (Optional[int]): Código da UG emitente.
num_doc_cont (Optional[str]): Número do Documento de Contabilização.
"""
ano_doc_cont: Optional[int | str] = None
cod_tipo_doc_cont: Optional[str] = None
cod_ug_emit: Optional[int] = None
num_doc_cont: Optional[str] = None
[documentos]
class DocOrigemModel(BaseModelSiafi):
"""Representa um documento de origem (ex: nota fiscal) associado a um Documento Hábil.
Attributes:
cod_ident_emit (Optional[str]): Identificação do emissor do documento (CPF/CNPJ).
dt_emis (Optional[str]): Data de emissão do documento de origem.
num_doc_origem (Optional[str]): Número do documento de origem.
vlr (Optional[float]): Valor do documento de origem (15,2).
"""
cod_ident_emit: Optional[str] = None
dt_emis: Optional[str] = None
num_doc_origem: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class DocRelacionadoModel(BaseModelSiafi):
"""Representa um documento hábil já cadastrado que possui relação com o que está sendo cadastrado.
Attributes:
cod_ug_emit (Optional[int]): UG emitente do documento relacionado.
num_doc_relacionado (Optional[str]): Número do documento relacionado (ex: 2025NE000123).
"""
cod_ug_emit: Optional[int] = None
num_doc_relacionado: Optional[str] = None
[documentos]
class DocumentoHabilChaveModel(BaseModelSiafi):
"""Representa uma chave de identificação única para um Documento Hábil.
Attributes:
ano (Optional[int | str]): Ano do documento hábil.
numero (Optional[int | str]): Número do documento hábil.
tipo (Optional[str]): Tipo do documento hábil.
ug_emitente (Optional[int | str]): UG Emitente do documento hábil.
"""
ano: Optional[int | str] = None
numero: Optional[int | str] = None
tipo: Optional[str] = None
ug_emitente: Optional[int | str] = None
[documentos]
class DocumentoHabilOPModel(BaseModelSiafi):
"""Representa a chave de um Documento Hábil associado a uma Ordem de Pagamento.
Attributes:
ano (Optional[str]): Ano do documento hábil.
numero (Optional[str]): Número do documento hábil.
tipo (Optional[str]): Tipo do documento hábil.
ug_emitente (Optional[int | str]): UG Emitente do documento hábil.
"""
ano: Optional[str] = None
numero: Optional[str] = None
tipo: Optional[str] = None
ug_emitente: Optional[int | str] = None
[documentos]
class DocumentoOrdemPagamentoModel(BaseModelSiafi):
"""Representa um documento de Ordem de Pagamento gerado na realização de um compromisso.
Attributes:
numero_documento (Optional[str]): Número do Documento OP Gerado.
ug_emitente_documento (Optional[int | str]): UG emitente do Documento OP.
valor_documento (Optional[str]): Valor do Documento OP Gerado.
"""
numero_documento: Optional[str] = None
ug_emitente_documento: Optional[int | str] = None
valor_documento: Optional[str] = None
[documentos]
class DocumentoOrigemModel(BaseModelSiafi):
"""Schema para DocumentoOrigemModel.
Attributes:
cod_ug_documento (Optional[int | str]): Campo não documentado.
numero_documento (Optional[int | str]): Campo não documentado.
"""
cod_ug_documento: Optional[int | str] = None
numero_documento: Optional[int | str] = None
[documentos]
class DocumentoSIAFIModel(BaseModelSiafi):
"""Representa um documento SIAFI genérico.
Attributes:
ano_documento (Optional[int]): Ano do documento.
numero_documento (Optional[int | str]): Número do documento SIAFI.
tipo_documento (Optional[str]): Tipo do documento SIAFI (DF, DR, GF, etc.).
ug_emitente_documento (Optional[int | str]): Unidade gestora emitente do documento.
valor_documento (Optional[float]): Valor do documento (15,2).
"""
ano_documento: Optional[int] = None
numero_documento: Optional[int | str] = None
tipo_documento: Optional[str] = None
ug_emitente_documento: Optional[int | str] = None
valor_documento: Optional[float] = None
[documentos]
class DocumentoSIAFIOPModel(BaseModelSiafi):
"""Representa um documento SIAFI associado a uma Ordem de Pagamento.
Attributes:
data_emissao_documento (Optional[str]): Data de Emissão do Documento SIAFI Gerado.
doc_cancelamento (Optional['DocumentoSIAFIRealizacaoModel']): Documento SIAFI de Cancelamento.
numero_documento (Optional[str]): Número do Documento SIAFI Gerado.
ug_emitente_documento (Optional[int | str]): UG emitente do Documento SIAFI.
valor_documento (Optional[str]): Valor do Documento SIAFI Gerado.
"""
data_emissao_documento: Optional[str] = None
doc_cancelamento: Optional['DocumentoSIAFIRealizacaoModel'] = None
numero_documento: Optional[str] = None
ug_emitente_documento: Optional[int | str] = None
valor_documento: Optional[str] = None
[documentos]
class DocumentoSIAFIRealizacaoModel(BaseModelSiafi):
"""Representa um documento SIAFI gerado na realização ou estorno de um compromisso.
Attributes:
data_emissao_documento (Optional[str]): Data de Emissão do Documento SIAFI Gerado.
numero_documento (Optional[str]): Número do Documento SIAFI Gerado.
ug_emitente_documento (Optional[int | str]): UG emitente do Documento SIAFI.
valor_documento (Optional[str]): Valor do Documento SIAFI Gerado.
"""
data_emissao_documento: Optional[str] = None
numero_documento: Optional[str] = None
ug_emitente_documento: Optional[int | str] = None
valor_documento: Optional[str] = None
[documentos]
class DocumentoSIAFIResumidoModel(BaseModelSiafi):
"""Representa um documento SIAFI de forma resumida, contendo apenas a chave.
Attributes:
numero_documento (Optional[int | str]): Número do Documento (OP, OB, etc.).
ug_emitente_documento (Optional[int | str]): UG emitente do Documento.
"""
numero_documento: Optional[int | str] = None
ug_emitente_documento: Optional[int | str] = None
[documentos]
class DocumentoSiafiModel(BaseModelSiafi):
"""Schema para DocumentoSiafiModel.
Attributes:
ano (Optional[int | str]): Ano do documento PF (int, 4 dígitos)
numero_documento (Optional[int | str]): Número do documento SIAFI (int, 1-6)
cod_ug_emit (Optional[int | str]): Unidade Gestora Emitente do documento (int, 1-6)
"""
ano: Optional[int | str] = None
numero_documento: Optional[int | str] = None
cod_ug_emit: Optional[int | str] = None
[documentos]
class DomBancarioFavorecidoModel(BaseModelSiafi):
"""Representa o domicílio bancário de um favorecido.
Attributes:
banco (Optional[int | str]): Código do banco.
agencia (Optional[int | str]): Número da agência.
conta (Optional[str]): Número da conta do favorecido.
"""
banco: Optional[int | str] = None
agencia: Optional[int | str] = None
conta: Optional[str] = None
[documentos]
class DomBancarioUGPagadoraModel(BaseModelSiafi):
"""Representa o domicílio bancário de uma UG Pagadora.
Attributes:
agencia (Optional[int | str]): Número da agência.
banco (Optional[int | str]): Código do banco.
conta (Optional[str]): Número da conta da UG Pagadora.
"""
agencia: Optional[int | str] = None
banco: Optional[int | str] = None
conta: Optional[str] = None
[documentos]
class EncargoModelOutput(BaseModelSiafi):
"""Representa um lançamento de encargo em um Documento Hábil.
Attributes:
acrescimo (Optional[List['AcrescimoModel']]): Lista de acréscimos.
cod_sit (Optional[str]): Código da Situação do CPR.
cod_sub_item_empe (Optional[int | str]): Código do Subitem do empenho.
cod_ug_empe (Optional[int | str]): Código da UG do empenho.
cod_ug_pgto (Optional[int | str]): Código da UG de pagamento.
dt_pgto_receb (Optional[str]): Data de pagamento/recebimento.
dt_venc (Optional[str]): Data de vencimento.
indr_liquidado (Optional[bool]): Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.
item_recolhimento (Optional['ItemRecolhimentoModel']): Item de recolhimento.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_class_C (Optional[int | str]): Informação de classificação do item da Situação.
num_empe (Optional[str]): Número do empenho.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
predoc (Optional['PredocModelOutput']): Dados do pré-documento (Pré-doc).
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor do encargo (15,2).
"""
acrescimo: Optional[List['AcrescimoModel']] = None
cod_sit: Optional[str] = None
cod_sub_item_empe: Optional[int | str] = None
cod_ug_empe: Optional[int | str] = None
cod_ug_pgto: Optional[int | str] = None
dt_pgto_receb: Optional[str] = None
dt_venc: Optional[str] = None
indr_liquidado: Optional[bool] = None
item_recolhimento: Optional['ItemRecolhimentoModel'] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_class_C: Optional[int | str] = None
num_empe: Optional[str] = None
num_seq_item: Optional[int | str] = None
predoc: Optional['PredocModelOutput'] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class EventoSituacaoModel(BaseModelSiafi):
"""Representa um evento de contabilização associado a uma situação do CPR.
Attributes:
cod_evento (Optional[str]): Código do evento contábil.
cod_RF_classif_contabil1 (Optional[str]): Código da regra de formatação para classificação contábil 1.
cod_RF_classif_contabil2 (Optional[str]): Código da regra de formatação para classificação contábil 2.
cod_RF_classif_orcamentaria1 (Optional[str]): Código da regra de formatação para classificação orçamentária 1.
cod_RF_classif_orcamentaria2 (Optional[str]): Código da regra de formatação para classificação orçamentária 2.
cod_RF_inscricao1 (Optional[str]): Código da regra de formatação para inscrição 1.
cod_RF_inscricao2 (Optional[str]): Código da regra de formatação para inscrição 2.
cod_tipo_evento (Optional[str]): Código do tipo de evento.
"""
cod_evento: Optional[str] = None
cod_RF_classif_contabil1: Optional[str] = None
cod_RF_classif_contabil2: Optional[str] = None
cod_RF_classif_orcamentaria1: Optional[str] = None
cod_RF_classif_orcamentaria2: Optional[str] = None
cod_RF_inscricao1: Optional[str] = None
cod_RF_inscricao2: Optional[str] = None
cod_tipo_evento: Optional[str] = None
[documentos]
class HTTPValidationError(BaseModelSiafi):
"""Schema para HTTPValidationError.
Attributes:
detail (Optional[List['ValidationError']]): Campo não documentado.
"""
detail: Optional[List['ValidationError']] = None
[documentos]
class IncluirAmparoLegalRequestModel(BaseModelSiafi):
"""Request para inclusão de Amparo Legal.
Attributes:
orc_amparo_legal_dados (Optional['OrcAmparoLegalDadosModel']): Dados do Amparo Legal a ser incluído.
motivo (Optional[str]): Motivo da inclusão.
"""
orc_amparo_legal_dados: Optional['OrcAmparoLegalDadosModel'] = None
motivo: Optional[str] = None
[documentos]
class IncluirEmpenhoRequestModel(BaseModelSiafi):
"""Request para inclusão de empenho.
Parâmetros:
ugEmitente (int): Código da UG emitente do empenho. Obrigatório.
anoEmpenho (int): Ano do empenho (AAAA). Obrigatório.
numEmpenho (int, opcional): Número do empenho (NumNE). Obrigatório se numeração manual.
preEmpenho (str, opcional): Número do pré-empenho (PE), se houver.
transferencia (List[TransferenciaModel], opcional): Lista de transferências.
celulaOrcamentaria (CelulaOrcamentariaModel): Dados da célula orçamentária. Obrigatório.
tipoEmpenho (int): Tipo do empenho. Obrigatório.
dtEmis (str): Data de emissão (AAAA-MM-DD). Obrigatório.
txtProcesso (str, opcional): Processo associado.
vlrTaxaCambio (Decimal, opcional): Taxa de câmbio.
vlrEmpenho (Decimal, opcional): Valor do empenho.
codFavorecido (str): Código do favorecido. Obrigatório.
codAmparoLegal (int): Código do amparo legal. Obrigatório.
txtInfoCompl (str, opcional): Informação complementar. Para o Sistema PORTALCONV, deve ser preenchido com o Número da Transferência. Para os demais Sistemas, é opcional.
codTipoTransf (int, opcional): Código do tipo de transferência. Campo de uso obrigatório e exclusivo do Sistema PORTALCONV.
txtLocalEntrega (str, opcional): Local de entrega.
txtDescricao (str): Descrição do empenho. Obrigatório.
passivoAnterior (PassivoAnteriorModel, opcional): Dados de passivo anterior. Deve ser enviado caso o Empenho tenha passivo anterior.
itemEmpenho (List[ItemEmpenhoModel]): Lista de itens do empenho. Obrigatório, mínimo 1.
Attributes:
ug_emitente (Optional[int]): Código da UG emitente do empenho. Obrigatório.
ano_empenho (Optional[int]): Ano do empenho (AAAA). Obrigatório.
num_empenho (Optional[int]): Número do empenho (NumNE). Obrigatório se numeração manual.
pre_empenho (Optional[str]): Número do pré-empenho (PE), se houver.
transferencia (Optional[List['TransferenciaModel']]): Lista de transferências.
celula_orcamentaria (Optional['CelulaOrcamentariaModel']): Dados da célula orçamentária. Obrigatório.
tipo_empenho (Optional[int]): Tipo do empenho. Obrigatório.
dt_emis (Optional[str]): Data de emissão (AAAA-MM-DD). Obrigatório.
txt_processo (Optional[str]): Processo associado.
vlr_taxa_cambio (Optional[float | str]): Taxa de câmbio.
vlr_empenho (Optional[float | str]): Valor do empenho.
cod_favorecido (Optional[str]): Código do favorecido. Obrigatório.
cod_amparo_legal (Optional[int]): Código do amparo legal. Obrigatório.
txt_info_compl (Optional[str]): Informação complementar. Para o Sistema PORTALCONV, deve ser preenchido com o Número da Transferência. Para os demais Sistemas, é opcional.
cod_tipo_transf (Optional[int]): Código do tipo de transferência. Campo de uso obrigatório e exclusivo do Sistema PORTALCONV.
txt_local_entrega (Optional[str]): Local de entrega.
txt_descricao (Optional[str]): Descrição do empenho. Obrigatório.
passivo_anterior (Optional['PassivoAnteriorModelInput']): Dados de passivo anterior. Deve ser enviado caso o Empenho tenha passivo anterior.
item_empenho (Optional[List['ItemEmpenhoModelInput']]): Lista de itens do empenho. Obrigatório, mínimo 1.
"""
ug_emitente: Optional[int] = None
ano_empenho: Optional[int] = None
num_empenho: Optional[int] = None
pre_empenho: Optional[str] = None
transferencia: Optional[List['TransferenciaModel']] = None
celula_orcamentaria: Optional['CelulaOrcamentariaModel'] = None
tipo_empenho: Optional[int] = None
dt_emis: Optional[str] = None
txt_processo: Optional[str] = None
vlr_taxa_cambio: Optional[float | str] = None
vlr_empenho: Optional[float | str] = None
cod_favorecido: Optional[str] = None
cod_amparo_legal: Optional[int] = None
txt_info_compl: Optional[str] = None
cod_tipo_transf: Optional[int] = None
txt_local_entrega: Optional[str] = None
txt_descricao: Optional[str] = None
passivo_anterior: Optional['PassivoAnteriorModelInput'] = None
item_empenho: Optional[List['ItemEmpenhoModelInput']] = None
[documentos]
class IncluirPreEmpenhoRequestModel(BaseModelSiafi):
"""Request para inclusão de pré-empenho.
Parâmetros:
ugEmitente (int): Código da UG emitente do pré-empenho. Obrigatório.
anoPreEmpenho (int): Ano do pré-empenho (AAAA). Obrigatório.
numPreEmpenho (int, opcional): Número do pré-empenho (NumPE). Obrigatório se numeração manual.
celulaOrcamentaria (CelulaOrcamentariaModel): Dados da célula orçamentária. Obrigatório.
dtEmis (str): Data de emissão (AAAA-MM-DD). Obrigatório.
txtProcesso (str, opcional): Processo associado.
vlrTaxaCambio (Decimal, opcional): Taxa de câmbio.
vlrPreEmpenho (Decimal): Valor do pré-empenho. Obrigatório.
codFavorecido (str, opcional): Código do favorecido.
txtDescricao (str): Descrição do pré-empenho. Obrigatório.
Attributes:
ug_emitente (Optional[int]): UG emitente do pré-empenho. Parâmetro: ugEmitente, Tipo: int, Ocorrência: [1..1], Restrição: UG.
ano_pre_empenho (Optional[int]): Ano do pré-empenho. Parâmetro: anoPreEmpenho, Tipo: int, Ocorrência: [1..1], Restrição: Ano.
num_pre_empenho (Optional[int]): Número do pré-empenho. Parâmetro: numPreEmpenho, Tipo: int, Ocorrência: [0..1], Restrição: NumPE. Caso a UG Emitente esteja configurada para utilizar numeração manual, é obrigatório informar o número do Pré-empenho.
celula_orcamentaria (Optional['CelulaOrcamentariaModel']): Célula orçamentária. Parâmetro: celulaOrcamentaria, Tipo: CelulaOrcamentaria, Ocorrência: [1..1].
dt_emis (Optional[str]): Data de emissão. Parâmetro: dtEmis, Tipo: date, Ocorrência: [1..1]. Formato: AAAA-MM-DD.
txt_processo (Optional[str]): Processo associado. Parâmetro: txtProcesso, Tipo: string, Ocorrência: [0..1], Restrição: Processo.
vlr_taxa_cambio (Optional[float | str]): Taxa de câmbio. Parâmetro: vlrTaxaCambio, Tipo: decimal, Ocorrência: [0..1], Restrição: TaxaCambio.
vlr_pre_empenho (Optional[float | str]): Valor do pré-empenho. Parâmetro: vlrPreEmpenho, Tipo: decimal, Ocorrência: [1..1], Restrição: Valor.
cod_favorecido (Optional[str]): Código do favorecido. Parâmetro: codFavorecido, Tipo: string, Ocorrência: [0..1], Restrição: Favorecido.
txt_descricao (Optional[str]): Descrição do pré-empenho. Parâmetro: txtDescricao, Tipo: string, Ocorrência: [1..1], Restrição: DescricaoPreEmpenho. Representa a descrição do pré-empenho e irá compor o documento RO.
"""
ug_emitente: Optional[int] = None
ano_pre_empenho: Optional[int] = None
num_pre_empenho: Optional[int] = None
celula_orcamentaria: Optional['CelulaOrcamentariaModel'] = None
dt_emis: Optional[str] = None
txt_processo: Optional[str] = None
vlr_taxa_cambio: Optional[float | str] = None
vlr_pre_empenho: Optional[float | str] = None
cod_favorecido: Optional[str] = None
txt_descricao: Optional[str] = None
[documentos]
class IndicadoresModel(BaseModelSiafi):
"""Representa os indicadores de comportamento de uma situação do CPR.
Attributes:
aba_anular (Optional[str]): Indica a aba para anulação.
cod_sit_compensavel (Optional[List[str]]): Lista de códigos de situação compensáveis.
cod_sit_credito_relacionado (Optional[List[str]]): Lista de códigos de situação de crédito relacionados.
cod_sit_PF_relacionada (Optional[str]): Código de situação de Programação Financeira relacionada.
indr_compensavel (Optional[bool]): Indica se é compensável.
indr_contabilizacao_CPR (Optional[str]): Indicador do tipo de contabilização no CPR.
indr_doc_realizacao_comp (Optional[str]): Indicador do tipo de documento de realização de compromisso.
indr_efeito_centro_custo (Optional[str]): Indicador do efeito no centro de custo.
indr_exige_NDD_centro_custo (Optional[bool]): Indica se exige Natureza de Despesa Detalhada no centro de custo.
indr_geracao_comp (Optional[List[str]]): Indicador do tipo de geração de compromisso.
indr_integra_liquido_comp (Optional[bool]): Indica se integra o líquido do compromisso.
indr_natureza (Optional[str]): Indicador da natureza da situação.
indr_permite_contrato (Optional[bool]): Indica se permite contrato.
indr_permite_cron_baixa_pat (Optional[bool]): Indica se permite cronograma de baixa patrimonial.
indr_permite_desp_antecipada (Optional[bool]): Indica se permite despesa antecipada.
indr_permite_estorno_normal (Optional[bool]): Indica se permite estorno normal.
"""
aba_anular: Optional[str] = None
cod_sit_compensavel: Optional[List[str]] = None
cod_sit_credito_relacionado: Optional[List[str]] = None
cod_sit_PF_relacionada: Optional[str] = None
indr_compensavel: Optional[bool] = None
indr_contabilizacao_CPR: Optional[str] = None
indr_doc_realizacao_comp: Optional[str] = None
indr_efeito_centro_custo: Optional[str] = None
indr_exige_NDD_centro_custo: Optional[bool] = None
indr_geracao_comp: Optional[List[str]] = None
indr_integra_liquido_comp: Optional[bool] = None
indr_natureza: Optional[str] = None
indr_permite_contrato: Optional[bool] = None
indr_permite_cron_baixa_pat: Optional[bool] = None
indr_permite_desp_antecipada: Optional[bool] = None
indr_permite_estorno_normal: Optional[bool] = None
[documentos]
class ItemCLTModelOutput(BaseModelSiafi):
"""Schema para ItemCLTModel-Output.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
mes_programacao (Optional[str]): Mês da Programação Financeira (string, 1-2)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
mes_programacao: Optional[str] = None
[documentos]
class ItemCompromissoModel(BaseModelSiafi):
"""Representa um item de um compromisso financeiro.
Attributes:
codigo_categoria_gasto (Optional[int | str]): Código da categoria de gasto.
codigo_item_compromisso (Optional[int | str]): Identificador único do item de compromisso.
codigo_resultado_primario (Optional[int | str]): Código do Indicador de Resultado Primário do Empenho.
doc_realiz_liquid (Optional[List['DocumentoSIAFIModel']]): Lista de documentos de realização/liquidação.
empenho (Optional[str]): Número do empenho.
fonte_recurso (Optional[str]): Fonte de recurso.
valor_cancelado_fora_cpr (Optional[str]): Valor cancelado fora do CPR para o item.
valor_realizado (Optional[str]): Valor realizado do item de compromisso.
valor_realizado_fora_cpr (Optional[str]): Valor realizado fora do CPR para o item.
valor_realizavel (Optional[str]): Valor realizável do item de compromisso.
valor_total (Optional[str]): Valor total do item de compromisso.
vinculacoes (Optional[List['VinculacaoModel']]): Lista de vinculações.
"""
codigo_categoria_gasto: Optional[int | str] = None
codigo_item_compromisso: Optional[int | str] = None
codigo_resultado_primario: Optional[int | str] = None
doc_realiz_liquid: Optional[List['DocumentoSIAFIModel']] = None
empenho: Optional[str] = None
fonte_recurso: Optional[str] = None
valor_cancelado_fora_cpr: Optional[str] = None
valor_realizado: Optional[str] = None
valor_realizado_fora_cpr: Optional[str] = None
valor_realizavel: Optional[str] = None
valor_total: Optional[str] = None
vinculacoes: Optional[List['VinculacaoModel']] = None
[documentos]
class ItemCompromissoRealizacaoModel(BaseModelSiafi):
"""Representa um item de compromisso a ser realizado.
Attributes:
codigo_item_compromisso (Optional[int | str]): Identificador único do item de compromisso.
vinculacoes (Optional[List['VinculacaoModel']]): Lista de vinculações para a realização.
"""
codigo_item_compromisso: Optional[int | str] = None
vinculacoes: Optional[List['VinculacaoModel']] = None
[documentos]
class ItemDRFDevolucaoModel(BaseModelSiafi):
"""Schema para ItemDRFDevolucaoModel.
Attributes:
vlr (Optional[float]): Campo não documentado.
codigo_item_PF_origem (Optional[int | str]): Identificador do item PF de origem. Obtenha do endpoint /detalhar-programacao-financeira
"""
vlr: Optional[float] = None
codigo_item_PF_origem: Optional[int | str] = None
[documentos]
class ItemDRFModel(BaseModelSiafi):
"""Schema para ItemDRFModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
mes_programacao (Optional[str]): Mês da Programação Financeira (string, 1-2)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
mes_programacao: Optional[str] = None
[documentos]
class ItemEmpenhoModelOutput(BaseModelSiafi):
"""Item do empenho.
Parâmetros:
numSeqItem (int): Número sequencial do item. Obrigatório.
codSubElemento (str, opcional): Código do subelemento da natureza da despesa. Obrigatório quando informado novos itens de empenho.
descricao (str, opcional): Descrição do item de empenho. Obrigatório quando informado novos itens de empenho.
operacaoItemEmpenho (OperacaoItemEmpenhoModel, opcional): Operação aplicada no item de empenho.
Attributes:
num_seq_item (Optional[int]): Número sequencial do item. Obrigatório.
cod_sub_elemento (Optional[str]): Código do subelemento da natureza da despesa. Obrigatório quando informado novos itens de empenho.
descricao (Optional[str]): Descrição do item de empenho. Obrigatório quando informado novos itens de empenho.
operacao_item_empenho (Optional['OperacaoItemEmpenhoModelOutput']): Operação aplicada no item de empenho.
"""
num_seq_item: Optional[int] = None
cod_sub_elemento: Optional[str] = None
descricao: Optional[str] = None
operacao_item_empenho: Optional['OperacaoItemEmpenhoModelOutput'] = None
[documentos]
class ItemLXDetalheModel(BaseModelSiafi):
"""Representa o detalhe de um item de uma Lista de Credores PIX (LX).
Attributes:
dados_item_LX (Optional['DadosItemLXModel']): Dados do item da lista LX.
dados_pagamento_PIX (Optional['DadosPagamentoPIXModel']): Dados do pagamento PIX, retornado quando o item entrou em processo de pagamento.
doc_siafi_cancelamento (Optional['DocumentoSIAFIResumidoModel']): Documento contábil gerado para o cancelamento, caso o pagamento não tenha sido efetivado.
num_seq_item (Optional[int | str]): Número sequencial do item.
tipo_cancelamento (Optional[str]): Identifica o tipo de cancelamento na contabilidade, caso o pagamento não tenha sido efetivado.
"""
dados_item_LX: Optional['DadosItemLXModel'] = None
dados_pagamento_PIX: Optional['DadosPagamentoPIXModel'] = None
doc_siafi_cancelamento: Optional['DocumentoSIAFIResumidoModel'] = None
num_seq_item: Optional[int | str] = None
tipo_cancelamento: Optional[str] = None
[documentos]
class ItemLXErroModel(BaseModelSiafi):
"""Representa um erro ocorrido em um item de uma Lista de Credores PIX (LX) durante a manutenção.
Attributes:
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de erro para o item.
num_seq_item (Optional[int | str]): Sequencial do item da lista LX em que ocorreu o erro.
"""
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
num_seq_item: Optional[int | str] = None
[documentos]
class ItemLXModel(BaseModelSiafi):
"""Representa um item a ser mantido (incluído, alterado, excluído) em uma Lista de Credores PIX (LX).
Attributes:
dados_item_LX (Optional['DadosItemLXModel']): Dados do item da lista LX.
num_seq_item (Optional[int | str]): Identificador do item. Não pode ser repetido na mesma lista LX.
tipo_operacao_item (Optional[str]): Tipo de operação a ser aplicada no item (INCLUSAO, ALTERACAO, EXCLUSAO).
"""
dados_item_LX: Optional['DadosItemLXModel'] = None
num_seq_item: Optional[int | str] = None
tipo_operacao_item: Optional[str] = None
[documentos]
class ItemMovLimiteModel(BaseModelSiafi):
"""Item de movimentação de limite plurianual.
Attributes:
tipo_mov_lim (Optional[int]): Tipo de movimentação, conforme parametrizado na transação >CONEVELIMI.
inscricao1 (Optional[str]): Exercício ou identificação da cota. Tamanho: 1-4.
vlr_limite (Optional[float | str]): Valor do limite. Decimal, 2 casas decimais, 15 inteiros.
"""
tipo_mov_lim: Optional[int] = None
inscricao1: Optional[str] = None
vlr_limite: Optional[float | str] = None
[documentos]
class ItemPADModel(BaseModelSiafi):
"""Schema para ItemPADModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_prevista (Optional[str]): Data prevista para liberação do recurso financeiro (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_prevista: Optional[str] = None
[documentos]
class ItemPAPModel(BaseModelSiafi):
"""Schema para ItemPAPModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_liberacao (Optional[str]): Data da liberação do recurso financeiro (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_liberacao: Optional[str] = None
[documentos]
class ItemPARModel(BaseModelSiafi):
"""Schema para ItemPARModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
indr_limite_saque (Optional[bool]): Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque
mes_lib_tran (Optional[str]): Mês em que o recurso foi liberado ou transferido (string, 1-2)
celula_de (Optional['CelulaFinanceiraModel']): Célula financeira 'De' relativa à origem do remanejamento
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
indr_limite_saque: Optional[bool] = None
mes_lib_tran: Optional[str] = None
celula_de: Optional['CelulaFinanceiraModel'] = None
[documentos]
class ItemPCAModel(BaseModelSiafi):
"""Schema para ItemPCAModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_liberacao (Optional[str]): Data da liberação do recurso financeiro (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_liberacao: Optional[str] = None
[documentos]
class ItemPCDModel(BaseModelSiafi):
"""Schema para ItemPCDModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_prevista (Optional[str]): Data Prevista para liberação do recurso financeiro (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_prevista: Optional[str] = None
[documentos]
class ItemPCRModel(BaseModelSiafi):
"""Schema para ItemPCRModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
indr_limite_saque (Optional[bool]): Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque
mes_lib_tran (Optional[str]): Mês em que o recurso foi liberado ou transferido (string, 1-2)
celula_de (Optional['CelulaFinanceiraModel']): Célula financeira 'De' relativa à origem do remanejamento
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
indr_limite_saque: Optional[bool] = None
mes_lib_tran: Optional[str] = None
celula_de: Optional['CelulaFinanceiraModel'] = None
[documentos]
class ItemPCSModel(BaseModelSiafi):
"""Schema para ItemPCSModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_liberacao (Optional[str]): Data prevista para liberação do recurso financeiro solicitado (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_liberacao: Optional[str] = None
[documentos]
class ItemPFDTOModel(BaseModelSiafi):
"""Schema para ItemPFDTOModel.
Attributes:
data_processamento (Optional[str]): Data de processamento (date, opcional)
vlr (Optional[float]): Valor (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação (int, 1-3)
cod_font_recur (Optional[int | str]): Código Fonte Recursos (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código Categoria de Gastos (string, 1)
cod_sit (Optional[str]): Código da Situação (string, 6)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int | str]): Classificação A (int, 1-9)
txt_class_B (Optional[int | str]): Classificação B (int, 1-9)
"""
data_processamento: Optional[str] = None
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int | str] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int | str] = None
txt_class_B: Optional[int | str] = None
[documentos]
class ItemPLBModel(BaseModelSiafi):
"""Schema para ItemPLBModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_liberacao (Optional[str]): Data da liberação do recurso financeiro (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_liberacao: Optional[str] = None
[documentos]
class ItemPRDModel(BaseModelSiafi):
"""Schema para ItemPRDModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
indr_limite_saque (Optional[bool]): Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque
mes_lib_tran (Optional[str]): Mês em que o recurso foi liberado ou transferido (string, 1-2)
celula_de (Optional['CelulaFinanceiraModel']): Célula financeira 'De' relativa à origem do remanejamento
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
indr_limite_saque: Optional[bool] = None
mes_lib_tran: Optional[str] = None
celula_de: Optional['CelulaFinanceiraModel'] = None
[documentos]
class ItemPSLModel(BaseModelSiafi):
"""Schema para ItemPSLModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
data_prevista (Optional[str]): Data prevista para liberação do recurso financeiro (AAAA-MM-DD)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
data_prevista: Optional[str] = None
[documentos]
class ItemPSRModel(BaseModelSiafi):
"""Schema para ItemPSRModel.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
indr_limite_saque (Optional[bool]): Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque
mes_lib_tran (Optional[str]): Mês em que o recurso foi liberado ou transferido (string, 1-2)
celula_de (Optional['CelulaFinanceiraModel']): Célula financeira 'De' relativa à origem do remanejamento
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
indr_limite_saque: Optional[bool] = None
mes_lib_tran: Optional[str] = None
celula_de: Optional['CelulaFinanceiraModel'] = None
[documentos]
class ItemRecolhimentoModel(BaseModelSiafi):
"""Representa um item de recolhimento em um Documento Hábil.
Attributes:
cod_recolhedor (Optional[str]): Código do recolhedor (CPF, CNPJ, etc.).
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
vlr (Optional[float]): Valor do recolhimento (15,2).
vlr_atm_multa_juros (Optional[str]): Valor de atualização monetária, multa e juros (15,2).
vlr_base_calculo (Optional[str]): Valor da base de cálculo (15,2).
vlr_juros (Optional[str]): Valor dos juros (15,2).
vlr_multa (Optional[str]): Valor da multa (15,2).
vlr_outras_ent (Optional[str]): Valor de outras entidades (15,2).
"""
cod_recolhedor: Optional[str] = None
num_seq_item: Optional[int | str] = None
vlr: Optional[float] = None
vlr_atm_multa_juros: Optional[str] = None
vlr_base_calculo: Optional[str] = None
vlr_juros: Optional[str] = None
vlr_multa: Optional[str] = None
vlr_outras_ent: Optional[str] = None
[documentos]
class ItemTRFModelOutput(BaseModelSiafi):
"""Schema para ItemTRFModel-Output.
Attributes:
vlr (Optional[float]): Valor do item PF (decimal, 1-17)
cod_vinc (Optional[int]): Código da Vinculação de Pagamento (int, 1-3)
cod_font_recur (Optional[int]): Código da Fonte de Recurso (int, 1-10)
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto (string, 1)
cod_sit (Optional[str]): Código da Situação contábil (string, 6)
cod_recurso (Optional[str]): Código do Recurso (string, 1)
codigo_item_PF (Optional[int]): Identificador do item PF (long, 1-10)
saldo_item_PF (Optional[float]): Saldo do item PF (decimal, 1-17)
txt_inscr_A (Optional[str]): Inscrição A (string, 1-28)
txt_inscr_B (Optional[str]): Inscrição B (string, 1-28)
txt_inscr_C (Optional[str]): Inscrição C (string, 1-28)
txt_inscr_D (Optional[str]): Inscrição D (string, 1-28)
txt_class_A (Optional[int]): Classificação A (int, 1-9)
txt_class_B (Optional[int]): Classificação B (int, 1-9)
"""
vlr: Optional[float] = None
cod_vinc: Optional[int] = None
cod_font_recur: Optional[int] = None
cod_ctgo_gasto: Optional[str] = None
cod_sit: Optional[str] = None
cod_recurso: Optional[str] = None
codigo_item_PF: Optional[int] = None
saldo_item_PF: Optional[float] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
txt_class_A: Optional[int] = None
txt_class_B: Optional[int] = None
[documentos]
class OperacaoBaixaSaldoModel(BaseModelSiafi):
"""Operação de baixa de saldo de empenho do exercício anterior.
Attributes:
data_operacao (Optional[str]): Data da operação.
tipo_operacao_item_empenho (Optional[str]): Tipo da operação.
vlr_total (Optional[str]): Valor total da operação.
"""
data_operacao: Optional[str] = None
tipo_operacao_item_empenho: Optional[str] = None
vlr_total: Optional[str] = None
[documentos]
class OperacaoItemEmpenhoModelOutput(BaseModelSiafi):
"""Operação aplicada em item de empenho.
Parâmetros:
tipoOperacaoItemEmpenho (str): [1..1] Tipo da operação aplicada no item de empenho. Valores possíveis:
- INCLUSAO: somente quando for uma inclusão de empenho.
- REFORCO: para novos itens e itens já existentes na alteração de empenho de exercício corrente.
- ANULACAO: somente para itens já existentes na alteração de empenho de exercício corrente.
- CANCELAMENTO: somente para itens já existentes na alteração de empenho de exercícios anteriores.
quantidade (Decimal): [1..1] Quantidade do item de empenho (QtdItemEmp).
vlrUnitario (Decimal): [1..1] Valor unitário do item de empenho (ValorUnitarioItemEmp).
vlrOperacao (Decimal, opcional): [0..1] Valor da operação. Quando informado, será calculado e validado multiplicando quantidade e vlrUnitario e usando a regra de arredondamento numérico.
Attributes:
tipo_operacao_item_empenho (Optional[str]): Tipo da operação aplicada no item de empenho. [1..1] Valores: INCLUSAO, REFORCO, ANULACAO, CANCELAMENTO.
quantidade (Optional[str]): Quantidade do item de empenho. [1..1] QtdItemEmp.
vlr_unitario (Optional[str]): Valor unitário do item de empenho. [1..1] ValorUnitarioItemEmp.
vlr_operacao (Optional[str]): Valor da operação. [0..1] Quando informado, será calculado e validado multiplicando quantidade e vlrUnitario e usando a regra de arredondamento numérico.
"""
tipo_operacao_item_empenho: Optional[str] = None
quantidade: Optional[str] = None
vlr_unitario: Optional[str] = None
vlr_operacao: Optional[str] = None
[documentos]
class OperacaoPreEmpenhoDetalheModel(BaseModelSiafi):
"""Operação aplicada em pré-empenho (detalhamento).
Attributes:
dt_operacao (Optional[str]): Data da operação.
tipo_operacao (Optional[str]): Tipo da operação.
vlr_operacao (Optional[str]): Valor da operação.
"""
dt_operacao: Optional[str] = None
tipo_operacao: Optional[str] = None
vlr_operacao: Optional[str] = None
[documentos]
class OperacaoPreEmpenhoModel(BaseModelSiafi):
"""Operação aplicada em pré-empenho.
Parâmetros:
tipoOperacao (str): Tipo de operação aplicada no pré-empenho. Obrigatório.
vlrOperacao (Decimal): Valor da operação. Obrigatório.
Attributes:
tipo_operacao (Optional[str]): Tipo de operação aplicada no pré-empenho.
vlr_operacao (Optional[float | str]): Valor da operação.
"""
tipo_operacao: Optional[str] = None
vlr_operacao: Optional[float | str] = None
[documentos]
class OrcAmparoLegalDadosModel(BaseModelSiafi):
"""Dados do Amparo Legal a ser incluído ou alterado.
Attributes:
cod_modalidade_licitacao (Optional[int]): Código da Modalidade de Licitação.
ato_normativo (Optional[str]): Descrição do Ato Normativo.
artigo (Optional[str]): Artigo do Ato Normativo.
paragrafo (Optional[str]): Parágrafo do Ato Normativo.
inciso (Optional[str]): Inciso do Ato Normativo.
alinea (Optional[str]): Alínea do Ato Normativo.
restricao (Optional[List['RestricaoAmparoLegalModel']]): Lista de restrições de uso do Amparo Legal.
"""
cod_modalidade_licitacao: Optional[int] = None
ato_normativo: Optional[str] = None
artigo: Optional[str] = None
paragrafo: Optional[str] = None
inciso: Optional[str] = None
alinea: Optional[str] = None
restricao: Optional[List['RestricaoAmparoLegalModel']] = None
[documentos]
class OrcAmparoLegalRespostaModel(BaseModelSiafi):
"""Resposta das operações de Amparo Legal (incluir, alterar, excluir, reincluir).
Attributes:
cod_amparo_legal (Optional[int]): Código do Amparo Legal gerado ou alterado.
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Lista de mensagens de retorno.
"""
cod_amparo_legal: Optional[int] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OrcBaixaSaldoEmpenhoExercAnteriorDadosModel(BaseModelSiafi):
"""Dados da baixa de saldo de empenho do exercício anterior.
Attributes:
ug_emitente (Optional[int | str]): Código da UG emitente do empenho.
ano_empenho (Optional[int | str]): Ano do empenho.
num_empenho (Optional[int | str]): Número do empenho.
txt_info_compl (Optional[str]): Informação complementar.
sistema_origem (Optional[str]): Sistema de origem.
operacao_baixa_saldo (Optional[List['OperacaoBaixaSaldoModel']]): Lista de operações de baixa de saldo.
"""
ug_emitente: Optional[int | str] = None
ano_empenho: Optional[int | str] = None
num_empenho: Optional[int | str] = None
txt_info_compl: Optional[str] = None
sistema_origem: Optional[str] = None
operacao_baixa_saldo: Optional[List['OperacaoBaixaSaldoModel']] = None
[documentos]
class OrcConsultarBaixaSaldoEmpenhoExercAnteriorRespostaModel(BaseModelSiafi):
"""Resposta da consulta de baixa de saldo de empenho do exercício anterior.
Attributes:
baixa_saldo (Optional['OrcBaixaSaldoEmpenhoExercAnteriorDadosModel']): Dados da baixa de saldo.
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Lista de mensagens de retorno.
"""
baixa_saldo: Optional['OrcBaixaSaldoEmpenhoExercAnteriorDadosModel'] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OrcConsultarRelatorioEmpenhoRespostaModel(BaseModelSiafi):
"""Resposta da consulta de relatório de empenho (PDF em base64).
Parâmetros:
dadosRelatorio (DadosRelatorioEmpenhoModel): [0..1] Dados do relatório PDF do empenho.
mensagem (List[MensagemModel]): [0..n] Mensagem(ns) de erro retornada(s) caso o empenho não esteja disponível para impressão PDF ou o empenho não exista na base de dados ou qualquer outro erro de negócio que impossibilite a impressão PDF da versão atual do empenho informado.
Attributes:
dados_relatorio (Optional['DadosRelatorioEmpenhoModel']): Dados do relatório gerado. [0..1] Dados do relatório PDF do empenho.
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Lista de mensagens de retorno. [0..n] Mensagens de erro/alerta.
"""
dados_relatorio: Optional['DadosRelatorioEmpenhoModel'] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OrcDetalharEmpenhoRespostaModel(BaseModelSiafi):
"""Parâmetros de resposta do detalhamento de Empenho.
Parâmetro Tipo Ocorrência Restrição Observação
empenho OrcEmpenhoDados [0..1] - Dados do Empenho.
mensagem Mensagem [0..n] - Mensagens de retorno.
Attributes:
empenho (Optional['OrcEmpenhoDadosModel']): Dados do Empenho. Parâmetro: empenho, Tipo: OrcEmpenhoDados, Ocorrência: [0..1].
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Mensagens de retorno. Parâmetro: mensagem, Tipo: Mensagem, Ocorrência: [0..n].
"""
empenho: Optional['OrcEmpenhoDadosModel'] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OrcDetalharPreEmpenhoRespostaModel(BaseModelSiafi):
"""Resposta do detalhamento de pré-empenho.
Attributes:
pre_empenho (Optional['OrcPreEmpenhoDetalheModel']): Campo não documentado.
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Lista de mensagens de retorno.
"""
pre_empenho: Optional['OrcPreEmpenhoDetalheModel'] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OrcEmpenhoDadosModel(BaseModelSiafi):
"""Dados do Empenho conforme WSDL ns2:OrcEmpenhoDados.
Parâmetro Tipo Ocorrência Restrição Observação
ugEmitente str/int [1..1] UG Código da UG emitente do empenho
anoEmpenho int [1..1] Ano Ano do empenho
numEmpenho str/int [1..1] NumNE Número do empenho
preEmpenho str [0..1] PE Número do pré-empenho, se houver
tipoEmpenho str/int [1..1] TipoEmpenho Tipo do empenho
celulaOrcamentaria CelulaOrcamentariaModel [1..1] - Dados da célula orçamentária
dtEmis str [1..1] Date Data de emissão (AAAA-MM-DD)
txtProcesso str [0..1] Processo Processo associado
vlrTaxaCambio Decimal [0..1] TaxaCambio Taxa de câmbio
vlrEmpenho Decimal [1..1] Valor Valor do empenho
codFavorecido str [1..1] Favorecido Código do favorecido
codAmparoLegal str/int [0..1] AmparoLegal Código do amparo legal
txtInfoCompl str [0..1] InformacaoComplementar Informação complementar
codTipoTransf str/int [0..1] TipoTransferencia Código do tipo de transferência
txtLocalEntrega str [0..1] LocalEntrega Local de entrega
txtDescricao str [0..1] DescricaoEmpenho Descrição do empenho
passivoAnterior PassivoAnteriorModel [0..1] - Dados de passivo anterior
itemEmpenho List[ItemEmpenhoModel] [1..n] - Lista de itens do empenho
Attributes:
ug_emitente (Optional[int | str]): Código da UG emitente do empenho.
ano_empenho (Optional[int]): Ano do empenho.
num_empenho (Optional[int | str]): Número do empenho.
pre_empenho (Optional[str]): Número do pré-empenho, se houver.
tipo_empenho (Optional[int | str]): Tipo do empenho.
celula_orcamentaria (Optional['CelulaOrcamentariaModel']): Dados da célula orçamentária.
dt_emis (Optional[str]): Data de emissão (AAAA-MM-DD).
txt_processo (Optional[str]): Processo associado.
vlr_taxa_cambio (Optional[str]): Taxa de câmbio.
vlr_empenho (Optional[str]): Valor do empenho.
cod_favorecido (Optional[str]): Código do favorecido.
cod_amparo_legal (Optional[int | str]): Código do amparo legal.
txt_info_compl (Optional[str]): Informação complementar.
cod_tipo_transf (Optional[int | str]): Código do tipo de transferência.
txt_local_entrega (Optional[str]): Local de entrega.
txt_descricao (Optional[str]): Descrição do empenho.
passivo_anterior (Optional['PassivoAnteriorModelOutput']): Dados de passivo anterior.
item_empenho (Optional[List['ItemEmpenhoModelOutput']]): Lista de itens do empenho.
"""
ug_emitente: Optional[int | str] = None
ano_empenho: Optional[int] = None
num_empenho: Optional[int | str] = None
pre_empenho: Optional[str] = None
tipo_empenho: Optional[int | str] = None
celula_orcamentaria: Optional['CelulaOrcamentariaModel'] = None
dt_emis: Optional[str] = None
txt_processo: Optional[str] = None
vlr_taxa_cambio: Optional[str] = None
vlr_empenho: Optional[str] = None
cod_favorecido: Optional[str] = None
cod_amparo_legal: Optional[int | str] = None
txt_info_compl: Optional[str] = None
cod_tipo_transf: Optional[int | str] = None
txt_local_entrega: Optional[str] = None
txt_descricao: Optional[str] = None
passivo_anterior: Optional['PassivoAnteriorModelOutput'] = None
item_empenho: Optional[List['ItemEmpenhoModelOutput']] = None
[documentos]
class OrcEmpenhoRespostaModel(BaseModelSiafi):
"""Resposta das operações de Empenho (incluir, alterar).
Parâmetros:
ugEmitente (str): [0..1] Código da UG emitente do empenho (UG Emitente do Empenho).
empenho (str): [0..1] Número do empenho (NE) original envolvido na operação.
documentoRO (str): [0..1] Número do documento RO (RO) contábil gerado na operação.
mensagem (List[MensagemModel]): [0..n] Lista de mensagens de erro/alerta.
Attributes:
ug_emitente (Optional[int | str]): Código da UG emitente do empenho. [0..1] UG Emitente do Empenho.
empenho (Optional[str]): Número do empenho (NE) gerado ou alterado. [0..1] Empenho original envolvido na operação.
documento_RO (Optional[str]): Número do documento RO gerado. [0..1] Documento contábil gerado na operação.
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Lista de mensagens de retorno. [0..n] Mensagens de erro/alerta.
"""
ug_emitente: Optional[int | str] = None
empenho: Optional[str] = None
documento_RO: Optional[str] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OrcPreEmpenhoDetalheModel(BaseModelSiafi):
"""Dados completos do pré-empenho detalhado.
Attributes:
ug_emitente (Optional[int | str]): Código da UG emitente do pré-empenho.
ano_pre_empenho (Optional[int | str]): Ano do pré-empenho.
num_pre_empenho (Optional[int | str]): Número do pré-empenho.
empenho_relacionado (Optional[List[str]]): Lista de empenhos relacionados.
celula_orcamentaria (Optional['CelulaOrcamentariaModel']): Célula orçamentária.
dt_emis (Optional[str]): Data de emissão.
txt_processo (Optional[str]): Processo associado.
vlr_taxa_cambio (Optional[str]): Taxa de câmbio.
vlr_pre_empenho (Optional[str]): Valor do pré-empenho.
cod_favorecido (Optional[str]): Código do favorecido.
txt_descricao (Optional[str]): Descrição do pré-empenho.
sistema_origem (Optional[str]): Sistema de origem.
operacao (Optional[List['OperacaoPreEmpenhoDetalheModel']]): Lista de operações de pré-empenho.
registro_alteracao (Optional['RegistroAlteracaoPreEmpenhoModel']): Registro de alteração.
"""
ug_emitente: Optional[int | str] = None
ano_pre_empenho: Optional[int | str] = None
num_pre_empenho: Optional[int | str] = None
empenho_relacionado: Optional[List[str]] = None
celula_orcamentaria: Optional['CelulaOrcamentariaModel'] = None
dt_emis: Optional[str] = None
txt_processo: Optional[str] = None
vlr_taxa_cambio: Optional[str] = None
vlr_pre_empenho: Optional[str] = None
cod_favorecido: Optional[str] = None
txt_descricao: Optional[str] = None
sistema_origem: Optional[str] = None
operacao: Optional[List['OperacaoPreEmpenhoDetalheModel']] = None
registro_alteracao: Optional['RegistroAlteracaoPreEmpenhoModel'] = None
[documentos]
class OrcPreEmpenhoRespostaModel(BaseModelSiafi):
"""Resposta das operações de Pré-Empenho (incluir, alterar).
Attributes:
ug_emitente (Optional[int]): UG Emitente do Pré-empenho. Parâmetro: ugEmitente, Tipo: int, Ocorrência: [0..1], Restrição: UG.
pre_empenho (Optional[str]): Pré-empenho original envolvido na operação. Parâmetro: preEmpenho, Tipo: string, Ocorrência: [0..1], Restrição: PE.
documento_RO (Optional[str]): Documento contábil gerado na operação. Parâmetro: documentoRO, Tipo: string, Ocorrência: [0..1], Restrição: RO.
mensagem (Optional[List['schemas__orcamentario__MensagemModel']]): Lista de mensagens de erro/alerta. Parâmetro: mensagem, Tipo: Mensagem, Ocorrência: [0..n].
"""
ug_emitente: Optional[int] = None
pre_empenho: Optional[str] = None
documento_RO: Optional[str] = None
mensagem: Optional[List['schemas__orcamentario__MensagemModel']] = None
[documentos]
class OutrosLancModelOutput(BaseModelSiafi):
"""Representa um lançamento na aba 'Outros Lançamentos' de um Documento Hábil.
Attributes:
cod_sit (Optional[str]): Código da Situação do CPR.
cron_baixa_patrimonial (Optional['CronBaixaPatrimonialModel']): Cronograma de baixa patrimonial.
indr_liquidado (Optional[bool]): Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.
indr_tem_contrato (Optional[bool]): Indica se tem contrato associado.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_class_C (Optional[int | str]): Informação de classificação do item da Situação.
num_class_D (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
tp_normal_estorno (Optional[str]): Tipo de Lançamento: 'N' - Normal, 'E' - Estorno.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_D (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor do lançamento (15,2).
"""
cod_sit: Optional[str] = None
cron_baixa_patrimonial: Optional['CronBaixaPatrimonialModel'] = None
indr_liquidado: Optional[bool] = None
indr_tem_contrato: Optional[bool] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_class_C: Optional[int | str] = None
num_class_D: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
tp_normal_estorno: Optional[str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class PADModel(BaseModelSiafi):
"""Schema para PADModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PAD (Optional[List['ItemPADModel']]): Itens da Aprovação Direta de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PAD: Optional[List['ItemPADModel']] = None
[documentos]
class PAPModel(BaseModelSiafi):
"""Schema para PAPModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PAP (Optional[List['ItemPAPModel']]): Itens da Aprovação de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PAP: Optional[List['ItemPAPModel']] = None
[documentos]
class PARModel(BaseModelSiafi):
"""Schema para PARModel.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[int | str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PAR (Optional[List['ItemPARModel']]): Itens do Ajuste de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[int | str] = None
numero_documento: Optional[str] = None
item_PAR: Optional[List['ItemPARModel']] = None
[documentos]
class PCAModel(BaseModelSiafi):
"""Schema para PCAModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PCA (Optional[List['ItemPCAModel']]): Itens do Cancelamento de Aprovação de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PCA: Optional[List['ItemPCAModel']] = None
[documentos]
class PCDModel(BaseModelSiafi):
"""Schema para PCDModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PCD (Optional[List['ItemPCDModel']]): Itens do Cancelamento de Aprovação Direta de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PCD: Optional[List['ItemPCDModel']] = None
[documentos]
class PCRModel(BaseModelSiafi):
"""Schema para PCRModel.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[int | str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PCR (Optional[List['ItemPCRModel']]): Itens da Reprogramação de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[int | str] = None
numero_documento: Optional[str] = None
item_PCR: Optional[List['ItemPCRModel']] = None
[documentos]
class PCSModel(BaseModelSiafi):
"""Schema para PCSModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PCS (Optional[List['ItemPCSModel']]): Itens do Cancelamento de Solicitação de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PCS: Optional[List['ItemPCSModel']] = None
[documentos]
class PFCadastrarPFRequestModel(BaseModelSiafi):
"""Schema para PFCadastrarPFRequestModel.
Attributes:
pf_DTO (Optional['PFDTOModel']): Campo não documentado.
"""
pf_DTO: Optional['PFDTOModel'] = None
[documentos]
class PFCadastrarPFResponseModel(BaseModelSiafi):
"""Schema para PFCadastrarPFResponseModel.
Attributes:
pf_resposta_DTO (Optional['PFRespostaDTOModel']): Campo não documentado.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Campo não documentado.
"""
pf_resposta_DTO: Optional['PFRespostaDTOModel'] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PFCancelamentoLibTranModel(BaseModelSiafi):
"""Schema para PFCancelamentoLibTranModel.
Attributes:
cod_ug_emit (Optional[int | str]): Código da unidade gestora emitente (int, 1-6)
observacao (Optional[str]): Observação do cancelamento (string, 1-234)
CLT (Optional['CLTModelInput']): Dados do cancelamento de liberação de transferência
"""
cod_ug_emit: Optional[int | str] = None
observacao: Optional[str] = None
CLT: Optional['CLTModelInput'] = None
[documentos]
class PFCancelarLiberacaoTransferenciaRequestModel(BaseModelSiafi):
"""Schema para PFCancelarLiberacaoTransferenciaRequestModel.
Attributes:
programacao_financeira (Optional['PFCancelamentoLibTranModel']): Campo não documentado.
"""
programacao_financeira: Optional['PFCancelamentoLibTranModel'] = None
[documentos]
class PFCancelarLiberacaoTransferenciaResponseModel(BaseModelSiafi):
"""Schema para PFCancelarLiberacaoTransferenciaResponseModel.
Attributes:
documento_gerado (Optional[List['DocumentoSiafiModel']]): Campo não documentado.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Campo não documentado.
"""
documento_gerado: Optional[List['DocumentoSiafiModel']] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PFConsultaModel(BaseModelSiafi):
"""Schema para PFConsultaModel.
Attributes:
cod_ug_emit (Optional[int | str]): Código da unidade gestora emitente (int, 1-6)
observacao (Optional[str]): Observação da Programação Financeira (string, 1-234)
data_emissao (Optional[str]): Data de emissão da Programação Financeira (AAAA-MM-DD)
PSL (Optional['PSLModel']): Solicitação de Recurso Financeiro
PAP (Optional['PAPModel']): Aprovação de Recurso Financeiro
PAD (Optional['PADModel']): Aprovação Direta de Recurso Financeiro
PLB (Optional['PLBModel']): Liberação de Recurso Financeiro
PCS (Optional['PCSModel']): Cancelamento de Solicitação de Recurso Financeiro
PCA (Optional['PCAModel']): Cancelamento de Aprovação de Recurso Financeiro
PCD (Optional['PCDModel']): Cancelamento de Aprovação Direta de Recurso Financeiro
CLT (Optional['CLTModelOutput']): Cancelamento de Liberação de Transferência
TRF (Optional['TRFModelOutput']): Transferência de Recurso Financeiro
DRF (Optional['DRFModel']): Devolução de Recurso Financeiro
PSR (Optional['PSRModel']): Remanejamento de Recurso Financeiro
PCR (Optional['PCRModel']): Reprogramação de Recurso Financeiro
PAR (Optional['PARModel']): Ajuste de Recurso Financeiro
PRD (Optional['PRDModel']): Devolução de Ajuste de Recurso Financeiro
"""
cod_ug_emit: Optional[int | str] = None
observacao: Optional[str] = None
data_emissao: Optional[str] = None
PSL: Optional['PSLModel'] = None
PAP: Optional['PAPModel'] = None
PAD: Optional['PADModel'] = None
PLB: Optional['PLBModel'] = None
PCS: Optional['PCSModel'] = None
PCA: Optional['PCAModel'] = None
PCD: Optional['PCDModel'] = None
CLT: Optional['CLTModelOutput'] = None
TRF: Optional['TRFModelOutput'] = None
DRF: Optional['DRFModel'] = None
PSR: Optional['PSRModel'] = None
PCR: Optional['PCRModel'] = None
PAR: Optional['PARModel'] = None
PRD: Optional['PRDModel'] = None
[documentos]
class PFConsultarProgramacaoFinanceiraResponseModel(BaseModelSiafi):
"""Schema para PFConsultarProgramacaoFinanceiraResponseModel.
Attributes:
resultado (Optional[List['PFConsultarProgramacaoFinanceiraRespostaModel']]): Campo não documentado.
"""
resultado: Optional[List['PFConsultarProgramacaoFinanceiraRespostaModel']] = None
[documentos]
class PFConsultarProgramacaoFinanceiraRespostaModel(BaseModelSiafi):
"""Schema para PFConsultarProgramacaoFinanceiraRespostaModel.
Attributes:
programacao_financeira (Optional[List['PFDadosProgramacaoFinanceiraModel']]): Campo não documentado.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Campo não documentado.
"""
programacao_financeira: Optional[List['PFDadosProgramacaoFinanceiraModel']] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PFDTOModel(BaseModelSiafi):
"""Schema para PFDTOModel.
Attributes:
tipo_PF (Optional[str]): Código do Tipo de Programação Financeira (string, 3). Ex: 'TRF'
observacao (Optional[str]): Descrição (string, 1-234)
cod_ug_emit (Optional[int | str]): Código da unidade gestora emitente (int, 1-6)
cod_ug_favorecida (Optional[int | str]): Código da unidade gestora favorecida (int, 1-6)
limite_de_saque (Optional[bool]): Indicador de limite de saque (boolean)
lista_item_PFDTO (Optional[List['ItemPFDTOModel']]): Lista de itens de programação financeira
numero_documento (Optional[int | str]): Número do documento SIAFI (int, 1-6)
"""
tipo_PF: Optional[str] = None
observacao: Optional[str] = None
cod_ug_emit: Optional[int | str] = None
cod_ug_favorecida: Optional[int | str] = None
limite_de_saque: Optional[bool] = None
lista_item_PFDTO: Optional[List['ItemPFDTOModel']] = None
numero_documento: Optional[int | str] = None
[documentos]
class PFDadosItensProgramacaoFinanceiraModel(BaseModelSiafi):
"""Schema para PFDadosItensProgramacaoFinanceiraModel.
Attributes:
celula (Optional['CelulaFinanceiraModel']): Campo não documentado.
valor (Optional[float]): Campo não documentado.
saldo (Optional[float]): Campo não documentado.
"""
celula: Optional['CelulaFinanceiraModel'] = None
valor: Optional[float] = None
saldo: Optional[float] = None
[documentos]
class PFDadosItensRemanejamentoModel(BaseModelSiafi):
"""Schema para PFDadosItensRemanejamentoModel.
Attributes:
indr_limite_saque (Optional[str]): Campo não documentado.
numero_documento (Optional[str]): Campo não documentado.
celula_de (Optional['CelulaFinanceiraModel']): Campo não documentado.
celula_para (Optional['CelulaFinanceiraModel']): Campo não documentado.
valor (Optional[float]): Campo não documentado.
saldo (Optional[float]): Campo não documentado.
"""
indr_limite_saque: Optional[str] = None
numero_documento: Optional[str] = None
celula_de: Optional['CelulaFinanceiraModel'] = None
celula_para: Optional['CelulaFinanceiraModel'] = None
valor: Optional[float] = None
saldo: Optional[float] = None
[documentos]
class PFDadosProgramacaoFinanceiraModel(BaseModelSiafi):
"""Schema para PFDadosProgramacaoFinanceiraModel.
Attributes:
acao (Optional[str]): Campo não documentado.
cod_ug_emit (Optional[int | str]): Campo não documentado.
cod_ug_favorecida (Optional[int | str]): Campo não documentado.
mes_programacao (Optional[str]): Campo não documentado.
ano_programacao (Optional[int | str]): Campo não documentado.
dados_itens_prog_finan (Optional[List['PFDadosItensProgramacaoFinanceiraModel']]): Campo não documentado.
dados_itens_remanejamento (Optional[List['PFDadosItensRemanejamentoModel']]): Campo não documentado.
"""
acao: Optional[str] = None
cod_ug_emit: Optional[int | str] = None
cod_ug_favorecida: Optional[int | str] = None
mes_programacao: Optional[str] = None
ano_programacao: Optional[int | str] = None
dados_itens_prog_finan: Optional[List['PFDadosItensProgramacaoFinanceiraModel']] = None
dados_itens_remanejamento: Optional[List['PFDadosItensRemanejamentoModel']] = None
[documentos]
class PFDetalharProgramacaoFinanceiraResponseModel(BaseModelSiafi):
"""Schema para PFDetalharProgramacaoFinanceiraResponseModel.
Attributes:
programacao_financeira (Optional['PFConsultaModel']): Objeto contendo os dados de uma Programação Financeira.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Lista de mensagens/erros do sistema.
"""
programacao_financeira: Optional['PFConsultaModel'] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PFDevolucaoModel(BaseModelSiafi):
"""Schema para PFDevolucaoModel.
Attributes:
cod_ug_emit (Optional[int | str]): Campo não documentado.
observacao (Optional[str]): Campo não documentado.
DRF (Optional['DRFDevolucaoModel']): Campo não documentado.
"""
cod_ug_emit: Optional[int | str] = None
observacao: Optional[str] = None
DRF: Optional['DRFDevolucaoModel'] = None
[documentos]
class PFDevolverRecursoFinanceiroRequestModel(BaseModelSiafi):
"""Schema para PFDevolverRecursoFinanceiroRequestModel.
Attributes:
programacao_financeira (Optional['PFDevolucaoModel']): Campo não documentado.
"""
programacao_financeira: Optional['PFDevolucaoModel'] = None
[documentos]
class PFDevolverRecursoFinanceiroResponseModel(BaseModelSiafi):
"""Schema para PFDevolverRecursoFinanceiroResponseModel.
Attributes:
documento_gerado (Optional[List['DocumentoSiafiModel']]): Campo não documentado.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Campo não documentado.
"""
documento_gerado: Optional[List['DocumentoSiafiModel']] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PFRespostaDTOModel(BaseModelSiafi):
"""Schema para PFRespostaDTOModel.
Attributes:
ano (Optional[int | str]): Campo não documentado.
numero_documento (Optional[int | str]): Campo não documentado.
cod_ug_emit (Optional[int | str]): Campo não documentado.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Campo não documentado.
"""
ano: Optional[int | str] = None
numero_documento: Optional[int | str] = None
cod_ug_emit: Optional[int | str] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PFTransferenciaModel(BaseModelSiafi):
"""Schema para PFTransferenciaModel.
Attributes:
cod_ug_emit (Optional[int | str]): Campo não documentado.
observacao (Optional[str]): Campo não documentado.
TRF (Optional['TRFModelInput']): Campo não documentado.
"""
cod_ug_emit: Optional[int | str] = None
observacao: Optional[str] = None
TRF: Optional['TRFModelInput'] = None
[documentos]
class PFTransferirRecursoFinanceiroRequestModel(BaseModelSiafi):
"""Schema para PFTransferirRecursoFinanceiroRequestModel.
Attributes:
programacao_financeira (Optional['PFTransferenciaModel']): Campo não documentado.
"""
programacao_financeira: Optional['PFTransferenciaModel'] = None
[documentos]
class PFTransferirRecursoFinanceiroResponseModel(BaseModelSiafi):
"""Schema para PFTransferirRecursoFinanceiroResponseModel.
Attributes:
documento_gerado (Optional[List['DocumentoSiafiModel']]): Campo não documentado.
mensagem (Optional[List['schemas__pf__MensagemModel']]): Campo não documentado.
"""
documento_gerado: Optional[List['DocumentoSiafiModel']] = None
mensagem: Optional[List['schemas__pf__MensagemModel']] = None
[documentos]
class PLBModel(BaseModelSiafi):
"""Schema para PLBModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PLB (Optional[List['ItemPLBModel']]): Itens da Liberação de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PLB: Optional[List['ItemPLBModel']] = None
[documentos]
class PRDModel(BaseModelSiafi):
"""Schema para PRDModel.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[int | str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PRD (Optional[List['ItemPRDModel']]): Itens da Devolução de Ajuste de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[int | str] = None
numero_documento: Optional[str] = None
item_PRD: Optional[List['ItemPRDModel']] = None
[documentos]
class PSLModel(BaseModelSiafi):
"""Schema para PSLModel.
Attributes:
cod_ug_favorecida (Optional[int]): Código da UG Favorecida (int, 1-6)
ano (Optional[int]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PSL (Optional[List['ItemPSLModel']]): Itens da Solicitação de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int] = None
ano: Optional[int] = None
numero_documento: Optional[str] = None
item_PSL: Optional[List['ItemPSLModel']] = None
[documentos]
class PSRModel(BaseModelSiafi):
"""Schema para PSRModel.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[int | str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[str]): Número da Programação Financeira (string, 1-6)
item_PSR (Optional[List['ItemPSRModel']]): Itens do Remanejamento de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[int | str] = None
numero_documento: Optional[str] = None
item_PSR: Optional[List['ItemPSRModel']] = None
[documentos]
class ParamAlterarChavesPixModel(BaseModelSiafi):
"""Parâmetros para alteração de chaves PIX do credor.
Attributes:
credor (Optional[str]): CPF ou CNPJ do credor. Tamanho: 11-14.
chave_pix (Optional[List['ChavePixModelInput']]): Lista de chaves PIX (0-5).
"""
credor: Optional[str] = None
chave_pix: Optional[List['ChavePixModelInput']] = None
[documentos]
class ParamAlterarChavesPixResponseModel(BaseModelSiafi):
"""Schema para ParamAlterarChavesPixResponseModel.
Attributes:
mensagem (Optional[List['schemas__tabelas__MensagemModel']]): Campo não documentado.
"""
mensagem: Optional[List['schemas__tabelas__MensagemModel']] = None
[documentos]
class ParamConsultarChavesPixResponseModel(BaseModelSiafi):
"""Schema para ParamConsultarChavesPixResponseModel.
Attributes:
credor (Optional[str]): Campo não documentado.
chave_pix (Optional[List['ChavePixModelOutput']]): Campo não documentado.
mensagem (Optional[List['schemas__tabelas__MensagemModel']]): Campo não documentado.
"""
credor: Optional[str] = None
chave_pix: Optional[List['ChavePixModelOutput']] = None
mensagem: Optional[List['schemas__tabelas__MensagemModel']] = None
[documentos]
class ParamEstabLimPlurianuaisModel(BaseModelSiafi):
"""Parâmetros para estabelecimento de limites plurianuais.
Attributes:
tipo_requisicao (Optional[int]): Tipo da requisição, conforme parametrizado na transação >CONEVELIMI.
orgao_SOF (Optional[int]): Código do Órgão Orçamentário da SOF. Tamanho: 1-5.
item_mov_limite (Optional[List['ItemMovLimiteModel']]): Lista de movimentações de limites (1-12).
observacao (Optional[str]): Observação da requisição. Tamanho: 1-100.
"""
tipo_requisicao: Optional[int] = None
orgao_SOF: Optional[int] = None
item_mov_limite: Optional[List['ItemMovLimiteModel']] = None
observacao: Optional[str] = None
[documentos]
class ParamEstabLimPlurianuaisResponseModel(BaseModelSiafi):
"""Schema para ParamEstabLimPlurianuaisResponseModel.
Attributes:
num_NS_gerada (Optional[str]): Campo não documentado.
mensagem (Optional[List['schemas__tabelas__MensagemModel']]): Campo não documentado.
"""
num_NS_gerada: Optional[str] = None
mensagem: Optional[List['schemas__tabelas__MensagemModel']] = None
[documentos]
class ParamManterRIPModel(BaseModelSiafi):
"""Parâmetros para inclusão/alteração de RIP.
Attributes:
cod_RIP (Optional[str]): Código do Registro Imobiliário Patrimonial. Tamanho: 13. Aceita apenas números, zeros à esquerda são significativos.
titulo_RIP (Optional[str]): Título do RIP. Tamanho: 1-80.
cod_tipo_RIP (Optional[int]): Código da tipologia do RIP. 1=Dominiais, 2=Uso comum, 3=Uso especial.
txt_motivo (Optional[str]): Motivo da inclusão/alteração. Tamanho: 1-1024.
indr_ativo (Optional[bool]): Indicador ativo (True) ou inativo (False).
"""
cod_RIP: Optional[str] = None
titulo_RIP: Optional[str] = None
cod_tipo_RIP: Optional[int] = None
txt_motivo: Optional[str] = None
indr_ativo: Optional[bool] = None
[documentos]
class ParamManterRIPResponseModel(BaseModelSiafi):
"""Schema para ParamManterRIPResponseModel.
Attributes:
mensagem (Optional[List['schemas__tabelas__MensagemModel']]): Campo não documentado.
"""
mensagem: Optional[List['schemas__tabelas__MensagemModel']] = None
[documentos]
class ParametrosContabilizacaoModel(BaseModelSiafi):
"""Agrupa os parâmetros de contabilização (eventos) para uma situação do CPR.
Attributes:
parametro (Optional[List['EventoSituacaoModel']]): Lista de eventos de contabilização.
"""
parametro: Optional[List['EventoSituacaoModel']] = None
[documentos]
class ParcelaModel(BaseModelSiafi):
"""Representa uma parcela de um cronograma de baixa patrimonial.
Attributes:
dt_prevista (Optional[str]): Data prevista para a baixa da parcela.
num_parcela (Optional[int | str]): Número sequencial da parcela.
vlr (Optional[float]): Valor da parcela (15,2).
"""
dt_prevista: Optional[str] = None
num_parcela: Optional[int | str] = None
vlr: Optional[float] = None
[documentos]
class PassivoAnteriorModelOutput(BaseModelSiafi):
"""Dados de passivo anterior do empenho.
Parâmetros:
codContaContabil (str, opcional): Código da Conta Contábil. Informar apenas na inclusão de empenho.
passivoPermanente (List[PassivoPermanenteModel], opcional): Lista de passivos permanentes.
Attributes:
cod_conta_contabil (Optional[str]): Código da Conta Contábil. Informar apenas na inclusão de empenho.
passivo_permanente (Optional[List['PassivoPermanenteModelOutput']]): Lista de passivos permanentes.
"""
cod_conta_contabil: Optional[str] = None
passivo_permanente: Optional[List['PassivoPermanenteModelOutput']] = None
[documentos]
class PassivoPermanenteModelOutput(BaseModelSiafi):
"""Item de passivo permanente do empenho.
Parâmetros:
contaCorrente (str): Conta corrente contábil do passivo permanente. Obrigatório.
vlrRelacionado (Decimal): Valor relacionado ao passivo permanente. Obrigatório.
Attributes:
conta_corrente (Optional[str]): Conta corrente contábil do passivo permanente. Obrigatório.
vlr_relacionado (Optional[str]): Valor relacionado ao passivo permanente. Obrigatório.
"""
conta_corrente: Optional[str] = None
vlr_relacionado: Optional[str] = None
[documentos]
class PcoItemModel(BaseModelSiafi):
"""Representa um item de lançamento na aba 'Principal com Orçamento' (PCO) de um Documento Hábil.
Attributes:
cod_sub_item_empe (Optional[str]): Código do Subitem do empenho.
indr_liquidado (Optional[bool]): Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_class_C (Optional[int | str]): Informação de classificação do item da Situação.
num_empe (Optional[str]): Número do empenho.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor do item (15,2).
"""
cod_sub_item_empe: Optional[str] = None
indr_liquidado: Optional[bool] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_class_C: Optional[int | str] = None
num_empe: Optional[str] = None
num_seq_item: Optional[int | str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class PcoModelOutput(BaseModelSiafi):
"""Representa um lançamento na aba 'Principal com Orçamento' (PCO) de um Documento Hábil.
Attributes:
cod_sit (Optional[str]): Código da Situação do CPR.
cod_ug_empe (Optional[int | str]): Código da UG do empenho.
cron_baixa_patrimonial (Optional['CronBaixaPatrimonialModel']): Cronograma de baixa patrimonial.
indr_tem_contrato (Optional[bool]): Indica se tem contrato associado.
num_class_D (Optional[int | str]): Informação de classificação do item da Situação.
num_class_E (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
pco_item (Optional[List['PcoItemModel']]): Lista de itens de PCO.
txt_inscr_D (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_E (Optional[str]): Informação de inscrição do item da Situação.
"""
cod_sit: Optional[str] = None
cod_ug_empe: Optional[int | str] = None
cron_baixa_patrimonial: Optional['CronBaixaPatrimonialModel'] = None
indr_tem_contrato: Optional[bool] = None
num_class_D: Optional[int | str] = None
num_class_E: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
pco_item: Optional[List['PcoItemModel']] = None
txt_inscr_D: Optional[str] = None
txt_inscr_E: Optional[str] = None
[documentos]
class PredocDARFModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo DARF (Documento de Arrecadação de Receitas Federais).
Attributes:
cod_recurso (Optional[str]): Código do tipo de recurso para DARF/GPS.
cod_tipo_DARF (Optional[str]): Código do tipo de DARF (DFS, DFN, DFD). Se não informado, será 'DFS'.
dt_prdo_apuracao (Optional[str]): Data do período de apuração.
num_cod_barras (Optional[str]): Número do código de barras. Informar apenas se codTipoDARF for 'DFN'.
num_ref (Optional[str]): Número de referência.
txt_processo (Optional[str]): Número do processo.
vinculacao (Optional[str]): Código da vinculação. Informar apenas se codTipoDARF for 'DFND'.
vlr_percentual (Optional[str]): Valor percentual (2,2).
vlr_rcta_bruta_acum (Optional[str]): Valor da receita bruta acumulada (15,2).
"""
cod_recurso: Optional[str] = None
cod_tipo_DARF: Optional[str] = None
dt_prdo_apuracao: Optional[str] = None
num_cod_barras: Optional[str] = None
num_ref: Optional[str] = None
txt_processo: Optional[str] = None
vinculacao: Optional[str] = None
vlr_percentual: Optional[str] = None
vlr_rcta_bruta_acum: Optional[str] = None
[documentos]
class PredocDARModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo DAR (Documento de Arrecadação Estadual/Municipal).
Attributes:
ano_referencia (Optional[str]): Ano de referência.
cod_muni_nf (Optional[int | str]): Código do município da nota fiscal.
cod_recurso (Optional[str]): Código do tipo de recurso.
cod_ug_tmdr_serv (Optional[int | str]): Código da UG tomadora do serviço.
dt_emis_nf (Optional[str]): Data de emissão da nota fiscal.
mes_referencia (Optional[str]): Mês de referência.
num_aliq_nf (Optional[str]): Alíquota da nota fiscal (2,3).
num_nf (Optional[int | str]): Número da nota fiscal.
num_sub_serie_nf (Optional[int | str]): Subsérie da nota fiscal.
txt_serie_nf (Optional[str]): Série da nota fiscal.
vlr_nf (Optional[str]): Valor da nota fiscal (15,2).
"""
ano_referencia: Optional[str] = None
cod_muni_nf: Optional[int | str] = None
cod_recurso: Optional[str] = None
cod_ug_tmdr_serv: Optional[int | str] = None
dt_emis_nf: Optional[str] = None
mes_referencia: Optional[str] = None
num_aliq_nf: Optional[str] = None
num_nf: Optional[int | str] = None
num_sub_serie_nf: Optional[int | str] = None
txt_serie_nf: Optional[str] = None
vlr_nf: Optional[str] = None
[documentos]
class PredocGFIPModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo GFIP (Guia de Recolhimento do FGTS e Informações à Previdência Social).
Attributes:
cod_agencia (Optional[str]): Código da agência.
cod_entidades (Optional[str]): Código de outras entidades.
cod_fpas (Optional[str]): Código FPAS (Fundo de Previdência e Assistência Social).
cod_recurso (Optional[str]): Código do tipo de recurso.
indr_simples (Optional[bool]): Indicador de Simples Nacional.
num_cod_barras (Optional[str]): Número do código de barras.
num_id_recolhimento (Optional[str]): Identificação do Recolhimento.
num_ident_gfip (Optional[str]): Código de identificação da GFIP.
num_qtd_trabalhador (Optional[str]): Quantidade de trabalhadores.
vlr13_salr_inss (Optional[str]): Valor do 13º salário para INSS (15,2).
vlr_cont_seg_desc (Optional[str]): Valor da contribuição do segurado descontada (15,2).
vlr_cont_seg_dev (Optional[str]): Valor da contribuição do segurado devida (15,2).
vlr_dep_cont_social (Optional[str]): Valor do depósito da contribuição social (15,2).
vlr_encargos (Optional[str]): Valor dos encargos (15,2).
vlr_mens_inss (Optional[str]): Valor mensal para INSS (15,2).
vlr_prev_social (Optional[str]): Valor da previdência social (15,2).
vlr_rmes_cat (Optional[str]): Valor da remuneração mensal por categoria (15,2).
vlr_rmes_fgts (Optional[str]): Valor da remuneração mensal para FGTS (15,2).
"""
cod_agencia: Optional[str] = None
cod_entidades: Optional[str] = None
cod_fpas: Optional[str] = None
cod_recurso: Optional[str] = None
indr_simples: Optional[bool] = None
num_cod_barras: Optional[str] = None
num_id_recolhimento: Optional[str] = None
num_ident_gfip: Optional[str] = None
num_qtd_trabalhador: Optional[str] = None
vlr13_salr_inss: Optional[str] = None
vlr_cont_seg_desc: Optional[str] = None
vlr_cont_seg_dev: Optional[str] = None
vlr_dep_cont_social: Optional[str] = None
vlr_encargos: Optional[str] = None
vlr_mens_inss: Optional[str] = None
vlr_prev_social: Optional[str] = None
vlr_rmes_cat: Optional[str] = None
vlr_rmes_fgts: Optional[str] = None
[documentos]
class PredocGPSModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo GPS (Guia da Previdência Social).
Attributes:
ano_compet (Optional[str]): Ano de competência.
cod_recurso (Optional[str]): Código do tipo de recurso para DARF/GPS.
indr_adiant13 (Optional[bool]): Indica se é adiantamento de 13º.
mes_compet (Optional[str]): Mês de competência.
txt_processo (Optional[str]): Número do processo.
"""
ano_compet: Optional[str] = None
cod_recurso: Optional[str] = None
indr_adiant13: Optional[bool] = None
mes_compet: Optional[str] = None
txt_processo: Optional[str] = None
[documentos]
class PredocGRUModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo GRU (Guia de Recolhimento da União).
Attributes:
ano_compet (Optional[int | str]): Ano de competência.
cod_recolhedor (Optional[str]): Código do recolhedor (CPF, CNPJ, etc.).
cod_recolhimento (Optional[int | str]): Código de recolhimento da GRU.
cod_recurso (Optional[str]): Código do tipo de recurso.
cod_ug_favorecida (Optional[int | str]): Código da UG favorecida.
mes_compet (Optional[int | str]): Mês de competência.
num_cod_barras (Optional[str]): Número do código de barras.
num_referencia (Optional[int | str]): Número de referência.
txt_processo (Optional[str]): Número do processo.
vlr_desconto (Optional[str]): Valor do desconto (15,2).
vlr_documento (Optional[str]): Valor do documento (15,2).
vlr_outr_deduc (Optional[str]): Valor de outras deduções (15,2).
"""
ano_compet: Optional[int | str] = None
cod_recolhedor: Optional[str] = None
cod_recolhimento: Optional[int | str] = None
cod_recurso: Optional[str] = None
cod_ug_favorecida: Optional[int | str] = None
mes_compet: Optional[int | str] = None
num_cod_barras: Optional[str] = None
num_referencia: Optional[int | str] = None
txt_processo: Optional[str] = None
vlr_desconto: Optional[str] = None
vlr_documento: Optional[str] = None
vlr_outr_deduc: Optional[str] = None
[documentos]
class PredocModelOutput(BaseModelSiafi):
"""Agrupa os dados de um pré-documento. Apenas um dos tipos de pré-documento (predocOB, predocNS, etc.) pode ser preenchido.
Attributes:
predoc_DAR (Optional['PredocDARModel']): Dados de um pré-documento DAR.
predoc_DARF (Optional['PredocDARFModel']): Dados de um pré-documento DARF.
predoc_GFIP (Optional['PredocGFIPModel']): Dados de um pré-documento GFIP.
predoc_GPS (Optional['PredocGPSModel']): Dados de um pré-documento GPS.
predoc_GRU (Optional['PredocGRUModel']): Dados de um pré-documento GRU.
predoc_NS (Optional['PredocNSModel']): Dados de um pré-documento NS.
predoc_OB (Optional['PredocOBModel']): Dados de um pré-documento OB.
predoc_PF (Optional['PredocPFModel']): Dados de um pré-documento PF.
txt_obser (Optional[str]): Texto de observação.
"""
predoc_DAR: Optional['PredocDARModel'] = None
predoc_DARF: Optional['PredocDARFModel'] = None
predoc_GFIP: Optional['PredocGFIPModel'] = None
predoc_GPS: Optional['PredocGPSModel'] = None
predoc_GRU: Optional['PredocGRUModel'] = None
predoc_NS: Optional['PredocNSModel'] = None
predoc_OB: Optional['PredocOBModel'] = None
predoc_PF: Optional['PredocPFModel'] = None
txt_obser: Optional[str] = None
[documentos]
class PredocNSModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo NS (Nota de Sistema).
Attributes:
cod_credor_devedor (Optional[str]): Código do credor/devedor (CPF, CNPJ, etc.).
cod_insc_gen (Optional[str]): Código de Inscrição Genérica.
cod_tipo_banco (Optional[str]): Tipo de banco: 'O' - Oficial, 'L' - Local.
num_domi_banc_pgto (Optional['DomBancarioUGPagadoraModel']): Domicílio bancário da UG pagadora.
"""
cod_credor_devedor: Optional[str] = None
cod_insc_gen: Optional[str] = None
cod_tipo_banco: Optional[str] = None
num_domi_banc_pgto: Optional['DomBancarioUGPagadoraModel'] = None
[documentos]
class PredocOBModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo OB (Ordem Bancária).
Attributes:
cod_cont_repas (Optional[int | str]): Código do Contrato de Repasse.
cod_credor_devedor (Optional[str]): Código do credor/devedor (CPF, CNPJ, etc.).
cod_devolucao_SPB (Optional[int | str]): Código de devolução do evento BACEN.
cod_evnt_bacen (Optional[str]): Código do evento no Bacen.
cod_finalidade (Optional[int | str]): Código da finalidade.
cod_num_lista (Optional[str]): Código da entidade Numero Lista do SIAFI.
cod_rec_darf (Optional[int | str]): Código de recolhimento DARF (apenas para OB de restituição).
cod_reco_gru (Optional[int | str]): Código de recolhimento GRU (apenas para OB de restituição).
cod_tipo_OB (Optional[str]): Código do tipo de OB (OBC, OBP, OBPIX, etc.).
cod_ug_ra_gru (Optional[int | str]): Código da UG do RA da GRU (apenas para OB de restituição).
num_domi_banc_favo (Optional['DomBancarioFavorecidoModel']): Domicílio bancário do favorecido.
num_domi_banc_pgto (Optional['DomBancarioUGPagadoraModel']): Domicílio bancário da UG pagadora.
num_ra_gru (Optional[str]): Número do RA da GRU (apenas para OB de restituição).
num_ref_darf (Optional[int | str]): Número de referência do DARF (apenas para OB de restituição).
txt_chave_pix (Optional[str]): Chave PIX. Apenas para codTipoOB 'OBPIX'. Mutuamente exclusivo com numDomiBancFavo.
txt_cit (Optional[str]): Código identificador de transferência (CIT).
txt_ctrl_original (Optional[str]): Texto de controle original.
txt_processo (Optional[str]): Número do processo.
vlr_taxa_cambio (Optional[str]): Valor da taxa de câmbio (15,2).
"""
cod_cont_repas: Optional[int | str] = None
cod_credor_devedor: Optional[str] = None
cod_devolucao_SPB: Optional[int | str] = None
cod_evnt_bacen: Optional[str] = None
cod_finalidade: Optional[int | str] = None
cod_num_lista: Optional[str] = None
cod_rec_darf: Optional[int | str] = None
cod_reco_gru: Optional[int | str] = None
cod_tipo_OB: Optional[str] = None
cod_ug_ra_gru: Optional[int | str] = None
num_domi_banc_favo: Optional['DomBancarioFavorecidoModel'] = None
num_domi_banc_pgto: Optional['DomBancarioUGPagadoraModel'] = None
num_ra_gru: Optional[str] = None
num_ref_darf: Optional[int | str] = None
txt_chave_pix: Optional[str] = None
txt_cit: Optional[str] = None
txt_ctrl_original: Optional[str] = None
txt_processo: Optional[str] = None
vlr_taxa_cambio: Optional[str] = None
[documentos]
class PredocPFModel(BaseModelSiafi):
"""Representa os dados de um pré-documento do tipo PF (Programação Financeira).
Attributes:
cod_UG_favorecida (Optional[int | str]): Código da UG favorecida.
num_class_A (Optional[int | str]): Informação de classificação.
num_class_B (Optional[int | str]): Informação de classificação.
txt_inscr_A (Optional[str]): Informação de inscrição.
txt_inscr_B (Optional[str]): Informação de inscrição.
txt_inscr_C (Optional[str]): Informação de inscrição.
txt_inscr_D (Optional[str]): Informação de inscrição.
vinculacao_pgto (Optional[int | str]): Código da vinculação de pagamento.
"""
cod_UG_favorecida: Optional[int | str] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
vinculacao_pgto: Optional[int | str] = None
[documentos]
class PsoItemModel(BaseModelSiafi):
"""Representa um item de lançamento na aba 'Principal sem Orçamento' (PSO) de um Documento Hábil.
Attributes:
cod_ctgo_gasto (Optional[str]): Código da Categoria de Gasto.
cod_font_recur (Optional[int | str]): Código da Fonte de Recurso.
indr_liquidado (Optional[bool]): Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.
num_class_A (Optional[int | str]): Informação de classificação do item da Situação.
num_class_B (Optional[int | str]): Informação de classificação do item da Situação.
num_class_C (Optional[int | str]): Informação de classificação do item da Situação.
num_class_D (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
txt_inscr_A (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_B (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_C (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_D (Optional[str]): Informação de inscrição do item da Situação.
vlr (Optional[float]): Valor do item (15,2).
"""
cod_ctgo_gasto: Optional[str] = None
cod_font_recur: Optional[int | str] = None
indr_liquidado: Optional[bool] = None
num_class_A: Optional[int | str] = None
num_class_B: Optional[int | str] = None
num_class_C: Optional[int | str] = None
num_class_D: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
txt_inscr_A: Optional[str] = None
txt_inscr_B: Optional[str] = None
txt_inscr_C: Optional[str] = None
txt_inscr_D: Optional[str] = None
vlr: Optional[float] = None
[documentos]
class PsoModel(BaseModelSiafi):
"""Representa um lançamento na aba 'Principal sem Orçamento' (PSO) de um Documento Hábil.
Attributes:
cod_sit (Optional[str]): Código da Situação do CPR.
num_class_E (Optional[int | str]): Informação de classificação do item da Situação.
num_class_F (Optional[int | str]): Informação de classificação do item da Situação.
num_seq_item (Optional[int | str]): Número sequencial único para o grupo de elementos.
pso_item (Optional[List['PsoItemModel']]): Lista de itens de PSO.
txt_inscr_E (Optional[str]): Informação de inscrição do item da Situação.
txt_inscr_F (Optional[str]): Informação de inscrição do item da Situação.
"""
cod_sit: Optional[str] = None
num_class_E: Optional[int | str] = None
num_class_F: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
pso_item: Optional[List['PsoItemModel']] = None
txt_inscr_E: Optional[str] = None
txt_inscr_F: Optional[str] = None
[documentos]
class RegistroAlteracaoModel(BaseModelSiafi):
"""Registro de alteração de empenho ou pré-empenho.
Parâmetros:
dtEmis (str): [1..1] Data de emissão do registro de alteração. Formato: AAAA-MM-DD.
txtMotivo (str): [1..1] Motivo da alteração (Observacao). Informação irá para o histórico e, caso gere contabilização, comporá o documento RO.
indrIndispCaixa (bool, opcional): [0..1] Indica se houve indisponibilidade de caixa. Esta tag somente se aplica quando o RegistroAlteracao é enviado numa requisição do Alterar Empenho. Caso não seja informada, será preenchido como Falso.
Attributes:
dt_emis (Optional[str]): Data de emissão do registro de alteração. [1..1] Formato: AAAA-MM-DD.
txt_motivo (Optional[str]): Motivo da alteração. [1..1] Informação irá para o histórico e, caso gere contabilização, comporá o documento RO.
indr_indisp_caixa (Optional[bool]): Indica se houve indisponibilidade de caixa. [0..1] Esta tag somente se aplica quando o RegistroAlteracao é enviado numa requisição do Alterar Empenho. Caso não seja informada, será preenchido como Falso.
"""
dt_emis: Optional[str] = None
txt_motivo: Optional[str] = None
indr_indisp_caixa: Optional[bool] = None
[documentos]
class RegistroAlteracaoPreEmpenhoModel(BaseModelSiafi):
"""Registro de alteração do pré-empenho (detalhamento).
Attributes:
dt_emis (Optional[str]): Data de emissão do registro de alteração.
txt_motivo (Optional[str]): Motivo da alteração.
"""
dt_emis: Optional[str] = None
txt_motivo: Optional[str] = None
[documentos]
class ReincluirAmparoLegalRequestModel(BaseModelSiafi):
"""Parâmetros para reinclusão de Amparo Legal.
Parâmetro Tipo Ocorrência Restrição Observação
codAmparoLegal int [1..1] AmparoLegal Informar o código do Amparo Legal no qual deseja efetuar a operação.
orcAmparoLegalDados OrcAmparoLegalDadosModel [1..1] - O SIAFIWeb substituirá os dados do Amparo Legal pelos que estão sendo enviados na operação. Todos os parâmetros que possuírem dados devem ser enviados, mesmo que somente alguns deles tenham sido alterados. No caso de parâmetro opcional, caso não seja enviado ou enviado com conteúdo vazio, o SIAFIWeb entenderá que o respectivo campo no Amparo Legal deve ficar vazio após executar a operação.
motivo string [1..1] Motivo Motivo da reinclusão.
Attributes:
cod_amparo_legal (Optional[int]): Código do Amparo Legal a ser reincluído.
orc_amparo_legal_dados (Optional['OrcAmparoLegalDadosModel']): Dados do Amparo Legal para reinclusão.
motivo (Optional[str]): Motivo da reinclusão.
"""
cod_amparo_legal: Optional[int] = None
orc_amparo_legal_dados: Optional['OrcAmparoLegalDadosModel'] = None
motivo: Optional[str] = None
[documentos]
class RelComItemModel(BaseModelSiafi):
"""Representa uma relação com um item filho e um item pai.
Attributes:
cod_nat_desp_det (Optional[int | str]): Natureza de Despesa Detalhada.
num_seq_item (Optional[int | str]): Número sequencial do item filho.
num_seq_pai (Optional[int | str]): Número sequencial do item pai.
"""
cod_nat_desp_det: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
num_seq_pai: Optional[int | str] = None
[documentos]
class RelComItemValorModel(BaseModelSiafi):
"""Representa uma relação com valor, associando um item filho a um item pai.
Attributes:
cod_nat_desp_det (Optional[int | str]): Natureza de Despesa Detalhada. Informar se a situação associada requerer.
num_seq_item (Optional[int | str]): Número sequencial do item filho.
num_seq_pai (Optional[int | str]): Número sequencial do item pai.
vlr (Optional[float]): Valor da relação (15,2).
"""
cod_nat_desp_det: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
num_seq_pai: Optional[int | str] = None
vlr: Optional[float] = None
[documentos]
class RelSemItemModel(BaseModelSiafi):
"""Representa uma relação com um item.
Attributes:
cod_nat_desp_det (Optional[int | str]): Natureza de Despesa Detalhada.
num_seq_item (Optional[int | str]): Número sequencial do item.
"""
cod_nat_desp_det: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
[documentos]
class RelSemItemValorModel(BaseModelSiafi):
"""Representa uma relação com valor, associando a um item.
Attributes:
cod_nat_desp_det (Optional[int | str]): Natureza de Despesa Detalhada. Informar se a situação associada requerer.
num_seq_item (Optional[int | str]): Número sequencial do item.
vlr (Optional[float]): Valor da relação (15,2).
"""
cod_nat_desp_det: Optional[int | str] = None
num_seq_item: Optional[int | str] = None
vlr: Optional[float] = None
[documentos]
class RelValorModel(BaseModelSiafi):
"""Representa um valor para uma relação.
Attributes:
vlr (Optional[float]): Valor (15,2).
"""
vlr: Optional[float] = None
[documentos]
class RestricaoAmparoLegalModel(BaseModelSiafi):
"""Restrição de uso do Amparo Legal.
Attributes:
tipo_restricao (Optional[str]): Tipo de restrição do Amparo Legal. Ex: TIPO_ADMINISTRACAO_EMITENTE, ORGAO_UG_EMITENTE, ORGAO_UG_FAVORECIDA, AGENCIA_EXECUTIVA, NATUREZA_DESPESA.
regra (Optional[str]): Regra da restrição. Ex: SOMENTE, EXCETO.
valor (Optional[List[str]]): Valores permitidos ou não permitidos para o Amparo Legal. Or
"""
tipo_restricao: Optional[str] = None
regra: Optional[str] = None
valor: Optional[List[str]] = None
[documentos]
class ResumoProcessamentoModel(BaseModelSiafi):
"""Representa o resumo do processamento de uma operação de compromisso.
Attributes:
documento_OP (Optional[List['DocumentoOrdemPagamentoModel']]): Lista de Ordens de Pagamento geradas (apenas na realização de compromisso OB).
documento_SIAFI (Optional[List['DocumentoSIAFIRealizacaoModel']]): Lista de Documentos SIAFI gerados (ex: NS, NL).
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Mensagem descrevendo o resultado do processamento.
tipo_processamento (Optional[str]): Tipo do resultado do processamento (BAIXADO, REALIZADO, ERRO, etc.).
valor_processamento (Optional[str]): Valor processado pela execução da operação (15,2).
"""
documento_OP: Optional[List['DocumentoOrdemPagamentoModel']] = None
documento_SIAFI: Optional[List['DocumentoSIAFIRealizacaoModel']] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
tipo_processamento: Optional[str] = None
valor_processamento: Optional[str] = None
[documentos]
class SaldoContabilInfoModel(BaseModelSiafi):
"""Schema para SaldoContabilInfoModel.
Attributes:
cod_UG (Optional[int | str]): Campo não documentado.
conta_contabil (Optional[str]): Campo não documentado.
conta_corrente (Optional[str]): Campo não documentado.
vlr_saldo (Optional[str]): Campo não documentado.
tipo_saldo (Optional[str]): Campo não documentado.
mensagem (Optional[List['schemas__tabelas__MensagemModel']]): Campo não documentado.
"""
cod_UG: Optional[int | str] = None
conta_contabil: Optional[str] = None
conta_corrente: Optional[str] = None
vlr_saldo: Optional[str] = None
tipo_saldo: Optional[str] = None
mensagem: Optional[List['schemas__tabelas__MensagemModel']] = None
[documentos]
class SituacaoCPRModel(BaseModelSiafi):
"""Representa o detalhamento completo de uma Situação do CPR, incluindo configurações e indicadores.
Attributes:
configuracao_campos (Optional['ConfiguracaoCamposModel']): Configuração de campos de classificação e inscrição.
dados_basicos (Optional['DadosBasicosSituacaoModel']): Dados básicos da situação.
indicadores (Optional['IndicadoresModel']): Indicadores de comportamento da situação.
mensagem (Optional[List['schemas__cpr__MensagemModel']]): Lista de mensagens de retorno.
parametros_contabilizacao (Optional['ParametrosContabilizacaoModel']): Parâmetros de contabilização (eventos).
"""
configuracao_campos: Optional['ConfiguracaoCamposModel'] = None
dados_basicos: Optional['DadosBasicosSituacaoModel'] = None
indicadores: Optional['IndicadoresModel'] = None
mensagem: Optional[List['schemas__cpr__MensagemModel']] = None
parametros_contabilizacao: Optional['ParametrosContabilizacaoModel'] = None
[documentos]
class SituacaoModel(BaseModelSiafi):
"""Representa uma Situação do CPR de forma resumida.
Attributes:
cod_sit (Optional[str]): Código da Situação.
titulo_sit (Optional[str]): Título/descrição da Situação.
"""
cod_sit: Optional[str] = None
titulo_sit: Optional[str] = None
[documentos]
class TRFModelOutput(BaseModelSiafi):
"""Schema para TRFModel-Output.
Attributes:
cod_ug_favorecida (Optional[int | str]): Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)
ano (Optional[str]): Ano da Programação Financeira (int, 4)
numero_documento (Optional[int | str]): Número da Programação Financeira (string/int, 1-6)
item_TRF (Optional[List['ItemTRFModelOutput']]): Itens da Transferência de Recurso Financeiro
"""
cod_ug_favorecida: Optional[int | str] = None
ano: Optional[str] = None
numero_documento: Optional[int | str] = None
item_TRF: Optional[List['ItemTRFModelOutput']] = None
[documentos]
class TabAlterarChavesPixRequestModel(BaseModelSiafi):
"""Request para alteração de chaves PIX.
Attributes:
param_alterar_chaves_pix (Optional['ParamAlterarChavesPixModel']): Parâmetros obrigatórios para alteração das chaves PIX.
"""
param_alterar_chaves_pix: Optional['ParamAlterarChavesPixModel'] = None
[documentos]
class TabAlterarRIPRequestModel(BaseModelSiafi):
"""Request para alteração de RIP.
Attributes:
param_manter_RIP (Optional['ParamManterRIPModel']): Parâmetros obrigatórios para alteração do RIP.
"""
param_manter_RIP: Optional['ParamManterRIPModel'] = None
[documentos]
class TabEstabLimPlurianuaisRequestModel(BaseModelSiafi):
"""Request para estabelecimento de limites plurianuais.
Attributes:
param_estab_lim_plurianuais (Optional['ParamEstabLimPlurianuaisModel']): Parâmetros obrigatórios para o estabelecimento.
"""
param_estab_lim_plurianuais: Optional['ParamEstabLimPlurianuaisModel'] = None
[documentos]
class TabIncluirRIPRequestModel(BaseModelSiafi):
"""Request para inclusão de RIP.
Attributes:
param_manter_RIP (Optional['ParamManterRIPModel']): Parâmetros obrigatórios para inclusão do RIP.
"""
param_manter_RIP: Optional['ParamManterRIPModel'] = None
[documentos]
class TramiteModel(BaseModelSiafi):
"""Representa o trâmite de um documento, com local e datas de entrada/saída.
Attributes:
dt_entrada (Optional[str]): Data de entrada no local.
dt_saida (Optional[str]): Data de saída do local.
txt_local (Optional[str]): Descrição do local do trâmite.
"""
dt_entrada: Optional[str] = None
dt_saida: Optional[str] = None
txt_local: Optional[str] = None
[documentos]
class TransferenciaModel(BaseModelSiafi):
"""Transferência entre empenhos.
Parâmetros:
dtOperacao (str): Data da operação de transferência. Formato: AAAA-MM-DD. Obrigatório.
operacao (str): Tipo de operação de transferência. Obrigatório.
origem (str): Identificação da origem da transferência. Obrigatório. Formato: <ug>/<aaaaNEnnnnnn>
destino (str): Identificação do destino da transferência. Obrigatório. Formato: <ug>/<aaaaNEnnnnnn>
Attributes:
dt_operacao (Optional[str]): Data da operação de transferência. Formato: AAAA-MM-DD.
operacao (Optional[str]): Tipo de operação de transferência.
origem (Optional[str]): Identificação da origem da transferência. Formato: <ug>/<aaaaNEnnnnnn>.
destino (Optional[str]): Identificação do destino da transferência. Formato: <ug>/<aaaaNEnnnnnn>.
"""
dt_operacao: Optional[str] = None
operacao: Optional[str] = None
origem: Optional[str] = None
destino: Optional[str] = None
[documentos]
class UGInfoModel(BaseModelSiafi):
"""Informações da Unidade Gestora (UG).
Parâmetro Tipo Ocorrência Restrição Observação
------------------------ ----------- ---------- ------------- ---------------------------------------------
cpfOrdenadorDespesas string [0..1] CPF CPF do ordenador de despesas da UG.
cpfOrdenadorSub string [0..1] CPF CPF do ordenador de despesas substituto da UG.
cpfGestorFinanceiro string [0..1] CPF CPF do gestor financeiro da UG.
cpfGestorSub string [0..1] CPF CPF do gestor financeiro substituto da UG.
codigo string [0..1] UG Código da UG.
titulo string [0..1] - Título da UG.
cnpj string [0..1] CNPJ CNPJ da UG.
txtIndrUGAtiva string [0..1] - -
codigoOrgao string [0..1] Orgao Código do Órgão da UG.
tituloOrgao string [0..1] - Título do Órgão da UG.
txtEsferaAdm string [0..1] - -
txtFuncao string [0..1] - -
codSIORG int [0..1] SIORG Código SIORG da UG.
txtPais string [0..1] - -
siglaUF string [0..1] SiglaUF -
txtMunicpio string [0..1] - -
txtEndereco string [0..1] - -
cep string [0..1] CEP -
txtTelefone string [0..1] - -
txtEmail string [0..1] - -
codMoeda int [0..1] CodigoMoeda -
txtMoeda string [0..1] - -
tipoAtoCriacao string [0..1] - -
numAtoCriacao string [0..1] - -
mensagem Mensagem [0..n] Mensagem Mensagens retornadas pelo sistema.
Attributes:
cpf_ordenador_despesas (Optional[str]): CPF do ordenador de despesas da UG.
cpf_ordenador_sub (Optional[str]): CPF do ordenador de despesas substituto da UG.
cpf_gestor_financeiro (Optional[str]): CPF do gestor financeiro da UG.
cpf_gestor_sub (Optional[str]): CPF do gestor financeiro substituto da UG.
codigo (Optional[str]): Código da UG.
titulo (Optional[str]): Título da UG.
cnpj (Optional[str]): CNPJ da UG.
txt_indr_UG_ativa (Optional[str]): Indicador se a UG está ativa.
codigo_orgao (Optional[str]): Código do Órgão da UG.
titulo_orgao (Optional[str]): Título do Órgão da UG.
txt_esfera_adm (Optional[str]): Esfera administrativa da UG.
txt_funcao (Optional[str]): Função da UG.
cod_SIORG (Optional[int]): Código SIORG da UG.
txt_pais (Optional[str]): País da UG.
sigla_UF (Optional[str]): Sigla da UF da UG.
txt_municpio (Optional[str]): Município da UG.
txt_endereco (Optional[str]): Endereço da UG.
cep (Optional[str]): CEP da UG.
txt_telefone (Optional[str]): Telefone da UG.
txt_email (Optional[str]): E-mail da UG.
cod_moeda (Optional[int]): Código da moeda.
txt_moeda (Optional[str]): Nome da moeda.
tipo_ato_criacao (Optional[str]): Tipo do ato de criação da UG.
num_ato_criacao (Optional[str]): Número do ato de criação da UG.
mensagem (Optional[List['schemas__tabelas__MensagemModel']]): Mensagens retornadas pelo sistema.
"""
cpf_ordenador_despesas: Optional[str] = None
cpf_ordenador_sub: Optional[str] = None
cpf_gestor_financeiro: Optional[str] = None
cpf_gestor_sub: Optional[str] = None
codigo: Optional[str] = None
titulo: Optional[str] = None
cnpj: Optional[str] = None
txt_indr_UG_ativa: Optional[str] = None
codigo_orgao: Optional[str] = None
titulo_orgao: Optional[str] = None
txt_esfera_adm: Optional[str] = None
txt_funcao: Optional[str] = None
cod_SIORG: Optional[int] = None
txt_pais: Optional[str] = None
sigla_UF: Optional[str] = None
txt_municpio: Optional[str] = None
txt_endereco: Optional[str] = None
cep: Optional[str] = None
txt_telefone: Optional[str] = None
txt_email: Optional[str] = None
cod_moeda: Optional[int] = None
txt_moeda: Optional[str] = None
tipo_ato_criacao: Optional[str] = None
num_ato_criacao: Optional[str] = None
mensagem: Optional[List['schemas__tabelas__MensagemModel']] = None
[documentos]
class ValidationError(BaseModelSiafi):
"""Schema para ValidationError.
Attributes:
loc (Optional[List[int | str]]): Campo não documentado.
msg (Optional[str]): Campo não documentado.
type (Optional[str]): Campo não documentado.
"""
loc: Optional[List[int | str]] = None
msg: Optional[str] = None
type: Optional[str] = None
[documentos]
class VinculacaoModel(BaseModelSiafi):
"""Representa uma vinculação de pagamento.
Attributes:
codigo_vinculacao (Optional[int | str]): Código da vinculação.
valor (Optional[float]): Valor da vinculação (15,2).
"""
codigo_vinculacao: Optional[int | str] = None
valor: Optional[float] = None
[documentos]
class schemas__cpr__MensagemModel(BaseModelSiafi):
"""Modelo para mensagens de retorno das operações, indicando sucesso, avisos ou erros.
Attributes:
cod_msg (Optional[str]): Código da mensagem. Pode não ser apresentado em algumas situações.
txt_msg (Optional[str]): Texto descritivo da mensagem.
"""
cod_msg: Optional[str] = None
txt_msg: Optional[str] = None
[documentos]
class schemas__orcamentario__MensagemModel(BaseModelSiafi):
"""Mensagem de retorno do SIAFI.
Attributes:
cod_msg (Optional[str]): Código da mensagem. Parâmetro: codMsg, Tipo: string, Ocorrência: [0..1]. Pode não ser apresentado em algumas situações.
txt_msg (Optional[str]): Texto da mensagem. Parâmetro: txtMsg, Tipo: Memorando, Ocorrência: [1..1].
"""
cod_msg: Optional[str] = None
txt_msg: Optional[str] = None
[documentos]
class schemas__pf__MensagemModel(BaseModelSiafi):
"""Schema para schemas__pf__MensagemModel.
Attributes:
cod_msg (Optional[str]): Código da mensagem, pode não estar presente.
txt_msg (Optional[str]): Texto da mensagem.
"""
cod_msg: Optional[str] = None
txt_msg: Optional[str] = None
[documentos]
class schemas__tabelas__MensagemModel(BaseModelSiafi):
"""Schema para schemas__tabelas__MensagemModel.
Attributes:
cod_msg (Optional[str]): Código da mensagem.
txt_msg (Optional[str]): Texto da mensagem.
"""
cod_msg: Optional[str] = None
txt_msg: Optional[str] = None