Visão geralServiçosEventosRecursos
TermoPortal

Fatura

7 funções do TermoPortal para fatura.

// npm install termo_core --save-exact
import * as portal from "termo_core/portal";
// ou: import { portal } from "termo_core";
FunçãoRotaO que faz
buscar_paginador_faturaGET /faturaLista as faturas paginadas
criar_faturaPOST /faturaCadastra uma fatura
buscar_auto_complete_faturaGET /fatura/autocompleteLista básica de faturas para seleção
buscar_pelo_filtro_faturaGET /fatura/filtroBusca faturas por filtro
buscar_pelo_id_faturaGET /fatura/{id}Busca uma fatura pelo id
atualizar_pelo_id_faturaPATCH /fatura/{id}Atualiza uma fatura
deletar_pelo_id_faturaDELETE /fatura/{id}Exclui uma fatura

buscar_paginador_fatura

GET/fatura Exige credencial

Lista as faturas paginadas

Exige a permissão ver no módulo Financeiro do perfil de quem chama (administrador e master têm tudo). Do vencimento mais recente para o mais antigo. Quem não é colaborador interno precisa informar unidade_id de uma unidade da própria sessão; colaborador interno pode omitir e vê todas. Paginado com 50 itens por página (fixo); pagina começa em 1 (padrão 1). A resposta traz itens, total (registros que casam), pagina e tamanho.

