Pular para o conteúdo principal

Faturamento

Esta referência cobre as chamadas do módulo Faturamento: a cobrança dos treinamentos feitos para as empresas clientes e o registro das notas fiscais de serviço correspondentes. As telas correspondentes estão no menu Faturamento do manual do usuário.

O Pedagogo não emite nota fiscal de serviço. A nota é emitida na prefeitura ou no portal da NFS-e, e o arquivo XML é importado no módulo.

Os caminhos começam por /invoicing, a partir do endereço base descrito em Convenções. Valem também a autenticação em Autenticação e as regras de paginação e erros em Convenções.

Recursos​

RecursoTelaPágina
À faturarÀ faturarÀ faturar
FaturadosFaturadosFaturados
Notas fiscaisNotas fiscaisNotas fiscais

Fluxo típico​

  1. Os treinamentos lançados no módulo Comercial aparecem em À faturar, agrupados por empresa.
  2. Um faturamento é aberto para a empresa e o período: POST /invoicing/pending-billings.
  3. Os alunos da empresa no período são incluídos no faturamento: to-bill-students e POST to-bill-students, descritos em Faturados.
  4. O faturamento é concluído: PATCH /invoicing/billings/{uuid}/conclude.
  5. A nota é emitida fora do Pedagogo e o XML é importado: POST /invoicing/invoices/import-xml.
  6. A nota é vinculada ao faturamento: PUT /invoicing/invoices/{uuid}/save-billing, com a sugestão de billing-sugestions.

Situação da nota​

O objeto status da nota traz o nome da situação cadastrada no sistema, por exemplo Authorized ou Canceled. A importação de XML grava somente as situações Autorizado (Authorized) e Cancelado (Canceled).