pyarialib package

Module contents

class pyarialib.Aria(username=None, password=None, base_url='https://apiapex.tesouro.gov.br/aria/', token=None)[código fonte]

Bases: object

get_chatLogos() → ChatLogos[código fonte]

get_persona() → Persona[código fonte]

get_sei() → Sei[código fonte]

get_siafi(env, ug, projeto_aria) → Siafi[código fonte]

get_token() → str[código fonte]

request(method: str, version: int, project: str, endpoint: str, body: str = '', json_body: dict = {}, headers: dict = {}, query_string_params: dict = {}, auto_pagination: bool = False, otp: Otp | None = None) → AriaResponse[código fonte]

Realiza uma requisição ao ARIA.

Parâmetros:

method (string) – método da requisição.
version (number) – número da versão da api.
project (string) – nome do projeto.
endpoint (string) – código do endpoint.
body (str, optional) – corpo da requisição em formato de string. Defaults to «».
json_body (dict, optional) – corpo da requisição em formato de dict, enviado como json. Defaults to {}.
headers (dict, optional) – headers da requisição. Defaults to {}.
query_string_params (dict, optional) – parâmetros via querystring. Defaults to {}.

Retorno:

resultado da requisição.

Tipo de retorno:

any

class pyarialib.ChatLogos(aria)[código fonte]

Bases: object

send_message(mensagem: str, login: str, siglaChat: str, nomeConfiguracao: str, idInteracao: int = None)[código fonte]

Envia uma mensagem para o endpoint de chat Logos do ARIA e retorna o conteúdo da resposta e o idInteracao.

Parâmetros:

mensagem (str) – Texto a ser enviado ao Logos.
login (str) – Login do usuário.
siglaChat (str) – Sigla do Logos.
nomeConfiguracao (str) – Nome da configuração do Logos.
idInteracao (int, optional) – ID da interação anterior. Defaults to None.

Retorno:

(content, idInteracao)

Tipo de retorno:

tuple

class pyarialib.Otp(type: str | None = None, value: str | None = None, flow_id: str | None = None, mode: str = 'manual')[código fonte]

Bases: object

Representa credenciais OTP para requisições.

Atributos:

type (str | None): Tipo do OTP (ex: apex, webauthn2steps, email…). value (str | None): Valor/código do OTP (quando requerido). flow_id (str | None): Identificador de fluxo (quando o tipo exige múltiplas etapas). mode (str): Modo de operação do OTP. Valores aceitos:

«manual» (default): envia type/value/flow_id (se existirem) em uma única requisição.

«interactive-console»: fluxo em 2 etapas; a segunda solicita código via console.

«interactive-window»: igual ao anterior, mas a solicitação ocorre em uma janela GUI (Tkinter).

Uso:

otp = Otp(type=»apex», mode=»manual») otp = Otp(type=»apex», mode=»interactive-console») otp = Otp(type=»apex», mode=»interactive-window»)

Durante cada chamada aria.request:

Se mode == «manual»: se presentes e NÃO já definidos manualmente em headers, serão automaticamente adicionados nas duas convenções encontradas nos endpoints atuais:
- x-otp-type / x-otp-value / x-otp-flow-id
- Otp-Type / Otp-Value / Otp-Flow-Id
Se mode in {«interactive-console», «interactive-window»}: duas requisições internas.

flow_id: str | None = None

is_configured() → bool[código fonte]

is_interactive() → bool[código fonte]

mode: str = 'manual'

type: str | None = None

value: str | None = None

class pyarialib.Persona(aria)[código fonte]

Bases: object

get_colaborador(id=None, cpf=None, login=None, inclui_funcoes=False, inclui_frequencia=False, data_frequencia=None, inclui_ocorrencias=False, data_ocorrencias=None, inclui_dependentes=False, inclui_exercicios=False, inclui_jornada_trabalho=False, inclui_telefones=False, inclui_substituicoes=False)[código fonte]

Obtém dados de um colaborador.

Parâmetros:

