Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

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

Chamada

GET /api/v4/produtos/custos-produtos

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
CNPJEmpresaCNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000stringAtenção! É recomendado utilizar o filtro de CNPJ ao realizar requisições para esta API.
idCategoriaCódigo sequencial do cadastro de categoria.IntegerNão há
codigoAcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)stringNão há
descricaoProdutoDescrição cadastrada para o produtostringNão há
familiaDescrição da família do produtostringNão há
dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssstringNão há
idFamiliaCódigo sequencial do cadastro de família do produtoIntegerNão há
idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
idFornecedorCódigo sequencial do cadastro de fornecedorIntegerNão há
_pageNo
IntegerNão há
_pageSize
IntegerNã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)
NumeroEmpresaNúmero da empresaIntegerNão há
CustoBrutoCusto gerencial bruto unitário do produtoNumberNão há
CustoBrutoSemSTCusto gerencial bruto unitário subtraindo ICMS STNumberNão há
CustoLiquidoCusto gerencial líquido unitário do produtoNumberNão há
CustoFiscalCusto fiscal / contábil unitário do produtoNumberNão há
UtilAcresProdRelIndica se será considerado percentual de acréscimo no custo de produto relacionado. N = Não. S = Sim.StringNão há
PerAcresProdRelPercentual de acréscimo no custo de produto relacionado, caso existaNumberNão há
EmbVendaEmbalagem padrão de vendaNumberNão há
MargemNormalMargem de lucro objetiva para o produto. Depende do cadastro da divisão para o local de origem.NumberNão há
MargemPromocaoMargem de lucro em promoção para o produto.NumberNão há
CodigoAcessoPrincipalCódigo de acesso principalStringNão há
IdProdutoCódigo sequencial do cadastro do produtoIntegerNão há
IdFamiliaCódigo sequencial do cadastro da família do produtoIntegerNão há
IdProdutoBaseCódigo sequencial do cadastro do produto baseIntegerNão há
DataUltimaAtualizacaoData da ultima atualizaçãoStringNã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"
  }
]