Módulo SIAFI

Integra o ARIA aos endpoints SIAFI definidos em pyarialib/siafi-global.json (OpenAPI). Fornece:

Um cliente de alto nível Siafi com métodos tipados (ex.: consultar_ug, consultar_chaves_pix, alterar_chaves_pix, etc.).
Centenas de modelos Pydantic em models.py para montar payloads e validar respostas.
Conversão automática entre snake_case (Python) e camelCase (API) ao enviar/receber dados.

Sumário

Visão Geral
Instalação & Pré‑requisitos
Autenticação / Configuração
Inicializando o Cliente Siafi
Exemplos de Uso (GET / POST / PUT)
Uso de Modelos Pydantic
OTP (fluxos manual e interativo)
Tratamento de Erros
Como estender (novos métodos)
Boas Práticas
Roadmap / Próximos Passos
Referências

1. Visão Geral

O cliente Siafi encapsula regras comuns:

Montagem de query params obrigatórios (ug, env).
Inclusão automática de OTP para métodos não-GET (padrão Otp(type="webauthn2steps", mode="interactive-window")).
Normalização de chaves: modelos Pydantic usam snake_case; na requisição saem em camelCase; respostas retornam em snake_case.
Instanciação opcional de modelos de resposta tipados.

2. Instalação & Pré‑requisitos

Requer Python 3.8+.

pip install pyarialib

Variáveis de ambiente (exemplos):

Variável	Descrição
`ARIA_USERNAME`	Login usado para obter o token JWT
`ARIA_PASSWORD`	Senha
`ARIA_BASE_URL`	Base (default `https://apiapex.tesouro.gov.br/aria/`)
`SIAFI_AMBIENTE`	Ambiente SIAFI (ex.: `siafi2025`, `hom`)
`SIAFI_GESTAO`	UG/gestão padrão (quando aplicável)

Carregue via python-dotenv se necessário.

3. Autenticação / Configuração

from pyarialib import Aria

aria = Aria("usuario", "senha")  # obtém e gerencia o token automaticamente

O token é revalidado sob demanda caso expire. Você também pode fornecer um token já emitido: Aria(token="seu_jwt").

4. Inicializando o Cliente `Siafi`

from pyarialib import Aria, Siafi

aria = Aria("usuario", "senha")
client = Siafi(aria, ug="160001", env="siafi2025")

# Pode alterar depois:
client.set_ug("160002")
client.set_env("hom")

4.1 Usando `Aria.get_siafi`

Além de instanciar diretamente Siafi(aria, ...), a classe Aria expõe o atalho get_siafi(env, ug, projeto_aria) que já injeta a instância de transporte e retorna um cliente configurado. Use quando quiser um bootstrap mais declarativo em uma única linha.

Assinatura (conforme código):

def get_siafi(self, env, ug, projeto_aria) -> Siafi:
    return Siafi(self, env=env, ug=ug, projeto_aria=projeto_aria)

Parâmetros:

Parâmetro	Obrigatório	Descrição	Exemplo
`env`	Sim	Identificador do ambiente SIAFI (ex.: `siafi2025he`, `hom`, `prod`).	`"siafi2025he"`
`ug`	Sim	Código da UG padrão para as operações (enviado como query param).	`170860`
`projeto_aria`	Sim	Nome do projeto usado no path do ARIA (padrão comum: `siafi-global-hom`).	`"siafi-global-hom"`

Exemplo prático (equivalente ao notebook de fluxos):

from pyarialib import Aria

aria = Aria("usuario", "senha")
siafi = aria.get_siafi(env="siafi2025he", ug=170860, projeto_aria="siafi-global-hom")

# Agora pode chamar métodos diretamente
info_ug = siafi.consultar_ug(170860)
print(info_ug)

Qual escolher?

Siafi(aria, ug=..., env=...): mais flexível se quiser alterar projeto_aria depois (pode passar argumento opcional manualmente numa versão futura).
aria.get_siafi(...): inicialização concisa e explícita dos três parâmetros de uma vez.

Se você possui múltiplos ambientes simultâneos (ex.: produção e homolog), pode manter duas instâncias retornadas por get_siafi em variáveis distintas.

É possível trocar a ug ou o env após a instanciação do siafi com os métodos set_ug e set_env.

Se ug ou env não forem definidos antes de uma chamada, será lançado ValueError.

5. Exemplos de Uso

5.1 Consulta simples (GET)

from pyarialib import Aria, Siafi

client = Siafi(Aria("usuario", "senha"), ug="160001", env="siafi2025")
ug_info = client.consultar_ug(codigo_ug="160001")
print(ug_info)

5.2 Consultar chaves PIX

pix = client.consultar_chaves_pix(credor="12345678901")
print(pix)

5.3 Alterar chaves PIX (PUT, com OTP implícito)

from pyarialib.siafi import TabAlterarChavesPixRequestModel, ChavePixModelInput
from pyarialib import Otp

payload = TabAlterarChavesPixRequestModel(
    credor="12345678901",
    chaves_pix=[
        ChavePixModelInput(tipo_chave="CPF", chave="12345678901")
    ]
)

# Se quiser controlar o fluxo OTP manualmente:
otp = Otp(type="webauthn2steps", mode="interactive-console")
resp = client.alterar_chaves_pix(payload=payload, otp=otp)
print(resp)

5.4 Incluir RIP (POST)

from pyarialib.siafi import TabIncluirRIPRequestModel

novo_rip = TabIncluirRIPRequestModel(
    # preencha os campos necessários conforme a especificação
)
resultado = client.incluir_rip(payload=novo_rip)  # OTP padrão (interactive-window) será usado
print(resultado)

5.5 Consultar saldo contábil

saldo = client.consultar_saldo_contabil(
    cod_UG="160001",
    conta_contabil="123456789",
    mes_ref_saldo="JAN"
)
print(saldo)

5.6 Fluxo Pré-Empenho: inclusão

Este exemplo mostra a criação de um Pré-Empenho: definimos identificadores (UG, ano, número), informações orçamentárias mínimas e favorecido. O objetivo é reservar dotação antes da emissão do Empenho definitivo. Comentários destacam cada campo crítico e onde ajustar para seu caso. Sempre use ambiente de homologação para validar o fluxo.

from pyarialib import Aria, Siafi, Otp
from pyarialib.siafi import IncluirPreEmpenhoRequestModel, CelulaOrcamentariaModel

# Instancia cliente principal (token gerenciado internamente) e cliente SIAFI
client = Siafi(Aria("usuario", "senha"), ug="170860", env="siafi2025he")

# Monta o modelo tipado do pré-empenho
pre_empenho = IncluirPreEmpenhoRequestModel(
    ug_emitente=170860,              # UG que emitirá o pré-empenho
    ano_pre_empenho=2025,            # Ano de referência
    num_pre_empenho=400005,          # Número sequencial (garanta unicidade no ambiente)
    dt_emis="2025-01-10",           # Data de emissão ISO (AAAA-MM-DD)
    vlr_pre_empenho=2.00,            # Valor total a reservar
    txt_descricao="Aquisição de materiais de consumo.",
    vlr_taxa_cambio=11.99,           # Se aplicável; caso não haja câmbio, pode omitir
    cod_favorecido="00000000000191", # CNPJ/CPF do favorecido
    celula_orcamentaria=CelulaOrcamentariaModel(
        esfera="1",                 # Esfera orçamentária
        cod_fonte_rec="1000000000",  # Fonte de recurso
        cod_nat_desp=334041,          # Natureza de despesa
        cod_PTRES="140846"           # PTRES (Programa de Trabalho Resumido)
    )
)

# Envia a requisição; OTP interativo abrirá janela ou cairá em console se Tk não disponível
resposta = client.incluir_pre_empenho(pre_empenho, otp=Otp(type="webauthn2steps", mode="interactive-window"))
print(resposta.model_dump())  # Dict validado pelo modelo de resposta

5.7 Detalhar e alterar Pré-Empenho (Reforço)

Após criado, é comum consultar (detalhar) um Pré-Empenho para confirmar atributos e em seguida aplicar operações como REFORÇO (aumenta valor), ANULAÇÃO parcial, etc. O exemplo abaixo faz a leitura e depois envia um reforço de +100, registrando motivo e data de alteração.

from pyarialib.siafi import AlterarPreEmpenhoRequestModel, OperacaoPreEmpenhoModel, RegistroAlteracaoModel

# Consulta do pré-empenho atual para inspecionar antes da mudança
detalhe = client.detalhar_pre_empenho(
    ug_emitente=170860,
    ano_pre_empenho=2025,
    num_pre_empenho=400005
)
print(detalhe.model_dump())

# Prepara operação de REFORÇO
reforco = AlterarPreEmpenhoRequestModel(
    ug_emitente=170860,
    ano_pre_empenho=2025,
    num_pre_empenho=400005,
    operacao=OperacaoPreEmpenhoModel(
        tipo_operacao="REFORCO",  # Tipos comuns: REFORCO, ANULACAO (ver especificação)
        vlr_operacao=100.00        # Valor adicional
    ),
    registro_alteracao=RegistroAlteracaoModel(
        dt_emis="2025-01-15",       # Data associada à alteração
        txt_motivo="Revisão orçamentária",  # Justificativa
        indr_indisp_caixa=False       # Indica se indisponibiliza caixa
    )
)

resultado = client.alterar_pre_empenho(reforco, otp=Otp(type="webauthn2steps", mode="interactive-window"))
print(resultado.model_dump())

5.8 Empenho: inclusão e detalhamento

O Empenho materializa a reserva orçamentária. Normalmente referencia um Pré-Empenho (campo pre_empenho) e traz itens detalhados com subelemento, quantidade e valores. Após inclusão, detalhamos para validar a persistência. Certifique-se de que o número não está duplicado e os códigos (amparo legal, natureza, PTRES) são válidos no ambiente.

from pyarialib.siafi import IncluirEmpenhoRequestModel

payload_empenho = IncluirEmpenhoRequestModel(
    ug_emitente=170860,               # UG emitente
    ano_empenho=2025,                 # Ano do empenho
    num_empenho=400014,               # Número sequencial
    pre_empenho="2025PE400005",       # Referência ao pré-empenho já criado
    celula_orcamentaria=CelulaOrcamentariaModel(
        esfera="1",
        cod_fonte_rec="1000000000",
        cod_nat_desp=334041,
        cod_PTRES="140846"
    ),
    tipo_empenho=1,                   # Tipo (ver especificação: ordinário, estimativo, etc.)
    dt_emis="2025-01-10",            # Data emissão
    txt_processo="PROC-123",          # Referência processual
    vlr_taxa_cambio=11.99,            # Se aplicável
    vlr_empenho=100.00,               # Valor total
    cod_favorecido="00000000000191",  # Favorecido
    cod_amparo_legal=1,               # Amparo legal (deve existir)
    txt_info_compl="Aquisição de materiais.",
    txt_local_entrega="Setor X",
    txt_descricao="Aquisição de materiais de consumo.",
    item_empenho=[{
        "num_seq_item": 1,           # Sequência do item
        "cod_sub_elemento": "1",    # Sub-elemento (exemplo)
        "descricao": "Material de consumo",
        "operacao_item_empenho": {   # Operação sobre o item
            "tipo_operacao_item_empenho": "INCLUSAO",
            "quantidade": 1,
            "vlr_unitario": 100,
            "vlr_operacao": 100
        }
    }]
)

incluido = client.incluir_empenho(payload_empenho, otp=Otp(type="webauthn2steps", mode="interactive-window"))
print(incluido.model_dump())

# Consulta posterior para validar dados
detalhe = client.detalhar_empenho(ug_emitente=170860, ano_empenho=2025, num_empenho=400014)
print(detalhe)

5.9 Documento Hábil (CPR) e Realização de Compromissos

O Documento Hábil (DH) no módulo de Contas a Pagar/Receber (CPR) agrega dados básicos (valor, favorecido, origem), PCO (principal com orçamento), centros de custo, dados de pagamento (predoc) e posteriormente gera compromissos a realizar. O fluxo abaixo: (1) cadastra DH, (2) consulta compromissos gerados para realização, (3) realiza todos informando vinculação e valores.

from pyarialib.siafi import (
    CprDhCadastrarModel, DadosBasicosModel, DocOrigemModel, PcoModelInput, PcoItemModel,
    CentroCustoCadastroModel, RelComItemValorModel, DadosPgtoModelInput, PredocModelInput,
    CompromissoRealizacaoModel, CprCPRealizarTotalModel, ItemCompromissoRealizacaoModel, VinculacaoModel
)

# Montagem do Documento Hábil (DH)
payload_doc_habil = CprDhCadastrarModel(
    ano_DH=2025,
    cod_tipo_DH="TF",                  # Tipo de DH (exemplo)
    cod_ug_emit=170860,
    num_DH="800009",                   # Número identificador
    dados_basicos=DadosBasicosModel(
        dt_emis="2025-10-07",
        dt_venc="2025-10-07",          # Data de vencimento
        cod_ug_pgto=170860,             # UG de pagamento
        vlr=2.25,                       # Valor global
        txt_obser="Transferência Especial",
        dt_ateste="2025-10-07",
        cod_credor_devedor="05055009000113",  # Credor
        dt_pgto_receb="2025-10-07",
        doc_origem=[DocOrigemModel(
            cod_ident_emit="170860",
            dt_emis="2025-05-15",
            num_doc_origem="2025DF00146",
            vlr=1.50
        )],
        doc_relacionado=[],
        tramite=[]
    ),
    pco=[PcoModelInput(                # Principal com orçamento
        num_seq_item="1",
        cod_sit="TRF017",             # Situação (contábil/orçamentária)
        cod_ug_empe="170860",
        indr_tem_contrato=False,
        pco_item=[PcoItemModel(
            num_seq_item="1",
            num_empe="2025NE400012",  # Empenho relacionado
            cod_sub_item_empe="1",
            indr_liquidado=True,
            vlr=2.25,
            num_class_A="352450300",
            num_class_B="215250000"
        )]
    )],
    centro_custo=[CentroCustoCadastroModel(
        num_seq_item="1",
        cod_centro_custo="STNTRCON",
        mes_referencia="6",
        ano_referencia="2025",
        cod_ug_benef="170860",
        cod_SIORG="105930",
        rel_pco_item=[RelComItemValorModel(
            num_seq_item="1",
            num_seq_pai="1",
            cod_nat_desp_det="33404101",
            vlr=2.25
        )]
    )],
    dados_pgto=[DadosPgtoModelInput(
        cod_credor_devedor="05055009000113",
        vlr=2.25,
        predoc=PredocModelInput(
            txt_obser="Transferência Especial",
            predoc_OB={                 # Estrutura específica para OB
                "cod_tipo_OB": "OBC",
                "cod_credor_devedor": "05055009000113",
                "num_domi_banc_favo": {"banco": "1", "agencia": "1674", "conta": "103497"},
                "num_domi_banc_pgto": {"conta": "UNICA"},
                "txt_processo": "N/A"
            }
        )
    )],
    doc_contabilizacao=[]               # Pode conter lançamentos contábeis adicionais
)

# Cadastro do DH
dh = client.cadastrar_documento_habil(payload_doc_habil, otp=Otp(type="webauthn2steps", mode="interactive-window"))
print(dh.model_dump())

# Consulta de compromissos gerados para posterior realização
compromissos = client.consultar_compromissos_para_realizacao(
    documento_habil_ano=2025,
    documento_habil_numero="800009",
    documento_habil_tipo="TF",
    documento_habil_ug_emitente=170860,
    favorecido_recolhedor="05055009000113",
    tipo_compromisso="LIQUIDO"
)

# Prepara lista de realização (vinculando valor a cada item)
lista_realizacao = []
for comp in compromissos.lista_compromissos:
    itens = []
    for item in comp.itens_compromisso:
        itens.append(ItemCompromissoRealizacaoModel(
            codigo_item_compromisso=item.codigo_item_compromisso,
            vinculacoes=[VinculacaoModel(codigo_vinculacao=400, valor=2.25)]  # Código de vinculação e valor
        ))
    lista_realizacao.append(
        CompromissoRealizacaoModel(
            codigo_compromisso=comp.codigo_compromisso,
            itens_compromisso=itens
        )
    )

# Realização total dos compromissos
realizacao = client.realizar_total_compromissos(
    CprCPRealizarTotalModel(lista_compromissos=lista_realizacao),
    otp=Otp(type="webauthn2steps", mode="interactive-window")
)
print(realizacao)

5.10 Alterar RIP

Atualiza um Registro de Informações de Pagamento (RIP) existente, substituindo dados conforme regras da API (campos ausentes podem ser limpos conforme documentação). Exemplo mostra alteração de título e marcação de ativo.

from pyarialib.siafi import TabAlterarRIPRequestModel, ParamManterRIPModel

resultado = client.alterar_rip(
    TabAlterarRIPRequestModel(
        param_manter_RIP=ParamManterRIPModel(
            cod_RIP="0000000123456",        # Código RIP alvo
            titulo_RIP="Imóvel Exemplo",     # Novo título
            cod_tipo_RIP=1,                  # Tipo (ver tabela)
            txt_motivo="Atualização cadastral",  # Justificativa obrigatória
            indr_ativo=True                  # Mantém ativo
        )
    ),
    otp=Otp(type="webauthn2steps", mode="interactive-window")
)
print(resultado.model_dump())

5.11 Alterar e consultar chaves PIX

Demonstra ciclo de manutenção de chaves PIX para um credor: primeiro altera a(s) chave(s), depois consulta para confirmar persistência.

from pyarialib.siafi import TabAlterarChavesPixRequestModel, ParamAlterarChavesPixModel, ChavePixModelInput

alteracao = client.alterar_chaves_pix(
    TabAlterarChavesPixRequestModel(
        param_alterar_chaves_pix=ParamAlterarChavesPixModel(
            credor="00000000000191",  # CNPJ/CPF do credor
            chave_pix=[
                ChavePixModelInput(tipo_chave="CNPJ", chave="00000000000191")  # Nova chave
            ]
        )
    ),
    otp=Otp(type="webauthn2steps", mode="interactive-window")
)
print(alteracao.model_dump())

# Consulta para verificar
consulta = client.consultar_chaves_pix(credor="00000000000191")
print(consulta.model_dump())

5.12 Programação Financeira: detalhar

Obtém detalhes de uma Programação Financeira (PF), permitindo validar situação, valores e chaves de identificação antes de operações subsequentes (estorno, devolução, transferência, etc.).

pf = client.detalhar_programacao_financeira(
    ano=2025,
    cod_ug_emit=170500,
    numero_documento=400005
)
print(pf.model_dump())

Observação: Todos os valores / códigos nos exemplos são ilustrativos. Use sempre ambientes de homologação e dados de teste controlados.

6. Uso de Modelos Pydantic

Os modelos (ex.: TabIncluirRIPRequestModel) herdam de BaseModelSiafi.

Benefícios:

Validação de tipos antes do envio.
Geração de payload automaticamente convertido para camelCase via função interna _normalize_dict_keys.
Remoção de campos None (já tratada no processo de normalização).

from pyarialib.siafi import IncluirEmpenhoRequestModel

empenho = IncluirEmpenhoRequestModel(
    ug_emitente=160001,
    ano_empenho=2025,
    # ... outros campos
)

# O método interno converte para camelCase antes de enviar

Se a operação aceitar lista, envie List[Model] normalmente. Respostas retornam já em snake_case.

7. OTP (One-Time Password)

O core de requisição (Aria.request) suporta três modos através da classe Otp:

Modo	Descrição	Quando usar
`manual`	Envia cabeçalhos `Otp-*` já preenchidos	Jobs automatizados com código obtido externamente
`interactive-console`	2 etapas no terminal: obtém `flowId`, solicita código	Ambiente sem GUI
`interactive-window`	Janela Tkinter para inserir código (default de métodos não-GET no `Siafi`)	Uso local com desktop

Exemplo manual:

otp = Otp(type="webauthn2steps", value="123456", flow_id="ABCD", mode="manual")
resp = client.alterar_rip(payload=algum_payload, otp=otp)

Se nenhum otp for passado a métodos não-GET, o Siafi usa Siafi.otp_default.

8. Tratamento de Erros

Qualquer resposta com status não 200/201 gera ValueError contendo mensagem derivada de detail no JSON ou o payload bruto.
Valide campos opcionais antes de acessar.
Ajuste try/except conforme necessidade:

try:
    resp = client.consultar_ug(codigo_ug="999999")
except ValueError as e:
    print("Falha na consulta:", e)

9. Como Estender (Adicionar Novo Método)

Localize o path e schema em siafi-global.json.
Gere (ou identifique) os modelos de request/response em models.py (se ainda não existirem).
Abra pyarialib/siafi/__init__.py e adicione um método seguindo o padrão existente:

def consultar_algo(self, parametro_opcional: str | None = None) -> MeuModeloResposta:
    query_params = {}
    if parametro_opcional:
        query_params['parametroOp'] = parametro_opcional
    resposta = self._execute_request(method='get', endpoint='tabelas/consultar-algo', query_params=query_params)
    return self._process_response(resposta, response_model=MeuModeloResposta, is_list=False)

Garanta que o modelo foi importado no topo do arquivo (from .models import ...).
Caso seja POST/PUT/PATCH com corpo: crie payload Pydantic e use _normalize_dict_keys(payload) para serializar.

10. Boas Práticas

Use sempre métodos tipados existentes antes de cair em requisições genéricas.
Preencha apenas campos necessários; excesso de campos pode ser rejeitado.
Em jobs automatizados, prefira Otp(mode='manual') para evitar interação.
Centralize logs de auditoria (método + params essenciais).
Revise breaking changes ao atualizar siafi-global.json (commit isolado + diff).

12. Referências

Recurso	Caminho
Especificação OpenAPI	`pyarialib/siafi-global.json`
Modelos Pydantic	`pyarialib/siafi/models.py`
Implementação Cliente	`pyarialib/siafi/__init__.py`
Classe OTP	`pyarialib/otp.py`

Licença

MIT (consulte o repositório raiz).

(Cabeçalho original do README já exibido acima.)

API de Referência

Modelos (Pydantic)

Bases: 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: str | None

cod_font_recur: str | None

cod_sub_item_empe: int | str | None

indr_liquidado: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sub_item_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tp_acrescimo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_empe: str | None

tp_acrescimo: str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

vlr: float | None

class pyarialib.siafi.models.AlterarAmparoLegalRequestModel(**extra_data: Any)[código fonte]

Bases: 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: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_amparo_legal': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'orc_amparo_legal_dados': FieldInfo(annotation=Union[OrcAmparoLegalDadosModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

motivo: str | None

orc_amparo_legal_dados: OrcAmparoLegalDadosModel | None

class pyarialib.siafi.models.AlterarEmpenhoRequestModel(**extra_data: Any)[código fonte]

Bases: 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.

ano_empenho: int | None