id (string, optional) – Busca pelo ID do Colaborador. Defaults to None.
cpf (number, optional) – Busca pelo CPF do Colaborador. Defaults to None.
login (string, optional) – Busca pelo login do Colaborador. Defaults to None.
inclui_funcoes (bool, optional) – inclui no atributo «funcoes» a lista de funções que o usuário possui. Defaults to False.
inclui_frequencia (bool, optional) – inclui no atributo «folhas» a lista de folhas de frequência do colaborador. Defaults to False.
data_frequencia (string, optional) – Obtém apenas as ocorrências de uma determinada data ou período. Este atributo pode ter 3 tipos de formatos: «<ano>», para obter todas as ocorrências de um determinado ano. «<mes>/<ano>», para obter todas as ocorrências de um determinado mês. E «<dia>/<mes>/<ano>», para obter as folhas de um dia específico. Defaults to None.
inclui_ocorrencias (bool, optional) – se inclui no atributo «ocorrencias» a lista de ocorrências registradas pelo colaborador. Defaults to False.
data_ocorrencias (string, optional) – obtém apenas as ocorrências de uma determinada data ou período. Este atributo pode ter 3 tipos de formatos: «<ano>», para obter todas as ocorrências de um determinado ano. «<mes>/<ano>», para obter todas as ocorrências de um determinado mês. E «<dia>/<mes>/<ano>», para obter as folhas de um dia específico. Defaults to None.
inclui_dependentes (bool, optional) – se inclui no atributo «dependentes» uma lista de dependentes. Defaults to False.
inclui_exercicios (bool, optional) – se inclui no atributo «exercicios» uma lista de uorgs em que o usuário esteve lotado. Defaults to False.
inclui_jornada_trabalho (bool, optional) – se inclui no atributo «jornadaTrabalho» informações históricas sobre a jornada de trabalho do colaborador. Defaults to False.
inclui_telefones (bool, optional) – se inclui no atributo «telefones» uma lista de telefones cadastrados do colaborador. Defaults to False.
inclui_substituicoes (bool, optional) – se inclui uma lista de substituições de funções do colaborador. Defaults to False.

Retorno:

Um dict do colaborador.

Tipo de retorno:

dict

get_colaboradores(id_uorg=None, inclui_subuorgs=False, inclui_funcoes=False, inclui_frequencia=False, data_frequencia=None, inclui_ocorrencias=False, data_ocorrencias=None, inclui_dependentes=False, inclui_exercicios=False, inclui_jornada_trabalho=False, inclui_telefones=False, inclui_substituicoes=False)[código fonte]

Obtém um array de colaboradores.

Parâmetros:

id_uorg (number, optional) – Busca pelo ID da Uorg. Defaults to None.
inclui_subuorgs (bool, optional) – Inclui as uorgs filho na propriedade «subuorgs». Defaults to False.
inclui_funcoes (bool, optional) – inclui no atributo «funcoes» a lista de funções que o usuário possui. Defaults to False.
inclui_frequencia (bool, optional) – inclui no atributo «folhas» a lista de folhas de frequência do colaborador. Defaults to False.
data_frequencia (string, optional) – Obtém apenas as ocorrências de uma determinada data ou período. Este atributo pode ter 3 tipos de formatos: «<ano>», para obter todas as ocorrências de um determinado ano. «<mes>/<ano>», para obter todas as ocorrências de um determinado mês. E «<dia>/<mes>/<ano>», para obter as folhas de um dia específico. Defaults to None.
inclui_ocorrencias (bool, optional) – se inclui no atributo «ocorrencias» a lista de ocorrências registradas pelo colaborador. Defaults to False.
data_ocorrencias (string, optional) – obtém apenas as ocorrências de uma determinada data ou período. Este atributo pode ter 3 tipos de formatos: «<ano>», para obter todas as ocorrências de um determinado ano. «<mes>/<ano>», para obter todas as ocorrências de um determinado mês. E «<dia>/<mes>/<ano>», para obter as folhas de um dia específico. Defaults to None.
inclui_dependentes (bool, optional) – se inclui no atributo «dependentes» uma lista de dependentes. Defaults to False.
inclui_exercicios (bool, optional) – se inclui no atributo «exercicios» uma lista de uorgs em que o usuário esteve lotado. Defaults to False.
inclui_jornada_trabalho (bool, optional) – se inclui no atributo «jornadaTrabalho» informações históricas sobre a jornada de trabalho do colaborador. Defaults to False.
inclui_telefones (bool, optional) – se inclui no atributo «telefones» uma lista de telefones cadastrados do colaborador. Defaults to False.
inclui_substituicoes (bool, optional) – se inclui uma lista de substituições de funções do colaborador. Defaults to False.

