Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

1. Exemplo do json:

{
  "codigo": 1,
  "id_natureza_operacao": 1001,
  "entrada_saida": "E",
  "descricao": "Configuração de Nota Fiscal",
  "emite_documento_eletronico": "S",
  "tipo_documento_eletronico": "NF-e",
  "finalidade_nfe": "N",
  "ativo": "S",
  "pegar_decimais_unidade_para_usar_quantidade": "S",
  "decimais_quantidade": 2,
  "decimais_valor_unitario": 2,
  "decimais_valor_total": 2,
  "decimais_impressao_valor_unitario": 2,
  "decimais_impressao_desconto_unitario": 2,
  "cfop": "5102",
  "calcular_custo": "S",
  "contabilidade": "S",
  "impostos_obrigatorios": "S",
  "codigo_externo": "EXT123",
  "data_alteracao": "2024-08-29T13:16:13.212Z",
  "nota_configuracao_centro_custo": {
    "id": 1,
    "id_nota_configuracao": 1001,
    "id_centro_custo": 2001,
    "codigo_externo": "EXT123"
  },
  "nota_configuracao_forma_pagamento_aceitar": [
    {
      "id": 1,
      "id_nota_configuracao": 1001,
      "id_forma_pagamento": 2001,
      "codigo_externo": "EXT123"
    }
  ],
  "nota_configuracao_forma_pagamento_gerar": [
    {
      "id": 1,
      "id_nota_configuracao": 1001,
      "id_forma_pagamento": 2001,
      "codigo_externo": "EXT123"
    }
  ]
}

Campos:

  • codigo: Código único da configuração da nota

  • id_natureza_operacao: ID da natureza da operação

  • entrada_saida: Entrada ou saída da nota. Valores disponíveis: (E)ENTRADA, (S)SAIDA

  • descricao: Descrição da configuração da nota

  • emite_documento_eletronico: Indica se emite documento eletrônico. Valores disponíveis: SIM(S), NAO(N)

  • tipo_documento_eletronico: Tipo de documento eletrônico

  • finalidade_nfe: Finalidade da NF-e. Valores disponíveis: (N) NORMAL, (C) COMPLEMENTAR, (A) AJUSTE, (D) DEVOLUCAO

  • ativo: Indica se a configuração está ativa. Valores disponíveis: SIM (S), NAO (N)

  • pegar_decimais_unidade_para_usar_quantidade: Indica se deve pegar decimais da unidade para usar na

  • quantidade. Valores disponíveis: SIM (S), NAO (N)

  • decimais_quantidade: Número de decimais na quantidade

  • decimais_valor_unitario: Número de decimais no valor unitário

  • decimais_valor_total: Número de decimais no valor total

  • decimais_impressao_valor_unitario: Número de decimais na impressão do valor unitário

  • decimais_impressao_desconto_unitario: Número de decimais na impressão do desconto unitário

  • cfop: Código Fiscal de Operações e Prestações (CFOP)

  • calcular_custo: Indica se deve calcular custo. Valores disponíveis: SIM(S), NAO(N)

  • contabilidade: Indica se deve considerar contabilidade. Valores disponíveis: SIM (S), NAO (N)

  • impostos_obrigatorios: Indica se deve considerar impostos obrigatórios. Valores disponíveis: SIM (S), NAO (N)

  • codigo_externo: Código externo da configuração da nota

  • data_alteracao: Data da última alteração do registro

  • nota_configuracao_centro_custo: Configuração do centro de custo da nota

    • id: ID único do centro de custo da configuração da nota

    • id_nota_configuracao: ID da configuração da nota

    • id_centro_custo: ID do centro de custo

    • codigo_externo: Código externo

  • nota_configuracao_forma_pagamento_aceitar Configuração das formas de pagamento aceitas

    • id: ID único da forma de pagamento aceita na configuração da nota

    • id_nota_configuracao: ID da configuração da nota

    • id_forma_pagamento: ID da forma de pagamento

    • codigo_externo: Código externo da forma de pagamento

  • nota_configuracao_forma_pagamento_gerar Configuração das formas de pagamento a serem geradas

    • id: ID único da forma de pagamento gerada na configuração da nota

    • id_nota_configuracao: ID da configuração da nota

    • id_forma_pagamento: ID da forma de pagamento

    • codigo_externo: Código externo da forma de pagamento

2. Endpoints

2.1 - Buscar configurações de nota pelo código

Endpoint: /nota-configuracao

Tipo: get

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código da configuração de nota no banco de dados do CRM.

Resposta: Status 200 - Retorna a configuração de nota no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as configurações de nota

Endpoint: /nota-configuracao/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das configurações de nota no formato documentado na sessão Exemplo do json

2.5 - Retornar os metadados das configurações de nota

Endpoint: /nota-configuracao/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos da configuração de nota

2.6 - Pesquisar

Endpoint: /nota-configuracao/pesquisa

Tipo: post

Notas:

  • Esse endpoint retorna as configurações de nota baseado nos filtros e na ordenação informados;

  • Exemplo do corpo da requisição:

{
  "pagina": 1,
  "quantidadeRegistros": 10,
  "filtros": [
    {
      "campo": "descricao",
      "comparacao": "COMECA_COM",
      "valor": "C"
    }
  ],
  "ordenacao": [
    {
      "campo": "descricao",
      "ordenacao": "ASC"
    }
  ]
}

  • Nesse exemplo, estamos filtrando todas os Configurações de nota cuja descrição começa com a letra C;

  • No labels