Linha Datasul

Árvore de páginas

CONTEÚDO

  1. Visão Geral
  2. API x Pontos UPC Relacionados
  3. Observações Gerais

01. Visão Geral 

Este documento tem como objetivo descrever o que poderá ser customizado na execução da geração de planilha por meio da API REST cdp/api/v1/planilha.p.
Aqui será descrito quais dados podem ser customizados.

02. API x Pontos UPC Relacionados

Segue a lista de pontos UPC disponíveis.
Para maiores detalhes de como cadastrar uma UPC para essa API podem ser visualizados aqui.

Importante

Tomar cuidado ao manipular os dados via UPC com o endpoint de geração de planilha, pois o mesmo é genérico e é executado por várias telas HTML. No payload da requisição é possível identificar qual é a tela por meio dos atributos: programApiQuery e title.

Exemplo
{
  programApiQuery: "cdp/rules/paramEventoTributosRules.r",
  title: "Parâmetros evento tributos",
  procedureQuery: "executeQuery",
  visibleFields: [...]
}
Manipulação de Dados
EndpointEventoEntradaObservação
generate

beforeGenerate

Dados do requisição (input)

Executado antes da geração da planilha.

generate

afterGenerate

Dados do requisição (input)

Dados do retorno (output)

Executado depois da geração da planilha.

03. Observações Gerais