Retorno:

Array de dicts de colaboradores.

Tipo de retorno:

dict

get_uorg(id_uorg=None, sigla=None, sigla_pai=None, inclui_funcoes=False, inclui_inativas=False, inclui_subuorgs=False)[código fonte]

Obtém dados da Uorg.

Parâmetros:

id_uorg (_type_, optional) – Buscar pelo ID da Uorg. Defaults to None.
sigla (_type_, optional) – Buscar pela sigla da Uorg. Defaults to None.
sigla_pai (_type_, optional) – Buscar pela sigla pai da Uorg. Defaults to None.
inclui_funcoes (bool, optional) – se inclui as funções e os colaboradores que ocuparam as funções da uorg. Defaults to False.
inclui_inativas (bool, optional) – se inclui unidades inativas no resultado. Defaults to False.
inclui_subuorgs (bool, optional) – traz não somente a uorg em questão, mas também todas as suas subUorgs, no atributo subUorgs. Defaults to False.

Retorno:

Dicts de dados da Uorg.

Tipo de retorno:

dict

get_uorgs(id_nivel=None, id_uorg_pai=None, inclui_funcoes=False, inclui_inativas=False, inclui_subuorgs=False)[código fonte]

Obtém dados de várias uorgs.

Parâmetros:

id_nivel (_type_, optional) – Busca pelo nível da Uorg. Defaults to None.
id_uorg_pai (_type_, optional) – Busca pelo ID da Uorg. Defaults to None.
inclui_funcoes (bool, optional) – se inclui as funções e os colaboradores que ocuparam as funções da uorg. Defaults to False.
inclui_inativas (bool, optional) – se inclui unidades inativas no resultado. Defaults to False.
inclui_subuorgs (bool, optional) – traz não somente a uorg em questão, mas também todas as suas subUorgs, no atributo subUorgs. Defaults to False.

Retorno:

Dicts de dados da Uorg.

Tipo de retorno:

dict

get_uorgs_stn()[código fonte]

Obtém toda a hierarquia de uorgs da STN.

Retorno:: Dict contendo a Uorg STN + todas as subuorgs na propriedade subUorgs.
Tipo de retorno:: dict

class pyarialib.Sei(aria)[código fonte]

Bases: object

gerar_procedimento(id_tipo_procedimento: int) → dict[código fonte]

Gera um procedimento/processo vazio no SEI. Retorna informações sobre o procedimento.

Example

Parâmetros:: id_tipo_procedimento (int) – ID do tipo de procedimento.
Retorno:: Informações do procedimento.
Tipo de retorno:: dict

get_documento(codigo: str) → dict[código fonte]

Obtém um documento pelo seu código do SEI.

Example

documento_novo = sei.get_documento(codigo="134112")

Parâmetros:: codigo (str) – código SEI do Documento.
Retorno:: Documento SEI.
Tipo de retorno:: dict

get_documentos(codigo_procedimento_sei: str = None) → list[dict][código fonte]

Obtém uma lista de documentos de um determindo procedimento/processo. Procedimento é o mesmo que processo.

Somente vai trazer se o processo tiver sido feito pela API.

Example

documentos_procedimento = sei.get_documentos(codigo_procedimento_sei="17944.100037/2023-84")

for doc in documentos_procedimento:
    print(doc)

Parâmetros:: codigo_procedimento_sei (str, optional) – Código do procedimento/processo SEI. Defaults to None.
Retorno:: _description_
Tipo de retorno:: _type_

get_modelo_html(id: int) → dict[código fonte]

Obtém um modelo HTML com base em seu id.

Example

modelo_html = sei.get_modelo_html(id=1)
print(modelo_html.get("idModeloHtml"))
print(modelo_html.get("nome"))
print(modelo_html.get("html"))
print(modelo_html.get("idUnidadeStn"))

Parâmetros:: id (int) – ID do Modelo HTML. Defaults to None.
Retorno:: _description_
Tipo de retorno:: _type_

get_modelos_html(id_unidade_stn: int = None) → list[dict][código fonte]

Obtém uma lista de modelos HTML do SEI Administrar.

