Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Adicionar uma divisão para uma família

Chamada

POST ​[URLAPI]/CadastrosEstruturaisAPI/api​/v1​/Familia​/divisao

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais 


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

IdFamilia*

Identificador da famíliainteger($int64)Mínimo: 0
idDivisao*

Identificador da divisão

integer($int64)Mínimo: 0
padraoEmbCompra*Padrão da embalagem de compranumber($double)
Máximo: 999999.999999
Mínimo: 0
idComprador*

Identificador do comprador

integer($int64)
Mínimo: 0
idTributacao*

Identificador da tributação

integer($int64)
Mínimo: 0
finalidadeFamilia*

Finalidade da família P = Matéria-Prima (Produção Interna). B = Brinde. U = Material de Uso e Consumo. A = Ativo Imobilizado. S = Serviços. G = Seguro. F = Frete. D = Despesas. V = Aproveitamento. L = Vale / Recibo. E = Embalagem. C = Produto em Processo. Q = Produto Acabado. T = Subproduto. I = Produto Intermediário. O = Outros insumos J = Adjudicação Cred ICMS. N = Rest Cred Trib M = Complemento Antecipado X = Garantia Estendida Z = Vale Gás R ou nulo = Mercadoria para Revenda.

stringMáximo: 1
formaAbastecimento*

Forma de abastecimento

stringMáximo: 1
codOrigemTrib

Origem da mercadoria

stringMáximo: 1
Aceita Nulo: Sim
fatorAtendimento*

Fator de atendimento

integer($int64)
Mínimo: 0
margemLucroDivisao*

Margem de lucro da divisão

number($double)

Máximo: 999.99
Mínimo: 0

idPauta

Identificador pauta St

integer($int64)

Mínimo: 0

idPautaIcms

Identificador pauta ICMS

integer($int64)

Mínimo: 0

padraoEmbTransfPadrão embalagem de transferêncianumber($double)
Máximo: 999999.999999
Mínimo: 0

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "expandables": [
    "string"
  ],
  "idFamilia": 0,
  "idDivisao": 0,
  "padraoEmbTransf": 0,
  "padraoEmbCompra": 0,
  "idComprador": 0,
  "idTributacao": 0,
  "finalidadeFamilia": "string",
  "formaAbastecimento": "string",
  "dtaHorInclusao": "2020-11-18T16:36:01.046Z",
  "usuarioInclusao": "string",
  "codOrigemTrib": "string",
  "idPauta": 0,
  "idPautaIcms": 0
}


application/json, text/json


CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}