Produto | Custos Produtos (Consultar) - GET

Objetivo

A finalidade deste método é possibilitar a consulta do custo dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/custos-produtos

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 Produtos > API Produtos

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)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
modelo.CNPJEmpresa	CNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000	string	Atenção! É recomendado utilizar o filtro de CNPJ ao realizar requisições para esta API.
modelo.idCategoria	Código sequencial do cadastro de categoria.	Integer	Não há
modelo.codigoAcesso	Códigos de acessos associados ao produto (GTIN, Interno, Fornecedor)	string	Quando não informado o IdFornecedor, a busca irá se basear apenas nos tipos de códigos de acesso: EAN, DUN e Interno (E, D e B).
modelo.descricaoProduto	Descrição cadastrada para o produto	string	Não há
modelo.indicaUsaAFV	Indica se usa AFV	string	Não há
modelo.familia	Descrição da família do produto	string	Não há
modelo.dataAtualizacao	Data da ultima atualização Formato: YYYY-MM-DDThh:mm:ss	string	Quando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data.
modelo.idFamilia	Código sequencial do cadastro de família do produto	Integer	Não há
modelo.idProduto	Código sequencial do cadastro do produto	Integer	Não há
modelo.idFornecedor	Código sequencial do cadastro de fornecedor	Integer	Quando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F).
modelo._pageNo		Integer	Não há
modelo._pageSize		Integer	Não há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
NumeroEmpresa	Número da empresa	Integer	Não há
CustoBruto	Custo gerencial bruto unitário do produto	Number	Não há
CustoBrutoSemST	Custo gerencial bruto unitário subtraindo ICMS ST	Number	Não há
CustoLiquido	Custo gerencial líquido unitário do produto	Number	Não há
CustoFiscal	Custo fiscal / contábil unitário do produto	Number	Não há
UtilAcresProdRel	Indica se será considerado percentual de acréscimo no custo de produto relacionado. N = Não. S = Sim.	String	Não há
PerAcresProdRel	Percentual de acréscimo no custo de produto relacionado, caso exista	Number	Não há
EmbVenda	Embalagem padrão de venda	Number	Não há
MargemNormal	Margem de lucro objetiva para o produto. Depende do cadastro da divisão para o local de origem.	Number	Não há
MargemPromocao	Margem de lucro em promoção para o produto.	Number	Não há
CodigoAcessoPrincipal	Código de acesso principal	String	Não há
IdProduto	Código sequencial do cadastro do produto	Integer	Não há
IdFamilia	Código sequencial do cadastro da família do produto	Integer	Não há
IdProdutoBase	Código sequencial do cadastro do produto base	Integer	Não há
DataUltimaAtualizacao	Data da ultima atualização	String	Não há

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "NumeroEmpresa": 0,
    "CustoBruto": 0,
    "CustoBrutoSemST": 0,
    "CustoLiquido": 0,
    "CustoFiscal": 0,
    "UtilAcresProdRel": "string",
    "PerAcresProdRel": 0,
    "EmbVenda": 0,
    "MargemNormal": 0,
    "MargemPromocao": 0,
    "CodigoAcessoPrincipal": "string",
    "IdProduto": 0,
    "IdFamilia": 0,
    "IdProdutoBase": 0,
    "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
  }
]

Árvore de páginas