item_empenho: List[ItemEmpenhoModelInput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_empenho': FieldInfo(annotation=Union[List[ItemEmpenhoModelInput], NoneType], required=False, default=None), 'num_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'passivo_anterior': FieldInfo(annotation=Union[PassivoAnteriorModelInput, NoneType], required=False, default=None), 'registro_alteracao': FieldInfo(annotation=Union[RegistroAlteracaoModel, NoneType], required=False, default=None), 'txt_descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_local_entrega': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_empenho: int | None

passivo_anterior: PassivoAnteriorModelInput | None

registro_alteracao: RegistroAlteracaoModel | None

txt_descricao: str | None

txt_local_entrega: str | None

ug_emitente: int | None

class pyarialib.siafi.models.AlterarPreEmpenhoRequestModel(**extra_data: Any)[código fonte]

Bases: 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.

ano_pre_empenho: int | None

cod_favorecido: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_pre_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_pre_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'operacao': FieldInfo(annotation=Union[OperacaoPreEmpenhoModel, NoneType], required=False, default=None), 'registro_alteracao': FieldInfo(annotation=Union[RegistroAlteracaoModel, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_pre_empenho: int | None

operacao: OperacaoPreEmpenhoModel | None

registro_alteracao: RegistroAlteracaoModel | None

ug_emitente: int | None

class pyarialib.siafi.models.BaseModelSiafi(**extra_data: Any)[código fonte]

Bases: BaseModel

BaseModel customizado para SIAFI com configuração padrão.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CLTModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para CLTModel-Input.

numero_documento

Número do documento que vai ser gerado como resultado do cancelamento.

Type:: Optional[int | str]

numero_documento_cancelado

Número do documento que está sendo cancelado.

Type:: Optional[int | str]

item_CLT

Campo não documentado.

Type:: Optional[List[“ItemCLTModelInput”]]

item_CLT: List[ItemCLTModelInput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'item_CLT': FieldInfo(annotation=Union[List[ItemCLTModelInput], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'numero_documento_cancelado': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

numero_documento_cancelado: int | str | None

class pyarialib.siafi.models.CLTModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para CLTModel-Output.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[str]

numero_documento

Número da Programação Financeira (string/int, 1-6)

Type:: Optional[int | str]

item_CLT

Itens do Cancelamento de Liberação de Transferência

Type:: Optional[List[“ItemCLTModelOutput”]]

ano: str | None

cod_ug_favorecida: int | str | None

item_CLT: List[ItemCLTModelOutput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_CLT': FieldInfo(annotation=Union[List[ForwardRef('ItemCLTModelOutput')], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

Bases: BaseModelSiafi

Representa a configuração de um campo variável (classificação ou inscrição) para uma situação do CPR.

aba

Aba do CPR à qual o campo pertence (ex: PCO, PSO, CREDITO).

Type:: Optional[str]

campo

Tipo de discriminação do campo.

Type:: Optional[str]

indr_restricao_uso

Tipo de restrição de uso do campo variável.

Type:: Optional[str]

indr_tipo_classificacao

Tipo de classificação do campo variável.

Type:: Optional[str]

indr_tipo_dado_inscr

Tipo de dado de inscrição do campo variável.

Type:: Optional[str]

indr_tipo_restricao_mascara

Tipo de restrição de máscara do campo.

Type:: Optional[str]

mascara

Código da máscara a ser aplicada ao campo.

Type:: Optional[str]

rotulo

Rótulo do campo a ser exibido na interface.

Type:: Optional[str]

submascara

Código da submáscara a ser aplicada ao campo.

Type:: Optional[str]

aba: str | None

campo: str | None

indr_restricao_uso: str | None

indr_tipo_classificacao: str | None

indr_tipo_dado_inscr: str | None

indr_tipo_restricao_mascara: str | None

mascara: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'aba': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'campo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_restricao_uso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_tipo_classificacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_tipo_dado_inscr': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_tipo_restricao_mascara': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mascara': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'rotulo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'submascara': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

rotulo: str | None

submascara: str | None

Bases: BaseModelSiafi

Schema para CelulaFinanceiraModel.

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Bases: 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.

cod_PTRES: str | None

cod_fonte_rec: str | None

cod_nat_desp: int | None

cod_plano_interno: str | None

esfera: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_PTRES': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_fonte_rec': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_nat_desp': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_plano_interno': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'esfera': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_responsavel': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

ug_responsavel: int | str | None

class pyarialib.siafi.models.CentroCustoCadastroModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um Centro de Custo para cadastro/alteração em um Documento Hábil (baseado em ns5:CentroCusto).

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

cod_centro_custo

Código do Centro de Custo.

Type:: Optional[str]

mes_referencia

Mês de referência (1 a 12).

Type:: Optional[str]

ano_referencia

Ano de referência com 4 dígitos.

Type:: Optional[str]

cod_ug_benef

Código da UG beneficiária.

Type:: Optional[int | str]

cod_SIORG

Código SIORG do centro de custo.

Type:: Optional[str]

rel_pco_item

Relação de itens PCO (Principal com Orçamento).

Type:: Optional[List[“RelComItemValorModel”]]

rel_outros_lanc

Relação de outros lançamentos.

Type:: Optional[List[“RelSemItemValorModel”]]

rel_outros_lanc_cronograma_patrimonial

Relação de outros lançamentos do cronograma patrimonial.

Type:: Optional[List[“RelSemItemValorModel”]]

rel_pso_item

Relação de itens PSO (Principal sem Orçamento).

Type:: Optional[List[“RelComItemValorModel”]]

rel_encargo

Relação de encargos.

Type:: Optional[List[“RelSemItemValorModel”]]

rel_acrescimo_deducao

Relação de valores de acréscimo de dedução.

Type:: Optional[List[“RelComItemValorModel”]]

rel_acrescimo_encargo

Relação de valores de acréscimo de encargo.

Type:: Optional[List[“RelComItemValorModel”]]

rel_acrescimo_dados_pag

Relação de valores de acréscimo de dados de pagamento.

Type:: Optional[List[“RelComItemValorModel”]]

rel_despesa_antecipada

Relação de despesas antecipadas.

Type:: Optional[List[“RelComItemValorModel”]]

rel_despesa_anular

Relação de despesas a anular.

Type:: Optional[List[“RelComItemValorModel”]]

ano_referencia: str | None

cod_SIORG: str | None

cod_centro_custo: str | None

cod_ug_benef: int | str | None

mes_referencia: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_referencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_SIORG': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_centro_custo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_benef': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'mes_referencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'rel_acrescimo_dados_pag': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'rel_acrescimo_deducao': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'rel_acrescimo_encargo': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'rel_despesa_antecipada': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'rel_despesa_anular': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'rel_encargo': FieldInfo(annotation=Union[List[ForwardRef('RelSemItemValorModel')], NoneType], required=False, default=None), 'rel_outros_lanc': FieldInfo(annotation=Union[List[ForwardRef('RelSemItemValorModel')], NoneType], required=False, default=None), 'rel_outros_lanc_cronograma_patrimonial': FieldInfo(annotation=Union[List[ForwardRef('RelSemItemValorModel')], NoneType], required=False, default=None), 'rel_pco_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'rel_pso_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

rel_acrescimo_dados_pag: List[RelComItemValorModel] | None

rel_acrescimo_deducao: List[RelComItemValorModel] | None

rel_acrescimo_encargo: List[RelComItemValorModel] | None

rel_despesa_antecipada: List[RelComItemValorModel] | None

rel_despesa_anular: List[RelComItemValorModel] | None

rel_encargo: List[RelSemItemValorModel] | None

rel_outros_lanc: List[RelSemItemValorModel] | None

rel_outros_lanc_cronograma_patrimonial: List[RelSemItemValorModel] | None

rel_pco_item: List[RelComItemValorModel] | None

rel_pso_item: List[RelComItemValorModel] | None

class pyarialib.siafi.models.CentroCustoConsultaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um Centro de Custo para consulta em um Documento Hábil (baseado em ns8:CentroCusto).

cod_centro_custo

Código do Centro de Custo.

Type:: Optional[str]

mes_referencia

Mês de referência (1 a 12).

Type:: Optional[str]

ano_referencia

Ano de referência com 4 dígitos.

Type:: Optional[str]

cod_ug_benef

Código da UG beneficiária.

Type:: Optional[int | str]

cod_SIORG

Código SIORG do centro de custo.

Type:: Optional[str]

rel_pco_item

Relação de itens PCO (Principal com Orçamento).

Type:: Optional[List[“RelValorModel”]]

rel_outros_lanc

Relação de outros lançamentos.

Type:: Optional[List[“RelValorModel”]]

rel_outros_lanc_cronograma_patrimonial

Relação de outros lançamentos do cronograma patrimonial.

Type:: Optional[List[“RelValorModel”]]

rel_pso_item

Relação de itens PSO (Principal sem Orçamento).

Type:: Optional[List[“RelValorModel”]]

rel_encargo

Relação de encargos.

Type:: Optional[List[“RelValorModel”]]

rel_acrescimo_deducao

Relação de valores de acréscimo de dedução.

Type:: Optional[List[“RelValorModel”]]

rel_acrescimo_encargo

Relação de valores de acréscimo de encargo.

Type:: Optional[List[“RelValorModel”]]

rel_acrescimo_dados_pag

Relação de valores de acréscimo de dados de pagamento.

Type:: Optional[List[“RelValorModel”]]

rel_despesa_antecipada

Relação de despesas antecipadas.

Type:: Optional[List[“RelValorModel”]]

rel_despesa_anular

Relação de despesas a anular.

Type:: Optional[List[“RelValorModel”]]

ano_referencia: str | None

cod_SIORG: str | None

cod_centro_custo: str | None

cod_ug_benef: int | str | None

mes_referencia: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_referencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_SIORG': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_centro_custo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_benef': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'mes_referencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'rel_acrescimo_dados_pag': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_acrescimo_deducao': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_acrescimo_encargo': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_despesa_antecipada': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_despesa_anular': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_encargo': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_outros_lanc': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_outros_lanc_cronograma_patrimonial': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_pco_item': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None), 'rel_pso_item': FieldInfo(annotation=Union[List[ForwardRef('RelValorModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

rel_acrescimo_dados_pag: List[RelValorModel] | None

rel_acrescimo_deducao: List[RelValorModel] | None

rel_acrescimo_encargo: List[RelValorModel] | None

rel_despesa_antecipada: List[RelValorModel] | None

rel_despesa_anular: List[RelValorModel] | None

rel_encargo: List[RelValorModel] | None

rel_outros_lanc: List[RelValorModel] | None

rel_outros_lanc_cronograma_patrimonial: List[RelValorModel] | None

rel_pco_item: List[RelValorModel] | None

rel_pso_item: List[RelValorModel] | None

class pyarialib.siafi.models.ChavePixModelInput(*, tipo_chave: str | None = None, chave: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Chave PIX do credor.

tipo_chave

Tipo de chave PIX. Valores: “CPF”, “CNPJ”, “EMAIL”, “PHONE”, “EVP”. Tamanho: 1-5.

Type:: Optional[str]

chave

Valor da chave. Tamanho: 1-77.

Type:: Optional[str]

chave: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'chave': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_chave': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_chave: str | None

class pyarialib.siafi.models.ChavePixModelOutput(*, tipo_chave: str | None = None, chave: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ChavePixModel-Output.

tipo_chave

Campo não documentado.

Type:: Optional[str]

chave

Campo não documentado.

Type:: Optional[str]

chave: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'chave': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_chave': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_chave: str | None

class pyarialib.siafi.models.CompensacaoModel(**extra_data: Any)[código fonte]

Bases: 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: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'rel_deducao': FieldInfo(annotation=Union[ForwardRef('RelSemItemModel'), NoneType], required=False, default=None), 'rel_encargo': FieldInfo(annotation=Union[ForwardRef('RelSemItemModel'), NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_seq_item: int | str | None

rel_deducao: RelSemItemModel | None

rel_encargo: RelSemItemModel | None

txt_inscr_A: str | None

vlr: float | None

class pyarialib.siafi.models.CompromissoBaixaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Define um compromisso a ser baixado.

codigo_compromisso

Identificador único do compromisso.

Type:: Optional[int]

lista_documentos_baixa

Lista de documentos usados na baixa.

Type:: Optional[List[“DocumentoSIAFIModel”]]

tipo_motivo_baixa

Motivo da baixa (CANCELAMENTO ou REALIZACAO).

Type:: Optional[str]

codigo_compromisso: int | None

lista_documentos_baixa: List[DocumentoSIAFIModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_compromisso': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'lista_documentos_baixa': FieldInfo(annotation=Union[List[ForwardRef('DocumentoSIAFIModel')], NoneType], required=False, default=None), 'tipo_motivo_baixa': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_motivo_baixa: str | None

class pyarialib.siafi.models.CompromissoEstornoModel(*, codigo_compromisso: int | None = None, nova_data_emissao: str | None = None, observacao: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Define um compromisso a ser estornado.

codigo_compromisso

Identificador único do compromisso.

Type:: Optional[int]

nova_data_emissao

Nova data de emissão para estorno do compromisso.

Type:: Optional[str]

observacao

Observação/descrição do estorno.

Type:: Optional[str]

codigo_compromisso: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_compromisso': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'nova_data_emissao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

nova_data_emissao: str | None

observacao: str | None

class pyarialib.siafi.models.CompromissoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um compromisso financeiro no sistema.

cod_tipo_DARF

Tipo do DARF.

Type:: Optional[str]

codigo_compromisso

Identificador único do compromisso.

Type:: Optional[str]

data_pagamento_recebimento

Data de pagamento ou recebimento.

Type:: Optional[str]

data_vencimento

Data de vencimento do compromisso.

Type:: Optional[str]

doc_habil

Chave de identificação de um documento hábil.

Type:: Optional[“DocumentoHabilChaveModel”]

documento_origem

Documento de origem.

Type:: Optional[List[“DocOrigemModel”]]

documentos_SIAFI

Lista de documentos do SIAFI (preenchida na consulta para Estorno).

Type:: Optional[List[“DocumentoSIAFIModel”]]

exige_data_limite

Indica se a realização deste compromisso exige nova data de emissão.

Type:: Optional[bool]

exige_vinculacao

Indica se a realização deste compromisso exige informar uma vinculação.

Type:: Optional[bool]

itens_compromisso

Lista de itens do compromisso.

Type:: Optional[List[“ItemCompromissoModel”]]

tipo_compromisso

Tipo do compromisso (LIQUIDO, ENCARGO, DEDUCAO, VARIACAO_PATRIMONIAL).

Type:: Optional[str]

tipo_documento_realizacao

Tipo do Documento de Realização do Compromisso.

Type:: Optional[str]

valor_cancelado_fora_cpr

Valor cancelado do compromisso fora do módulo de Contas a Pagar e Receber.

Type:: Optional[str]

valor_realizado

Valor já realizado.

Type:: Optional[str]

valor_realizado_fora_cpr

Valor realizado do compromisso fora do módulo de Contas a Pagar e Receber.

Type:: Optional[str]

valor_realizavel

Valor realizável do compromisso.

Type:: Optional[str]

cod_tipo_DARF: str | None

codigo_compromisso: str | None

data_pagamento_recebimento: str | None

data_vencimento: str | None

doc_habil: DocumentoHabilChaveModel | None

documento_origem: List[DocOrigemModel] | None

documentos_SIAFI: List[DocumentoSIAFIModel] | None

exige_data_limite: bool | None

exige_vinculacao: bool | None

itens_compromisso: List[ItemCompromissoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_tipo_DARF': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'codigo_compromisso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_pagamento_recebimento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_vencimento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'doc_habil': FieldInfo(annotation=Union[ForwardRef('DocumentoHabilChaveModel'), NoneType], required=False, default=None), 'documento_origem': FieldInfo(annotation=Union[List[ForwardRef('DocOrigemModel')], NoneType], required=False, default=None), 'documentos_SIAFI': FieldInfo(annotation=Union[List[ForwardRef('DocumentoSIAFIModel')], NoneType], required=False, default=None), 'exige_data_limite': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'exige_vinculacao': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'itens_compromisso': FieldInfo(annotation=Union[List[ForwardRef('ItemCompromissoModel')], NoneType], required=False, default=None), 'tipo_compromisso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_documento_realizacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_cancelado_fora_cpr': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_realizado': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_realizado_fora_cpr': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_realizavel': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_compromisso: str | None

tipo_documento_realizacao: str | None

valor_cancelado_fora_cpr: str | None

valor_realizado: str | None

valor_realizado_fora_cpr: str | None

valor_realizavel: str | None

class pyarialib.siafi.models.CompromissoRealizacaoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Define um compromisso a ser realizado.

codigo_compromisso

Identificador único do compromisso.

Type:: Optional[int]

itens_compromisso

Lista de itens de compromisso para realização.

Type:: Optional[List[“ItemCompromissoRealizacaoModel”]]

nova_data_data_emissao

Nova data de emissão para realização, se necessário.

Type:: Optional[str]

codigo_compromisso: int | None

itens_compromisso: List[ItemCompromissoRealizacaoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_compromisso': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'itens_compromisso': FieldInfo(annotation=Union[List[ForwardRef('ItemCompromissoRealizacaoModel')], NoneType], required=False, default=None), 'nova_data_data_emissao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

nova_data_data_emissao: str | None

class pyarialib.siafi.models.CompromissoRestabelecerModel(*, codigo_compromisso: int | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Define um compromisso a ser restabelecido.

codigo_compromisso

Identificador único do compromisso que será restabelecido.

Type:: Optional[int]

codigo_compromisso: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_compromisso': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.ConfiguracaoCamposModel(*, classificacao: List[CampoVariavelCPRModel] | None = None, inscricao: List[CampoVariavelCPRModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Agrupa a configuração de campos de classificação e inscrição para uma situação do CPR.

classificacao

Lista de configurações para campos de classificação.

Type:: Optional[List[“CampoVariavelCPRModel”]]

inscricao

Lista de configurações para campos de inscrição.

Type:: Optional[List[“CampoVariavelCPRModel”]]

classificacao: List[CampoVariavelCPRModel] | None

inscricao: List[CampoVariavelCPRModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'classificacao': FieldInfo(annotation=Union[List[CampoVariavelCPRModel], NoneType], required=False, default=None), 'inscricao': FieldInfo(annotation=Union[List[CampoVariavelCPRModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPBaixarCompromissoResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Response wrapper para a operação cprCPBaixarCompromisso.

resultado_execucao

Resultado da execução da baixa.

Type:: Optional[List[“CprCPResultadoExecucaoModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'resultado_execucao': FieldInfo(annotation=Union[List[ForwardRef('CprCPResultadoExecucaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resultado_execucao: List[CprCPResultadoExecucaoModel] | None

class pyarialib.siafi.models.CprCPBaixarModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Contém a lista de compromissos para baixa.

lista_compromissos

Lista de compromissos para baixa.

Type:: Optional[List[“CompromissoBaixaModel”]]

lista_compromissos: List[CompromissoBaixaModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'lista_compromissos': FieldInfo(annotation=Union[List[CompromissoBaixaModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPConsultaRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta da consulta de compromissos, contendo a lista de resultados.

lista_compromissos

Lista de compromissos de uma consulta.

Type:: Optional[List[“CompromissoModel”]]

mensagem

Mensagem, se aplicável, relativo ao resultado da pesquisa.

Type:: Optional[“schemas__cpr__MensagemModel”]

numero_resultados

Número de resultados da consulta.

Type:: Optional[int]

lista_compromissos: List[CompromissoModel] | None

mensagem: schemas__cpr__MensagemModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'lista_compromissos': FieldInfo(annotation=Union[List[CompromissoModel], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[ForwardRef('schemas__cpr__MensagemModel'), NoneType], required=False, default=None), 'numero_resultados': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_resultados: int | None

class pyarialib.siafi.models.CprCPDetalharLXRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resultado do detalhamento de uma Lista de Credores PIX (LX).

ano_LX

Ano da Lista LX.

Type:: Optional[int | str]

cod_ug_emit

UG Emitente da Lista LX.

Type:: Optional[int]

doc_siafi_OB

Identifica a Ordem Bancária que a lista LX está associada.

Type:: Optional[“DocumentoSIAFIResumidoModel”]

doc_siafi_OP

Identifica a Ordem de Pagamento que a lista LX está associada.

Type:: Optional[“DocumentoSIAFIResumidoModel”]

item_LX

Representa a lista de itens LX detalhados.

Type:: Optional[List[“ItemLXDetalheModel”]]

mensagem

Mensagens de erro em caso de falha.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

num_LX

Número da lista LX.

Type:: Optional[int | str]

prox_num_seq_paginacao

Próximo sequencial para paginação, retornado quando há mais itens a serem detalhados.

Type:: Optional[int | str]

qtd_total_itens_LX

Quantidade total de itens na LX.

Type:: Optional[int]

status

Status da LX (ex: CRIADA, PAGA, CANCELADA).

Type:: Optional[str]

tipo_pagto_LX

Tipo de pagamento da lista de credores pix (LX).

Type:: Optional[str]

vlr_total_LX

Valor total da LX.

Type:: Optional[str]

ano_LX: int | str | None

cod_ug_emit: int | None

doc_siafi_OB: DocumentoSIAFIResumidoModel | None

doc_siafi_OP: DocumentoSIAFIResumidoModel | None

item_LX: List[ItemLXDetalheModel] | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_LX': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'doc_siafi_OB': FieldInfo(annotation=Union[ForwardRef('DocumentoSIAFIResumidoModel'), NoneType], required=False, default=None), 'doc_siafi_OP': FieldInfo(annotation=Union[ForwardRef('DocumentoSIAFIResumidoModel'), NoneType], required=False, default=None), 'item_LX': FieldInfo(annotation=Union[List[ForwardRef('ItemLXDetalheModel')], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'num_LX': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'prox_num_seq_paginacao': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'qtd_total_itens_LX': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_pagto_LX': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_total_LX': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_LX: int | str | None

prox_num_seq_paginacao: int | str | None

qtd_total_itens_LX: int | None

status: str | None

tipo_pagto_LX: str | None

vlr_total_LX: str | None

class pyarialib.siafi.models.CprCPDetalharOPResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Response wrapper para a operação cprCPDetalharOP.

cpr_CP_detalhar_OP_resposta

Resultado da operação.

Type:: Optional[“CprCPDetalharOPRespostaModel”]

cpr_CP_detalhar_OP_resposta: CprCPDetalharOPRespostaModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cpr_CP_detalhar_OP_resposta': FieldInfo(annotation=Union[ForwardRef('CprCPDetalharOPRespostaModel'), NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPDetalharOPRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta do detalhamento de uma Ordem de Pagamento (OP), com dados bancários, status e assinaturas.

cod_banco_pagador

Código do Banco Pagador da OP.

Type:: Optional[int | str]

cod_num_lista

Parâmetro retornado quando a OP está associada a uma Lista.

Type:: Optional[str]

cpf_gestor_financeiro

CPF do Gestor Financeiro que assinou a OP.

Type:: Optional[str]

cpf_liberacao_STN

CPF do responsável da STN pela liberação do pagamento da OP em D+0.

Type:: Optional[str]

cpf_ordenador_despesa

CPF do Ordenador da Despesa que assinou a OP.

Type:: Optional[str]

dados_pagamento_PIX

Grupo de dados retornados quando a OP possuir um pagamento PIX associado.

Type:: Optional[“DadosPagamentoPIXModel”]

data_assinatura_gest_fin

Data/hora da assinatura do Gestor Financeiro.

Type:: Optional[str]

data_assinatura_ord_desp

Data/hora da assinatura do Ordenador da Despesa.

Type:: Optional[str]

data_emissao

Data de emissão da OP.

Type:: Optional[str]

data_liberacao_STN

Data/hora da assinatura do responsável da STN pela liberação do pagamento da OP em D+0.

Type:: Optional[str]

data_processamento

Data em que a OP foi ou será processada, a depender do seu status.

Type:: Optional[str]

documento_habil

Lista de documentos hábeis associados à OP.

Type:: Optional[List[“DocumentoHabilOPModel”]]

documento_SIAFI

Lista de documentos SIAFI associados à OP.

Type:: Optional[List[“DocumentoSIAFIOPModel”]]

indr_processamento

Indicador do Processamento da OP (SUCESSO ou ERRO).

Type:: Optional[str]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

numero_OP

Número do documento OP.

Type:: Optional[str]

status

Status da OP (ex: PENDENTE ASSINATURA, PAGA, CANCELADA).

Type:: Optional[str]

txt_erro_processamento

Caso o indicador de Processamento seja erro, descreve o motivo.

Type:: Optional[str]

ug_pagadora

UG pagadora do documento OP.

Type:: Optional[int | str]

valor_documento

Valor do documento OP.

Type:: Optional[str]

cod_banco_pagador: int | str | None

cod_num_lista: str | None

cpf_gestor_financeiro: str | None

cpf_liberacao_STN: str | None

cpf_ordenador_despesa: str | None

dados_pagamento_PIX: DadosPagamentoPIXModel | None

data_assinatura_gest_fin: str | None

data_assinatura_ord_desp: str | None

data_emissao: str | None

data_liberacao_STN: str | None

data_processamento: str | None

documento_SIAFI: List[DocumentoSIAFIOPModel] | None

documento_habil: List[DocumentoHabilOPModel] | None

indr_processamento: str | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_banco_pagador': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_num_lista': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_gestor_financeiro': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_liberacao_STN': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_ordenador_despesa': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dados_pagamento_PIX': FieldInfo(annotation=Union[ForwardRef('DadosPagamentoPIXModel'), NoneType], required=False, default=None), 'data_assinatura_gest_fin': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_assinatura_ord_desp': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_emissao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_liberacao_STN': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'documento_SIAFI': FieldInfo(annotation=Union[List[ForwardRef('DocumentoSIAFIOPModel')], NoneType], required=False, default=None), 'documento_habil': FieldInfo(annotation=Union[List[ForwardRef('DocumentoHabilOPModel')], NoneType], required=False, default=None), 'indr_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'numero_OP': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_erro_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_pagadora': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'valor_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_OP: str | None

status: str | None

txt_erro_processamento: str | None

ug_pagadora: int | str | None

valor_documento: str | None

class pyarialib.siafi.models.CprCPEstornarCompromissoResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Response wrapper para a operação cprCPEstornarCompromisso.

resultado_execucao

Resultado da execução do estorno.

Type:: Optional[List[“CprCPResultadoExecucaoModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'resultado_execucao': FieldInfo(annotation=Union[List[ForwardRef('CprCPResultadoExecucaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resultado_execucao: List[CprCPResultadoExecucaoModel] | None

class pyarialib.siafi.models.CprCPEstornarModel(*, lista_compromissos: List[CompromissoEstornoModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Contém a lista de compromissos para estorno.

lista_compromissos

Lista de compromissos para estorno.

Type:: Optional[List[“CompromissoEstornoModel”]]

lista_compromissos: List[CompromissoEstornoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'lista_compromissos': FieldInfo(annotation=Union[List[CompromissoEstornoModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPExcluirLXRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta da operação de exclusão de LX.

mensagem

Retorna mensagens de erro ou sucesso da requisição.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPManterLXEntradaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Parâmetros para incluir ou alterar uma Lista de Credores PIX (LX) e seus itens.

ano_LX

Ano da Lista.

Type:: Optional[int | str]

cod_ug_emit

UG Emitente da Lista LX.

Type:: Optional[int]

item_LX

Lista de itens a serem incluídos/alterados/excluídos. Limitado a 100 itens por chamada.

Type:: Optional[List[“ItemLXModel”]]

num_LX

Número da lista. Obrigatório se a UG utiliza numeração manual.

Type:: Optional[int | str]

tipo_pagto_LX

Tipo de pagamento da lista (PAGAMENTOS DIVERSOS ou REPAGAMENTO_FOLHA).

Type:: Optional[str]

ano_LX: int | str | None

cod_ug_emit: int | None

item_LX: List[ItemLXModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_LX': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_LX': FieldInfo(annotation=Union[List[ForwardRef('ItemLXModel')], NoneType], required=False, default=None), 'num_LX': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tipo_pagto_LX': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_LX: int | str | None

tipo_pagto_LX: str | None

class pyarialib.siafi.models.CprCPManterLXRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta da operação de manutenção de LX, retornando o resultado e possíveis erros.

ano_LX

Ano da Lista LX.

Type:: Optional[int | str]

cod_ug_emit

UG Emitente da Lista LX.

Type:: Optional[int]

item_LX

Retorna os erros ocorridos nos itens da lista.

Type:: Optional[List[“ItemLXErroModel”]]

mensagem

Retorna os erros ocorridos nos dados gerais da lista.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

num_LX

Número da lista LX que foi incluída ou alterada.

Type:: Optional[int | str]

ano_LX: int | str | None

cod_ug_emit: int | None

item_LX: List[ItemLXErroModel] | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_LX': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_LX': FieldInfo(annotation=Union[List[ForwardRef('ItemLXErroModel')], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'num_LX': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_LX: int | str | None

class pyarialib.siafi.models.CprCPRealizarTotalCompromissosResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Response wrapper para a operação cprCPRealizarTotalCompromissos.

resultado_execucao

Resultado da execução da realização.

Type:: Optional[List[“CprCPResultadoExecucaoModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'resultado_execucao': FieldInfo(annotation=Union[List[ForwardRef('CprCPResultadoExecucaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resultado_execucao: List[CprCPResultadoExecucaoModel] | None

class pyarialib.siafi.models.CprCPRealizarTotalModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Contém a lista de compromissos para realização total.

lista_compromissos

Lista de compromissos para realização.

Type:: Optional[List[“CompromissoRealizacaoModel”]]

lista_compromissos: List[CompromissoRealizacaoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'lista_compromissos': FieldInfo(annotation=Union[List[CompromissoRealizacaoModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPRestabelecerCompromissoResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Response wrapper para a operação cprCPRestabelecerCompromisso.

resultado_execucao

Resultado da execução do restabelecimento.

Type:: Optional[List[“CprCPResultadoExecucaoModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'resultado_execucao': FieldInfo(annotation=Union[List[ForwardRef('CprCPResultadoExecucaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resultado_execucao: List[CprCPResultadoExecucaoModel] | None

class pyarialib.siafi.models.CprCPRestabelecerModel(*, lista_compromissos: List[CompromissoRestabelecerModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Contém a lista de compromissos para restabelecimento.

lista_compromissos

Lista de compromissos para restabelecimento.

Type:: Optional[List[“CompromissoRestabelecerModel”]]

lista_compromissos: List[CompromissoRestabelecerModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'lista_compromissos': FieldInfo(annotation=Union[List[CompromissoRestabelecerModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprCPResultadoExecucaoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resultado da execução de uma operação de compromisso (baixa, estorno, etc.).

codigo_compromisso

Identificador único do compromisso processado.

Type:: Optional[int]

doc_habil

Chave de identificação do documento hábil relacionado.

Type:: Optional[“DocumentoHabilChaveModel”]

resumo_processamento

Lista de informações do processamento da opção executada.

Type:: Optional[List[“ResumoProcessamentoModel”]]

codigo_compromisso: int | None

doc_habil: DocumentoHabilChaveModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_compromisso': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'doc_habil': FieldInfo(annotation=Union[ForwardRef('DocumentoHabilChaveModel'), NoneType], required=False, default=None), 'resumo_processamento': FieldInfo(annotation=Union[List[ForwardRef('ResumoProcessamentoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resumo_processamento: List[ResumoProcessamentoModel] | None

class pyarialib.siafi.models.CprDAConsultarSitRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resultado da consulta de Situação, com as situações encontradas e mensagens.

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

situacao

Lista de situações encontradas.

Type:: Optional[List[“SituacaoModel”]]

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'situacao': FieldInfo(annotation=Union[List[ForwardRef('SituacaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

situacao: List[SituacaoModel] | None

class pyarialib.siafi.models.CprDADetalharSitRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta do detalhamento de uma Situação, com informações detalhadas e mensagens.

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

situacao

Lista de situações detalhadas.

Type:: Optional[List[“SituacaoCPRModel”]]

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'situacao': FieldInfo(annotation=Union[List[ForwardRef('SituacaoCPRModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

situacao: List[SituacaoCPRModel] | None

class pyarialib.siafi.models.CprDhAlterarIncluirItensModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Parâmetros para alterar um Documento Hábil existente, permitindo alterar Dados Básicos e adicionar novos itens.

ano_DH

Ano do Documento Hábil.

Type:: Optional[int | str]

centro_custo

Lista de centros de custo.

Type:: Optional[List[“CentroCustoCadastroModel”]]

cod_tipo_DH

Código do tipo do Documento Hábil.

Type:: Optional[str]

cod_ug_emit

Código da UG Emitente do DH. Se não informado, usa a UG do cabeçalho.

Type:: Optional[int]

compensacao

Lista de compensações.

Type:: Optional[List[“CompensacaoModel”]]

credito

Lista de créditos.

Type:: Optional[List[“CreditoModel”]]

dados_basicos_alteracao

Dados básicos a serem alterados.

Type:: Optional[“DadosBasicosAlteracaoModel”]

dados_pgto

Lista de dados de pagamento (somente para Líquido com realização OB).

Type:: Optional[List[“DadosPgtoModelInput”]]

deducao

Lista de deduções.

Type:: Optional[List[“DeducaoModelInput”]]

despesa_anular

Lista de despesas a anular.

Type:: Optional[List[“DespesaAnularModelInput”]]

doc_contabilizacao

Lista de documentos de contabilização.

Type:: Optional[List[“DocContabilizacaoModel”]]

dt_emis

Data de emissão do documento NS gerado pela alteração.

Type:: Optional[str]

encargo

Lista de encargos.

Type:: Optional[List[“EncargoModelInput”]]

num_DH

Número do Documento Hábil.

Type:: Optional[int | str]

outros_lanc

Lista de outros lançamentos.

Type:: Optional[List[“OutrosLancModelInput”]]

pco

Lista de itens de Principal com Orçamento (PCO).

Type:: Optional[List[“PcoModelInput”]]

pso

Lista de itens de Principal sem Orçamento (PSO).

Type:: Optional[List[“PsoModel”]]

txt_motivo

Motivo/Observação da alteração.

Type:: Optional[str]

ano_DH: int | str | None

centro_custo: List[CentroCustoCadastroModel] | None

cod_tipo_DH: str | None

cod_ug_emit: int | None

compensacao: List[CompensacaoModel] | None

credito: List[CreditoModel] | None

dados_basicos_alteracao: DadosBasicosAlteracaoModel | None

dados_pgto: List[DadosPgtoModelInput] | None

deducao: List[DeducaoModelInput] | None

despesa_anular: List[DespesaAnularModelInput] | None

doc_contabilizacao: List[DocContabilizacaoModel] | None

dt_emis: str | None

encargo: List[EncargoModelInput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'centro_custo': FieldInfo(annotation=Union[List[CentroCustoCadastroModel], NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'compensacao': FieldInfo(annotation=Union[List[CompensacaoModel], NoneType], required=False, default=None), 'credito': FieldInfo(annotation=Union[List[ForwardRef('CreditoModel')], NoneType], required=False, default=None), 'dados_basicos_alteracao': FieldInfo(annotation=Union[ForwardRef('DadosBasicosAlteracaoModel'), NoneType], required=False, default=None), 'dados_pgto': FieldInfo(annotation=Union[List[ForwardRef('DadosPgtoModelInput')], NoneType], required=False, default=None), 'deducao': FieldInfo(annotation=Union[List[ForwardRef('DeducaoModelInput')], NoneType], required=False, default=None), 'despesa_anular': FieldInfo(annotation=Union[List[ForwardRef('DespesaAnularModelInput')], NoneType], required=False, default=None), 'doc_contabilizacao': FieldInfo(annotation=Union[List[ForwardRef('DocContabilizacaoModel')], NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'encargo': FieldInfo(annotation=Union[List[ForwardRef('EncargoModelInput')], NoneType], required=False, default=None), 'num_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'outros_lanc': FieldInfo(annotation=Union[List[ForwardRef('OutrosLancModelInput')], NoneType], required=False, default=None), 'pco': FieldInfo(annotation=Union[List[ForwardRef('PcoModelInput')], NoneType], required=False, default=None), 'pso': FieldInfo(annotation=Union[List[ForwardRef('PsoModel')], NoneType], required=False, default=None), 'txt_motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_DH: int | str | None

outros_lanc: List[OutrosLancModelInput] | None

pco: List[PcoModelInput] | None

pso: List[PsoModel] | None

txt_motivo: str | None

Bases: BaseModelSiafi

Parâmetros para alterar um Documento Hábil para liquidar todos os itens “em liquidação”.

ano_DH

Ano do Documento Hábil.

Type:: Optional[int | str]

cod_tipo_DH

Código do tipo do Documento Hábil.

Type:: Optional[str]

cod_ug_emit

Código da UG Emitente do DH. Se não informado, usa a UG do cabeçalho.

Type:: Optional[int]

dt_ateste

Data do ateste.

Type:: Optional[str]

dt_emis

Data de emissão do documento NS gerado pela alteração.

Type:: Optional[str]

num_DH

Número do Documento Hábil.

Type:: Optional[int | str]

txt_motivo

Motivo/Observação da alteração.

Type:: Optional[str]

ano_DH: int | str | None

cod_tipo_DH: str | None

cod_ug_emit: int | None

dt_ateste: str | None

dt_emis: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'dt_ateste': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_DH: int | str | None

txt_motivo: str | None

class pyarialib.siafi.models.CprDhCadastrarModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Parâmetros para cadastrar um novo Documento Hábil (DH) no CPR.

ano_DH

Ano do Documento Hábil.

Type:: Optional[int | str]

centro_custo

Lista de centros de custo.

Type:: Optional[List[“CentroCustoCadastroModel”]]

cod_tipo_DH

Código do tipo do Documento Hábil.

Type:: Optional[str]

cod_ug_emit

Código da UG Emitente.

Type:: Optional[int]

compensacao

Lista de compensações.

Type:: Optional[List[“CompensacaoModel”]]

credito

Lista de créditos.

Type:: Optional[List[“CreditoModel”]]

dados_basicos

Dados básicos do Documento Hábil.

Type:: Optional[“DadosBasicosModel”]

dados_pgto

Lista de dados de pagamento.

Type:: Optional[List[“DadosPgtoModelInput”]]

deducao

Lista de deduções.

Type:: Optional[List[“DeducaoModelInput”]]

despesa_anular

Lista de despesas a anular.

Type:: Optional[List[“DespesaAnularModelInput”]]

doc_contabilizacao

Lista de documentos de contabilização.

Type:: Optional[List[“DocContabilizacaoModel”]]

encargo

Lista de encargos.

Type:: Optional[List[“EncargoModelInput”]]

num_DH

Número do Documento Hábil.

Type:: Optional[int | str]

outros_lanc

Lista de outros lançamentos.

Type:: Optional[List[“OutrosLancModelInput”]]

pco

Lista de itens de Principal com Orçamento (PCO).

Type:: Optional[List[“PcoModelInput”]]

pso

Lista de itens de Principal sem Orçamento (PSO).

Type:: Optional[List[“PsoModel”]]

ano_DH: int | str | None

centro_custo: List[CentroCustoCadastroModel] | None

cod_tipo_DH: str | None

cod_ug_emit: int | None

compensacao: List[CompensacaoModel] | None

credito: List[CreditoModel] | None

dados_basicos: DadosBasicosModel | None

dados_pgto: List[DadosPgtoModelInput] | None

deducao: List[DeducaoModelInput] | None

despesa_anular: List[DespesaAnularModelInput] | None

doc_contabilizacao: List[DocContabilizacaoModel] | None

encargo: List[EncargoModelInput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'centro_custo': FieldInfo(annotation=Union[List[CentroCustoCadastroModel], NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'compensacao': FieldInfo(annotation=Union[List[CompensacaoModel], NoneType], required=False, default=None), 'credito': FieldInfo(annotation=Union[List[ForwardRef('CreditoModel')], NoneType], required=False, default=None), 'dados_basicos': FieldInfo(annotation=Union[ForwardRef('DadosBasicosModel'), NoneType], required=False, default=None), 'dados_pgto': FieldInfo(annotation=Union[List[ForwardRef('DadosPgtoModelInput')], NoneType], required=False, default=None), 'deducao': FieldInfo(annotation=Union[List[ForwardRef('DeducaoModelInput')], NoneType], required=False, default=None), 'despesa_anular': FieldInfo(annotation=Union[List[ForwardRef('DespesaAnularModelInput')], NoneType], required=False, default=None), 'doc_contabilizacao': FieldInfo(annotation=Union[List[ForwardRef('DocContabilizacaoModel')], NoneType], required=False, default=None), 'encargo': FieldInfo(annotation=Union[List[ForwardRef('EncargoModelInput')], NoneType], required=False, default=None), 'num_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'outros_lanc': FieldInfo(annotation=Union[List[ForwardRef('OutrosLancModelInput')], NoneType], required=False, default=None), 'pco': FieldInfo(annotation=Union[List[ForwardRef('PcoModelInput')], NoneType], required=False, default=None), 'pso': FieldInfo(annotation=Union[List[ForwardRef('PsoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_DH: int | str | None

outros_lanc: List[OutrosLancModelInput] | None

pco: List[PcoModelInput] | None

pso: List[PsoModel] | None

Bases: BaseModelSiafi

Parâmetros para cancelar um Documento Hábil existente.

ano_DH

Ano do Documento Hábil.

Type:: Optional[int | str]

cod_tipo_DH

Código do tipo do Documento Hábil.

Type:: Optional[str]

cod_ug_emit

Código da UG Emitente do DH. Se não informado, usa a UG do cabeçalho.

Type:: Optional[int]

dt_emis

Data de emissão.

Type:: Optional[str]

num_DH

Número do Documento Hábil.

Type:: Optional[int | str]

txt_motivo_cancel

Motivo do cancelamento.

Type:: Optional[str]

ano_DH: int | str | None

cod_tipo_DH: str | None

cod_ug_emit: int | None

dt_emis: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_motivo_cancel': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_DH: int | str | None

txt_motivo_cancel: str | None

class pyarialib.siafi.models.CprDhConsultarModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Modelo para consulta de Documento Hábil (DH) no CPR. Reutiliza a estrutura de CprDhCadastrar para os filtros.

ano_DH

Ano do Documento Hábil.

Type:: Optional[int | str]

centro_custo

Filtro por centro de custo.

Type:: Optional[List[“CentroCustoConsultaModel”]]

cod_tipo_DH

Filtro por tipo de Documento Hábil.

Type:: Optional[str]

cod_ug_emit

Filtro por UG Emitente.

Type:: Optional[int]

compensacao

Filtro por compensação.

Type:: Optional[List[“CompensacaoModel”]]

credito

Filtro por crédito.

Type:: Optional[List[“CreditoModel”]]

dados_basicos

Filtro por dados básicos.

Type:: Optional[“DadosBasicosModel”]

dados_pgto

Filtro por dados de pagamento.

Type:: Optional[List[“DadosPgtoModelOutput”]]

deducao

Filtro por dedução.

Type:: Optional[List[“DeducaoModelOutput”]]

despesa_anular

Filtro por despesa a anular.

Type:: Optional[List[“DespesaAnularModelOutput”]]

doc_contabilizacao

Filtro por documento de contabilização.

Type:: Optional[List[“DocContabilizacaoModel”]]

encargo

Filtro por encargo.

Type:: Optional[List[“EncargoModelOutput”]]

num_DH

Filtro por número do Documento Hábil.

Type:: Optional[int | str]

outros_lanc

Filtro por outros lançamentos.

Type:: Optional[List[“OutrosLancModelOutput”]]

pco

Filtro por PCO.

Type:: Optional[List[“PcoModelOutput”]]

pso

Filtro por PSO.

Type:: Optional[List[“PsoModel”]]

ano_DH: int | str | None

centro_custo: List[CentroCustoConsultaModel] | None

cod_tipo_DH: str | None

cod_ug_emit: int | None

compensacao: List[CompensacaoModel] | None

credito: List[CreditoModel] | None

dados_basicos: DadosBasicosModel | None

dados_pgto: List[DadosPgtoModelOutput] | None

deducao: List[DeducaoModelOutput] | None

despesa_anular: List[DespesaAnularModelOutput] | None

doc_contabilizacao: List[DocContabilizacaoModel] | None

encargo: List[EncargoModelOutput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'centro_custo': FieldInfo(annotation=Union[List[CentroCustoConsultaModel], NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'compensacao': FieldInfo(annotation=Union[List[CompensacaoModel], NoneType], required=False, default=None), 'credito': FieldInfo(annotation=Union[List[ForwardRef('CreditoModel')], NoneType], required=False, default=None), 'dados_basicos': FieldInfo(annotation=Union[ForwardRef('DadosBasicosModel'), NoneType], required=False, default=None), 'dados_pgto': FieldInfo(annotation=Union[List[ForwardRef('DadosPgtoModelOutput')], NoneType], required=False, default=None), 'deducao': FieldInfo(annotation=Union[List[ForwardRef('DeducaoModelOutput')], NoneType], required=False, default=None), 'despesa_anular': FieldInfo(annotation=Union[List[ForwardRef('DespesaAnularModelOutput')], NoneType], required=False, default=None), 'doc_contabilizacao': FieldInfo(annotation=Union[List[ForwardRef('DocContabilizacaoModel')], NoneType], required=False, default=None), 'encargo': FieldInfo(annotation=Union[List[ForwardRef('EncargoModelOutput')], NoneType], required=False, default=None), 'num_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'outros_lanc': FieldInfo(annotation=Union[List[ForwardRef('OutrosLancModelOutput')], NoneType], required=False, default=None), 'pco': FieldInfo(annotation=Union[List[ForwardRef('PcoModelOutput')], NoneType], required=False, default=None), 'pso': FieldInfo(annotation=Union[List[ForwardRef('PsoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_DH: int | str | None

outros_lanc: List[OutrosLancModelOutput] | None

pco: List[PcoModelOutput] | None

pso: List[PsoModel] | None

class pyarialib.siafi.models.CprDhDetalharRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta do detalhamento de um Documento Hábil, contendo os dados do DH e mensagens.

documento_habil

Dados do DH Detalhado.

Type:: Optional[“CprDhConsultarModel”]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

documento_habil: CprDhConsultarModel | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_habil': FieldInfo(annotation=Union[CprDhConsultarModel, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.CprDhRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta padrão para operações de Documento Hábil (cadastrar, alterar, cancelar).

ano_DH

Ano do Documento Hábil processado.

Type:: Optional[int | str]

cod_tipo_DH

Código do tipo do Documento Hábil processado.

Type:: Optional[str]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

num_DH

Número do Documento Hábil processado.

Type:: Optional[int | str]

num_ns

Lista de Notas de Sistema (NS) geradas.

Type:: Optional[List[str]]

num_qtd_comp_atualizado

Quantidade de Compromissos atualizados.

Type:: Optional[int | str]

ano_DH: int | str | None

cod_tipo_DH: str | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'num_DH': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_ns': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'num_qtd_comp_atualizado': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_DH: int | str | None

num_ns: List[str] | None

num_qtd_comp_atualizado: int | str | None

Bases: BaseModelSiafi

Representa um lançamento de crédito em um Documento Hábil.

cod_ctgo_gasto

Código Categoria de Gastos.

Type:: Optional[str]

cod_font_recur

Código Fonte de Recursos.

Type:: Optional[int | str]

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do crédito (15,2).

Type:: Optional[float]

cod_ctgo_gasto: str | None

cod_font_recur: int | str | None

cod_sit: str | None

indr_liquidado: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_seq_item: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

vlr: float | None

class pyarialib.siafi.models.CronBaixaPatrimonialModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Define o cronograma de baixa patrimonial com suas parcelas.

parcela

Lista de parcelas do cronograma.

Type:: Optional[List[“ParcelaModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'parcela': FieldInfo(annotation=Union[List[ParcelaModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

parcela: List[ParcelaModel] | None

class pyarialib.siafi.models.DRFDevolucaoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para DRFDevolucaoModel.

numero_documento

Campo não documentado.

Type:: Optional[int | str]

documento_origem

Campo não documentado.

Type:: Optional[“DocumentoOrigemModel”]

item_DRF

Campo não documentado.

Type:: Optional[List[“ItemDRFDevolucaoModel”]]

documento_origem: DocumentoOrigemModel | None

item_DRF: List[ItemDRFDevolucaoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_origem': FieldInfo(annotation=Union[DocumentoOrigemModel, NoneType], required=False, default=None), 'item_DRF': FieldInfo(annotation=Union[List[ItemDRFDevolucaoModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

class pyarialib.siafi.models.DRFModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para DRFModel.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[str]

numero_documento

Número da Programação Financeira (string/int, 1-6)

Type:: Optional[int | str]

item_DRF

Itens da Devolução de Recurso Financeiro

Type:: Optional[List[“ItemDRFModel”]]

ano: str | None

cod_ug_favorecida: int | str | None

item_DRF: List[ItemDRFModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_DRF': FieldInfo(annotation=Union[List[ForwardRef('ItemDRFModel')], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

class pyarialib.siafi.models.DadosBasicosAlteracaoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Define os dados básicos que podem ser alterados em um Documento Hábil.

dt_venc

Nova data de vencimento.

Type:: Optional[str]

cod_ug_pgto

Novo código da UG de pagamento.

Type:: Optional[int | str]

vlr

Novo valor.

Type:: Optional[float]

txt_info_adic

Novas informações adicionais.

Type:: Optional[str]

txt_processo

Novo número do processo.

Type:: Optional[str]

dt_ateste

Nova data de ateste.

Type:: Optional[str]

dt_pgto_receb

Nova data de pagamento/recebimento.

Type:: Optional[str]

doc_origem

Novos documentos de origem.

Type:: Optional[List[“DocOrigemModel”]]

doc_relacionado

Novos documentos relacionados.

Type:: Optional[List[“DocRelacionadoModel”]]

tramite

Novos trâmites.

Type:: Optional[List[“TramiteModel”]]

cod_ug_pgto: int | str | None

doc_origem: List[DocOrigemModel] | None

doc_relacionado: List[DocRelacionadoModel] | None

dt_ateste: str | None

dt_pgto_receb: str | None

dt_venc: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ug_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'doc_origem': FieldInfo(annotation=Union[List[ForwardRef('DocOrigemModel')], NoneType], required=False, default=None), 'doc_relacionado': FieldInfo(annotation=Union[List[ForwardRef('DocRelacionadoModel')], NoneType], required=False, default=None), 'dt_ateste': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_pgto_receb': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_venc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tramite': FieldInfo(annotation=Union[List[ForwardRef('TramiteModel')], NoneType], required=False, default=None), 'txt_info_adic': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tramite: List[TramiteModel] | None

txt_info_adic: str | None

txt_processo: str | None

vlr: float | None

class pyarialib.siafi.models.DadosBasicosModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os dados básicos de um Documento Hábil.

cod_credor_devedor

Código do credor/devedor (CPF, CNPJ, etc.).

Type:: Optional[str]

cod_ug_pgto

Código da UG de pagamento.

Type:: Optional[int | str]

doc_origem

Lista de documentos de origem.

Type:: Optional[List[“DocOrigemModel”]]

doc_relacionado

Lista de documentos hábeis relacionados.

Type:: Optional[List[“DocRelacionadoModel”]]

dt_ateste

Data do ateste.

Type:: Optional[str]

dt_emis

Data de emissão.

Type:: Optional[str]

dt_pgto_receb

Data de pagamento/recebimento.

Type:: Optional[str]

dt_venc

Data de vencimento.

Type:: Optional[str]

tramite

Lista de trâmites do documento.

Type:: Optional[List[“TramiteModel”]]

txt_info_adic

Texto de informações adicionais (memorando).

Type:: Optional[str]

txt_obser

Texto de observação.

Type:: Optional[str]

txt_processo

Número do processo.

Type:: Optional[str]

vlr

Valor do documento (15,2).

Type:: Optional[float]

vlr_taxa_cambio

Taxa de câmbio (6,4).

Type:: Optional[float]

cod_credor_devedor: str | None

cod_ug_pgto: int | str | None

doc_origem: List[DocOrigemModel] | None

doc_relacionado: List[DocRelacionadoModel] | None

dt_ateste: str | None

dt_emis: str | None

dt_pgto_receb: str | None

dt_venc: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_credor_devedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'doc_origem': FieldInfo(annotation=Union[List[ForwardRef('DocOrigemModel')], NoneType], required=False, default=None), 'doc_relacionado': FieldInfo(annotation=Union[List[ForwardRef('DocRelacionadoModel')], NoneType], required=False, default=None), 'dt_ateste': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_pgto_receb': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_venc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tramite': FieldInfo(annotation=Union[List[ForwardRef('TramiteModel')], NoneType], required=False, default=None), 'txt_info_adic': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_obser': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr_taxa_cambio': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tramite: List[TramiteModel] | None

txt_info_adic: str | None

txt_obser: str | None

txt_processo: str | None

vlr: float | None

vlr_taxa_cambio: float | None

class pyarialib.siafi.models.DadosBasicosSituacaoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os dados básicos de uma Situação do CPR.

aba_permitida

Lista de abas permitidas para esta situação.

Type:: Optional[List[str]]

cod_tipo_DH

Lista de tipos de Documento Hábil permitidos.

Type:: Optional[List[str]]

codigo

Código da Situação.

Type:: Optional[str]

descricao

Descrição detalhada da situação.

Type:: Optional[str]

erro_validacao

Lista de erros de validação da situação.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

indr_estado

Estado da situação.

Type:: Optional[str]

indr_estado_validacao

Estado de validação da situação.

Type:: Optional[str]

tipo_situacao

Código do tipo de situação.

Type:: Optional[str]

titulo

Título da situação.

Type:: Optional[str]

aba_permitida: List[str] | None

cod_tipo_DH: List[str] | None

codigo: str | None

descricao: str | None

erro_validacao: List[schemas__cpr__MensagemModel] | None

indr_estado: str | None

indr_estado_validacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'aba_permitida': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'cod_tipo_DH': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'codigo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'erro_validacao': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'indr_estado': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_estado_validacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_situacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'titulo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_situacao: str | None

titulo: str | None

class pyarialib.siafi.models.DadosItemLXModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os dados de um item em uma Lista de Credores PIX (LX).

cod_favorecido

CPF ou CNPJ do favorecido.

Type:: Optional[str]

domicilio_bancario

Domicílio bancário do favorecido. Mutuamente exclusivo com “txtChavePix”.

Type:: Optional[“DomBancarioFavorecidoModel”]

nome_favorecido

Nome do favorecido.

Type:: Optional[str]

txt_chave_pix

Chave PIX do favorecido. Mutuamente exclusivo com “domicilioBancario”.

Type:: Optional[str]

vlr_item

Valor do item (15,2).

Type:: Optional[str]

cod_favorecido: str | None

domicilio_bancario: DomBancarioFavorecidoModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'domicilio_bancario': FieldInfo(annotation=Union[DomBancarioFavorecidoModel, NoneType], required=False, default=None), 'nome_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_chave_pix': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_item': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

nome_favorecido: str | None

txt_chave_pix: str | None

vlr_item: str | None

Bases: BaseModelSiafi

Detalhes de um pagamento PIX associado a uma Ordem de Pagamento.

cod_end_to_end_id

Código identificador fim-a-fim que rastreia o pagamento PIX com o BACEN.

Type:: Optional[str]

situacao

Situação do pagamento PIX (EFETIVADO, REJEITADO, etc.).

Type:: Optional[str]

txt_erro_processamento

Descrição do erro, se a situação for REJEITADO.

Type:: Optional[str]

data_liquidacao_pagto

Data da liquidação, se a situação for EFETIVADO.

Type:: Optional[str]

txt_chave_pix

Chave PIX utilizada no pagamento.

Type:: Optional[str]

cod_ispb_banco

Código ISPB do banco recebedor do pagamento PIX.

Type:: Optional[str]

num_agencia

Número da agência do recebedor do pagamento PIX.

Type:: Optional[int | str]

num_conta

Número da conta bancária do recebedor do pagamento PIX.

Type:: Optional[str]

tipo_conta

Tipo da conta do recebedor do pagamento PIX (CACC, SVGS, etc.).

Type:: Optional[str]

cod_favorecido

CPF ou CNPJ do recebedor do pagamento PIX.

Type:: Optional[str]

nome_favorecido

Nome do recebedor do pagamento PIX.

Type:: Optional[str]

cod_end_to_end_id: str | None

cod_favorecido: str | None

cod_ispb_banco: str | None

data_liquidacao_pagto: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_end_to_end_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ispb_banco': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'data_liquidacao_pagto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'nome_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_agencia': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_conta': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'situacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_conta': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_chave_pix': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_erro_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

nome_favorecido: str | None

num_agencia: int | str | None

num_conta: str | None

situacao: str | None

tipo_conta: str | None

txt_chave_pix: str | None

txt_erro_processamento: str | None

class pyarialib.siafi.models.DadosPgtoModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os dados de pagamento em um Documento Hábil.

acrescimo

Lista de acréscimos.

Type:: Optional[List[“AcrescimoModel”]]

cod_credor_devedor

Código do credor/devedor.

Type:: Optional[str]

item_recolhimento

Lista de itens de recolhimento.

Type:: Optional[List[“ItemRecolhimentoModel”]]

predoc

Dados do pré-documento (Pré-doc).

Type:: Optional[“PredocModelInput”]

vlr

Valor do pagamento (15,2).

Type:: Optional[float]

acrescimo: List[AcrescimoModel] | None

cod_credor_devedor: str | None

item_recolhimento: List[ItemRecolhimentoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acrescimo': FieldInfo(annotation=Union[List[AcrescimoModel], NoneType], required=False, default=None), 'cod_credor_devedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'item_recolhimento': FieldInfo(annotation=Union[List[ForwardRef('ItemRecolhimentoModel')], NoneType], required=False, default=None), 'predoc': FieldInfo(annotation=Union[ForwardRef('PredocModelInput'), NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

predoc: PredocModelInput | None

vlr: float | None

class pyarialib.siafi.models.DadosPgtoModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os dados de pagamento em um Documento Hábil.

acrescimo

Lista de acréscimos.

Type:: Optional[List[“AcrescimoModel”]]

cod_credor_devedor

Código do credor/devedor.

Type:: Optional[str]

item_recolhimento

Lista de itens de recolhimento.

Type:: Optional[List[“ItemRecolhimentoModel”]]

predoc

Dados do pré-documento (Pré-doc).

Type:: Optional[“PredocModelOutput”]

vlr

Valor do pagamento (15,2).

Type:: Optional[float]

acrescimo: List[AcrescimoModel] | None

cod_credor_devedor: str | None

item_recolhimento: List[ItemRecolhimentoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acrescimo': FieldInfo(annotation=Union[List[AcrescimoModel], NoneType], required=False, default=None), 'cod_credor_devedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'item_recolhimento': FieldInfo(annotation=Union[List[ForwardRef('ItemRecolhimentoModel')], NoneType], required=False, default=None), 'predoc': FieldInfo(annotation=Union[ForwardRef('PredocModelOutput'), NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

predoc: PredocModelOutput | None

vlr: float | None

class pyarialib.siafi.models.DadosRelatorioEmpenhoModel(*, ug_emitente: int | None = None, ano_empenho: int | None = None, num_empenho: int | None = None, relatorio_base64: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Dados do relatório PDF do empenho (em base64).

ug_emitente

UG emitente do empenho. Parâmetro: ugEmitente, Tipo: int, Ocorrência: [1..1], Restrição: UG.

Type:: Optional[int]

ano_empenho

Ano do empenho. Parâmetro: anoEmpenho, Tipo: int, Ocorrência: [1..1], Restrição: Ano.

Type:: Optional[int]

num_empenho

Número do empenho. Parâmetro: numEmpenho, Tipo: int, Ocorrência: [1..1], Restrição: NumNE.

Type:: Optional[int]

relatorio_base64

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.

Type:: Optional[str]

ano_empenho: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'num_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'relatorio_base64': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_empenho: int | None

relatorio_base64: str | None

ug_emitente: int | None

class pyarialib.siafi.models.DeducaoModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento de dedução em um Documento Hábil.

acrescimo

Lista de acréscimos.

Type:: Optional[List[“AcrescimoModel”]]

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_ug_pgto

Código da UG de pagamento.

Type:: Optional[int | str]

dt_pgto_receb

Data de pagamento/recebimento.

Type:: Optional[str]

dt_venc

Data de vencimento.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado. Se não informado, será True.

Type:: Optional[bool]

item_recolhimento

Lista de itens de recolhimento.

Type:: Optional[List[“ItemRecolhimentoModel”]]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

predoc

Dados do pré-documento (Pré-doc).

Type:: Optional[“PredocModelInput”]

rel_credito

Relação com itens de crédito.

Type:: Optional[List[“RelSemItemModel”]]

rel_pco_item

Relação com itens de PCO.

Type:: Optional[List[“RelComItemModel”]]

rel_pso_item

Relação com itens de PSO.

Type:: Optional[List[“RelComItemModel”]]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor da dedução (15,2).

Type:: Optional[float]

acrescimo: List[AcrescimoModel] | None

cod_sit: str | None

cod_ug_pgto: int | str | None

dt_pgto_receb: str | None

dt_venc: str | None

indr_liquidado: bool | None

item_recolhimento: List[ItemRecolhimentoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acrescimo': FieldInfo(annotation=Union[List[AcrescimoModel], NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dt_pgto_receb': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_venc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'item_recolhimento': FieldInfo(annotation=Union[List[ForwardRef('ItemRecolhimentoModel')], NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'predoc': FieldInfo(annotation=Union[ForwardRef('PredocModelInput'), NoneType], required=False, default=None), 'rel_credito': FieldInfo(annotation=Union[List[ForwardRef('RelSemItemModel')], NoneType], required=False, default=None), 'rel_pco_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemModel')], NoneType], required=False, default=None), 'rel_pso_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemModel')], NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_class_D: int | str | None

num_seq_item: int | str | None

predoc: PredocModelInput | None

rel_credito: List[RelSemItemModel] | None

rel_pco_item: List[RelComItemModel] | None

rel_pso_item: List[RelComItemModel] | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.DeducaoModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento de dedução em um Documento Hábil.

acrescimo

Lista de acréscimos.

Type:: Optional[List[“AcrescimoModel”]]

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_ug_pgto

Código da UG de pagamento.

Type:: Optional[int | str]

dt_pgto_receb

Data de pagamento/recebimento.

Type:: Optional[str]

dt_venc

Data de vencimento.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado. Se não informado, será True.

Type:: Optional[bool]

item_recolhimento

Lista de itens de recolhimento.

Type:: Optional[List[“ItemRecolhimentoModel”]]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

predoc

Dados do pré-documento (Pré-doc).

Type:: Optional[“PredocModelOutput”]

rel_credito

Relação com itens de crédito.

Type:: Optional[List[“RelSemItemModel”]]

rel_pco_item

Relação com itens de PCO.

Type:: Optional[List[“RelComItemModel”]]

rel_pso_item

Relação com itens de PSO.

Type:: Optional[List[“RelComItemModel”]]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor da dedução (15,2).

Type:: Optional[float]

acrescimo: List[AcrescimoModel] | None

cod_sit: str | None

cod_ug_pgto: int | str | None

dt_pgto_receb: str | None

dt_venc: str | None

indr_liquidado: bool | None

item_recolhimento: List[ItemRecolhimentoModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acrescimo': FieldInfo(annotation=Union[List[AcrescimoModel], NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dt_pgto_receb': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_venc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'item_recolhimento': FieldInfo(annotation=Union[List[ForwardRef('ItemRecolhimentoModel')], NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'predoc': FieldInfo(annotation=Union[ForwardRef('PredocModelOutput'), NoneType], required=False, default=None), 'rel_credito': FieldInfo(annotation=Union[List[ForwardRef('RelSemItemModel')], NoneType], required=False, default=None), 'rel_pco_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemModel')], NoneType], required=False, default=None), 'rel_pso_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemModel')], NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_class_D: int | str | None

num_seq_item: int | str | None

predoc: PredocModelOutput | None

rel_credito: List[RelSemItemModel] | None

rel_pco_item: List[RelComItemModel] | None

rel_pso_item: List[RelComItemModel] | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.DespesaAnularItemModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um item de despesa a anular dentro de um Documento Hábil.

cod_sub_item_empe

Código do Subitem do empenho.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado.

Type:: Optional[bool]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_empe

Número do empenho.

Type:: Optional[str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

rel_encargo

Relação com itens de encargo.

Type:: Optional[List[“RelSemItemValorModel”]]

rel_pco_item

Relação com itens de PCO.

Type:: Optional[List[“RelComItemValorModel”]]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor a anular (15,2).

Type:: Optional[float]

cod_sub_item_empe: str | None

indr_liquidado: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sub_item_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'rel_encargo': FieldInfo(annotation=Union[List[ForwardRef('RelSemItemValorModel')], NoneType], required=False, default=None), 'rel_pco_item': FieldInfo(annotation=Union[List[ForwardRef('RelComItemValorModel')], NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_empe: str | None

num_seq_item: int | str | None

rel_encargo: List[RelSemItemValorModel] | None

rel_pco_item: List[RelComItemValorModel] | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

vlr: float | None

class pyarialib.siafi.models.DespesaAnularModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento de despesa a anular em um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_ug_empe

Código da UG do empenho.

Type:: Optional[int | str]

despesa_anular_item

Lista de itens de despesa a anular.

Type:: Optional[List[“DespesaAnularItemModel”]]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_E

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_E

Informação de inscrição do item da Situação.

Type:: Optional[str]

cod_sit: str | None

cod_ug_empe: int | str | None

despesa_anular_item: List[DespesaAnularItemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'despesa_anular_item': FieldInfo(annotation=Union[List[DespesaAnularItemModel], NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_E': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_E': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_D: int | str | None

num_class_E: int | str | None

num_seq_item: int | str | None

txt_inscr_D: str | None

txt_inscr_E: str | None

class pyarialib.siafi.models.DespesaAnularModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento de despesa a anular em um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_ug_empe

Código da UG do empenho.

Type:: Optional[int | str]

despesa_anular_item

Lista de itens de despesa a anular.

Type:: Optional[List[“DespesaAnularItemModel”]]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_E

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_E

Informação de inscrição do item da Situação.

Type:: Optional[str]

cod_sit: str | None

cod_ug_empe: int | str | None

despesa_anular_item: List[DespesaAnularItemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'despesa_anular_item': FieldInfo(annotation=Union[List[DespesaAnularItemModel], NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_E': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_E': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_D: int | str | None

num_class_E: int | str | None

num_seq_item: int | str | None

txt_inscr_D: str | None

txt_inscr_E: str | None

Bases: BaseModelSiafi

Representa um documento de contabilização associado a um Documento Hábil.

ano_doc_cont

Ano do Documento de Contabilização.

Type:: Optional[int | str]

cod_tipo_doc_cont

Código do Tipo de Documento Contábil.

Type:: Optional[str]

cod_ug_emit

Código da UG emitente.

Type:: Optional[int]

num_doc_cont

Número do Documento de Contabilização.

Type:: Optional[str]

ano_doc_cont: int | str | None

cod_tipo_doc_cont: str | None

cod_ug_emit: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_doc_cont': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_tipo_doc_cont': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'num_doc_cont': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_doc_cont: str | None

class pyarialib.siafi.models.DocOrigemModel(*, cod_ident_emit: str | None = None, dt_emis: str | None = None, num_doc_origem: str | None = None, vlr: float | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um documento de origem (ex: nota fiscal) associado a um Documento Hábil.

cod_ident_emit

Identificação do emissor do documento (CPF/CNPJ).

Type:: Optional[str]

dt_emis

Data de emissão do documento de origem.

Type:: Optional[str]

num_doc_origem

Número do documento de origem.

Type:: Optional[str]

vlr

Valor do documento de origem (15,2).

Type:: Optional[float]

cod_ident_emit: str | None

dt_emis: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ident_emit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_doc_origem': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_doc_origem: str | None

vlr: float | None

class pyarialib.siafi.models.DocRelacionadoModel(*, cod_ug_emit: int | None = None, num_doc_relacionado: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um documento hábil já cadastrado que possui relação com o que está sendo cadastrado.

cod_ug_emit

UG emitente do documento relacionado.

Type:: Optional[int]

num_doc_relacionado

Número do documento relacionado (ex: 2025NE000123).

Type:: Optional[str]

cod_ug_emit: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ug_emit': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'num_doc_relacionado': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_doc_relacionado: str | None

Bases: BaseModelSiafi

Representa uma chave de identificação única para um Documento Hábil.

ano

Ano do documento hábil.

Type:: Optional[int | str]

numero

Número do documento hábil.

Type:: Optional[int | str]

tipo

Tipo do documento hábil.

Type:: Optional[str]

ug_emitente

UG Emitente do documento hábil.

Type:: Optional[int | str]

ano: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'numero': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tipo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero: int | str | None

tipo: str | None

ug_emitente: int | str | None

Bases: BaseModelSiafi

Representa a chave de um Documento Hábil associado a uma Ordem de Pagamento.

ano

Ano do documento hábil.

Type:: Optional[str]

numero

Número do documento hábil.

Type:: Optional[str]

tipo

Tipo do documento hábil.

Type:: Optional[str]

ug_emitente

UG Emitente do documento hábil.

Type:: Optional[int | str]

ano: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'numero': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero: str | None

tipo: str | None

ug_emitente: int | str | None

class pyarialib.siafi.models.DocumentoOrdemPagamentoModel(*, numero_documento: str | None = None, ug_emitente_documento: int | str | None = None, valor_documento: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um documento de Ordem de Pagamento gerado na realização de um compromisso.

numero_documento

Número do Documento OP Gerado.

Type:: Optional[str]

ug_emitente_documento

UG emitente do Documento OP.

Type:: Optional[int | str]

valor_documento

Valor do Documento OP Gerado.

Type:: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'valor_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

ug_emitente_documento: int | str | None

valor_documento: str | None

class pyarialib.siafi.models.DocumentoOrigemModel(*, cod_ug_documento: int | str | None = None, numero_documento: int | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para DocumentoOrigemModel.

cod_ug_documento

Campo não documentado.

Type:: Optional[int | str]

numero_documento

Campo não documentado.

Type:: Optional[int | str]

cod_ug_documento: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ug_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

Bases: BaseModelSiafi

Representa um documento SIAFI genérico.

ano_documento

Ano do documento.

Type:: Optional[int]

numero_documento

Número do documento SIAFI.

Type:: Optional[int | str]

tipo_documento

Tipo do documento SIAFI (DF, DR, GF, etc.).

Type:: Optional[str]

ug_emitente_documento

Unidade gestora emitente do documento.

Type:: Optional[int | str]

valor_documento

Valor do documento (15,2).

Type:: Optional[float]

ano_documento: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_documento': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tipo_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'valor_documento': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

tipo_documento: str | None

ug_emitente_documento: int | str | None

valor_documento: float | None

class pyarialib.siafi.models.DocumentoSIAFIOPModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um documento SIAFI associado a uma Ordem de Pagamento.

data_emissao_documento

Data de Emissão do Documento SIAFI Gerado.

Type:: Optional[str]

doc_cancelamento

Documento SIAFI de Cancelamento.

Type:: Optional[“DocumentoSIAFIRealizacaoModel”]

numero_documento

Número do Documento SIAFI Gerado.

Type:: Optional[str]

ug_emitente_documento

UG emitente do Documento SIAFI.

Type:: Optional[int | str]

valor_documento

Valor do Documento SIAFI Gerado.

Type:: Optional[str]

data_emissao_documento: str | None

doc_cancelamento: DocumentoSIAFIRealizacaoModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'data_emissao_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'doc_cancelamento': FieldInfo(annotation=Union[ForwardRef('DocumentoSIAFIRealizacaoModel'), NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'valor_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

ug_emitente_documento: int | str | None

valor_documento: str | None

class pyarialib.siafi.models.DocumentoSIAFIRealizacaoModel(*, data_emissao_documento: str | None = None, numero_documento: str | None = None, ug_emitente_documento: int | str | None = None, valor_documento: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um documento SIAFI gerado na realização ou estorno de um compromisso.

data_emissao_documento

Data de Emissão do Documento SIAFI Gerado.

Type:: Optional[str]

numero_documento

Número do Documento SIAFI Gerado.

Type:: Optional[str]

ug_emitente_documento

UG emitente do Documento SIAFI.

Type:: Optional[int | str]

valor_documento

Valor do Documento SIAFI Gerado.

Type:: Optional[str]

data_emissao_documento: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'data_emissao_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'valor_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

ug_emitente_documento: int | str | None

valor_documento: str | None

class pyarialib.siafi.models.DocumentoSIAFIResumidoModel(*, numero_documento: int | str | None = None, ug_emitente_documento: int | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um documento SIAFI de forma resumida, contendo apenas a chave.

numero_documento

Número do Documento (OP, OB, etc.).

Type:: Optional[int | str]

ug_emitente_documento

UG emitente do Documento.

Type:: Optional[int | str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'ug_emitente_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

ug_emitente_documento: int | str | None

class pyarialib.siafi.models.DocumentoSiafiModel(*, ano: int | str | None = None, numero_documento: int | str | None = None, cod_ug_emit: int | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para DocumentoSiafiModel.

ano

Ano do documento PF (int, 4 dígitos)

Type:: Optional[int | str]

numero_documento

Número do documento SIAFI (int, 1-6)

Type:: Optional[int | str]

cod_ug_emit

Unidade Gestora Emitente do documento (int, 1-6)

Type:: Optional[int | str]

ano: int | str | None

cod_ug_emit: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

Bases: BaseModelSiafi

Representa o domicílio bancário de um favorecido.

banco

Código do banco.

Type:: Optional[int | str]

agencia

Número da agência.

Type:: Optional[int | str]

conta

Número da conta do favorecido.

Type:: Optional[str]

agencia: int | str | None

banco: int | str | None

conta: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'agencia': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'banco': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'conta': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Bases: BaseModelSiafi

Representa o domicílio bancário de uma UG Pagadora.

agencia

Número da agência.

Type:: Optional[int | str]

banco

Código do banco.

Type:: Optional[int | str]

conta

Número da conta da UG Pagadora.

Type:: Optional[str]

agencia: int | str | None

banco: int | str | None

conta: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'agencia': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'banco': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'conta': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.EncargoModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento de encargo em um Documento Hábil.

acrescimo

Lista de acréscimos.

Type:: Optional[List[“AcrescimoModel”]]

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_sub_item_empe

Código do Subitem do empenho.

Type:: Optional[int | str]

cod_ug_empe

Código da UG do empenho.

Type:: Optional[int | str]

cod_ug_pgto

Código da UG de pagamento.

Type:: Optional[int | str]

dt_pgto_receb

Data de pagamento/recebimento.

Type:: Optional[str]

dt_venc

Data de vencimento.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

item_recolhimento

Item de recolhimento.

Type:: Optional[“ItemRecolhimentoModel”]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_empe

Número do empenho.

Type:: Optional[str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

predoc

Dados do pré-documento (Pré-doc).

Type:: Optional[“PredocModelInput”]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do encargo (15,2).

Type:: Optional[float]

acrescimo: List[AcrescimoModel] | None

cod_sit: str | None

cod_sub_item_empe: int | str | None

cod_ug_empe: int | str | None

cod_ug_pgto: int | str | None

dt_pgto_receb: str | None

dt_venc: str | None

indr_liquidado: bool | None

item_recolhimento: ItemRecolhimentoModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acrescimo': FieldInfo(annotation=Union[List[AcrescimoModel], NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sub_item_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dt_pgto_receb': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_venc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'item_recolhimento': FieldInfo(annotation=Union[ForwardRef('ItemRecolhimentoModel'), NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'predoc': FieldInfo(annotation=Union[ForwardRef('PredocModelInput'), NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_empe: str | None

num_seq_item: int | str | None

predoc: PredocModelInput | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

vlr: float | None

class pyarialib.siafi.models.EncargoModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento de encargo em um Documento Hábil.

acrescimo

Lista de acréscimos.

Type:: Optional[List[“AcrescimoModel”]]

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_sub_item_empe

Código do Subitem do empenho.

Type:: Optional[int | str]

cod_ug_empe

Código da UG do empenho.

Type:: Optional[int | str]

cod_ug_pgto

Código da UG de pagamento.

Type:: Optional[int | str]

dt_pgto_receb

Data de pagamento/recebimento.

Type:: Optional[str]

dt_venc

Data de vencimento.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

item_recolhimento

Item de recolhimento.

Type:: Optional[“ItemRecolhimentoModel”]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_empe

Número do empenho.

Type:: Optional[str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

predoc

Dados do pré-documento (Pré-doc).

Type:: Optional[“PredocModelOutput”]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do encargo (15,2).

Type:: Optional[float]

acrescimo: List[AcrescimoModel] | None

cod_sit: str | None

cod_sub_item_empe: int | str | None

cod_ug_empe: int | str | None

cod_ug_pgto: int | str | None

dt_pgto_receb: str | None

dt_venc: str | None

indr_liquidado: bool | None

item_recolhimento: ItemRecolhimentoModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acrescimo': FieldInfo(annotation=Union[List[AcrescimoModel], NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sub_item_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dt_pgto_receb': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_venc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'item_recolhimento': FieldInfo(annotation=Union[ForwardRef('ItemRecolhimentoModel'), NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'predoc': FieldInfo(annotation=Union[ForwardRef('PredocModelOutput'), NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_empe: str | None

num_seq_item: int | str | None

predoc: PredocModelOutput | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

vlr: float | None

class pyarialib.siafi.models.EventoSituacaoModel(*, cod_evento: str | None = None, cod_RF_classif_contabil1: str | None = None, cod_RF_classif_contabil2: str | None = None, cod_RF_classif_orcamentaria1: str | None = None, cod_RF_classif_orcamentaria2: str | None = None, cod_RF_inscricao1: str | None = None, cod_RF_inscricao2: str | None = None, cod_tipo_evento: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um evento de contabilização associado a uma situação do CPR.

cod_evento

Código do evento contábil.

Type:: Optional[str]

cod_RF_classif_contabil1

Código da regra de formatação para classificação contábil 1.

Type:: Optional[str]

cod_RF_classif_contabil2

Código da regra de formatação para classificação contábil 2.

Type:: Optional[str]

cod_RF_classif_orcamentaria1

Código da regra de formatação para classificação orçamentária 1.

Type:: Optional[str]

cod_RF_classif_orcamentaria2

Código da regra de formatação para classificação orçamentária 2.

Type:: Optional[str]

cod_RF_inscricao1

Código da regra de formatação para inscrição 1.

Type:: Optional[str]

cod_RF_inscricao2

Código da regra de formatação para inscrição 2.

Type:: Optional[str]

cod_tipo_evento

Código do tipo de evento.

Type:: Optional[str]

cod_RF_classif_contabil1: str | None

cod_RF_classif_contabil2: str | None

cod_RF_classif_orcamentaria1: str | None

cod_RF_classif_orcamentaria2: str | None

cod_RF_inscricao1: str | None

cod_RF_inscricao2: str | None

cod_evento: str | None

cod_tipo_evento: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_RF_classif_contabil1': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_RF_classif_contabil2': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_RF_classif_orcamentaria1': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_RF_classif_orcamentaria2': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_RF_inscricao1': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_RF_inscricao2': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_evento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_tipo_evento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.HTTPValidationError(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para HTTPValidationError.

detail

Campo não documentado.

Type:: Optional[List[“ValidationError”]]

detail: List[ValidationError] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=Union[List[ForwardRef('ValidationError')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.IncluirAmparoLegalRequestModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Request para inclusão de Amparo Legal.

orc_amparo_legal_dados

Dados do Amparo Legal a ser incluído.

Type:: Optional[“OrcAmparoLegalDadosModel”]

motivo

Motivo da inclusão.

Type:: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'orc_amparo_legal_dados': FieldInfo(annotation=Union[ForwardRef('OrcAmparoLegalDadosModel'), NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

motivo: str | None

orc_amparo_legal_dados: OrcAmparoLegalDadosModel | None

class pyarialib.siafi.models.IncluirEmpenhoRequestModel(**extra_data: Any)[código fonte]

Bases: 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.

ano_empenho: int | None

celula_orcamentaria: CelulaOrcamentariaModel | None

cod_amparo_legal: int | None

cod_favorecido: str | None

cod_tipo_transf: int | None

dt_emis: str | None

item_empenho: List[ItemEmpenhoModelInput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'celula_orcamentaria': FieldInfo(annotation=Union[CelulaOrcamentariaModel, NoneType], required=False, default=None), 'cod_amparo_legal': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_tipo_transf': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'item_empenho': FieldInfo(annotation=Union[List[ForwardRef('ItemEmpenhoModelInput')], NoneType], required=False, default=None), 'num_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'passivo_anterior': FieldInfo(annotation=Union[ForwardRef('PassivoAnteriorModelInput'), NoneType], required=False, default=None), 'pre_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'transferencia': FieldInfo(annotation=Union[List[ForwardRef('TransferenciaModel')], NoneType], required=False, default=None), 'txt_descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_info_compl': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_local_entrega': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'vlr_empenho': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None), 'vlr_taxa_cambio': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_empenho: int | None

passivo_anterior: PassivoAnteriorModelInput | None

pre_empenho: str | None

tipo_empenho: int | None

transferencia: List[TransferenciaModel] | None

txt_descricao: str | None

txt_info_compl: str | None

txt_local_entrega: str | None

txt_processo: str | None

ug_emitente: int | None

vlr_empenho: float | str | None

vlr_taxa_cambio: float | str | None

Bases: 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.

ano_pre_empenho: int | None

celula_orcamentaria: CelulaOrcamentariaModel | None

cod_favorecido: str | None

dt_emis: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_pre_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'celula_orcamentaria': FieldInfo(annotation=Union[CelulaOrcamentariaModel, NoneType], required=False, default=None), 'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_pre_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'vlr_pre_empenho': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None), 'vlr_taxa_cambio': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_pre_empenho: int | None

txt_descricao: str | None

txt_processo: str | None

ug_emitente: int | None

vlr_pre_empenho: float | str | None

vlr_taxa_cambio: float | str | None

class pyarialib.siafi.models.IndicadoresModel(*, aba_anular: str | None = None, cod_sit_compensavel: List[str] | None = None, cod_sit_credito_relacionado: List[str] | None = None, cod_sit_PF_relacionada: str | None = None, indr_compensavel: bool | None = None, indr_contabilizacao_CPR: str | None = None, indr_doc_realizacao_comp: str | None = None, indr_efeito_centro_custo: str | None = None, indr_exige_NDD_centro_custo: bool | None = None, indr_geracao_comp: List[str] | None = None, indr_integra_liquido_comp: bool | None = None, indr_natureza: str | None = None, indr_permite_contrato: bool | None = None, indr_permite_cron_baixa_pat: bool | None = None, indr_permite_desp_antecipada: bool | None = None, indr_permite_estorno_normal: bool | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os indicadores de comportamento de uma situação do CPR.

aba_anular

Indica a aba para anulação.

Type:: Optional[str]

cod_sit_compensavel

Lista de códigos de situação compensáveis.

Type:: Optional[List[str]]

cod_sit_credito_relacionado

Lista de códigos de situação de crédito relacionados.

Type:: Optional[List[str]]

cod_sit_PF_relacionada

Código de situação de Programação Financeira relacionada.

Type:: Optional[str]

indr_compensavel

Indica se é compensável.

Type:: Optional[bool]

indr_contabilizacao_CPR

Indicador do tipo de contabilização no CPR.

Type:: Optional[str]

indr_doc_realizacao_comp

Indicador do tipo de documento de realização de compromisso.

Type:: Optional[str]

indr_efeito_centro_custo

Indicador do efeito no centro de custo.

Type:: Optional[str]

indr_exige_NDD_centro_custo

Indica se exige Natureza de Despesa Detalhada no centro de custo.

Type:: Optional[bool]

indr_geracao_comp

Indicador do tipo de geração de compromisso.

Type:: Optional[List[str]]

indr_integra_liquido_comp

Indica se integra o líquido do compromisso.

Type:: Optional[bool]

indr_natureza

Indicador da natureza da situação.

Type:: Optional[str]

indr_permite_contrato

Indica se permite contrato.

Type:: Optional[bool]

indr_permite_cron_baixa_pat

Indica se permite cronograma de baixa patrimonial.

Type:: Optional[bool]

indr_permite_desp_antecipada

Indica se permite despesa antecipada.

Type:: Optional[bool]

indr_permite_estorno_normal

Indica se permite estorno normal.

Type:: Optional[bool]

aba_anular: str | None

cod_sit_PF_relacionada: str | None

cod_sit_compensavel: List[str] | None

cod_sit_credito_relacionado: List[str] | None

indr_compensavel: bool | None

indr_contabilizacao_CPR: str | None

indr_doc_realizacao_comp: str | None

indr_efeito_centro_custo: str | None

indr_exige_NDD_centro_custo: bool | None

indr_geracao_comp: List[str] | None

indr_integra_liquido_comp: bool | None

indr_natureza: str | None

indr_permite_contrato: bool | None

indr_permite_cron_baixa_pat: bool | None

indr_permite_desp_antecipada: bool | None

indr_permite_estorno_normal: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'aba_anular': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit_PF_relacionada': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit_compensavel': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'cod_sit_credito_relacionado': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'indr_compensavel': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_contabilizacao_CPR': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_doc_realizacao_comp': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_efeito_centro_custo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_exige_NDD_centro_custo': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_geracao_comp': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'indr_integra_liquido_comp': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_natureza': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_permite_contrato': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_permite_cron_baixa_pat': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_permite_desp_antecipada': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_permite_estorno_normal': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Bases: BaseModelSiafi

Schema para ItemCLTModel-Input.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int | str]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int | str]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int | str]

mes_programacao

Mês da Programação Financeira (string, 1-2)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | str | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

mes_programacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'mes_programacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | str | None

txt_class_B: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemCLTModel-Output.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

mes_programacao

Mês da Programação Financeira (string, 1-2)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

mes_programacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'mes_programacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.ItemCompromissoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um item de um compromisso financeiro.

codigo_categoria_gasto

Código da categoria de gasto.

Type:: Optional[int | str]

codigo_item_compromisso

Identificador único do item de compromisso.

Type:: Optional[int | str]

codigo_resultado_primario

Código do Indicador de Resultado Primário do Empenho.

Type:: Optional[int | str]

doc_realiz_liquid

Lista de documentos de realização/liquidação.

Type:: Optional[List[“DocumentoSIAFIModel”]]

empenho

Número do empenho.

Type:: Optional[str]

fonte_recurso

Fonte de recurso.

Type:: Optional[str]

valor_cancelado_fora_cpr

Valor cancelado fora do CPR para o item.

Type:: Optional[str]

valor_realizado

Valor realizado do item de compromisso.

Type:: Optional[str]

valor_realizado_fora_cpr

Valor realizado fora do CPR para o item.

Type:: Optional[str]

valor_realizavel

Valor realizável do item de compromisso.

Type:: Optional[str]

valor_total

Valor total do item de compromisso.

Type:: Optional[str]

vinculacoes

Lista de vinculações.

Type:: Optional[List[“VinculacaoModel”]]

codigo_categoria_gasto: int | str | None

codigo_item_compromisso: int | str | None

codigo_resultado_primario: int | str | None

doc_realiz_liquid: List[DocumentoSIAFIModel] | None

empenho: str | None

fonte_recurso: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_categoria_gasto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'codigo_item_compromisso': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'codigo_resultado_primario': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'doc_realiz_liquid': FieldInfo(annotation=Union[List[DocumentoSIAFIModel], NoneType], required=False, default=None), 'empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'fonte_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_cancelado_fora_cpr': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_realizado': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_realizado_fora_cpr': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_realizavel': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_total': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vinculacoes': FieldInfo(annotation=Union[List[ForwardRef('VinculacaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

valor_cancelado_fora_cpr: str | None

valor_realizado: str | None

valor_realizado_fora_cpr: str | None

valor_realizavel: str | None

valor_total: str | None

vinculacoes: List[VinculacaoModel] | None

class pyarialib.siafi.models.ItemCompromissoRealizacaoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um item de compromisso a ser realizado.

codigo_item_compromisso

Identificador único do item de compromisso.

Type:: Optional[int | str]

vinculacoes

Lista de vinculações para a realização.

Type:: Optional[List[“VinculacaoModel”]]

codigo_item_compromisso: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_item_compromisso': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vinculacoes': FieldInfo(annotation=Union[List[ForwardRef('VinculacaoModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

vinculacoes: List[VinculacaoModel] | None

class pyarialib.siafi.models.ItemDRFDevolucaoModel(*, vlr: float | None = None, codigo_item_PF_origem: int | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ItemDRFDevolucaoModel.

vlr

Campo não documentado.

Type:: Optional[float]

codigo_item_PF_origem

Identificador do item PF de origem. Obtenha do endpoint /detalhar-programacao-financeira

Type:: Optional[int | str]

codigo_item_PF_origem: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_item_PF_origem': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemDRFModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

mes_programacao

Mês da Programação Financeira (string, 1-2)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

mes_programacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'mes_programacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.ItemEmpenhoModelInput(**extra_data: Any)[código fonte]

Bases: 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[“OperacaoItemEmpenhoModelInput”]): Operação aplicada no item de empenho.

cod_sub_elemento: str | None

descricao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sub_elemento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'operacao_item_empenho': FieldInfo(annotation=Union[OperacaoItemEmpenhoModelInput, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | None

operacao_item_empenho: OperacaoItemEmpenhoModelInput | None

class pyarialib.siafi.models.ItemEmpenhoModelOutput(**extra_data: Any)[código fonte]

Bases: 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.

cod_sub_elemento: str | None

descricao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sub_elemento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'operacao_item_empenho': FieldInfo(annotation=Union[ForwardRef('OperacaoItemEmpenhoModelOutput'), NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | None

operacao_item_empenho: OperacaoItemEmpenhoModelOutput | None

class pyarialib.siafi.models.ItemLXDetalheModel(*, dados_item_LX: DadosItemLXModel | None = None, dados_pagamento_PIX: DadosPagamentoPIXModel | None = None, doc_siafi_cancelamento: DocumentoSIAFIResumidoModel | None = None, num_seq_item: int | str | None = None, tipo_cancelamento: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa o detalhe de um item de uma Lista de Credores PIX (LX).

dados_item_LX

Dados do item da lista LX.

Type:: Optional[“DadosItemLXModel”]

dados_pagamento_PIX

Dados do pagamento PIX, retornado quando o item entrou em processo de pagamento.

Type:: Optional[“DadosPagamentoPIXModel”]

doc_siafi_cancelamento

Documento contábil gerado para o cancelamento, caso o pagamento não tenha sido efetivado.

Type:: Optional[“DocumentoSIAFIResumidoModel”]

num_seq_item

Número sequencial do item.

Type:: Optional[int | str]

tipo_cancelamento

Identifica o tipo de cancelamento na contabilidade, caso o pagamento não tenha sido efetivado.

Type:: Optional[str]

dados_item_LX: DadosItemLXModel | None

dados_pagamento_PIX: DadosPagamentoPIXModel | None

doc_siafi_cancelamento: DocumentoSIAFIResumidoModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dados_item_LX': FieldInfo(annotation=Union[DadosItemLXModel, NoneType], required=False, default=None), 'dados_pagamento_PIX': FieldInfo(annotation=Union[DadosPagamentoPIXModel, NoneType], required=False, default=None), 'doc_siafi_cancelamento': FieldInfo(annotation=Union[DocumentoSIAFIResumidoModel, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tipo_cancelamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

tipo_cancelamento: str | None

class pyarialib.siafi.models.ItemLXErroModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um erro ocorrido em um item de uma Lista de Credores PIX (LX) durante a manutenção.

mensagem

Lista de mensagens de erro para o item.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

num_seq_item

Sequencial do item da lista LX em que ocorreu o erro.

Type:: Optional[int | str]

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

class pyarialib.siafi.models.ItemLXModel(*, dados_item_LX: DadosItemLXModel | None = None, num_seq_item: int | str | None = None, tipo_operacao_item: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um item a ser mantido (incluído, alterado, excluído) em uma Lista de Credores PIX (LX).

dados_item_LX

Dados do item da lista LX.

Type:: Optional[“DadosItemLXModel”]

num_seq_item

Identificador do item. Não pode ser repetido na mesma lista LX.

Type:: Optional[int | str]

tipo_operacao_item

Tipo de operação a ser aplicada no item (INCLUSAO, ALTERACAO, EXCLUSAO).

Type:: Optional[str]

dados_item_LX: DadosItemLXModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dados_item_LX': FieldInfo(annotation=Union[DadosItemLXModel, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tipo_operacao_item': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

tipo_operacao_item: str | None

class pyarialib.siafi.models.ItemMovLimiteModel(*, tipo_mov_lim: int | None = None, inscricao1: str | None = None, vlr_limite: float | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Item de movimentação de limite plurianual.

tipo_mov_lim

Tipo de movimentação, conforme parametrizado na transação >CONEVELIMI.

Type:: Optional[int]

inscricao1

Exercício ou identificação da cota. Tamanho: 1-4.

Type:: Optional[str]

vlr_limite

Valor do limite. Decimal, 2 casas decimais, 15 inteiros.

Type:: Optional[float | str]

inscricao1: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'inscricao1': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_mov_lim': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'vlr_limite': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_mov_lim: int | None

vlr_limite: float | str | None

Bases: BaseModelSiafi

Schema para ItemPADModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_prevista

Data prevista para liberação do recurso financeiro (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_prevista: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_prevista': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPAPModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_liberacao

Data da liberação do recurso financeiro (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_liberacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_liberacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPARModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

indr_limite_saque

Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque

Type:: Optional[bool]

mes_lib_tran

Mês em que o recurso foi liberado ou transferido (string, 1-2)

Type:: Optional[str]

celula_de

Célula financeira “De” relativa à origem do remanejamento

Type:: Optional[“CelulaFinanceiraModel”]

celula_de: CelulaFinanceiraModel | None

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

indr_limite_saque: bool | None

mes_lib_tran: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'celula_de': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'indr_limite_saque': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'mes_lib_tran': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPCAModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_liberacao

Data da liberação do recurso financeiro (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_liberacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_liberacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPCDModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_prevista

Data Prevista para liberação do recurso financeiro (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_prevista: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_prevista': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPCRModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

indr_limite_saque

Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque

Type:: Optional[bool]

mes_lib_tran

Mês em que o recurso foi liberado ou transferido (string, 1-2)

Type:: Optional[str]

celula_de

Célula financeira “De” relativa à origem do remanejamento

Type:: Optional[“CelulaFinanceiraModel”]

celula_de: CelulaFinanceiraModel | None

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

indr_limite_saque: bool | None

mes_lib_tran: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'celula_de': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'indr_limite_saque': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'mes_lib_tran': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPCSModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_liberacao

Data prevista para liberação do recurso financeiro solicitado (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_liberacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_liberacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPFDTOModel.

data_processamento

Data de processamento (date, opcional)

Type:: Optional[str]

vlr

Valor (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código Fonte Recursos (int, 1-10)

Type:: Optional[int | str]

cod_ctgo_gasto

Código Categoria de Gastos (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação (string, 6)

Type:: Optional[str]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int | str]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int | str]

cod_ctgo_gasto: str | None

cod_font_recur: int | str | None

cod_sit: str | None

cod_vinc: int | None

data_processamento: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_class_A: int | str | None

txt_class_B: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPLBModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_liberacao

Data da liberação do recurso financeiro (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_liberacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_liberacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPRDModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

indr_limite_saque

Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque

Type:: Optional[bool]

mes_lib_tran

Mês em que o recurso foi liberado ou transferido (string, 1-2)

Type:: Optional[str]

celula_de

Célula financeira “De” relativa à origem do remanejamento

Type:: Optional[“CelulaFinanceiraModel”]

celula_de: CelulaFinanceiraModel | None

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

indr_limite_saque: bool | None

mes_lib_tran: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'celula_de': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'indr_limite_saque': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'mes_lib_tran': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPSLModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

data_prevista

Data prevista para liberação do recurso financeiro (AAAA-MM-DD)

Type:: Optional[str]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

data_prevista: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'data_prevista': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemPSRModel.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

indr_limite_saque

Indicador de limite de saque (booleano): 0 – sem limite de saque, 1 – com limite de saque

Type:: Optional[bool]

mes_lib_tran

Mês em que o recurso foi liberado ou transferido (string, 1-2)

Type:: Optional[str]

celula_de

Célula financeira “De” relativa à origem do remanejamento

Type:: Optional[“CelulaFinanceiraModel”]

celula_de: CelulaFinanceiraModel | None

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

indr_limite_saque: bool | None

mes_lib_tran: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'celula_de': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'indr_limite_saque': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'mes_lib_tran': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Representa um item de recolhimento em um Documento Hábil.

cod_recolhedor

Código do recolhedor (CPF, CNPJ, etc.).

Type:: Optional[str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

vlr

Valor do recolhimento (15,2).

Type:: Optional[float]

vlr_atm_multa_juros

Valor de atualização monetária, multa e juros (15,2).

Type:: Optional[str]

vlr_base_calculo

Valor da base de cálculo (15,2).

Type:: Optional[str]

vlr_juros

Valor dos juros (15,2).

Type:: Optional[str]

vlr_multa

Valor da multa (15,2).

Type:: Optional[str]

vlr_outras_ent

Valor de outras entidades (15,2).

Type:: Optional[str]

cod_recolhedor: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_recolhedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'vlr_atm_multa_juros': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_base_calculo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_juros': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_multa': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_outras_ent': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

vlr: float | None

vlr_atm_multa_juros: str | None

vlr_base_calculo: str | None

vlr_juros: str | None

vlr_multa: str | None

vlr_outras_ent: str | None

Bases: BaseModelSiafi

Schema para ItemTRFModel-Input.

vlr

Campo não documentado.

Type:: Optional[float]

cod_vinc

Campo não documentado.

Type:: Optional[int]

cod_font_recur

Campo não documentado.

Type:: Optional[int | str]

cod_ctgo_gasto

Campo não documentado.

Type:: Optional[str]

cod_sit

Campo não documentado.

Type:: Optional[str]

txt_inscr_A

Campo não documentado.

Type:: Optional[str]

txt_inscr_B

Campo não documentado.

Type:: Optional[str]

txt_inscr_C

Campo não documentado.

Type:: Optional[str]

txt_inscr_D

Campo não documentado.

Type:: Optional[str]

txt_class_A

Campo não documentado.

Type:: Optional[int | str]

txt_class_B

Campo não documentado.

Type:: Optional[int | str]

cod_ctgo_gasto: str | None

cod_font_recur: int | str | None

cod_sit: str | None

cod_vinc: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_class_A: int | str | None

txt_class_B: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Schema para ItemTRFModel-Output.

vlr

Valor do item PF (decimal, 1-17)

Type:: Optional[float]

cod_vinc

Código da Vinculação de Pagamento (int, 1-3)

Type:: Optional[int]

cod_font_recur

Código da Fonte de Recurso (int, 1-10)

Type:: Optional[int]

cod_ctgo_gasto

Código da Categoria de Gasto (string, 1)

Type:: Optional[str]

cod_sit

Código da Situação contábil (string, 6)

Type:: Optional[str]

cod_recurso

Código do Recurso (string, 1)

Type:: Optional[str]

codigo_item_PF

Identificador do item PF (long, 1-10)

Type:: Optional[int]

saldo_item_PF

Saldo do item PF (decimal, 1-17)

Type:: Optional[float]

txt_inscr_A

Inscrição A (string, 1-28)

Type:: Optional[str]

txt_inscr_B

Inscrição B (string, 1-28)

Type:: Optional[str]

txt_inscr_C

Inscrição C (string, 1-28)

Type:: Optional[str]

txt_inscr_D

Inscrição D (string, 1-28)

Type:: Optional[str]

txt_class_A

Classificação A (int, 1-9)

Type:: Optional[int]

txt_class_B

Classificação B (int, 1-9)

Type:: Optional[int]

cod_ctgo_gasto: str | None

cod_font_recur: int | None

cod_recurso: str | None

cod_sit: str | None

cod_vinc: int | None

codigo_item_PF: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_vinc': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo_item_PF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'saldo_item_PF': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'txt_class_A': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_class_B': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo_item_PF: float | None

txt_class_A: int | None

txt_class_B: int | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.OperacaoBaixaSaldoModel(*, data_operacao: str | None = None, tipo_operacao_item_empenho: str | None = None, vlr_total: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Operação de baixa de saldo de empenho do exercício anterior.

data_operacao

Data da operação.

Type:: Optional[str]

tipo_operacao_item_empenho

Tipo da operação.

Type:: Optional[str]

vlr_total

Valor total da operação.

Type:: Optional[str]

data_operacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'data_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_operacao_item_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_total': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_operacao_item_empenho: str | None

vlr_total: str | None

Bases: 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[float | str]): Quantidade do item de empenho. [1..1] QtdItemEmp. vlr_unitario (Optional[float | str]): Valor unitário do item de empenho. [1..1] ValorUnitarioItemEmp. vlr_operacao (Optional[float | 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.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'quantidade': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None), 'tipo_operacao_item_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_operacao': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None), 'vlr_unitario': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

quantidade: float | str | None

tipo_operacao_item_empenho: str | None

vlr_operacao: float | str | None

vlr_unitario: float | str | None

class pyarialib.siafi.models.OperacaoItemEmpenhoModelOutput(*, tipo_operacao_item_empenho: str | None = None, quantidade: str | None = None, vlr_unitario: str | None = None, vlr_operacao: str | None = None, **extra_data: Any)[código fonte]

Bases: 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.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'quantidade': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_operacao_item_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_unitario': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

quantidade: str | None

tipo_operacao_item_empenho: str | None

vlr_operacao: str | None

vlr_unitario: str | None

class pyarialib.siafi.models.OperacaoPreEmpenhoDetalheModel(*, dt_operacao: str | None = None, tipo_operacao: str | None = None, vlr_operacao: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Operação aplicada em pré-empenho (detalhamento).

dt_operacao

Data da operação.

Type:: Optional[str]

tipo_operacao

Tipo da operação.

Type:: Optional[str]

vlr_operacao

Valor da operação.

Type:: Optional[str]

dt_operacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dt_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_operacao: str | None

vlr_operacao: str | None

class pyarialib.siafi.models.OperacaoPreEmpenhoModel(*, tipo_operacao: str | None = None, vlr_operacao: float | str | None = None, **extra_data: Any)[código fonte]

Bases: 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.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'tipo_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_operacao': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_operacao: str | None

vlr_operacao: float | str | None

class pyarialib.siafi.models.OrcAmparoLegalDadosModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Dados do Amparo Legal a ser incluído ou alterado.

cod_modalidade_licitacao

Código da Modalidade de Licitação.

Type:: Optional[int]

ato_normativo

Descrição do Ato Normativo.

Type:: Optional[str]

artigo

Artigo do Ato Normativo.

Type:: Optional[str]

paragrafo

Parágrafo do Ato Normativo.

Type:: Optional[str]

inciso

Inciso do Ato Normativo.

Type:: Optional[str]

alinea

Alínea do Ato Normativo.

Type:: Optional[str]

restricao

Lista de restrições de uso do Amparo Legal.

Type:: Optional[List[“RestricaoAmparoLegalModel”]]

alinea: str | None

artigo: str | None

ato_normativo: str | None

cod_modalidade_licitacao: int | None

inciso: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'alinea': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'artigo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ato_normativo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_modalidade_licitacao': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'inciso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'paragrafo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'restricao': FieldInfo(annotation=Union[List[RestricaoAmparoLegalModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

paragrafo: str | None

restricao: List[RestricaoAmparoLegalModel] | None

class pyarialib.siafi.models.OrcAmparoLegalRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta das operações de Amparo Legal (incluir, alterar, excluir, reincluir).

cod_amparo_legal

Código do Amparo Legal gerado ou alterado.

Type:: Optional[int]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__orcamentario__MensagemModel”]]

cod_amparo_legal: int | None

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_amparo_legal': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Bases: BaseModelSiafi

Dados da baixa de saldo de empenho do exercício anterior.

ug_emitente

Código da UG emitente do empenho.

Type:: Optional[int | str]

ano_empenho

Ano do empenho.

Type:: Optional[int | str]

num_empenho

Número do empenho.

Type:: Optional[int | str]

txt_info_compl

Informação complementar.

Type:: Optional[str]

sistema_origem

Sistema de origem.

Type:: Optional[str]

operacao_baixa_saldo

Lista de operações de baixa de saldo.

Type:: Optional[List[“OperacaoBaixaSaldoModel”]]

ano_empenho: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_empenho': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_empenho': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'operacao_baixa_saldo': FieldInfo(annotation=Union[List[OperacaoBaixaSaldoModel], NoneType], required=False, default=None), 'sistema_origem': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_info_compl': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_empenho: int | str | None

operacao_baixa_saldo: List[OperacaoBaixaSaldoModel] | None

sistema_origem: str | None

txt_info_compl: str | None

ug_emitente: int | str | None

class pyarialib.siafi.models.OrcConsultarBaixaSaldoEmpenhoExercAnteriorRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta da consulta de baixa de saldo de empenho do exercício anterior.

baixa_saldo

Dados da baixa de saldo.

Type:: Optional[“OrcBaixaSaldoEmpenhoExercAnteriorDadosModel”]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__orcamentario__MensagemModel”]]

baixa_saldo: OrcBaixaSaldoEmpenhoExercAnteriorDadosModel | None

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'baixa_saldo': FieldInfo(annotation=Union[OrcBaixaSaldoEmpenhoExercAnteriorDadosModel, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.OrcConsultarRelatorioEmpenhoRespostaModel(**extra_data: Any)[código fonte]

Bases: 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: DadosRelatorioEmpenhoModel | None

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dados_relatorio': FieldInfo(annotation=Union[DadosRelatorioEmpenhoModel, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.OrcDetalharEmpenhoRespostaModel(**extra_data: Any)[código fonte]

Bases: 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: OrcEmpenhoDadosModel | None

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'empenho': FieldInfo(annotation=Union[ForwardRef('OrcEmpenhoDadosModel'), NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.OrcDetalharPreEmpenhoRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta do detalhamento de pré-empenho.

pre_empenho

Campo não documentado.

Type:: Optional[“OrcPreEmpenhoDetalheModel”]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__orcamentario__MensagemModel”]]

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None), 'pre_empenho': FieldInfo(annotation=Union[ForwardRef('OrcPreEmpenhoDetalheModel'), NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

pre_empenho: OrcPreEmpenhoDetalheModel | None

class pyarialib.siafi.models.OrcEmpenhoDadosModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Dados do Empenho conforme Parâmetro Tipo ugEmitente str/int anoEmpenho int numEmpenho str/int preEmpenho str tipoEmpenho str/int celulaOrcamentaria dtEmis str txtProcesso str vlrTaxaCambio Decimal vlrEmpenho Decimal codFavorecido str codAmparoLegal str/int txtInfoCompl str codTipoTransf str/int txtLocalEntrega str txtDescricao str passivoAnterior itemEmpenho WSDL ns2:OrcEmpenhoDados. Ocorrência Restrição Observação [1..1] UG Código da UG emitente do empenho [1..1] Ano Ano do empenho [1..1] NumNE Número do empenho [0..1] PE Número do pré-empenho, se houver [1..1] TipoEmpenho Tipo do empenho CelulaOrcamentariaModel [1..1] - Dados da célula orçamentária [1..1] Date Data de emissão (AAAA-MM-DD) [0..1] Processo Processo associado [0..1] TaxaCambio Taxa de câmbio [1..1] Valor Valor do empenho [1..1] Favorecido Código do favorecido [0..1] AmparoLegal Código do amparo legal [0..1] InformacaoComplementar Informação complementar [0..1] TipoTransferencia Código do tipo de transferência [0..1] LocalEntrega Local de entrega [0..1] DescricaoEmpenho Descrição do empenho PassivoAnteriorModel [0..1] - Dados de passivo anterior 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.

ano_empenho: int | None

celula_orcamentaria: CelulaOrcamentariaModel | None

cod_amparo_legal: int | str | None

cod_favorecido: str | None

cod_tipo_transf: int | str | None

dt_emis: str | None

item_empenho: List[ItemEmpenhoModelOutput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_empenho': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'celula_orcamentaria': FieldInfo(annotation=Union[CelulaOrcamentariaModel, NoneType], required=False, default=None), 'cod_amparo_legal': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_tipo_transf': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'item_empenho': FieldInfo(annotation=Union[List[ItemEmpenhoModelOutput], NoneType], required=False, default=None), 'num_empenho': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'passivo_anterior': FieldInfo(annotation=Union[ForwardRef('PassivoAnteriorModelOutput'), NoneType], required=False, default=None), 'pre_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_empenho': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_info_compl': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_local_entrega': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_taxa_cambio': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_empenho: int | str | None

passivo_anterior: PassivoAnteriorModelOutput | None

pre_empenho: str | None

tipo_empenho: int | str | None

txt_descricao: str | None

txt_info_compl: str | None

txt_local_entrega: str | None

txt_processo: str | None

ug_emitente: int | str | None

vlr_empenho: str | None

vlr_taxa_cambio: str | None

class pyarialib.siafi.models.OrcEmpenhoRespostaModel(**extra_data: Any)[código fonte]

Bases: 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.

documento_RO: str | None

empenho: str | None

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_RO': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

ug_emitente: int | str | None

class pyarialib.siafi.models.OrcPreEmpenhoDetalheModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Dados completos do pré-empenho detalhado.

ug_emitente

Código da UG emitente do pré-empenho.

Type:: Optional[int | str]

ano_pre_empenho

Ano do pré-empenho.

Type:: Optional[int | str]

num_pre_empenho

Número do pré-empenho.

Type:: Optional[int | str]

empenho_relacionado

Lista de empenhos relacionados.

Type:: Optional[List[str]]

celula_orcamentaria

Célula orçamentária.

Type:: Optional[“CelulaOrcamentariaModel”]

dt_emis

Data de emissão.

Type:: Optional[str]

txt_processo

Processo associado.

Type:: Optional[str]

vlr_taxa_cambio

Taxa de câmbio.

Type:: Optional[str]

vlr_pre_empenho

Valor do pré-empenho.

Type:: Optional[str]

cod_favorecido

Código do favorecido.

Type:: Optional[str]

txt_descricao

Descrição do pré-empenho.

Type:: Optional[str]

sistema_origem

Sistema de origem.

Type:: Optional[str]

operacao

Lista de operações de pré-empenho.

Type:: Optional[List[“OperacaoPreEmpenhoDetalheModel”]]

registro_alteracao

Registro de alteração.

Type:: Optional[“RegistroAlteracaoPreEmpenhoModel”]

ano_pre_empenho: int | str | None

celula_orcamentaria: CelulaOrcamentariaModel | None

cod_favorecido: str | None

dt_emis: str | None

empenho_relacionado: List[str] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_pre_empenho': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'celula_orcamentaria': FieldInfo(annotation=Union[CelulaOrcamentariaModel, NoneType], required=False, default=None), 'cod_favorecido': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'empenho_relacionado': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None), 'num_pre_empenho': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'operacao': FieldInfo(annotation=Union[List[OperacaoPreEmpenhoDetalheModel], NoneType], required=False, default=None), 'registro_alteracao': FieldInfo(annotation=Union[ForwardRef('RegistroAlteracaoPreEmpenhoModel'), NoneType], required=False, default=None), 'sistema_origem': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_descricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr_pre_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_taxa_cambio': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_pre_empenho: int | str | None

operacao: List[OperacaoPreEmpenhoDetalheModel] | None

registro_alteracao: RegistroAlteracaoPreEmpenhoModel | None

sistema_origem: str | None

txt_descricao: str | None

txt_processo: str | None

ug_emitente: int | str | None

vlr_pre_empenho: str | None

vlr_taxa_cambio: str | None

class pyarialib.siafi.models.OrcPreEmpenhoRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Resposta das operações de Pré-Empenho (incluir, alterar).

ug_emitente

UG Emitente do Pré-empenho. Parâmetro: ugEmitente, Tipo: int, Ocorrência: [0..1], Restrição: UG.

Type:: Optional[int]

pre_empenho

Pré-empenho original envolvido na operação. Parâmetro: preEmpenho, Tipo: string, Ocorrência: [0..1], Restrição: PE.

Type:: Optional[str]

documento_RO

Documento contábil gerado na operação. Parâmetro: documentoRO, Tipo: string, Ocorrência: [0..1], Restrição: RO.

Type:: Optional[str]

mensagem

Lista de mensagens de erro/alerta. Parâmetro: mensagem, Tipo: Mensagem, Ocorrência: [0..n].

Type:: Optional[List[“schemas__orcamentario__MensagemModel”]]

documento_RO: str | None

mensagem: List[schemas__orcamentario__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_RO': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__orcamentario__MensagemModel')], NoneType], required=False, default=None), 'pre_empenho': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ug_emitente': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

pre_empenho: str | None

ug_emitente: int | None

class pyarialib.siafi.models.OutrosLancModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento na aba “Outros Lançamentos” de um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cron_baixa_patrimonial

Cronograma de baixa patrimonial.

Type:: Optional[“CronBaixaPatrimonialModel”]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

indr_tem_contrato

Indica se tem contrato associado.

Type:: Optional[bool]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

tp_normal_estorno

Tipo de Lançamento: “N” - Normal, “E” - Estorno.

Type:: Optional[str]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do lançamento (15,2).

Type:: Optional[float]

cod_sit: str | None

cron_baixa_patrimonial: CronBaixaPatrimonialModel | None

indr_liquidado: bool | None

indr_tem_contrato: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cron_baixa_patrimonial': FieldInfo(annotation=Union[CronBaixaPatrimonialModel, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_tem_contrato': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tp_normal_estorno': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_class_D: int | str | None

num_seq_item: int | str | None

tp_normal_estorno: str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.OutrosLancModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um lançamento na aba “Outros Lançamentos” de um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cron_baixa_patrimonial

Cronograma de baixa patrimonial.

Type:: Optional[“CronBaixaPatrimonialModel”]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

indr_tem_contrato

Indica se tem contrato associado.

Type:: Optional[bool]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

tp_normal_estorno

Tipo de Lançamento: “N” - Normal, “E” - Estorno.

Type:: Optional[str]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do lançamento (15,2).

Type:: Optional[float]

cod_sit: str | None

cron_baixa_patrimonial: CronBaixaPatrimonialModel | None

indr_liquidado: bool | None

indr_tem_contrato: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cron_baixa_patrimonial': FieldInfo(annotation=Union[CronBaixaPatrimonialModel, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'indr_tem_contrato': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'tp_normal_estorno': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_class_D: int | str | None

num_seq_item: int | str | None

tp_normal_estorno: str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

class pyarialib.siafi.models.PADModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PAD: List[ItemPADModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PADModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PAD

Itens da Aprovação Direta de Recurso Financeiro

Type:: Optional[List[“ItemPADModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PAD: List[ItemPADModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PAD': FieldInfo(annotation=Union[List[ItemPADModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.PAPModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PAP: List[ItemPAPModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PAPModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PAP

Itens da Aprovação de Recurso Financeiro

Type:: Optional[List[“ItemPAPModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PAP: List[ItemPAPModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PAP': FieldInfo(annotation=Union[List[ItemPAPModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

Bases: BaseModelSiafi

Schema para PARModel.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int | str]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PAR

Itens do Ajuste de Recurso Financeiro

Type:: Optional[List[“ItemPARModel”]]

ano: int | str | None

cod_ug_favorecida: int | str | None

item_PAR: List[ItemPARModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_PAR': FieldInfo(annotation=Union[List[ItemPARModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.PCAModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PCA: List[ItemPCAModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PCAModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PCA

Itens do Cancelamento de Aprovação de Recurso Financeiro

Type:: Optional[List[“ItemPCAModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PCA: List[ItemPCAModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PCA': FieldInfo(annotation=Union[List[ItemPCAModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.PCDModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PCD: List[ItemPCDModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PCDModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PCD

Itens do Cancelamento de Aprovação Direta de Recurso Financeiro

Type:: Optional[List[“ItemPCDModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PCD: List[ItemPCDModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PCD': FieldInfo(annotation=Union[List[ItemPCDModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

Bases: BaseModelSiafi

Schema para PCRModel.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int | str]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PCR

Itens da Reprogramação de Recurso Financeiro

Type:: Optional[List[“ItemPCRModel”]]

ano: int | str | None

cod_ug_favorecida: int | str | None

item_PCR: List[ItemPCRModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_PCR': FieldInfo(annotation=Union[List[ItemPCRModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.PCSModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PCS: List[ItemPCSModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PCSModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PCS

Itens do Cancelamento de Solicitação de Recurso Financeiro

Type:: Optional[List[“ItemPCSModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PCS: List[ItemPCSModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PCS': FieldInfo(annotation=Union[List[ItemPCSModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.PFCadastrarPFRequestModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFCadastrarPFRequestModel.

pf_DTO

Campo não documentado.

Type:: Optional[“PFDTOModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'pf_DTO': FieldInfo(annotation=Union[ForwardRef('PFDTOModel'), NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

pf_DTO: PFDTOModel | None

class pyarialib.siafi.models.PFCadastrarPFResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFCadastrarPFResponseModel.

pf_resposta_DTO

Campo não documentado.

Type:: Optional[“PFRespostaDTOModel”]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None), 'pf_resposta_DTO': FieldInfo(annotation=Union[ForwardRef('PFRespostaDTOModel'), NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

pf_resposta_DTO: PFRespostaDTOModel | None

class pyarialib.siafi.models.PFCancelamentoLibTranModel(*, cod_ug_emit: int | str | None = None, observacao: str | None = None, CLT: CLTModelInput | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFCancelamentoLibTranModel.

cod_ug_emit

Código da unidade gestora emitente (int, 1-6)

Type:: Optional[int | str]

observacao

Observação do cancelamento (string, 1-234)

Type:: Optional[str]

CLT

Dados do cancelamento de liberação de transferência

Type:: Optional[“CLTModelInput”]

CLT: CLTModelInput | None

cod_ug_emit: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'CLT': FieldInfo(annotation=Union[CLTModelInput, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

observacao: str | None

class pyarialib.siafi.models.PFCancelarLiberacaoTransferenciaRequestModel(*, programacao_financeira: PFCancelamentoLibTranModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFCancelarLiberacaoTransferenciaRequestModel.

programacao_financeira

Campo não documentado.

Type:: Optional[“PFCancelamentoLibTranModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'programacao_financeira': FieldInfo(annotation=Union[PFCancelamentoLibTranModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

programacao_financeira: PFCancelamentoLibTranModel | None

class pyarialib.siafi.models.PFCancelarLiberacaoTransferenciaResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFCancelarLiberacaoTransferenciaResponseModel.

documento_gerado

Campo não documentado.

Type:: Optional[List[“DocumentoSiafiModel”]]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

documento_gerado: List[DocumentoSiafiModel] | None

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_gerado': FieldInfo(annotation=Union[List[DocumentoSiafiModel], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.PFConsultaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFConsultaModel.

cod_ug_emit

Código da unidade gestora emitente (int, 1-6)

Type:: Optional[int | str]

observacao

Observação da Programação Financeira (string, 1-234)

Type:: Optional[str]

data_emissao

Data de emissão da Programação Financeira (AAAA-MM-DD)

Type:: Optional[str]

PSL

Solicitação de Recurso Financeiro

Type:: Optional[“PSLModel”]

PAP

Aprovação de Recurso Financeiro

Type:: Optional[“PAPModel”]

PAD

Aprovação Direta de Recurso Financeiro

Type:: Optional[“PADModel”]

PLB

Liberação de Recurso Financeiro

Type:: Optional[“PLBModel”]

PCS

Cancelamento de Solicitação de Recurso Financeiro

Type:: Optional[“PCSModel”]

PCA

Cancelamento de Aprovação de Recurso Financeiro

Type:: Optional[“PCAModel”]

PCD

Cancelamento de Aprovação Direta de Recurso Financeiro

Type:: Optional[“PCDModel”]

CLT

Cancelamento de Liberação de Transferência

Type:: Optional[“CLTModelOutput”]

TRF

Transferência de Recurso Financeiro

Type:: Optional[“TRFModelOutput”]

DRF

Devolução de Recurso Financeiro

Type:: Optional[“DRFModel”]

PSR

Remanejamento de Recurso Financeiro

Type:: Optional[“PSRModel”]

PCR

Reprogramação de Recurso Financeiro

Type:: Optional[“PCRModel”]

PAR

Ajuste de Recurso Financeiro

Type:: Optional[“PARModel”]

PRD

Devolução de Ajuste de Recurso Financeiro

Type:: Optional[“PRDModel”]

CLT: CLTModelOutput | None

DRF: DRFModel | None

PAD: PADModel | None

PAP: PAPModel | None

PAR: PARModel | None

PCA: PCAModel | None

PCD: PCDModel | None

PCR: PCRModel | None

PCS: PCSModel | None

PLB: PLBModel | None

PRD: PRDModel | None

PSL: PSLModel | None

PSR: PSRModel | None

TRF: TRFModelOutput | None

cod_ug_emit: int | str | None

data_emissao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'CLT': FieldInfo(annotation=Union[CLTModelOutput, NoneType], required=False, default=None), 'DRF': FieldInfo(annotation=Union[DRFModel, NoneType], required=False, default=None), 'PAD': FieldInfo(annotation=Union[PADModel, NoneType], required=False, default=None), 'PAP': FieldInfo(annotation=Union[PAPModel, NoneType], required=False, default=None), 'PAR': FieldInfo(annotation=Union[PARModel, NoneType], required=False, default=None), 'PCA': FieldInfo(annotation=Union[PCAModel, NoneType], required=False, default=None), 'PCD': FieldInfo(annotation=Union[PCDModel, NoneType], required=False, default=None), 'PCR': FieldInfo(annotation=Union[PCRModel, NoneType], required=False, default=None), 'PCS': FieldInfo(annotation=Union[PCSModel, NoneType], required=False, default=None), 'PLB': FieldInfo(annotation=Union[ForwardRef('PLBModel'), NoneType], required=False, default=None), 'PRD': FieldInfo(annotation=Union[ForwardRef('PRDModel'), NoneType], required=False, default=None), 'PSL': FieldInfo(annotation=Union[ForwardRef('PSLModel'), NoneType], required=False, default=None), 'PSR': FieldInfo(annotation=Union[ForwardRef('PSRModel'), NoneType], required=False, default=None), 'TRF': FieldInfo(annotation=Union[ForwardRef('TRFModelOutput'), NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'data_emissao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

observacao: str | None

class pyarialib.siafi.models.PFConsultarProgramacaoFinanceiraResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFConsultarProgramacaoFinanceiraResponseModel.

resultado

Campo não documentado.

Type:: Optional[List[“PFConsultarProgramacaoFinanceiraRespostaModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'resultado': FieldInfo(annotation=Union[List[ForwardRef('PFConsultarProgramacaoFinanceiraRespostaModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

resultado: List[PFConsultarProgramacaoFinanceiraRespostaModel] | None

class pyarialib.siafi.models.PFConsultarProgramacaoFinanceiraRespostaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFConsultarProgramacaoFinanceiraRespostaModel.

programacao_financeira

Campo não documentado.

Type:: Optional[List[“PFDadosProgramacaoFinanceiraModel”]]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None), 'programacao_financeira': FieldInfo(annotation=Union[List[ForwardRef('PFDadosProgramacaoFinanceiraModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

programacao_financeira: List[PFDadosProgramacaoFinanceiraModel] | None

Bases: BaseModelSiafi

Schema para PFDTOModel.

tipo_PF

Código do Tipo de Programação Financeira (string, 3). Ex: “TRF”

Type:: Optional[str]

observacao

Descrição (string, 1-234)

Type:: Optional[str]

cod_ug_emit

Código da unidade gestora emitente (int, 1-6)

Type:: Optional[int | str]

cod_ug_favorecida

Código da unidade gestora favorecida (int, 1-6)

Type:: Optional[int | str]

limite_de_saque

Indicador de limite de saque (boolean)

Type:: Optional[bool]

lista_item_PFDTO

Lista de itens de programação financeira

Type:: Optional[List[“ItemPFDTOModel”]]

numero_documento

Número do documento SIAFI (int, 1-6)

Type:: Optional[int | str]

cod_ug_emit: int | str | None

cod_ug_favorecida: int | str | None

limite_de_saque: bool | None

lista_item_PFDTO: List[ItemPFDTOModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'limite_de_saque': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'lista_item_PFDTO': FieldInfo(annotation=Union[List[ItemPFDTOModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_PF': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

observacao: str | None

tipo_PF: str | None

class pyarialib.siafi.models.PFDadosItensProgramacaoFinanceiraModel(*, celula: CelulaFinanceiraModel | None = None, valor: float | None = None, saldo: float | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFDadosItensProgramacaoFinanceiraModel.

celula

Campo não documentado.

Type:: Optional[“CelulaFinanceiraModel”]

valor

Campo não documentado.

Type:: Optional[float]

saldo

Campo não documentado.

Type:: Optional[float]

celula: CelulaFinanceiraModel | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'celula': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'saldo': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'valor': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

saldo: float | None

valor: float | None

class pyarialib.siafi.models.PFDadosItensRemanejamentoModel(*, indr_limite_saque: str | None = None, numero_documento: str | None = None, celula_de: CelulaFinanceiraModel | None = None, celula_para: CelulaFinanceiraModel | None = None, valor: float | None = None, saldo: float | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFDadosItensRemanejamentoModel.

indr_limite_saque

Campo não documentado.

Type:: Optional[str]

numero_documento

Campo não documentado.

Type:: Optional[str]

celula_de

Campo não documentado.

Type:: Optional[“CelulaFinanceiraModel”]

celula_para

Campo não documentado.

Type:: Optional[“CelulaFinanceiraModel”]

valor

Campo não documentado.

Type:: Optional[float]

saldo

Campo não documentado.

Type:: Optional[float]

celula_de: CelulaFinanceiraModel | None

celula_para: CelulaFinanceiraModel | None

indr_limite_saque: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'celula_de': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'celula_para': FieldInfo(annotation=Union[CelulaFinanceiraModel, NoneType], required=False, default=None), 'indr_limite_saque': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'saldo': FieldInfo(annotation=Union[float, NoneType], required=False, default=None), 'valor': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

saldo: float | None

valor: float | None

Bases: BaseModelSiafi

Schema para PFDadosProgramacaoFinanceiraModel.

acao

Campo não documentado.

Type:: Optional[str]

cod_ug_emit

Campo não documentado.

Type:: Optional[int | str]

cod_ug_favorecida

Campo não documentado.

Type:: Optional[int | str]

mes_programacao

Campo não documentado.

Type:: Optional[str]

ano_programacao

Campo não documentado.

Type:: Optional[int | str]

dados_itens_prog_finan

Campo não documentado.

Type:: Optional[List[“PFDadosItensProgramacaoFinanceiraModel”]]

dados_itens_remanejamento

Campo não documentado.

Type:: Optional[List[“PFDadosItensRemanejamentoModel”]]

acao: str | None

ano_programacao: int | str | None

cod_ug_emit: int | str | None

cod_ug_favorecida: int | str | None

dados_itens_prog_finan: List[PFDadosItensProgramacaoFinanceiraModel] | None

dados_itens_remanejamento: List[PFDadosItensRemanejamentoModel] | None

mes_programacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'acao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'ano_programacao': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dados_itens_prog_finan': FieldInfo(annotation=Union[List[PFDadosItensProgramacaoFinanceiraModel], NoneType], required=False, default=None), 'dados_itens_remanejamento': FieldInfo(annotation=Union[List[PFDadosItensRemanejamentoModel], NoneType], required=False, default=None), 'mes_programacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.PFDetalharProgramacaoFinanceiraResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFDetalharProgramacaoFinanceiraResponseModel.

programacao_financeira

Objeto contendo os dados de uma Programação Financeira.

Type:: Optional[“PFConsultaModel”]

mensagem

Lista de mensagens/erros do sistema.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None), 'programacao_financeira': FieldInfo(annotation=Union[PFConsultaModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

programacao_financeira: PFConsultaModel | None

class pyarialib.siafi.models.PFDevolucaoModel(*, cod_ug_emit: int | str | None = None, observacao: str | None = None, DRF: DRFDevolucaoModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFDevolucaoModel.

cod_ug_emit

Campo não documentado.

Type:: Optional[int | str]

observacao

Campo não documentado.

Type:: Optional[str]

DRF

Campo não documentado.

Type:: Optional[“DRFDevolucaoModel”]

DRF: DRFDevolucaoModel | None

cod_ug_emit: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'DRF': FieldInfo(annotation=Union[DRFDevolucaoModel, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

observacao: str | None

class pyarialib.siafi.models.PFDevolverRecursoFinanceiroRequestModel(*, programacao_financeira: PFDevolucaoModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFDevolverRecursoFinanceiroRequestModel.

programacao_financeira

Campo não documentado.

Type:: Optional[“PFDevolucaoModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'programacao_financeira': FieldInfo(annotation=Union[PFDevolucaoModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

programacao_financeira: PFDevolucaoModel | None

class pyarialib.siafi.models.PFDevolverRecursoFinanceiroResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFDevolverRecursoFinanceiroResponseModel.

documento_gerado

Campo não documentado.

Type:: Optional[List[“DocumentoSiafiModel”]]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

documento_gerado: List[DocumentoSiafiModel] | None

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_gerado': FieldInfo(annotation=Union[List[DocumentoSiafiModel], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.PFRespostaDTOModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFRespostaDTOModel.

ano

Campo não documentado.

Type:: Optional[int | str]

numero_documento

Campo não documentado.

Type:: Optional[int | str]

cod_ug_emit

Campo não documentado.

Type:: Optional[int | str]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

ano: int | str | None

cod_ug_emit: int | str | None

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

class pyarialib.siafi.models.PFTransferenciaModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFTransferenciaModel.

cod_ug_emit

Campo não documentado.

Type:: Optional[int | str]

observacao

Campo não documentado.

Type:: Optional[str]

TRF

Campo não documentado.

Type:: Optional[“TRFModelInput”]

TRF: TRFModelInput | None

cod_ug_emit: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'TRF': FieldInfo(annotation=Union[ForwardRef('TRFModelInput'), NoneType], required=False, default=None), 'cod_ug_emit': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

observacao: str | None

class pyarialib.siafi.models.PFTransferirRecursoFinanceiroRequestModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFTransferirRecursoFinanceiroRequestModel.

programacao_financeira

Campo não documentado.

Type:: Optional[“PFTransferenciaModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'programacao_financeira': FieldInfo(annotation=Union[PFTransferenciaModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

programacao_financeira: PFTransferenciaModel | None

class pyarialib.siafi.models.PFTransferirRecursoFinanceiroResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PFTransferirRecursoFinanceiroResponseModel.

documento_gerado

Campo não documentado.

Type:: Optional[List[“DocumentoSiafiModel”]]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__pf__MensagemModel”]]

documento_gerado: List[DocumentoSiafiModel] | None

mensagem: List[schemas__pf__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_gerado': FieldInfo(annotation=Union[List[DocumentoSiafiModel], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__pf__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.PLBModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PLB: List[ItemPLBModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PLBModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PLB

Itens da Liberação de Recurso Financeiro

Type:: Optional[List[“ItemPLBModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PLB: List[ItemPLBModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PLB': FieldInfo(annotation=Union[List[ItemPLBModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

Bases: BaseModelSiafi

Schema para PRDModel.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int | str]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PRD

Itens da Devolução de Ajuste de Recurso Financeiro

Type:: Optional[List[“ItemPRDModel”]]

ano: int | str | None

cod_ug_favorecida: int | str | None

item_PRD: List[ItemPRDModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_PRD': FieldInfo(annotation=Union[List[ItemPRDModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.PSLModel(*, cod_ug_favorecida: int | None = None, ano: int | None = None, numero_documento: str | None = None, item_PSL: List[ItemPSLModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para PSLModel.

cod_ug_favorecida

Código da UG Favorecida (int, 1-6)

Type:: Optional[int]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PSL

Itens da Solicitação de Recurso Financeiro

Type:: Optional[List[“ItemPSLModel”]]

ano: int | None

cod_ug_favorecida: int | None

item_PSL: List[ItemPSLModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'item_PSL': FieldInfo(annotation=Union[List[ItemPSLModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

Bases: BaseModelSiafi

Schema para PSRModel.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[int | str]

numero_documento

Número da Programação Financeira (string, 1-6)

Type:: Optional[str]

item_PSR

Itens do Remanejamento de Recurso Financeiro

Type:: Optional[List[“ItemPSRModel”]]

ano: int | str | None

cod_ug_favorecida: int | str | None

item_PSR: List[ItemPSRModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_PSR': FieldInfo(annotation=Union[List[ItemPSRModel], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: str | None

class pyarialib.siafi.models.ParamAlterarChavesPixModel(*, credor: str | None = None, chave_pix: List[ChavePixModelInput] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Parâmetros para alteração de chaves PIX do credor.

credor

CPF ou CNPJ do credor. Tamanho: 11-14.

Type:: Optional[str]

chave_pix

Lista de chaves PIX (0-5).

Type:: Optional[List[“ChavePixModelInput”]]

chave_pix: List[ChavePixModelInput] | None

credor: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'chave_pix': FieldInfo(annotation=Union[List[ChavePixModelInput], NoneType], required=False, default=None), 'credor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.ParamAlterarChavesPixResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ParamAlterarChavesPixResponseModel.

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__tabelas__MensagemModel”]]

mensagem: List[schemas__tabelas__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__tabelas__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.ParamConsultarChavesPixResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ParamConsultarChavesPixResponseModel.

credor

Campo não documentado.

Type:: Optional[str]

chave_pix

Campo não documentado.

Type:: Optional[List[“ChavePixModelOutput”]]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__tabelas__MensagemModel”]]

chave_pix: List[ChavePixModelOutput] | None

credor: str | None

mensagem: List[schemas__tabelas__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'chave_pix': FieldInfo(annotation=Union[List[ChavePixModelOutput], NoneType], required=False, default=None), 'credor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__tabelas__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.ParamEstabLimPlurianuaisModel(*, tipo_requisicao: int | None = None, orgao_SOF: int | None = None, item_mov_limite: List[ItemMovLimiteModel] | None = None, observacao: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Parâmetros para estabelecimento de limites plurianuais.

tipo_requisicao

Tipo da requisição, conforme parametrizado na transação >CONEVELIMI.

Type:: Optional[int]

orgao_SOF

Código do Órgão Orçamentário da SOF. Tamanho: 1-5.

Type:: Optional[int]

item_mov_limite

Lista de movimentações de limites (1-12).

Type:: Optional[List[“ItemMovLimiteModel”]]

observacao

Observação da requisição. Tamanho: 1-100.

Type:: Optional[str]

item_mov_limite: List[ItemMovLimiteModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'item_mov_limite': FieldInfo(annotation=Union[List[ItemMovLimiteModel], NoneType], required=False, default=None), 'observacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'orgao_SOF': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'tipo_requisicao': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

observacao: str | None

orgao_SOF: int | None

tipo_requisicao: int | None

class pyarialib.siafi.models.ParamEstabLimPlurianuaisResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ParamEstabLimPlurianuaisResponseModel.

num_NS_gerada

Campo não documentado.

Type:: Optional[str]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__tabelas__MensagemModel”]]

mensagem: List[schemas__tabelas__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__tabelas__MensagemModel')], NoneType], required=False, default=None), 'num_NS_gerada': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_NS_gerada: str | None

Bases: BaseModelSiafi

Parâmetros para inclusão/alteração de RIP.

cod_RIP

Código do Registro Imobiliário Patrimonial. Tamanho: 13. Aceita apenas números, zeros à esquerda são significativos.

Type:: Optional[str]

titulo_RIP

Título do RIP. Tamanho: 1-80.

Type:: Optional[str]

cod_tipo_RIP

Código da tipologia do RIP. 1=Dominiais, 2=Uso comum, 3=Uso especial.

Type:: Optional[int]

txt_motivo

Motivo da inclusão/alteração. Tamanho: 1-1024.

Type:: Optional[str]

indr_ativo

Indicador ativo (True) ou inativo (False).

Type:: Optional[bool]

cod_RIP: str | None

cod_tipo_RIP: int | None

indr_ativo: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_RIP': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_tipo_RIP': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'indr_ativo': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'titulo_RIP': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

titulo_RIP: str | None

txt_motivo: str | None

class pyarialib.siafi.models.ParamManterRIPResponseModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ParamManterRIPResponseModel.

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__tabelas__MensagemModel”]]

mensagem: List[schemas__tabelas__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__tabelas__MensagemModel')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class pyarialib.siafi.models.ParametrosContabilizacaoModel(*, parametro: List[EventoSituacaoModel] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Agrupa os parâmetros de contabilização (eventos) para uma situação do CPR.

parametro

Lista de eventos de contabilização.

Type:: Optional[List[“EventoSituacaoModel”]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'parametro': FieldInfo(annotation=Union[List[EventoSituacaoModel], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

parametro: List[EventoSituacaoModel] | None

class pyarialib.siafi.models.ParcelaModel(*, dt_prevista: str | None = None, num_parcela: int | str | None = None, vlr: float | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa uma parcela de um cronograma de baixa patrimonial.

dt_prevista

Data prevista para a baixa da parcela.

Type:: Optional[str]

num_parcela

Número sequencial da parcela.

Type:: Optional[int | str]

vlr

Valor da parcela (15,2).

Type:: Optional[float]

dt_prevista: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dt_prevista': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_parcela': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_parcela: int | str | None

vlr: float | None

class pyarialib.siafi.models.PassivoAnteriorModelInput(**extra_data: Any)[código fonte]

Bases: 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[“PassivoPermanenteModelInput”]]): Lista de passivos permanentes.

cod_conta_contabil: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_conta_contabil': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'passivo_permanente': FieldInfo(annotation=Union[List[PassivoPermanenteModelInput], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

passivo_permanente: List[PassivoPermanenteModelInput] | None

class pyarialib.siafi.models.PassivoAnteriorModelOutput(**extra_data: Any)[código fonte]

Bases: 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: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_conta_contabil': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'passivo_permanente': FieldInfo(annotation=Union[List[ForwardRef('PassivoPermanenteModelOutput')], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

passivo_permanente: List[PassivoPermanenteModelOutput] | None

class pyarialib.siafi.models.PassivoPermanenteModelInput(*, conta_corrente: str | None = None, vlr_relacionado: float | str | None = None, **extra_data: Any)[código fonte]

Bases: 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[float | str]): Valor relacionado ao passivo permanente. Obrigatório.

conta_corrente: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'conta_corrente': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_relacionado': FieldInfo(annotation=Union[float, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

vlr_relacionado: float | str | None

class pyarialib.siafi.models.PassivoPermanenteModelOutput(*, conta_corrente: str | None = None, vlr_relacionado: str | None = None, **extra_data: Any)[código fonte]

Bases: 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: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'conta_corrente': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_relacionado': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

vlr_relacionado: str | None

Bases: BaseModelSiafi

Representa um item de lançamento na aba “Principal com Orçamento” (PCO) de um Documento Hábil.

cod_sub_item_empe

Código do Subitem do empenho.

Type:: Optional[str]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_empe

Número do empenho.

Type:: Optional[str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do item (15,2).

Type:: Optional[float]

cod_sub_item_empe: str | None

indr_liquidado: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sub_item_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_empe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_empe: str | None

num_seq_item: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

vlr: float | None

Bases: BaseModelSiafi

Representa um lançamento na aba “Principal com Orçamento” (PCO) de um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_ug_empe

Código da UG do empenho.

Type:: Optional[int | str]

cron_baixa_patrimonial

Cronograma de baixa patrimonial.

Type:: Optional[“CronBaixaPatrimonialModel”]

indr_tem_contrato

Indica se tem contrato associado.

Type:: Optional[bool]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_E

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

pco_item

Lista de itens de PCO.

Type:: Optional[List[“PcoItemModel”]]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_E

Informação de inscrição do item da Situação.

Type:: Optional[str]

cod_sit: str | None

cod_ug_empe: int | str | None

cron_baixa_patrimonial: CronBaixaPatrimonialModel | None

indr_tem_contrato: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cron_baixa_patrimonial': FieldInfo(annotation=Union[CronBaixaPatrimonialModel, NoneType], required=False, default=None), 'indr_tem_contrato': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_E': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'pco_item': FieldInfo(annotation=Union[List[PcoItemModel], NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_E': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_D: int | str | None

num_class_E: int | str | None

num_seq_item: int | str | None

pco_item: List[PcoItemModel] | None

txt_inscr_D: str | None

txt_inscr_E: str | None

Bases: BaseModelSiafi

Representa um lançamento na aba “Principal com Orçamento” (PCO) de um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

cod_ug_empe

Código da UG do empenho.

Type:: Optional[int | str]

cron_baixa_patrimonial

Cronograma de baixa patrimonial.

Type:: Optional[“CronBaixaPatrimonialModel”]

indr_tem_contrato

Indica se tem contrato associado.

Type:: Optional[bool]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_E

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

pco_item

Lista de itens de PCO.

Type:: Optional[List[“PcoItemModel”]]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_E

Informação de inscrição do item da Situação.

Type:: Optional[str]

cod_sit: str | None

cod_ug_empe: int | str | None

cron_baixa_patrimonial: CronBaixaPatrimonialModel | None

indr_tem_contrato: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_empe': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cron_baixa_patrimonial': FieldInfo(annotation=Union[CronBaixaPatrimonialModel, NoneType], required=False, default=None), 'indr_tem_contrato': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_E': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'pco_item': FieldInfo(annotation=Union[List[PcoItemModel], NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_E': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_D: int | str | None

num_class_E: int | str | None

num_seq_item: int | str | None

pco_item: List[PcoItemModel] | None

txt_inscr_D: str | None

txt_inscr_E: str | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo DARF (Documento de Arrecadação de Receitas Federais).

cod_recurso

Código do tipo de recurso para DARF/GPS.

Type:: Optional[str]

cod_tipo_DARF

Código do tipo de DARF (DFS, DFN, DFD). Se não informado, será “DFS”.

Type:: Optional[str]

dt_prdo_apuracao

Data do período de apuração.

Type:: Optional[str]

num_cod_barras

Número do código de barras. Informar apenas se codTipoDARF for “DFN”.

Type:: Optional[str]

num_ref

Número de referência.

Type:: Optional[str]

txt_processo

Número do processo.

Type:: Optional[str]

vinculacao

Código da vinculação. Informar apenas se codTipoDARF for “DFND”.

Type:: Optional[str]

vlr_percentual

Valor percentual (2,2).

Type:: Optional[str]

vlr_rcta_bruta_acum

Valor da receita bruta acumulada (15,2).

Type:: Optional[str]

cod_recurso: str | None

cod_tipo_DARF: str | None

dt_prdo_apuracao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_tipo_DARF': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_prdo_apuracao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_cod_barras': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_ref': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vinculacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_percentual': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_rcta_bruta_acum': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_cod_barras: str | None

num_ref: str | None

txt_processo: str | None

vinculacao: str | None

vlr_percentual: str | None

vlr_rcta_bruta_acum: str | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo DAR (Documento de Arrecadação Estadual/Municipal).

ano_referencia

Ano de referência.

Type:: Optional[str]

cod_muni_nf

Código do município da nota fiscal.

Type:: Optional[int | str]

cod_recurso

Código do tipo de recurso.

Type:: Optional[str]

cod_ug_tmdr_serv

Código da UG tomadora do serviço.

Type:: Optional[int | str]

dt_emis_nf

Data de emissão da nota fiscal.

Type:: Optional[str]

mes_referencia

Mês de referência.

Type:: Optional[str]

num_aliq_nf

Alíquota da nota fiscal (2,3).

Type:: Optional[str]

num_nf

Número da nota fiscal.

Type:: Optional[int | str]

num_sub_serie_nf

Subsérie da nota fiscal.

Type:: Optional[int | str]

txt_serie_nf

Série da nota fiscal.

Type:: Optional[str]

vlr_nf

Valor da nota fiscal (15,2).

Type:: Optional[str]

ano_referencia: str | None

cod_muni_nf: int | str | None

cod_recurso: str | None

cod_ug_tmdr_serv: int | str | None

dt_emis_nf: str | None

mes_referencia: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_referencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_muni_nf': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_tmdr_serv': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'dt_emis_nf': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mes_referencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_aliq_nf': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_nf': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_sub_serie_nf': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_serie_nf': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_nf': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_aliq_nf: str | None

num_nf: int | str | None

num_sub_serie_nf: int | str | None

txt_serie_nf: str | None

vlr_nf: str | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo GFIP (Guia de Recolhimento do FGTS e Informações à Previdência Social).

cod_agencia

Código da agência.

Type:: Optional[str]

cod_entidades

Código de outras entidades.

Type:: Optional[str]

cod_fpas

Código FPAS (Fundo de Previdência e Assistência Social).

Type:: Optional[str]

cod_recurso

Código do tipo de recurso.

Type:: Optional[str]

indr_simples

Indicador de Simples Nacional.

Type:: Optional[bool]

num_cod_barras

Número do código de barras.

Type:: Optional[str]

num_id_recolhimento

Identificação do Recolhimento.

Type:: Optional[str]

num_ident_gfip

Código de identificação da GFIP.

Type:: Optional[str]

num_qtd_trabalhador

Quantidade de trabalhadores.

Type:: Optional[str]

vlr13_salr_inss

Valor do 13º salário para INSS (15,2).

Type:: Optional[str]

vlr_cont_seg_desc

Valor da contribuição do segurado descontada (15,2).

Type:: Optional[str]

vlr_cont_seg_dev

Valor da contribuição do segurado devida (15,2).

Type:: Optional[str]

vlr_dep_cont_social

Valor do depósito da contribuição social (15,2).

Type:: Optional[str]

vlr_encargos

Valor dos encargos (15,2).

Type:: Optional[str]

vlr_mens_inss

Valor mensal para INSS (15,2).

Type:: Optional[str]

vlr_prev_social

Valor da previdência social (15,2).

Type:: Optional[str]

vlr_rmes_cat

Valor da remuneração mensal por categoria (15,2).

Type:: Optional[str]

vlr_rmes_fgts

Valor da remuneração mensal para FGTS (15,2).

Type:: Optional[str]

cod_agencia: str | None

cod_entidades: str | None

cod_fpas: str | None

cod_recurso: str | None

indr_simples: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_agencia': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_entidades': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_fpas': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_simples': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_cod_barras': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_id_recolhimento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_ident_gfip': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_qtd_trabalhador': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr13_salr_inss': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_cont_seg_desc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_cont_seg_dev': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_dep_cont_social': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_encargos': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_mens_inss': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_prev_social': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_rmes_cat': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_rmes_fgts': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_cod_barras: str | None

num_id_recolhimento: str | None

num_ident_gfip: str | None

num_qtd_trabalhador: str | None

vlr13_salr_inss: str | None

vlr_cont_seg_desc: str | None

vlr_cont_seg_dev: str | None

vlr_dep_cont_social: str | None

vlr_encargos: str | None

vlr_mens_inss: str | None

vlr_prev_social: str | None

vlr_rmes_cat: str | None

vlr_rmes_fgts: str | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo GPS (Guia da Previdência Social).

ano_compet

Ano de competência.

Type:: Optional[str]

cod_recurso

Código do tipo de recurso para DARF/GPS.

Type:: Optional[str]

indr_adiant13

Indica se é adiantamento de 13º.

Type:: Optional[bool]

mes_compet

Mês de competência.

Type:: Optional[str]

txt_processo

Número do processo.

Type:: Optional[str]

ano_compet: str | None

cod_recurso: str | None

indr_adiant13: bool | None

mes_compet: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_compet': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_adiant13': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'mes_compet': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_processo: str | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo GRU (Guia de Recolhimento da União).

ano_compet

Ano de competência.

Type:: Optional[int | str]

cod_recolhedor

Código do recolhedor (CPF, CNPJ, etc.).

Type:: Optional[str]

cod_recolhimento

Código de recolhimento da GRU.

Type:: Optional[int | str]

cod_recurso

Código do tipo de recurso.

Type:: Optional[str]

cod_ug_favorecida

Código da UG favorecida.

Type:: Optional[int | str]

mes_compet

Mês de competência.

Type:: Optional[int | str]

num_cod_barras

Número do código de barras.

Type:: Optional[str]

num_referencia

Número de referência.

Type:: Optional[int | str]

txt_processo

Número do processo.

Type:: Optional[str]

vlr_desconto

Valor do desconto (15,2).

Type:: Optional[str]

vlr_documento

Valor do documento (15,2).

Type:: Optional[str]

vlr_outr_deduc

Valor de outras deduções (15,2).

Type:: Optional[str]

ano_compet: int | str | None

cod_recolhedor: str | None

cod_recolhimento: int | str | None

cod_recurso: str | None

cod_ug_favorecida: int | str | None

mes_compet: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano_compet': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_recolhedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_recolhimento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_recurso': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'mes_compet': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_cod_barras': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_referencia': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_desconto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_documento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_outr_deduc': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_cod_barras: str | None

num_referencia: int | str | None

txt_processo: str | None

vlr_desconto: str | None

vlr_documento: str | None

vlr_outr_deduc: str | None

class pyarialib.siafi.models.PredocModelInput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Agrupa os dados de um pré-documento. Apenas um dos tipos de pré-documento (predocOB, predocNS, etc.) pode ser preenchido.

predoc_DAR

Dados de um pré-documento DAR.

Type:: Optional[“PredocDARModel”]

predoc_DARF

Dados de um pré-documento DARF.

Type:: Optional[“PredocDARFModel”]

predoc_GFIP

Dados de um pré-documento GFIP.

Type:: Optional[“PredocGFIPModel”]

predoc_GPS

Dados de um pré-documento GPS.

Type:: Optional[“PredocGPSModel”]

predoc_GRU

Dados de um pré-documento GRU.

Type:: Optional[“PredocGRUModel”]

predoc_NS

Dados de um pré-documento NS.

Type:: Optional[“PredocNSModel”]

predoc_OB

Dados de um pré-documento OB.

Type:: Optional[“PredocOBModel”]

predoc_PF

Dados de um pré-documento PF.

Type:: Optional[“PredocPFModel”]

txt_obser

Texto de observação.

Type:: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'predoc_DAR': FieldInfo(annotation=Union[PredocDARModel, NoneType], required=False, default=None), 'predoc_DARF': FieldInfo(annotation=Union[PredocDARFModel, NoneType], required=False, default=None), 'predoc_GFIP': FieldInfo(annotation=Union[PredocGFIPModel, NoneType], required=False, default=None), 'predoc_GPS': FieldInfo(annotation=Union[PredocGPSModel, NoneType], required=False, default=None), 'predoc_GRU': FieldInfo(annotation=Union[PredocGRUModel, NoneType], required=False, default=None), 'predoc_NS': FieldInfo(annotation=Union[ForwardRef('PredocNSModel'), NoneType], required=False, default=None), 'predoc_OB': FieldInfo(annotation=Union[ForwardRef('PredocOBModel'), NoneType], required=False, default=None), 'predoc_PF': FieldInfo(annotation=Union[ForwardRef('PredocPFModel'), NoneType], required=False, default=None), 'txt_obser': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

predoc_DAR: PredocDARModel | None

predoc_DARF: PredocDARFModel | None

predoc_GFIP: PredocGFIPModel | None

predoc_GPS: PredocGPSModel | None

predoc_GRU: PredocGRUModel | None

predoc_NS: PredocNSModel | None

predoc_OB: PredocOBModel | None

predoc_PF: PredocPFModel | None

txt_obser: str | None

class pyarialib.siafi.models.PredocModelOutput(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Agrupa os dados de um pré-documento. Apenas um dos tipos de pré-documento (predocOB, predocNS, etc.) pode ser preenchido.

predoc_DAR

Dados de um pré-documento DAR.

Type:: Optional[“PredocDARModel”]

predoc_DARF

Dados de um pré-documento DARF.

Type:: Optional[“PredocDARFModel”]

predoc_GFIP

Dados de um pré-documento GFIP.

Type:: Optional[“PredocGFIPModel”]

predoc_GPS

Dados de um pré-documento GPS.

Type:: Optional[“PredocGPSModel”]

predoc_GRU

Dados de um pré-documento GRU.

Type:: Optional[“PredocGRUModel”]

predoc_NS

Dados de um pré-documento NS.

Type:: Optional[“PredocNSModel”]

predoc_OB

Dados de um pré-documento OB.

Type:: Optional[“PredocOBModel”]

predoc_PF

Dados de um pré-documento PF.

Type:: Optional[“PredocPFModel”]

txt_obser

Texto de observação.

Type:: Optional[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'predoc_DAR': FieldInfo(annotation=Union[PredocDARModel, NoneType], required=False, default=None), 'predoc_DARF': FieldInfo(annotation=Union[PredocDARFModel, NoneType], required=False, default=None), 'predoc_GFIP': FieldInfo(annotation=Union[PredocGFIPModel, NoneType], required=False, default=None), 'predoc_GPS': FieldInfo(annotation=Union[PredocGPSModel, NoneType], required=False, default=None), 'predoc_GRU': FieldInfo(annotation=Union[PredocGRUModel, NoneType], required=False, default=None), 'predoc_NS': FieldInfo(annotation=Union[ForwardRef('PredocNSModel'), NoneType], required=False, default=None), 'predoc_OB': FieldInfo(annotation=Union[ForwardRef('PredocOBModel'), NoneType], required=False, default=None), 'predoc_PF': FieldInfo(annotation=Union[ForwardRef('PredocPFModel'), NoneType], required=False, default=None), 'txt_obser': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

predoc_DAR: PredocDARModel | None

predoc_DARF: PredocDARFModel | None

predoc_GFIP: PredocGFIPModel | None

predoc_GPS: PredocGPSModel | None

predoc_GRU: PredocGRUModel | None

predoc_NS: PredocNSModel | None

predoc_OB: PredocOBModel | None

predoc_PF: PredocPFModel | None

txt_obser: str | None

class pyarialib.siafi.models.PredocNSModel(*, cod_credor_devedor: str | None = None, cod_insc_gen: str | None = None, cod_tipo_banco: str | None = None, num_domi_banc_pgto: DomBancarioUGPagadoraModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo NS (Nota de Sistema).

cod_credor_devedor

Código do credor/devedor (CPF, CNPJ, etc.).

Type:: Optional[str]

cod_insc_gen

Código de Inscrição Genérica.

Type:: Optional[str]

cod_tipo_banco

Tipo de banco: “O” - Oficial, “L” - Local.

Type:: Optional[str]

num_domi_banc_pgto

Domicílio bancário da UG pagadora.

Type:: Optional[“DomBancarioUGPagadoraModel”]

cod_credor_devedor: str | None

cod_insc_gen: str | None

cod_tipo_banco: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_credor_devedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_insc_gen': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_tipo_banco': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_domi_banc_pgto': FieldInfo(annotation=Union[DomBancarioUGPagadoraModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_domi_banc_pgto: DomBancarioUGPagadoraModel | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo OB (Ordem Bancária).

cod_cont_repas

Código do Contrato de Repasse.

Type:: Optional[int | str]

cod_credor_devedor

Código do credor/devedor (CPF, CNPJ, etc.).

Type:: Optional[str]

cod_devolucao_SPB

Código de devolução do evento BACEN.

Type:: Optional[int | str]

cod_evnt_bacen

Código do evento no Bacen.

Type:: Optional[str]

cod_finalidade

Código da finalidade.

Type:: Optional[int | str]

cod_num_lista

Código da entidade Numero Lista do SIAFI.

Type:: Optional[str]

cod_rec_darf

Código de recolhimento DARF (apenas para OB de restituição).

Type:: Optional[int | str]

cod_reco_gru

Código de recolhimento GRU (apenas para OB de restituição).

Type:: Optional[int | str]

cod_tipo_OB

Código do tipo de OB (OBC, OBP, OBPIX, etc.).

Type:: Optional[str]

cod_ug_ra_gru

Código da UG do RA da GRU (apenas para OB de restituição).

Type:: Optional[int | str]

num_domi_banc_favo

Domicílio bancário do favorecido.

Type:: Optional[“DomBancarioFavorecidoModel”]

num_domi_banc_pgto

Domicílio bancário da UG pagadora.

Type:: Optional[“DomBancarioUGPagadoraModel”]

num_ra_gru

Número do RA da GRU (apenas para OB de restituição).

Type:: Optional[str]

num_ref_darf

Número de referência do DARF (apenas para OB de restituição).

Type:: Optional[int | str]

txt_chave_pix

Chave PIX. Apenas para codTipoOB “OBPIX”. Mutuamente exclusivo com numDomiBancFavo.

Type:: Optional[str]

txt_cit

Código identificador de transferência (CIT).

Type:: Optional[str]

txt_ctrl_original

Texto de controle original.

Type:: Optional[str]

txt_processo

Número do processo.

Type:: Optional[str]

vlr_taxa_cambio

Valor da taxa de câmbio (15,2).

Type:: Optional[str]

cod_cont_repas: int | str | None

cod_credor_devedor: str | None

cod_devolucao_SPB: int | str | None

cod_evnt_bacen: str | None

cod_finalidade: int | str | None

cod_num_lista: str | None

cod_rec_darf: int | str | None

cod_reco_gru: int | str | None

cod_tipo_OB: str | None

cod_ug_ra_gru: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_cont_repas': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_credor_devedor': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_devolucao_SPB': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_evnt_bacen': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_finalidade': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_num_lista': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_rec_darf': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_reco_gru': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'cod_tipo_OB': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_ra_gru': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_domi_banc_favo': FieldInfo(annotation=Union[DomBancarioFavorecidoModel, NoneType], required=False, default=None), 'num_domi_banc_pgto': FieldInfo(annotation=Union[DomBancarioUGPagadoraModel, NoneType], required=False, default=None), 'num_ra_gru': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_ref_darf': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_chave_pix': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_cit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_ctrl_original': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_processo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_taxa_cambio': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_domi_banc_favo: DomBancarioFavorecidoModel | None

num_domi_banc_pgto: DomBancarioUGPagadoraModel | None

num_ra_gru: str | None

num_ref_darf: int | str | None

txt_chave_pix: str | None

txt_cit: str | None

txt_ctrl_original: str | None

txt_processo: str | None

vlr_taxa_cambio: str | None

Bases: BaseModelSiafi

Representa os dados de um pré-documento do tipo PF (Programação Financeira).

cod_UG_favorecida

Código da UG favorecida.

Type:: Optional[int | str]

num_class_A

Informação de classificação.

Type:: Optional[int | str]

num_class_B

Informação de classificação.

Type:: Optional[int | str]

txt_inscr_A

Informação de inscrição.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição.

Type:: Optional[str]

txt_inscr_D

Informação de inscrição.

Type:: Optional[str]

vinculacao_pgto

Código da vinculação de pagamento.

Type:: Optional[int | str]

cod_UG_favorecida: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_UG_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vinculacao_pgto': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vinculacao_pgto: int | str | None

Bases: BaseModelSiafi

Representa um item de lançamento na aba “Principal sem Orçamento” (PSO) de um Documento Hábil.

cod_ctgo_gasto

Código da Categoria de Gasto.

Type:: Optional[str]

cod_font_recur

Código da Fonte de Recurso.

Type:: Optional[int | str]

indr_liquidado

Indica se está liquidado. Caso não informado, será preenchido como Verdadeiro.

Type:: Optional[bool]

num_class_A

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_B

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_C

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_D

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

txt_inscr_A

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_B

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_C

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_D

Informação de inscrição do item da Situação.

Type:: Optional[str]

vlr

Valor do item (15,2).

Type:: Optional[float]

cod_ctgo_gasto: str | None

cod_font_recur: int | str | None

indr_liquidado: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ctgo_gasto': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_font_recur': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'indr_liquidado': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'num_class_A': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_B': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_C': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_D': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'txt_inscr_A': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_B': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_C': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_D': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_A: int | str | None

num_class_B: int | str | None

num_class_C: int | str | None

num_class_D: int | str | None

num_seq_item: int | str | None

txt_inscr_A: str | None

txt_inscr_B: str | None

txt_inscr_C: str | None

txt_inscr_D: str | None

vlr: float | None

Bases: BaseModelSiafi

Representa um lançamento na aba “Principal sem Orçamento” (PSO) de um Documento Hábil.

cod_sit

Código da Situação do CPR.

Type:: Optional[str]

num_class_E

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_class_F

Informação de classificação do item da Situação.

Type:: Optional[int | str]

num_seq_item

Número sequencial único para o grupo de elementos.

Type:: Optional[int | str]

pso_item

Lista de itens de PSO.

Type:: Optional[List[“PsoItemModel”]]

txt_inscr_E

Informação de inscrição do item da Situação.

Type:: Optional[str]

txt_inscr_F

Informação de inscrição do item da Situação.

Type:: Optional[str]

cod_sit: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'num_class_E': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_class_F': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'pso_item': FieldInfo(annotation=Union[List[PsoItemModel], NoneType], required=False, default=None), 'txt_inscr_E': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_inscr_F': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_class_E: int | str | None

num_class_F: int | str | None

num_seq_item: int | str | None

pso_item: List[PsoItemModel] | None

txt_inscr_E: str | None

txt_inscr_F: str | None

class pyarialib.siafi.models.RegistroAlteracaoModel(*, dt_emis: str | None = None, txt_motivo: str | None = None, indr_indisp_caixa: bool | None = None, **extra_data: Any)[código fonte]

Bases: 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: str | None

indr_indisp_caixa: bool | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'indr_indisp_caixa': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None), 'txt_motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_motivo: str | None

class pyarialib.siafi.models.RegistroAlteracaoPreEmpenhoModel(*, dt_emis: str | None = None, txt_motivo: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Registro de alteração do pré-empenho (detalhamento).

dt_emis

Data de emissão do registro de alteração.

Type:: Optional[str]

txt_motivo

Motivo da alteração.

Type:: Optional[str]

dt_emis: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dt_emis': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_motivo: str | None

class pyarialib.siafi.models.ReincluirAmparoLegalRequestModel(**extra_data: Any)[código fonte]

Bases: 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: int | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_amparo_legal': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'motivo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'orc_amparo_legal_dados': FieldInfo(annotation=Union[OrcAmparoLegalDadosModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

motivo: str | None

orc_amparo_legal_dados: OrcAmparoLegalDadosModel | None

class pyarialib.siafi.models.RelComItemModel(*, cod_nat_desp_det: int | str | None = None, num_seq_item: int | str | None = None, num_seq_pai: int | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa uma relação com um item filho e um item pai.

cod_nat_desp_det

Natureza de Despesa Detalhada.

Type:: Optional[int | str]

num_seq_item

Número sequencial do item filho.

Type:: Optional[int | str]

num_seq_pai

Número sequencial do item pai.

Type:: Optional[int | str]

cod_nat_desp_det: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_nat_desp_det': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_pai': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

num_seq_pai: int | str | None

Bases: BaseModelSiafi

Representa uma relação com valor, associando um item filho a um item pai.

cod_nat_desp_det

Natureza de Despesa Detalhada. Informar se a situação associada requerer.

Type:: Optional[int | str]

num_seq_item

Número sequencial do item filho.

Type:: Optional[int | str]

num_seq_pai

Número sequencial do item pai.

Type:: Optional[int | str]

vlr

Valor da relação (15,2).

Type:: Optional[float]

cod_nat_desp_det: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_nat_desp_det': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_pai': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

num_seq_pai: int | str | None

vlr: float | None

class pyarialib.siafi.models.RelSemItemModel(*, cod_nat_desp_det: int | str | None = None, num_seq_item: int | str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa uma relação com um item.

cod_nat_desp_det

Natureza de Despesa Detalhada.

Type:: Optional[int | str]

num_seq_item

Número sequencial do item.

Type:: Optional[int | str]

cod_nat_desp_det: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_nat_desp_det': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

Bases: BaseModelSiafi

Representa uma relação com valor, associando a um item.

cod_nat_desp_det

Natureza de Despesa Detalhada. Informar se a situação associada requerer.

Type:: Optional[int | str]

num_seq_item

Número sequencial do item.

Type:: Optional[int | str]

vlr

Valor da relação (15,2).

Type:: Optional[float]

cod_nat_desp_det: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_nat_desp_det': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'num_seq_item': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_seq_item: int | str | None

vlr: float | None

class pyarialib.siafi.models.RelValorModel(*, vlr: float | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa um valor para uma relação.

vlr

Valor (15,2).

Type:: Optional[float]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'vlr': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

vlr: float | None

class pyarialib.siafi.models.RestricaoAmparoLegalModel(*, tipo_restricao: str | None = None, regra: str | None = None, valor: List[str] | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Restrição de uso do Amparo Legal.

tipo_restricao

Tipo de restrição do Amparo Legal. Ex: TIPO_ADMINISTRACAO_EMITENTE, ORGAO_UG_EMITENTE, ORGAO_UG_FAVORECIDA, AGENCIA_EXECUTIVA, NATUREZA_DESPESA.

Type:: Optional[str]

regra

Regra da restrição. Ex: SOMENTE, EXCETO.

Type:: Optional[str]

valor

Valores permitidos ou não permitidos para o Amparo Legal. Or

Type:: Optional[List[str]]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'regra': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_restricao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

regra: str | None

tipo_restricao: str | None

valor: List[str] | None

class pyarialib.siafi.models.ResumoProcessamentoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa o resumo do processamento de uma operação de compromisso.

documento_OP

Lista de Ordens de Pagamento geradas (apenas na realização de compromisso OB).

Type:: Optional[List[“DocumentoOrdemPagamentoModel”]]

documento_SIAFI

Lista de Documentos SIAFI gerados (ex: NS, NL).

Type:: Optional[List[“DocumentoSIAFIRealizacaoModel”]]

mensagem

Mensagem descrevendo o resultado do processamento.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

tipo_processamento

Tipo do resultado do processamento (BAIXADO, REALIZADO, ERRO, etc.).

Type:: Optional[str]

valor_processamento

Valor processado pela execução da operação (15,2).

Type:: Optional[str]

documento_OP: List[DocumentoOrdemPagamentoModel] | None

documento_SIAFI: List[DocumentoSIAFIRealizacaoModel] | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'documento_OP': FieldInfo(annotation=Union[List[DocumentoOrdemPagamentoModel], NoneType], required=False, default=None), 'documento_SIAFI': FieldInfo(annotation=Union[List[DocumentoSIAFIRealizacaoModel], NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'tipo_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'valor_processamento': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_processamento: str | None

valor_processamento: str | None

class pyarialib.siafi.models.SaldoContabilInfoModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para SaldoContabilInfoModel.

cod_UG

Campo não documentado.

Type:: Optional[int | str]

conta_contabil

Campo não documentado.

Type:: Optional[str]

conta_corrente

Campo não documentado.

Type:: Optional[str]

vlr_saldo

Campo não documentado.

Type:: Optional[str]

tipo_saldo

Campo não documentado.

Type:: Optional[str]

mensagem

Campo não documentado.

Type:: Optional[List[“schemas__tabelas__MensagemModel”]]

cod_UG: int | str | None

conta_contabil: str | None

conta_corrente: str | None

mensagem: List[schemas__tabelas__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_UG': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'conta_contabil': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'conta_corrente': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__tabelas__MensagemModel')], NoneType], required=False, default=None), 'tipo_saldo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vlr_saldo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

tipo_saldo: str | None

vlr_saldo: str | None

class pyarialib.siafi.models.SituacaoCPRModel(**extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa o detalhamento completo de uma Situação do CPR, incluindo configurações e indicadores.

configuracao_campos

Configuração de campos de classificação e inscrição.

Type:: Optional[“ConfiguracaoCamposModel”]

dados_basicos

Dados básicos da situação.

Type:: Optional[“DadosBasicosSituacaoModel”]

indicadores

Indicadores de comportamento da situação.

Type:: Optional[“IndicadoresModel”]

mensagem

Lista de mensagens de retorno.

Type:: Optional[List[“schemas__cpr__MensagemModel”]]

parametros_contabilizacao

Parâmetros de contabilização (eventos).

Type:: Optional[“ParametrosContabilizacaoModel”]

configuracao_campos: ConfiguracaoCamposModel | None

dados_basicos: DadosBasicosSituacaoModel | None

indicadores: IndicadoresModel | None

mensagem: List[schemas__cpr__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'configuracao_campos': FieldInfo(annotation=Union[ConfiguracaoCamposModel, NoneType], required=False, default=None), 'dados_basicos': FieldInfo(annotation=Union[DadosBasicosSituacaoModel, NoneType], required=False, default=None), 'indicadores': FieldInfo(annotation=Union[IndicadoresModel, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__cpr__MensagemModel')], NoneType], required=False, default=None), 'parametros_contabilizacao': FieldInfo(annotation=Union[ParametrosContabilizacaoModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

parametros_contabilizacao: ParametrosContabilizacaoModel | None

class pyarialib.siafi.models.SituacaoModel(*, cod_sit: str | None = None, titulo_sit: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa uma Situação do CPR de forma resumida.

cod_sit

Código da Situação.

Type:: Optional[str]

titulo_sit

Título/descrição da Situação.

Type:: Optional[str]

cod_sit: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'titulo_sit': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

titulo_sit: str | None

Bases: BaseModelSiafi

Schema para TRFModel-Input.

cod_ug_favorecida

Campo não documentado.

Type:: Optional[int | str]

numero_documento

Campo não documentado.

Type:: Optional[int | str]

item_TRF

Campo não documentado.

Type:: Optional[List[“ItemTRFModelInput”]]

cod_ug_favorecida: int | str | None

item_TRF: List[ItemTRFModelInput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_TRF': FieldInfo(annotation=Union[List[ItemTRFModelInput], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

Bases: BaseModelSiafi

Schema para TRFModel-Output.

cod_ug_favorecida

Código da Unidade Gestora Favorecida da Programação Financeira (int, 1-6)

Type:: Optional[int | str]

ano

Ano da Programação Financeira (int, 4)

Type:: Optional[str]

numero_documento

Número da Programação Financeira (string/int, 1-6)

Type:: Optional[int | str]

item_TRF

Itens da Transferência de Recurso Financeiro

Type:: Optional[List[“ItemTRFModelOutput”]]

ano: str | None

cod_ug_favorecida: int | str | None

item_TRF: List[ItemTRFModelOutput] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ano': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_ug_favorecida': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'item_TRF': FieldInfo(annotation=Union[List[ItemTRFModelOutput], NoneType], required=False, default=None), 'numero_documento': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

numero_documento: int | str | None

class pyarialib.siafi.models.TabAlterarChavesPixRequestModel(*, param_alterar_chaves_pix: ParamAlterarChavesPixModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Request para alteração de chaves PIX.

param_alterar_chaves_pix

Parâmetros obrigatórios para alteração das chaves PIX.

Type:: Optional[“ParamAlterarChavesPixModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'param_alterar_chaves_pix': FieldInfo(annotation=Union[ParamAlterarChavesPixModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

param_alterar_chaves_pix: ParamAlterarChavesPixModel | None

class pyarialib.siafi.models.TabAlterarRIPRequestModel(*, param_manter_RIP: ParamManterRIPModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Request para alteração de RIP.

param_manter_RIP

Parâmetros obrigatórios para alteração do RIP.

Type:: Optional[“ParamManterRIPModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'param_manter_RIP': FieldInfo(annotation=Union[ParamManterRIPModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

param_manter_RIP: ParamManterRIPModel | None

class pyarialib.siafi.models.TabEstabLimPlurianuaisRequestModel(*, param_estab_lim_plurianuais: ParamEstabLimPlurianuaisModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Request para estabelecimento de limites plurianuais.

param_estab_lim_plurianuais

Parâmetros obrigatórios para o estabelecimento.

Type:: Optional[“ParamEstabLimPlurianuaisModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'param_estab_lim_plurianuais': FieldInfo(annotation=Union[ParamEstabLimPlurianuaisModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

param_estab_lim_plurianuais: ParamEstabLimPlurianuaisModel | None

class pyarialib.siafi.models.TabIncluirRIPRequestModel(*, param_manter_RIP: ParamManterRIPModel | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Request para inclusão de RIP.

param_manter_RIP

Parâmetros obrigatórios para inclusão do RIP.

Type:: Optional[“ParamManterRIPModel”]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'param_manter_RIP': FieldInfo(annotation=Union[ParamManterRIPModel, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

param_manter_RIP: ParamManterRIPModel | None

class pyarialib.siafi.models.TramiteModel(*, dt_entrada: str | None = None, dt_saida: str | None = None, txt_local: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa o trâmite de um documento, com local e datas de entrada/saída.

dt_entrada

Data de entrada no local.

Type:: Optional[str]

dt_saida

Data de saída do local.

Type:: Optional[str]

txt_local

Descrição do local do trâmite.

Type:: Optional[str]

dt_entrada: str | None

dt_saida: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'dt_entrada': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_saida': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_local': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_local: str | None

class pyarialib.siafi.models.TransferenciaModel(*, dt_operacao: str | None = None, operacao: str | None = None, origem: str | None = None, destino: str | None = None, **extra_data: Any)[código fonte]

Bases: 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>.

destino: str | None

dt_operacao: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'destino': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'dt_operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'operacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'origem': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

operacao: str | None

origem: str | None

class pyarialib.siafi.models.UGInfoModel(**extra_data: Any)[código fonte]

Bases: 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.

cep: str | None

cnpj: str | None

cod_SIORG: int | None

cod_moeda: int | None

codigo: str | None

codigo_orgao: str | None

cpf_gestor_financeiro: str | None

cpf_gestor_sub: str | None

cpf_ordenador_despesas: str | None

cpf_ordenador_sub: str | None

mensagem: List[schemas__tabelas__MensagemModel] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cep': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cnpj': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cod_SIORG': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'cod_moeda': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'codigo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'codigo_orgao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_gestor_financeiro': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_gestor_sub': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_ordenador_despesas': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'cpf_ordenador_sub': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'mensagem': FieldInfo(annotation=Union[List[ForwardRef('schemas__tabelas__MensagemModel')], NoneType], required=False, default=None), 'num_ato_criacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'sigla_UF': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'tipo_ato_criacao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'titulo': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'titulo_orgao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_email': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_endereco': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_esfera_adm': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_funcao': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_indr_UG_ativa': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_moeda': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_municpio': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_pais': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_telefone': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

num_ato_criacao: str | None

sigla_UF: str | None

tipo_ato_criacao: str | None

titulo: str | None

titulo_orgao: str | None

txt_email: str | None

txt_endereco: str | None

txt_esfera_adm: str | None

txt_funcao: str | None

txt_indr_UG_ativa: str | None

txt_moeda: str | None

txt_municpio: str | None

txt_pais: str | None

txt_telefone: str | None

class pyarialib.siafi.models.ValidationError(*, loc: List[int | str] | None = None, msg: str | None = None, type: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para ValidationError.

loc

Campo não documentado.

Type:: Optional[List[int | str]]

msg

Campo não documentado.

Type:: Optional[str]

type

Campo não documentado.

Type:: Optional[str]

loc: List[int | str] | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'loc': FieldInfo(annotation=Union[List[Union[int, str]], NoneType], required=False, default=None), 'msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'type': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

msg: str | None

type: str | None

class pyarialib.siafi.models.VinculacaoModel(*, codigo_vinculacao: int | str | None = None, valor: float | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Representa uma vinculação de pagamento.

codigo_vinculacao

Código da vinculação.

Type:: Optional[int | str]

valor

Valor da vinculação (15,2).

Type:: Optional[float]

codigo_vinculacao: int | str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'codigo_vinculacao': FieldInfo(annotation=Union[int, str, NoneType], required=False, default=None), 'valor': FieldInfo(annotation=Union[float, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

valor: float | None

class pyarialib.siafi.models.schemas__cpr__MensagemModel(*, cod_msg: str | None = None, txt_msg: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Modelo para mensagens de retorno das operações, indicando sucesso, avisos ou erros.

cod_msg

Código da mensagem. Pode não ser apresentado em algumas situações.

Type:: Optional[str]

txt_msg

Texto descritivo da mensagem.

Type:: Optional[str]

cod_msg: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_msg: str | None

class pyarialib.siafi.models.schemas__orcamentario__MensagemModel(*, cod_msg: str | None = None, txt_msg: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Mensagem de retorno do SIAFI.

cod_msg

Código da mensagem. Parâmetro: codMsg, Tipo: string, Ocorrência: [0..1]. Pode não ser apresentado em algumas situações.

Type:: Optional[str]

txt_msg

Texto da mensagem. Parâmetro: txtMsg, Tipo: Memorando, Ocorrência: [1..1].

Type:: Optional[str]

cod_msg: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_msg: str | None

class pyarialib.siafi.models.schemas__pf__MensagemModel(*, cod_msg: str | None = None, txt_msg: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para schemas__pf__MensagemModel.

cod_msg

Código da mensagem, pode não estar presente.

Type:: Optional[str]

txt_msg

Texto da mensagem.

Type:: Optional[str]

cod_msg: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_msg: str | None

class pyarialib.siafi.models.schemas__tabelas__MensagemModel(*, cod_msg: str | None = None, txt_msg: str | None = None, **extra_data: Any)[código fonte]

Bases: BaseModelSiafi

Schema para schemas__tabelas__MensagemModel.

cod_msg

Código da mensagem.

Type:: Optional[str]

txt_msg

Texto da mensagem.

Type:: Optional[str]

cod_msg: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'allow'}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cod_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'txt_msg': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

txt_msg: str | None

Cliente SIAFI

class pyarialib.siafi.Siafi(aria, ug: str = None, env: str = None, projeto_aria: str = 'siafi-global')[código fonte]

Bases: object

alterar_amparo_legal(payload: AlterarAmparoLegalRequestModel, otp: Otp | None = None) → OrcAmparoLegalRespostaModel[código fonte]

Alterar Amparo Legal (PUT /v1/siafi-global-hom/custom/orcamentario/alterar-amparo-legal).

Parâmetros:

payload (AlterarAmparoLegalRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcAmparoLegalRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_amparo_legal(
...     payload=AlterarAmparoLegalRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

alterar_chaves_pix(payload: TabAlterarChavesPixRequestModel, otp: Otp | None = None) → ParamAlterarChavesPixResponseModel[código fonte]

Alterar chaves PIX do credor (PUT /v1/siafi-global-hom/custom/tabelas/alterar-chaves-pix).

Parâmetros:

payload (TabAlterarChavesPixRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

ParamAlterarChavesPixResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_chaves_pix(
...     payload=TabAlterarChavesPixRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

alterar_dh_incluir_itens_dh(payload: CprDhAlterarIncluirItensModel, otp: Otp | None = None) → CprDhRespostaModel[código fonte]

Altera um Documento Hábil para incluir itens no SIAFI (POST /v1/siafi-global-hom/custom/cpr/alterar-documento-habil-incluir-itens).

Parâmetros:

payload (CprDhAlterarIncluirItensModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprDhRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_dh_incluir_itens_dh(
...     payload=CprDhAlterarIncluirItensModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

alterar_dh_liquidar_dh(payload: CprDhAlterarLiquidarModel, otp: Otp | None = None) → CprDhRespostaModel[código fonte]

Altera um Documento Hábil para liquidar no SIAFI (POST /v1/siafi-global-hom/custom/cpr/alterar-documento-habil-liquidar).

Parâmetros:

payload (CprDhAlterarLiquidarModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprDhRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_dh_liquidar_dh(
...     payload=CprDhAlterarLiquidarModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

alterar_empenho(payload: AlterarEmpenhoRequestModel, otp: Otp | None = None) → OrcEmpenhoRespostaModel[código fonte]

Alterar Empenho (PUT /v1/siafi-global-hom/custom/orcamentario/alterar-empenho).

Parâmetros:

payload (AlterarEmpenhoRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_empenho(
...     payload=AlterarEmpenhoRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

alterar_pre_empenho(payload: AlterarPreEmpenhoRequestModel, otp: Otp | None = None) → OrcPreEmpenhoRespostaModel[código fonte]

Alterar Pré-empenho (PUT /v1/siafi-global-hom/custom/orcamentario/alterar-pre-empenho).

Parâmetros:

payload (AlterarPreEmpenhoRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcPreEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_pre_empenho(
...     payload=AlterarPreEmpenhoRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

alterar_rip(payload: TabAlterarRIPRequestModel, otp: Otp | None = None) → ParamManterRIPResponseModel[código fonte]

Alterar Registro de Informações de Pagamento (RIP) (PUT /v1/siafi-global-hom/custom/tabelas/alterar-rip).

Parâmetros:

payload (TabAlterarRIPRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

ParamManterRIPResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.alterar_rip(
...     payload=TabAlterarRIPRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

baixar_compromisso(payload: CprCPBaixarModel, otp: Otp | None = None) → CprCPBaixarCompromissoResponseModel[código fonte]

Baixa de compromisso no SIAFI (POST /v1/siafi-global-hom/custom/cpr/baixar-compromisso).

Parâmetros:

payload (CprCPBaixarModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprCPBaixarCompromissoResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.baixar_compromisso(
...     payload=CprCPBaixarModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

cadastrar_documento_habil(payload: CprDhCadastrarModel, otp: Otp | None = None) → CprDhRespostaModel[código fonte]

Cadastra um novo Documento Hábil no SIAFI (POST /v1/siafi-global-hom/custom/cpr/cadastrar-documento-habil).

Parâmetros:

payload (CprDhCadastrarModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprDhRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.cadastrar_documento_habil(
...     payload=CprDhCadastrarModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

cadastrar_pf(payload: PFCadastrarPFRequestModel, otp: Otp | None = None) → PFCadastrarPFResponseModel[código fonte]

Cadastrar Programação Financeira (Depreciado) (POST /v1/siafi-global-hom/custom/pf/cadastrar-pf).

Parâmetros:

payload (PFCadastrarPFRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

PFCadastrarPFResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.cadastrar_pf(
...     payload=PFCadastrarPFRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

cancelar_dh(payload: CprDhCancelarModel, otp: Otp | None = None) → CprDhRespostaModel[código fonte]

Cancela um Documento Hábil no SIAFI (DELETE /v1/siafi-global-hom/custom/cpr/cancelar-documento-habil).

Parâmetros:

payload (CprDhCancelarModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprDhRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.cancelar_dh(
...     payload=CprDhCancelarModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

cancelar_liberacao_transferencia(payload: PFCancelarLiberacaoTransferenciaRequestModel, otp: Otp | None = None) → PFCancelarLiberacaoTransferenciaResponseModel[código fonte]

Cancelar Liberação e Transferência de Recurso Financeiro (POST /v1/siafi-global-hom/custom/pf/cancelar-liberacao-transferencia).

Parâmetros:

payload (PFCancelarLiberacaoTransferenciaRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

PFCancelarLiberacaoTransferenciaResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.cancelar_liberacao_transferencia(
...     payload=PFCancelarLiberacaoTransferenciaRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

consultar_baixa_saldo_empenho_exerc_anterior(ug_emitente: str | None = None, ano_empenho: str | None = None, num_empenho: str | None = None) → OrcConsultarBaixaSaldoEmpenhoExercAnteriorRespostaModel[código fonte]

Consultar baixa de saldo STN de Empenhos do Exercício anterior (GET /v1/siafi-global-hom/custom/orcamentario/consultar-baixa-saldo-empenho-exerc-anterior).

Parâmetros:

ug_emitente (Optional[str]) – Código da UG emitente do empenho.
ano_empenho (Optional[str]) – Ano do empenho (AAAA).
num_empenho (Optional[str]) – Número do empenho (NumNE).

Retorno:

Successful Response

Tipo de retorno:

OrcConsultarBaixaSaldoEmpenhoExercAnteriorRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_baixa_saldo_empenho_exerc_anterior(
...     ug_emitente="valor_exemplo",
...     ano_empenho="valor_exemplo",
...     num_empenho="valor_exemplo"
... )
>>> print(response)

consultar_chaves_pix(credor: str | None = None) → ParamConsultarChavesPixResponseModel[código fonte]

Consultar chaves PIX do credor (GET /v1/siafi-global-hom/custom/tabelas/consultar-chaves-pix).

Parâmetros:: credor (Optional[str]) – Código do credor (CPF ou CNPJ). Tipo: string, Tamanho: 11-14. Exemplo: “12345678901” ou “12345678000199”.
Retorno:: Successful Response
Tipo de retorno:: ParamConsultarChavesPixResponseModel
Levanta:: ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_chaves_pix(
...     credor="valor_exemplo"
... )
>>> print(response)

consultar_compromissos_para_baixa(documento_habil_ano: str | None = None, documento_habil_numero: str | None = None, documento_habil_tipo: str | None = None, documento_habil_ug_emitente: str | None = None, favorecido_recolhedor: str | None = None, numero_lista_codigo_numero_lista: str | None = None, numero_lista_codigo_UG: str | None = None, tipo_compromisso: str | None = None, ug_pagadora_recebedora: str | None = None) → CprCPConsultaRespostaModel[código fonte]

Consulta compromissos para baixa no SIAFI (GET /v1/siafi-global-hom/custom/cpr/consultar-compromissos-para-baixa).

Args:
documento_habil_ano (Optional[str]): Ano do Documento Hábil. (documentoHabil DocumentoHabilChave [1..1] - Chave para um documento hábil.) documento_habil_numero (Optional[str]): Número do Documento Hábil. (documentoHabil DocumentoHabilChave [1..1] - Chave para um documento hábil.) documento_habil_tipo (Optional[str]): Tipo do Documento Hábil. (documentoHabil DocumentoHabilChave [1..1] - Chave para um documento hábil.) documento_habil_ug_emitente (Optional[str]): UG Emitente do Documento Hábil. (documentoHabil DocumentoHabilChave [1..1] - Chave para um documento hábil.) favorecido_recolhedor (Optional[str]): Favorecido / Recolhedor do compromisso. [0..1] CodFavor. É obrigatório o preenchimento de pelo menos um dos parâmetros: favorecidoRecolhedor ou ugPagadoraRecebedora ou os dois simultaneamente. numero_lista_codigo_numero_lista (Optional[str]): Código do Número da Lista. numero_lista_codigo_UG (Optional[str]): Código da UG da Lista. tipo_compromisso (Optional[str]): Tipo de Compromisso [0..1]. Tipo do compromisso, consulte o TipoCompromisso para valores possíveis.

Valores possíveis: LIQUIDO - Compromisso de líquido. ENCARGO - Compromisso de encargo. DEDUCAO - Compromisso de dedução. VARIACAO_PATRIMONIAL - Compromisso de variação patrimonial.

ug_pagadora_recebedora (Optional[str]): UG pagadora / recebedora do compromisso. [0..1] UG. É obrigatório o preenchimento de pelo menos um dos parâmetros: favorecidoRecolhedor ou ugPagadoraRecebedora ou os dois simultaneamente.
Returns:
CprCPConsultaRespostaModel: Successful Response

Raises:
ValueError: Se a API retornar um código de erro (status não-2xx).

Example:
>>> response = client.consultar_compromissos_para_baixa(
...     documento_habil_ano="valor_exemplo",
...     documento_habil_numero="valor_exemplo",
...     documento_habil_tipo="valor_exemplo",
...     documento_habil_ug_emitente="valor_exemplo",
...     favorecido_recolhedor="valor_exemplo",
...     numero_lista_codigo_numero_lista="valor_exemplo",
...     numero_lista_codigo_UG="valor_exemplo",
...     tipo_compromisso="valor_exemplo",
...     ug_pagadora_recebedora="valor_exemplo"
... )
>>> print(response)

consultar_compromissos_para_estorno(documento_habil_ano: str | None = None, documento_habil_numero: str | None = None, documento_habil_tipo: str | None = None, documento_habil_ug_emitente: str | None = None, favorecido_recolhedor: str | None = None, numero_lista_codigo_numero_lista: str | None = None, numero_lista_codigo_UG: str | None = None, tipo_compromisso: str | None = None, ug_pagadora_recebedora: str | None = None) → CprCPConsultaRespostaModel[código fonte]

Consulta compromissos para estorno no SIAFI (GET /v1/siafi-global-hom/custom/cpr/consultar-compromissos-para-estorno).

Args:
documento_habil_ano (Optional[str]): Ano do Documento Hábil. documento_habil_numero (Optional[str]): Número do Documento Hábil. documento_habil_tipo (Optional[str]): Tipo do Documento Hábil. documento_habil_ug_emitente (Optional[str]): UG Emitente do Documento Hábil. favorecido_recolhedor (Optional[str]): Favorecido/Recolhedor. numero_lista_codigo_numero_lista (Optional[str]): Código do Número da Lista. numero_lista_codigo_UG (Optional[str]): Código da UG da Lista. tipo_compromisso (Optional[str]): Tipo de Compromisso. Valores possíveis:

LIQUIDO - Compromisso de líquido. +ENCARGO - Compromisso de encargo. +DEDUCAO - Compromisso de dedução. +VARIACAO_PATRIMONIAL - Compromisso de variação patrimonial.

ug_pagadora_recebedora (Optional[str]): UG Pagadora/Recebedora.

Returns:

CprCPConsultaRespostaModel: Successful Response

Raises:

ValueError: Se a API retornar um código de erro (status não-2xx).

Example:

>>> response = client.consultar_compromissos_para_estorno(
...     documento_habil_ano="valor_exemplo",
...     documento_habil_numero="valor_exemplo",
...     documento_habil_tipo="valor_exemplo",
...     documento_habil_ug_emitente="valor_exemplo",
...     favorecido_recolhedor="valor_exemplo",
...     numero_lista_codigo_numero_lista="valor_exemplo",
...     numero_lista_codigo_UG="valor_exemplo",
...     tipo_compromisso="valor_exemplo",
...     ug_pagadora_recebedora="valor_exemplo"
... )
>>> print(response)

consultar_compromissos_para_realizacao(documento_habil_ano: str | None = None, documento_habil_numero: str | None = None, documento_habil_tipo: str | None = None, documento_habil_ug_emitente: str | None = None, favorecido_recolhedor: str | None = None, numero_lista_codigo_numero_lista: str | None = None, numero_lista_codigo_UG: str | None = None, tipo_compromisso: str | None = None, ug_pagadora_recebedora: str | None = None) → CprCPConsultaRespostaModel[código fonte]

Consulta compromissos para realização no SIAFI (GET /v1/siafi-global-hom/custom/cpr/consultar-compromissos-para-realizacao).

Args:
documento_habil_ano (Optional[str]): Ano do Documento Hábil. documento_habil_numero (Optional[str]): Número do Documento Hábil. documento_habil_tipo (Optional[str]): Tipo do Documento Hábil. documento_habil_ug_emitente (Optional[str]): UG Emitente do Documento Hábil. favorecido_recolhedor (Optional[str]): Favorecido/Recolhedor. numero_lista_codigo_numero_lista (Optional[str]): Código do Número da Lista. numero_lista_codigo_UG (Optional[str]): Código da UG da Lista. tipo_compromisso (Optional[str]): Tipo de Compromisso. Valores possíveis:

LIQUIDO - Compromisso de líquido. +ENCARGO - Compromisso de encargo. +DEDUCAO - Compromisso de dedução. +VARIACAO_PATRIMONIAL - Compromisso de variação patrimonial.

ug_pagadora_recebedora (Optional[str]): UG Pagadora/Recebedora.

Returns:

CprCPConsultaRespostaModel: Successful Response

Raises:

ValueError: Se a API retornar um código de erro (status não-2xx).

Example:

>>> response = client.consultar_compromissos_para_realizacao(
...     documento_habil_ano="valor_exemplo",
...     documento_habil_numero="valor_exemplo",
...     documento_habil_tipo="valor_exemplo",
...     documento_habil_ug_emitente="valor_exemplo",
...     favorecido_recolhedor="valor_exemplo",
...     numero_lista_codigo_numero_lista="valor_exemplo",
...     numero_lista_codigo_UG="valor_exemplo",
...     tipo_compromisso="valor_exemplo",
...     ug_pagadora_recebedora="valor_exemplo"
... )
>>> print(response)

consultar_compromissos_para_restabelecimento(documento_habil_ano: str | None = None, documento_habil_numero: str | None = None, documento_habil_tipo: str | None = None, documento_habil_ug_emitente: str | None = None, favorecido_recolhedor: str | None = None, numero_lista_codigo_numero_lista: str | None = None, numero_lista_codigo_UG: str | None = None, tipo_compromisso: str | None = None, ug_pagadora_recebedora: str | None = None) → CprCPConsultaRespostaModel[código fonte]

Consulta compromissos para restabelecimento no SIAFI (GET /v1/siafi-global-hom/custom/cpr/consultar-compromissos-para-restabelecimento).

Args:
documento_habil_ano (Optional[str]): Ano do Documento Hábil. documento_habil_numero (Optional[str]): Número do Documento Hábil. documento_habil_tipo (Optional[str]): Tipo do Documento Hábil. documento_habil_ug_emitente (Optional[str]): UG Emitente do Documento Hábil. favorecido_recolhedor (Optional[str]): Favorecido/Recolhedor. numero_lista_codigo_numero_lista (Optional[str]): Código do Número da Lista. numero_lista_codigo_UG (Optional[str]): Código da UG da Lista. tipo_compromisso (Optional[str]): Tipo de Compromisso. Valores possíveis:

LIQUIDO - Compromisso de líquido. +ENCARGO - Compromisso de encargo. +DEDUCAO - Compromisso de dedução. +VARIACAO_PATRIMONIAL - Compromisso de variação patrimonial.

ug_pagadora_recebedora (Optional[str]): UG Pagadora/Recebedora.

Returns:

CprCPConsultaRespostaModel: Successful Response

Raises:

ValueError: Se a API retornar um código de erro (status não-2xx).

Example:

>>> response = client.consultar_compromissos_para_restabelecimento(
...     documento_habil_ano="valor_exemplo",
...     documento_habil_numero="valor_exemplo",
...     documento_habil_tipo="valor_exemplo",
...     documento_habil_ug_emitente="valor_exemplo",
...     favorecido_recolhedor="valor_exemplo",
...     numero_lista_codigo_numero_lista="valor_exemplo",
...     numero_lista_codigo_UG="valor_exemplo",
...     tipo_compromisso="valor_exemplo",
...     ug_pagadora_recebedora="valor_exemplo"
... )
>>> print(response)

Consultar Programação Financeira (GET /v1/siafi-global-hom/custom/pf/consultar-programacao-financeira).

Parâmetros:

acao (Optional[str]) – Ação da programação financeira: APROVACAO_DIRETA, APROVACAO, APROVACAO_REMANEJAMENTO, CANCELAMENTO_APROVACAO_DIRETA, CANCELAMENTO_APROVACAO, CANCELAMENTO_LIBERACAO_E_TRANSFERENCIA, CANCELAMENTO_SOLICITACAO, CANCELAMENTO_REMANEJAMENTO, DEVOLVER_RECURSO_FINANCEIRO, LIBERACAO_RECURSO_FINANCEIRO, REMANEJAMENTO_DIRETO, SOLICITACAO, SOLICITACAO_REMANEJAMENTO, TRANSFERENCIA.
data_emissao_de (Optional[str]) – Data de emissão inicial (YYYY-MM-DD).
data_emissao_ate (Optional[str]) – Data de emissão final (YYYY-MM-DD).
mes_programacao (Optional[str]) – Mês da programação.
cod_ug_emit (Optional[List[str]]) – Lista de UGs emitentes.
cod_ug_favorecida (Optional[List[str]]) – Lista de UGs favorecidas.
indr_limite_saque (Optional[str]) – Indicador de limite de saque.
cod_sit (Optional[str]) – Código da situação.
cod_ctgo_gasto (Optional[List[str]]) – Lista de códigos de categoria de gasto.
cod_font_recur (Optional[str]) – Código da fonte de recurso.
cod_vinc (Optional[str]) – Código de vínculo.

Retorno:

Successful Response

Tipo de retorno:

PFConsultarProgramacaoFinanceiraResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_programacao_financeira(
...     acao="valor_exemplo",
...     data_emissao_de="valor_exemplo",
...     data_emissao_ate="valor_exemplo",
...     mes_programacao="valor_exemplo",
...     cod_ug_emit="valor_exemplo",
...     cod_ug_favorecida="valor_exemplo",
...     indr_limite_saque="valor_exemplo",
...     cod_sit="valor_exemplo",
...     cod_ctgo_gasto="valor_exemplo",
...     cod_font_recur="valor_exemplo",
...     cod_vinc="valor_exemplo"
... )
>>> print(response)

consultar_relatorio_empenho(ug_emitente: str | None = None, ano_empenho: str | None = None, num_empenho: str | None = None) → OrcConsultarRelatorioEmpenhoRespostaModel[código fonte]

Consultar Relatório PDF do Empenho (GET /v1/siafi-global-hom/custom/orcamentario/consultar-relatorio-empenho).

Parâmetros:

ug_emitente (Optional[str]) – Código da UG emitente do empenho.
ano_empenho (Optional[str]) – Ano do empenho (AAAA).
num_empenho (Optional[str]) – Número do empenho (NumNE).

Retorno:

Successful Response

Tipo de retorno:

OrcConsultarRelatorioEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_relatorio_empenho(
...     ug_emitente="valor_exemplo",
...     ano_empenho="valor_exemplo",
...     num_empenho="valor_exemplo"
... )
>>> print(response)

Consultar saldo contábil de conta (GET /v1/siafi-global-hom/custom/tabelas/consultar-saldo-contabil).

Parâmetros:

cod_UG (Optional[str]) – Código da UG. Tipo: int, Tamanho: 1-6. Informe apenas um entre codUG ou codUO.
cod_UO (Optional[str]) – Código da UO. Tipo: int, Tamanho: 1-5. Informe apenas um entre codUG ou codUO.
conta_contabil (Optional[str]) – Conta contábil. Tipo: string, Tamanho: 9. Exemplo: “123456789”.
conta_corrente (Optional[str]) – Conta corrente associada à conta contábil. Tipo: string, Tamanho: 1-100. Opcional.
mes_ref_saldo (Optional[str]) – Mês de referência do saldo. Tipo: string, Tamanho: 3. Valores possíveis: “000”, “JAN”, “FEV”, …, “DEZ”, “013”, “014”. Opcional.
outros_param_saldo_contabil (Optional[str]) – Outros parâmetros para consulta. Usado se contaCorrente não for informado. Composição: ISF+EO+PTRES+FR+ND.

Retorno:

Successful Response

Tipo de retorno:

SaldoContabilInfoModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_saldo_contabil(
...     cod_UG="valor_exemplo",
...     cod_UO="valor_exemplo",
...     conta_contabil="valor_exemplo",
...     conta_corrente="valor_exemplo",
...     mes_ref_saldo="valor_exemplo",
...     outros_param_saldo_contabil="valor_exemplo"
... )
>>> print(response)

consultar_situacao(aba_dh: str | None = None, cod_tipo_dh: str | None = None) → CprDAConsultarSitRespostaModel[código fonte]

Consulta situação do Documento Hábil no SIAFI (GET /v1/siafi-global-hom/custom/cpr/da-consultar-situacao).

Parâmetros:

aba_dh (Optional[str]) – Aba do Documento Hábil. Possíveis valores: PCO (Aba de Principal Com Orçamento), PSO (Aba de Principal Sem Orçamento), VARPATRIMONIAL (Aba de Variação Patrimonial), CREDITO (Aba de Crédito), DEDUCAO (Aba de Dedução), ENCARGO (Aba de Encargo), OUTROSLANC (Aba de Outros Lançamentos).
cod_tipo_dh (Optional[str]) – Código do Tipo de Documento Hábil.

Retorno:

Successful Response

Tipo de retorno:

CprDAConsultarSitRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_situacao(
...     aba_dh="valor_exemplo",
...     cod_tipo_dh="valor_exemplo"
... )
>>> print(response)

consultar_ug(codigo_ug: str | None = None) → UGInfoModel[código fonte]

Consultar Unidade Gestora (UG) (GET /v1/siafi-global-hom/custom/tabelas/consultar-ug).

Parâmetros:: codigo_ug (Optional[str]) – Código da Unidade Gestora (UG) a ser consultada. Tipo: int, Tamanho: 1-6. Exemplo: “160001”.
Retorno:: Successful Response
Tipo de retorno:: UGInfoModel
Levanta:: ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.consultar_ug(
...     codigo_ug="valor_exemplo"
... )
>>> print(response)

detalhar_dh(cod_ug_emit: str | None = None, ano_DH: str | None = None, cod_tipo_DH: str | None = None, num_DH: str | None = None) → CprDhDetalharRespostaModel[código fonte]

Detalha um Documento Hábil no SIAFI (GET /v1/siafi-global-hom/custom/cpr/detalhar-documento-habil).

Parâmetros:

cod_ug_emit (Optional[str]) – Código da UG emitente.
ano_DH (Optional[str]) – Ano do Documento Hábil.
cod_tipo_DH (Optional[str]) – Código do Tipo de Documento Hábil.
num_DH (Optional[str]) – Número do Documento Hábil.

Retorno:

Successful Response

Tipo de retorno:

CprDhDetalharRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_dh(
...     cod_ug_emit="valor_exemplo",
...     ano_DH="valor_exemplo",
...     cod_tipo_DH="valor_exemplo",
...     num_DH="valor_exemplo"
... )
>>> print(response)

detalhar_empenho(ug_emitente: str | None = None, ano_empenho: str | None = None, num_empenho: str | None = None) → OrcDetalharEmpenhoRespostaModel[código fonte]

Detalhar Empenho (GET /v1/siafi-global-hom/custom/orcamentario/detalhar-empenho).

Parâmetros:

ug_emitente (Optional[str]) – Código da UG emitente do empenho.
ano_empenho (Optional[str]) – Ano do empenho (AAAA).
num_empenho (Optional[str]) – Número do empenho (NumNE).

Retorno:

Successful Response

Tipo de retorno:

OrcDetalharEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_empenho(
...     ug_emitente="valor_exemplo",
...     ano_empenho="valor_exemplo",
...     num_empenho="valor_exemplo"
... )
>>> print(response)

Detalha uma Lista de Credores Pix (Lista LX) no SIAFI (GET /v1/siafi-global-hom/custom/cpr/detalhar-lx).

Parâmetros:

cod_ug_emit (Optional[str]) – Código da UG emitente.
ano_LX (Optional[str]) – Ano da LX.
num_LX (Optional[str]) – Número da LX.
num_seq_item_A_partir_de (Optional[str]) – Número sequencial do item a partir de (opcional).
num_seq_item_selecionado (Optional[str]) – Números sequenciais dos itens selecionados (JSON ou string codificada, opcional).

Retorno:

Successful Response

Tipo de retorno:

CprCPDetalharLXRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_lx(
...     cod_ug_emit="valor_exemplo",
...     ano_LX="valor_exemplo",
...     num_LX="valor_exemplo",
...     num_seq_item_A_partir_de="valor_exemplo",
...     num_seq_item_selecionado="valor_exemplo"
... )
>>> print(response)

detalhar_op(ug_pagadora: str | None = None, numero_OP: str | None = None) → CprCPDetalharOPResponseModel[código fonte]

Detalha uma Ordem de Pagamento no SIAFI (GET /v1/siafi-global-hom/custom/cpr/detalhar-ordem-pagamento).

Parâmetros:

ug_pagadora (Optional[str]) – UG Pagadora.
numero_OP (Optional[str]) – Número da OP. Exemplo: 2025OP000001

Retorno:

Successful Response

Tipo de retorno:

CprCPDetalharOPResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_op(
...     ug_pagadora="valor_exemplo",
...     numero_OP="valor_exemplo"
... )
>>> print(response)

detalhar_pre_empenho(ug_emitente: str | None = None, ano_pre_empenho: str | None = None, num_pre_empenho: str | None = None) → OrcDetalharPreEmpenhoRespostaModel[código fonte]

Detalhar Pré-empenho (GET /v1/siafi-global-hom/custom/orcamentario/detalhar-pre-empenho).

Parâmetros:

ug_emitente (Optional[str]) – Código da UG emitente do pré-empenho.
ano_pre_empenho (Optional[str]) – Ano do pré-empenho (AAAA).
num_pre_empenho (Optional[str]) – Número do pré-empenho (NumPE).

Retorno:

Successful Response

Tipo de retorno:

OrcDetalharPreEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_pre_empenho(
...     ug_emitente="valor_exemplo",
...     ano_pre_empenho="valor_exemplo",
...     num_pre_empenho="valor_exemplo"
... )
>>> print(response)

detalhar_programacao_financeira(cod_ug_emit: str | None = None, ano: str | None = None, numero_documento: str | None = None) → PFDetalharProgramacaoFinanceiraResponseModel[código fonte]

Detalhar Programação Financeira (GET /v1/siafi-global-hom/custom/pf/detalhar-programacao-financeira).

Parâmetros:

cod_ug_emit (Optional[str]) – UG emitente.
ano (Optional[str]) – Ano da programação.
numero_documento (Optional[str]) – Número do documento SIAFI.

Retorno:

Successful Response

Tipo de retorno:

PFDetalharProgramacaoFinanceiraResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_programacao_financeira(
...     cod_ug_emit="valor_exemplo",
...     ano="valor_exemplo",
...     numero_documento="valor_exemplo"
... )
>>> print(response)

detalhar_situacao(cod_sit: str | None = None, grupo_dados: str | None = None) → CprDADetalharSitRespostaModel[código fonte]

Detalha situação do Documento Hábil no SIAFI (GET /v1/siafi-global-hom/custom/cpr/da-detalhar-situacao).

Parâmetros:

cod_sit (Optional[str]) – Código da Situação.
grupo_dados (Optional[str]) – Grupo de Dados (JSON ou string codificada).

Retorno:

Successful Response

Tipo de retorno:

CprDADetalharSitRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.detalhar_situacao(
...     cod_sit="valor_exemplo",
...     grupo_dados="valor_exemplo"
... )
>>> print(response)

devolver_recurso_financeiro(payload: PFDevolverRecursoFinanceiroRequestModel, otp: Otp | None = None) → PFDevolverRecursoFinanceiroResponseModel[código fonte]

Devolver Recurso Financeiro (POST /v1/siafi-global-hom/custom/pf/devolver-recurso-financeiro).

Parâmetros:

payload (PFDevolverRecursoFinanceiroRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

PFDevolverRecursoFinanceiroResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.devolver_recurso_financeiro(
...     payload=PFDevolverRecursoFinanceiroRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

estabelecer_limites_plurianuais(payload: TabEstabLimPlurianuaisRequestModel, otp: Otp | None = None) → ParamEstabLimPlurianuaisResponseModel[código fonte]

Estabelecer limites plurianuais para movimentação financeira (POST /v1/siafi-global-hom/custom/tabelas/estabelecer-limites-plurianuais).

Parâmetros:

payload (TabEstabLimPlurianuaisRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

ParamEstabLimPlurianuaisResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.estabelecer_limites_plurianuais(
...     payload=TabEstabLimPlurianuaisRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

estornar_compromisso(payload: CprCPEstornarModel, otp: Otp | None = None) → CprCPEstornarCompromissoResponseModel[código fonte]

Estorna um compromisso no SIAFI (POST /v1/siafi-global-hom/custom/cpr/estornar-compromisso).

Parâmetros:

payload (CprCPEstornarModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprCPEstornarCompromissoResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.estornar_compromisso(
...     payload=CprCPEstornarModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

excluir_amparo_legal(cod_amparo_legal: str | None = None, motivo: str | None = None, otp: Otp | None = None) → OrcAmparoLegalRespostaModel[código fonte]

Excluir Amparo Legal (DELETE /v1/siafi-global-hom/custom/orcamentario/excluir-amparo-legal).

Parâmetros:

cod_amparo_legal (Optional[str]) – Código do Amparo Legal a ser excluído.
motivo (Optional[str]) – Motivo da exclusão.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcAmparoLegalRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.excluir_amparo_legal(
...     cod_amparo_legal="valor_exemplo",
...     motivo="valor_exemplo",
...     otp=seu_objeto_otp
... )
>>> print(response)

excluir_lx(cod_ug_emit: str | None = None, ano_LX: str | None = None, num_LX: str | None = None, otp: Otp | None = None) → CprCPExcluirLXRespostaModel[código fonte]

Exclui uma Lista de Credores Pix (Lista LX) no SIAFI (DELETE /v1/siafi-global-hom/custom/cpr/excluir-lx).

Parâmetros:

cod_ug_emit (Optional[str]) – Código da UG emitente.
ano_LX (Optional[str]) – Ano da LX.
num_LX (Optional[str]) – Número da LX.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprCPExcluirLXRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.excluir_lx(
...     cod_ug_emit="valor_exemplo",
...     ano_LX="valor_exemplo",
...     num_LX="valor_exemplo",
...     otp=seu_objeto_otp
... )
>>> print(response)

incluir_amparo_legal(payload: IncluirAmparoLegalRequestModel, otp: Otp | None = None) → OrcAmparoLegalRespostaModel[código fonte]

Incluir Amparo Legal (POST /v1/siafi-global-hom/custom/orcamentario/incluir-amparo-legal).

Parâmetros:

payload (IncluirAmparoLegalRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcAmparoLegalRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.incluir_amparo_legal(
...     payload=IncluirAmparoLegalRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

incluir_empenho(payload: IncluirEmpenhoRequestModel, otp: Otp | None = None) → OrcEmpenhoRespostaModel[código fonte]

Incluir Empenho (POST /v1/siafi-global-hom/custom/orcamentario/incluir-empenho).

Parâmetros:

payload (IncluirEmpenhoRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.incluir_empenho(
...     payload=IncluirEmpenhoRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

incluir_pre_empenho(payload: IncluirPreEmpenhoRequestModel, otp: Otp | None = None) → OrcPreEmpenhoRespostaModel[código fonte]

Incluir Pré-empenho (POST /v1/siafi-global-hom/custom/orcamentario/incluir-pre-empenho).

Parâmetros:

payload (IncluirPreEmpenhoRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcPreEmpenhoRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.incluir_pre_empenho(
...     payload=IncluirPreEmpenhoRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

incluir_rip(payload: TabIncluirRIPRequestModel, otp: Otp | None = None) → ParamManterRIPResponseModel[código fonte]

Incluir novo Registro de Informações de Pagamento (RIP) (POST /v1/siafi-global-hom/custom/tabelas/incluir-rip).

Parâmetros:

payload (TabIncluirRIPRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

ParamManterRIPResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.incluir_rip(
...     payload=TabIncluirRIPRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

manter_lx(payload: CprCPManterLXEntradaModel, otp: Otp | None = None) → CprCPManterLXRespostaModel[código fonte]

Manutenção de Lista de Credores Pix (Lista LX) no SIAFI (PUT /v1/siafi-global-hom/custom/cpr/manter-lx).

Parâmetros:

payload (CprCPManterLXEntradaModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprCPManterLXRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.manter_lx(
...     payload=CprCPManterLXEntradaModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

otp_default: Otp = Otp(type='webauthn2steps', value=None, flow_id=None, mode='interactive-window')

realizar_total_compromissos(payload: CprCPRealizarTotalModel, otp: Otp | None = None) → CprCPRealizarTotalCompromissosResponseModel[código fonte]

Realiza o total de compromissos informados no SIAFI (POST /v1/siafi-global-hom/custom/cpr/realizar-total-compromissos).

Parâmetros:

payload (CprCPRealizarTotalModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprCPRealizarTotalCompromissosResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.realizar_total_compromissos(
...     payload=CprCPRealizarTotalModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

reincluir_amparo_legal(payload: ReincluirAmparoLegalRequestModel, otp: Otp | None = None) → OrcAmparoLegalRespostaModel[código fonte]

Reincluir Amparo Legal (POST /v1/siafi-global-hom/custom/orcamentario/reincluir-amparo-legal).

Parâmetros:

payload (ReincluirAmparoLegalRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

OrcAmparoLegalRespostaModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.reincluir_amparo_legal(
...     payload=ReincluirAmparoLegalRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

restabelecer_compromisso(payload: CprCPRestabelecerModel, otp: Otp | None = None) → CprCPRestabelecerCompromissoResponseModel[código fonte]

Restabelecimento de compromisso no SIAFI (POST /v1/siafi-global-hom/custom/cpr/restabelecer-compromisso).

Parâmetros:

payload (CprCPRestabelecerModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

CprCPRestabelecerCompromissoResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.restabelecer_compromisso(
...     payload=CprCPRestabelecerModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

set_env(env: str)[código fonte]: Altera o ambiente SIAFI padrão utilizado nas chamadas subsequentes.

set_ug(ug: str)[código fonte]: Altera a UG padrão utilizada nas chamadas subsequentes.

transferir_recurso_financeiro(payload: PFTransferirRecursoFinanceiroRequestModel, otp: Otp | None = None) → PFTransferirRecursoFinanceiroResponseModel[código fonte]

Transferir Recurso Financeiro (POST /v1/siafi-global-hom/custom/pf/transferir-recurso-financeiro).

Parâmetros:

payload (PFTransferirRecursoFinanceiroRequestModel) – O payload da requisição.
otp (Optional[Otp]) – Token de autenticação One-Time Password.

Retorno:

Successful Response

Tipo de retorno:

PFTransferirRecursoFinanceiroResponseModel

Levanta:

ValueError – Se a API retornar um código de erro (status não-2xx).

Example

>>> response = client.transferir_recurso_financeiro(
...     payload=PFTransferirRecursoFinanceiroRequestModel(...)  # Preencha com os dados,
...     otp=seu_objeto_otp
... )
>>> print(response)

wsdl_dump() → dict[código fonte]

Wsdl Dump Endpoint (GET /v1/siafi-global-hom/custom/wsdl/dump/{tipo}).

Retorno:: Successful Response
Tipo de retorno:: dict
Levanta:: ValueError – Se a API retornar um código de erro (status não-2xx).

wsdl_generate_python() → dict[código fonte]

Wsdl Generate Python Endpoint (GET /v1/siafi-global-hom/custom/wsdl/generate_python/{tipo}).

Retorno:: Successful Response
Tipo de retorno:: dict
Levanta:: ValueError – Se a API retornar um código de erro (status não-2xx).

Módulo SIAFI

Sumário

1. Visão Geral

2. Instalação & Pré‑requisitos

3. Autenticação / Configuração

4. Inicializando o Cliente Siafi

4.1 Usando Aria.get_siafi

5. Exemplos de Uso

5.1 Consulta simples (GET)

5.2 Consultar chaves PIX

5.3 Alterar chaves PIX (PUT, com OTP implícito)

5.4 Incluir RIP (POST)

5.5 Consultar saldo contábil

5.6 Fluxo Pré-Empenho: inclusão

5.7 Detalhar e alterar Pré-Empenho (Reforço)

5.8 Empenho: inclusão e detalhamento

5.9 Documento Hábil (CPR) e Realização de Compromissos

5.10 Alterar RIP

5.11 Alterar e consultar chaves PIX

5.12 Programação Financeira: detalhar

6. Uso de Modelos Pydantic

7. OTP (One-Time Password)

8. Tratamento de Erros

9. Como Estender (Adicionar Novo Método)

10. Boas Práticas

12. Referências

Licença

API de Referência

Modelos (Pydantic)

Cliente SIAFI

4. Inicializando o Cliente `Siafi`

4.1 Usando `Aria.get_siafi`