Example:

modelos_html_unidade = sei.get_modelos_html(id_unidade_stn=1)

for modelo_html in modelos_html_unidade:
    print(modelo_html.get("idModeloHtml"))
    print(modelo_html.get("nome"))
    print(modelo_html.get("html"))
    print(modelo_html.get("idUnidadeStn"))

Parâmetros:: id_unidade_stn (int, optional) – ID da Unidade a qu pertence os Modelos HTML. É opcional. Defaults to None.
Retorno:: a lista de Modelos Html.
Tipo de retorno:: _type_

get_procedimento(id: int = None, codigo: str = None) → dict[código fonte]

Obtém um procedimento/processo específico pelo seu id ou pelo seu código.

Example

Parâmetros:

id (int, optional) – ID do procedimento/processo. Defaults to None.
codigo (str, optional) – Código do procedimento/processo. Defaults to None.

Retorno:

O procedimento.

Tipo de retorno:

_type_

get_procedimentos() → list[dict][código fonte]

Obtém a lista de Processos/Procedimentos no SEI Administrar. Basicamente, esta função irá trazer todos os Processos/Procedimentos que foram criados utilizando esta API.

Example

procedimentos = sei.get_procedimentos()

for procedimento in procedimentos:
    print(procedimento.get("idProcedimento"))
    print(procedimento.get("codigoProcedimentoSei"))

Retorno:: Lista de Processos/procedimentos.
Tipo de retorno:: _type_

get_serie(nome: str) → dict[código fonte]

Obtém uma série do SEI pelo seu nome.

Example

serie = sei.get_serie(nome="Volume de Processo")
print(serie.get("idSerie"))
print(serie.get("nome"))
print(serie.get("aplicabilidade"))

Parâmetros:: nome (str) – o nome da série.
Retorno:: _description_
Tipo de retorno:: _type_

get_series() → list[dict][código fonte]

Obtém a lista de séries do SEI.

Example

series = sei.get_series()

for serie in series:
    print(serie.get("idSerie"))
    print(serie.get("nome"))
    print(serie.get("aplicabilidade"))

Retorno:: a lista de séries do SEI.
Tipo de retorno:: _type_

gravar_documento_arquivo(codigo_procedimento_sei: str, descricao: str, id_serie_sei: int, arquivo: bytes | str, nome_arquivo: str, data_arquivo: datetime | str) → str[código fonte]

Grava um documento qualquer (ex.: PDF) em um procedimento/processo SEI.

Example

with open("MeuDocumento.pdf", "rb") as arquivo:
    arquivo_teste = arquivo.read()

codigo_documento_novo_arquivo = sei.gravar_documento_arquivo(
    codigo_procedimento_sei=novo_procedimento.get('codigoProcedimentoSei'),
    descricao="17944.100005/2022-06",
    id_serie_sei=263,
    nome_arquivo="Teste1.pdf",
    data_arquivo=datetime.now(),
    arquivo=arquivo_teste
)

Parâmetros:

codigo_procedimento_sei (str) – Código do procedimento SEI a ser incluído o documento.
descricao (str) – Descrição do documento.
id_serie_sei (int) – ID da Série.
arquivo (bytes | str) – Arquivo em bytes, ou o arquivo codificado em base64 em string.
nome_arquivo (str) – Nome do arquivo.s
data_arquivo (datetime | str) – Data do arquivo em datetime, ou em string no formato «DD/MM/YYYY».

Retorno:

código SEI do documento.

Tipo de retorno:

str

gravar_documento_html(codigo_procedimento_sei: str, descricao: str, id_serie_sei: int, html: str) → str[código fonte]

Grava um documento HTML em um procedimento/processo SEI.

Example

codigo_documento_novo = sei.gravar_documento_html(
    codigo_procedimento_sei="17944.100005/2022-06",
    descricao="Meu novo documento",
    id_serie_sei=1247,
    html="<p>HTML do meu documento</p>"
)

Parâmetros:

codigo_procedimento_sei (str) – Código do procedimento/processo sei.
descricao (str) – Descrição do documento.
id_serie_sei (int) – ID da Série.
html (str) – HTML com o conteúdo do documento.

Retorno:

código SEI do documento gerado.

Tipo de retorno:

str

class pyarialib.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).