function buscar_paginador_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorFatura = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaFatura>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_fatura(credencial_de_acesso, { unidade_id: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaFatura> · Rust: Result<tipos::PaginaFatura, ErroAoChamarServico> · veja PaginaFatura.

criar_fatura

POST/fatura Exige credencial

Cadastra uma fatura

Exige a permissão criar no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Fatura (boleto/título) de uma unidade cliente, mostrada no Financeiro do portal. documento (até 60 caracteres) é único; unidade_id precisa ser da sessão (colaborador interno acessa todas); pedido_id opcional precisa ser um pedido da mesma unidade; vencimento (AAAA-MM-DD); valor; status_rotulo (até 60 caracteres, texto exibido) e tom (sucesso, alerta, perigo, informacao ou neutro, a cor do selo).

function criar_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.FaturaCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Fatura>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { criar_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_fatura(credencial_de_acesso, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Fatura> · Rust: Result<tipos::Fatura, ErroAoChamarServico> · veja Fatura.

buscar_auto_complete_fatura

GET/fatura/autocomplete Exige credencial

Lista básica de faturas para seleção

Exige a permissão ver no módulo Financeiro do perfil de quem chama (administrador e master têm tudo). Devolve só id e documento, em ordem alfabética. busca procura no documento. Quem não é colaborador interno precisa informar unidade_id de uma unidade da própria sessão; colaborador interno pode omitir e vê todas. tamanho tem padrão 10 e vai de 1 a 50; pagina começa em 1. A resposta traz itens, total, pagina e tamanho.

function buscar_auto_complete_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteFatura = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaFaturaAutoComplete>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_fatura(credencial_de_acesso, { busca: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaFaturaAutoComplete> · Rust: Result<tipos::PaginaFaturaAutoComplete, ErroAoChamarServico> · veja PaginaFaturaAutoComplete.

buscar_pelo_filtro_fatura

GET/fatura/filtro Exige credencial

Busca faturas por filtro

Exige a permissão ver no módulo Financeiro do perfil de quem chama (administrador e master têm tudo). Devolve as faturas não excluídas que casam com o filtro, até 50 por página (pagina, a partir de 1, padrão 1), do vencimento mais recente para o mais antigo. Quem não é colaborador interno precisa informar unidade_id de uma unidade da própria sessão; colaborador interno pode omitir e vê todas. pedido_id e documento são exatos.

function buscar_pelo_filtro_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroFatura = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Fatura>>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_fatura(credencial_de_acesso, { unidade_id: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<Array<tipos.Fatura>> · Rust: Result<Vec<tipos::Fatura>, ErroAoChamarServico>

buscar_pelo_id_fatura

GET/fatura/{id} Exige credencial

Busca uma fatura pelo id

Exige a permissão ver no módulo Financeiro do perfil de quem chama (administrador e master têm tudo). Fatura excluída, ou de unidade fora da sessão, responde 404.

function buscar_pelo_id_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Fatura>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_fatura(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Fatura> · Rust: Result<tipos::Fatura, ErroAoChamarServico> · veja Fatura.

atualizar_pelo_id_fatura

PATCH/fatura/{id} Exige credencial

Atualiza uma fatura

Exige a permissão editar no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Mesmas regras do cadastro; pedido_id aceita null para desvincular. A unidade não muda. Fatura de unidade fora da sessão responde 404. Atualização parcial: campo ausente mantém o valor atual. Campos: documento até 60 caracteres e único; vencimento em AAAA-MM-DD; valor é decimal; status_rotulo até 60 caracteres (texto do selo); tom é sucesso, alerta, perigo, informacao ou neutro.

function atualizar_pelo_id_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.FaturaAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Fatura>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_fatura(credencial_de_acesso, id, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Fatura> · Rust: Result<tipos::Fatura, ErroAoChamarServico> · veja Fatura.

deletar_pelo_id_fatura

DELETE/fatura/{id} Exige credencial

Exclui uma fatura

Exige a permissão excluir no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Fatura de unidade fora da sessão responde 404. A exclusão é lógica: o registro some das leituras, mas a linha não é apagada.

function deletar_pelo_id_fatura(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_fatura } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_fatura(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

Fatura

import type { Fatura } from "termo_core/portal";

export interface Fatura {
  atualizado_em: string;
  criado_em: string;
  documento: string;
  id: string;
  pedido_id?: string | null;
  pedido_numero?: string | null;
  status_rotulo: string;
  tom: string;
  unidade_id: string;
  unidade_razao_social: string;
  valor: number;
  vencimento: string;
}

FaturaAtualizar

import type { FaturaAtualizar } from "termo_core/portal";

export interface FaturaAtualizar {
  documento?: string | null;
  pedido_id?: string | null;
  status_rotulo?: string | null;
  tom?: string | null;
  valor?: number | null;
  vencimento?: string | null;
}

FaturaCriar

import type { FaturaCriar } from "termo_core/portal";

export interface FaturaCriar {
  documento: string;
  pedido_id?: string | null;
  status_rotulo: string;
  tom?: string | null;
  unidade_id: string;
  valor: number;
  vencimento: string;
}

PaginaFatura

import type { PaginaFatura } from "termo_core/portal";

export interface PaginaFatura {
  itens: Array<PaginaFaturaItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaFaturaAutoComplete

import type { PaginaFaturaAutoComplete } from "termo_core/portal";

export interface PaginaFaturaAutoComplete {
  itens: Array<PaginaFaturaAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaFaturaAutoCompleteItensItem

import type { PaginaFaturaAutoCompleteItensItem } from "termo_core/portal";

export interface PaginaFaturaAutoCompleteItensItem {
  documento: string;
  id: string;
}

PaginaFaturaItensItem

import type { PaginaFaturaItensItem } from "termo_core/portal";

export interface PaginaFaturaItensItem {
  atualizado_em: string;
  criado_em: string;
  documento: string;
  id: string;
  pedido_id?: string | null;
  pedido_numero?: string | null;
  status_rotulo: string;
  tom: string;
  unidade_id: string;
  unidade_razao_social: string;
  valor: number;
  vencimento: string;
}

Expedição

3 funções do TermoPortal para expedição.

Indicador compra

1 função do TermoPortal para indicador compra.

Nesta página

buscar_paginador_faturacriar_faturabuscar_auto_complete_faturabuscar_pelo_filtro_faturabuscar_pelo_id_faturaatualizar_pelo_id_faturadeletar_pelo_id_faturaTiposFaturaFaturaAtualizarFaturaCriarPaginaFaturaPaginaFaturaAutoCompletePaginaFaturaAutoCompleteItensItemPaginaFaturaItensItem