Pular para o conteúdo principal

Orçamento: visão geral

O orçamento é a proposta comercial que a clínica apresenta ao paciente antes de executar um tratamento: quais procedimentos serão feitos, quais produtos serão usados, o valor e o responsável pela execução.

Duas operações de consulta​

OperaçãoFinalidade
GET /orcamento/{id}Consultar um orçamento específico
GET /orcamento/listaListar orçamentos entre a data inicial e a data final

Os orçamentos são criados e movimentados pela interface do sistema. A API disponibiliza a consulta dos orçamentos de duas formas: um orçamento específico é consultado pelo seu id, e vários orçamentos são consultados pela listagem, que retorna os orçamentos entre a data inicial e a data final, de forma paginada.

O que um orçamento reúne​

ORÇAMENTO
│
├── paciente (cadastro completo, não só o id)
├── status ABERTO · APROVADO · PERDIDO · CANCELADO
├── valores bruto · desconto · líquido
├── procedimentos[] o que será feito
├── produtos[] o que será consumido
├── dadosExecucao onde, por quem e quando
└── pessoas envolvidas prospector · responsável · pagador

Conteúdo da listagem​

A listagem retorna, em cada item, o orçamento completo, incluindo o cadastro do paciente (nome, CPF, data de nascimento, contato e endereço), os procedimentos, os produtos e os dados de execução.

A listagem é paginada pelos parâmetros pagina e registrosPorPagina. Por exemplo, para obter a segunda página com 20 orçamentos por página:

curl -G "https://api.clinicanasnuvens.com.br/orcamento/lista" \
-H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
-H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
--data-urlencode "tipoData=CRIACAO" \
--data-urlencode "dataInicial=2026-09-01" \
--data-urlencode "dataFinal=2026-09-30" \
--data-urlencode "pagina=1" \
--data-urlencode "registrosPorPagina=20"
ParâmetroPadrãoLimite
pagina0A primeira página é 0
registrosPorPagina50Máximo de 100; valores maiores são ajustados para 100

Por isso, com registrosPorPagina=100, a resposta tem tamanho considerável. Páginas menores reduzem o volume de cada resposta.

Datas e status​

A resposta inclui a dataAprovacao, preenchida quando o orçamento está APROVADO. O orçamento permanece ABERTO até ser aprovado, cancelado ou perdido.

Próximo passo​

Como ler os valores descreve a composição de valor bruto, desconto e valor líquido.