Endpoint Pedidos de compra – itens (v1)

Atualizado em12 de junho de 2024

Descrição geral

Pedidos de compra – itens

URL

“/public-api/v1/commons/pedidocompraitem“

Verbos suportados

GET

Status HTTP

• 200 = OK;
• 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"id":1, "idpedidocompra":1, "idpedidocompraitempai":1, "idpedidocompraitemprincipal":1, "nritem":0, "quantidade":"0.000000", "preco":"0.000000", "precoinformado":"0.000000", "idproduto":1, "total":"0.00", "desconto":"0.00", "observacao":"Texto", "variacoes":"Texto", "numeroserie":"Texto", "brinde":0, "percentualdesconto":"0.00", "descontopromocao":"0.00", "idmotivodesconto":1, "idcfop":1, "situacaotributaria":"Texto", "situacaotributariasn":"Texto", "modalidadeicmsst":0, "percentualreducaomva":"0.00", "ipi":"0.000", "fatorconversao":"0.000000", "idembalagem":1, "idunidademedida":1, "percredbasepiscofins":"0.00", "basepis":"0.00", "basecofins":"0.00", "aliquotapis":"0.0000", "aliquotacofins":"0.0000", "pis":"0.00", "cofins":"0.00", "cstpis":"Texto", "cstcofins":"Texto", "idtipocredito":1, "idreceitasemcontribuicao":1, "idcontribuicaosocialapurada":1, "idcontribuicaosocialapurcofins":1, "situacaotributariaipi":"Texto", "modocalculoipi":0, "baseipi":"0.00", "percentualipi":"0.0000", "percentualipinaodestacado":"0.0000", "ipinaodestacado":"0.00", "percentualreducaoicms":"0.000000", "baseicms":"0.00", "percentualicms":"0.00", "icms":"0.00", "percentualicmsaproveitamento":"0.0000", "valoricmsaproveitamento":"0.00", "percentualicmsdiferido":"0.00", "icmsdiferido":"0.00", "percentualreducaoicmsdiferido":"0.00", "baseicmsdiferido":"0.00", "percentualicmssubstituicao":"0.00", "percreducaoicmssubstituicao":"0.00", "margemvaloradicionado":"0.00", "baseicmssubstituicao":"0.00", "icmssubstituicao":"0.00", "cargatributariamedia":"0.00", "baseicmsstanterior":"0.00", "valoricmsstanterior":"0.00", "valoricmssubstituto":"0.00", "basestufdestino":"0.00", "valorstufdestino":"0.00", "percentualfunrural":"0.00", "funrural":"0.00", "percimpostoaproximado":"0.00", "baseimpostoaproximado":"0.00", "chaveibpt":"Texto", "percimpostoaproximadomunicipal":"0.00", "impostoaproximadomunicipal":"0.00", "percimpostoaproximadoestadual":"0.00", "impostoaproximadoestadual":"0.00", "percimpostoaproximadofederal":"0.00", "impostoaproximadofederal":"0.00", "fonteibpt":"Texto", "impostoaproximado":"0.00", "valorimpostosincentivados":"0.00", "valorpisincentivado":"0.00", "valorcofinsincentivado":"0.00", "valoricmsincentivado":"0.00", "aliquotapisincentivado":"0.00", "aliquotacofinsincentivado":"0.00", "aliquotaicmsincentivado":"0.00", "percentualiss":"0.0000", "baseiss":"0.00", "percentualreducaoiss":"0.0000", "iss":"0.00", "percentualretencaoiss":"0.0000", "retencaoiss":"0.00", "perccontribuicaosocial":"0.00", "contribuicaosocial":"0.00", "percimpostorenda":"0.00", "impostorenda":"0.00", "baseimpostorenda":"0.00", "basecontribuicaosocial":"0.00", "aliquotareducaobasecalculoinss":"0.00", "baseinss":"0.00", "percinss":"0.00", "inss":"0.00", "descontosubtotal":"0.00", "frete":"0.00", "seguro":"0.00", "outrasdespesas":"0.00", "impostoimportacao":"0.00", "iof":"0.00", "despesasaduaneiras":"0.00", "veiculonovo":0, "tipokit":0, "taxasiscomex":"0.00", "valorafrmm":"0.00", "tributacao":"Texto", "baseimpostoimportacao":"0.00", "motivodesoneracaoicms":0, "motivodesoneracaopis":0, "motivodesoneracaocofins":0, "enviartagsdiferimentototal":0, "origem":0, "valordiferencaimportacaoxml":"0.00", "percentualicmsdestino":"0.00", "percentualicmsinterestadual":"0.00", "icmsdestino":"0.00", "icmsremetente":"0.00", "percentualpartilhaicmsestados":"0.00", "basecalculoicmsdifal":"0.00", "percentualicmsfundopobreza":"0.00", "icmsfundopobreza":"0.00", "basefundopobrezast":"0.00", "percentualicmsfundopobrezast":"0.00", "icmsfundopobrezast":"0.00", "basefundopobrezainterno":"0.00", "percicmsfundopobrezainterno":"0.00", "icmsfundopobrezainterno":"0.00", "basefcpstanterior":"0.00", "valorfcpstanterior":"0.00", "idenquadramentoipi":1, "naopossuiicmsstnotaorigem":0, "aliquotapisretido":"0.00", "aliquotacofinsretido":"0.00", "basepisretido":"0.00", "basecofinsretido":"0.00", "pisretido":"0.00", "cofinsretido":"0.00", "valoricmsdiferencialentrada":"0.00", "aliquotaicmsdiferencialentrada":"0.00", "idobservacaolancamentofiscal":1, "idajustedocumentofiscal":1, "baseicmsefetivo":"0.00", "aliquotaicmsefetivo":"0.00", "percentualredbaseicmsefetivo":"0.0000", "valoricmsefetivo":"0.00", "aliquotafcpstanterior":"0.00", "aliquotaicmsstanterior":"0.00", "informacaoadicional":"Texto", "motivodesoneracaoicmssemdesc":0, "baseicmsdesoneradosemdesconto":"0.00", "aliquotaicmsdesoneradosemdesc":"0.00", "valoricmsdesoneradosemdesconto":"0.00", "baseicmsstpresumido":"0.00", "aliquotaicmsstpresumido":"0.00", "valoricmsstpresumido":"0.00", "baseicmspresumido":"0.00", "aliquotaicmspresumido":"0.00", "valoricmspresumido":"0.00", "percentualreducaoicmsvirtual":"0.000000", "baseicmsvirtual":"0.00", "percentualicmsvirtual":"0.00", "icmsvirtual":"0.00", "basefundopobrezainternovirtual":"0.00", "percicmsfundopobinternovirtual":"0.00", "icmsfundopobrezainternovirtual":"0.00", "deducaoicmsbasepis":"0.00", "deducaoicmsbasecofins":"0.00", "baseicmsmonoproprio":"0.0000", "aliquotaicmsmonoproprio":"0.0000", "valoricmsmonoproprio":"0.00", "baseicmsmonoretencao":"0.0000", "aliquotaicmsmonoretencao":"0.0000", "valoricmsmonoretencao":"0.00", "baseicmsmonodiferido":"0.0000", "aliquotaicmsmonodiferido":"0.0000", "valoricmsmonodiferido":"0.00", "baseicmsmonoretanterior":"0.0000", "aliquotaicmsmonoretanterior":"0.0000", "valoricmsmonoretanterior":"0.00", "tributacaoissnacional":"Texto", "numerobeneficioissnacional":"Texto", "tiposuspensaoissnacional":"Texto", "tipoimunidadeissnacional":"Texto", "tiporetencaoissnacional":"Texto", "numeroprocessoissnacional":"Texto"}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pedidocompraitem

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/pedidocompraitem/${id}

Lista dos campos do JSON

Identificador

Descrição

Obrigatório

Tipo

Tamanho

Decimais

Observações

Inteiro

idpedidocompra

ID do pedido de compra

Inteiro

idpedidocompraitempai

ID do pedido de compra item pai

Inteiro

idpedidocompraitemprincipal

ID do pedido de compra item principal

Inteiro

nritem

Número do item

Inteiro

quantidade

Quantidade do item

Decimal

preco

Preço do item

Decimal

precoinformado

Preço unitário informado ao incluir o item

Decimal

idproduto

ID do produto

Inteiro

total

Valor total

Decimal

desconto

Desconto

Decimal

observacao

Observação

Caractere

variacoes

Variações

Caractere

4069

numeroserie

Número de série

Caractere

brinde

Brinde

Inteiro

percentualdesconto

Percentual de desconto

Decimal

descontopromocao

Desconto da promoção

Decimal

idmotivodesconto

ID do motivo de desconto

Inteiro

idcfop

ID da natureza de operação

Inteiro

situacaotributaria

Situação tributária do ICMS

Caractere

situacaotributariasn

Situação tributária do ICMS para Simples nacional

Caractere

modalidadeicmsst

Modalidade de determinação da base de cálculo do ICMS de substituição

Inteiro

0 –
4 – Margem valor agregado (%);
5 – Pauta (valor);
6 – Valor da operação;
9 – Carga tributária média.

percentualreducaomva

Percentual de redução de MVA

Decimal

ipi

Valor do IPI

Decimal

fatorconversao

Fator de conversão

Decimal

idembalagem

ID da embalagem

Inteiro

idunidademedida

Inteiro

percredbasepiscofins

Percentual de redução da base de PIS/COFINS

Decimal

basepis

Valor base PIS

Decimal

basecofins

Valor base COFINS

Decimal

aliquotapis

Alíquota PIS

Decimal

aliquotacofins

Alíquota COFINS

Decimal

pis

Valor PIS

Decimal

cofins

Valor COFINS

Decimal

cstpis

CST PIS

Caractere

cstcofins

CST COFINS

Caractere

idtipocredito

Tipo de crédito

Inteiro

idreceitasemcontribuicao

Receita sem contribuição

Inteiro

idcontribuicaosocialapurada

Contribuição social apurada

Inteiro

idcontribuicaosocialapurcofins

Contribuição social apurada cofins

Inteiro

situacaotributariaipi

Situação tributária do IPI

Caractere

modocalculoipi

Modo de cálculo do IPI

Inteiro

baseipi

Base de cálculo do IPI

Decimal

percentualipi

Percentual do IPI

Decimal

percentualipinaodestacado

Percentual do IPI não destacado

Decimal

ipinaodestacado

Valor do IPI não destacado

Decimal

percentualreducaoicms

Percentual de redução do ICMS

Decimal

baseicms

Valor da base de cálculo do ICMS

Decimal

percentualicms

Percentual do ICMS

Decimal

icms

Valor do icms

Decimal

percentualicmsaproveitamento

Percentual de aproveintameto de ICMS

Decimal

valoricmsaproveitamento

Percentual de aproveintameto de ICMS

Decimal

percentualicmsdiferido

Percentual do icms diferido

Decimal

icmsdiferido

Valor do ICMS

Decimal

percentualreducaoicmsdiferido

Percentual de redução do ICMS diferido

Decimal

baseicmsdiferido

Valor da base de cálculo do ICMS diferido

Decimal

percentualicmssubstituicao

Percentual do ICMS de substituição

Decimal

percreducaoicmssubstituicao

Percentual do ICMS de substituição

Decimal

margemvaloradicionado

Margem do valor adicionado

Decimal

baseicmssubstituicao

Valor base do ICMS de retenção na substituição tributaria

Decimal

icmssubstituicao

Valor da retenção de ICMS

Decimal

cargatributariamedia

Valor da carga tributária média

Decimal

baseicmsstanterior

Valor da base de ICMS ST cobrado anteriormente

Decimal

valoricmsstanterior

Valor do ICMS ST cobrado anteriormente

Decimal

valoricmssubstituto

Valor do ICMS substituto

Decimal

basestufdestino

Valor da BC do ICMS ST da UF destino

Decimal

valorstufdestino

Valor do ICMS ST da UF destino

Decimal

percentualfunrural

Percentual FUNRURAL

Decimal

funrural

Valor do FUNRURAL

Decimal

percimpostoaproximado

Percentual de imposto aproximado

Decimal

baseimpostoaproximado

Base de cálculo para o imposto aproximado

Decimal

chaveibpt

Chave estado

Caractere

percimpostoaproximadomunicipal

Percentual de imposto aproximado municipal

Decimal

impostoaproximadomunicipal

Valor do imposto aproximado municipal

Decimal

percimpostoaproximadoestadual

Percentual de imposto aproximado estadual

Decimal

impostoaproximadoestadual

Valor do imposto aproximado estadual

Decimal

percimpostoaproximadofederal

Percentual de imposto aproximado federal

Decimal

impostoaproximadofederal

Valor do imposto aproximado federal

Decimal

fonteibpt

Fonte

Caractere

impostoaproximado

Valor do imposto aproximado

Decimal

valorimpostosincentivados

Valor dos impostos incentivados

Decimal

valorpisincentivado

Valor do PIS incentivado

Decimal

valorcofinsincentivado

Valor do COFINS incentivado

Decimal

valoricmsincentivado

Valor do ICMS incentivado

Decimal

aliquotapisincentivado

Percentual do PIS incentivado

Decimal

aliquotacofinsincentivado

Percentual do COFINS incentivado

Decimal

aliquotaicmsincentivado

Percentual do ICMS incentivado

Decimal

percentualiss

Percentual de ISS

Decimal

baseiss

Base de cálculo do iss

Decimal

percentualreducaoiss

Percentual de redução do ISS

Decimal

iss

Valor do ISS

Decimal

percentualretencaoiss

Percentual retenção de ISS

Decimal

retencaoiss

Valor retenção de ISS

Decimal

perccontribuicaosocial

Percentual de contribuição social

Decimal

contribuicaosocial

Contribuição social

Decimal

percimpostorenda

Percentual de imposto de renda

Decimal

impostorenda

Imposto de renda

Decimal

baseimpostorenda

Base do imposto de renda

Decimal

basecontribuicaosocial

Base da CSLL

Decimal

aliquotareducaobasecalculoinss

Percentual Redução base de cálculo do INSS

Decimal

baseinss

Base de cálculo do INSS

Decimal

percinss

Percentual de INSS

Decimal

inss

Valor de INSS

Decimal

descontosubtotal

Valor rateado do desconto do subtotal da nota

Decimal

frete

Valor do frete

Decimal

seguro

Valor do seguro

Decimal

outrasdespesas

Valor de outras despesas

Decimal

impostoimportacao

Valor do imposto de importação

Decimal

iof

Valor do IOF

Decimal

despesasaduaneiras

Valor das despesas aduaneiras

Decimal

veiculonovo

0=Não;
1=Sim.

Inteiro

tipokit

0=Sem kit;
1=Kit pai;
2=Componente do kit.

Inteiro

taxasiscomex

Valor da taxa SISCOMEX

Decimal

valorafrmm

Valor AFRMM

Decimal

tributacao

Tipo de tributação item

Caractere

baseimpostoimportacao

Valor da base de cálculo do imposto de importação

Decimal

motivodesoneracaoicms

Motivo de desoneração do ICMS

Inteiro

motivodesoneracaopis

Motivo de desoneração do PIS

Inteiro

motivodesoneracaocofins

Motivo de desoneração do COFINS

Inteiro

enviartagsdiferimentototal

Enviar informações de diferimento total na NF-e

Inteiro

0 – Não;
1 – Sim.

origem

Origem do produto

Inteiro

valordiferencaimportacaoxml

Diferença do total do item na importação do XML

Decimal

percentualicmsdestino

Percentual do ICMS de destino

Decimal

percentualicmsinterestadual

Percentual do ICMS interestadual

Decimal

icmsdestino

Valor do ICMS para o estado de destino

Decimal

icmsremetente

Valor do ICMS para o estado do remetente

Decimal

percentualpartilhaicmsestados

Percentual do ICMS de partilha entre os estados

Decimal

basecalculoicmsdifal

Base de cálculo de ICMS do DIFAL

Decimal

percentualicmsfundopobreza

Percentual do ICMS relativo ao fundo de combate à pobreza (FCP) da UF de destino

Decimal

icmsfundopobreza

Valor do ICMS relativo ao fundo de combate à pobreza (FCP) da UF de destino

Decimal

basefundopobrezast

Base do ICMS relativo ao fundo de combate à pobreza ST

Decimal

percentualicmsfundopobrezast

Percentual do ICMS relativo ao fundo de combate à pobreza ST

Decimal

icmsfundopobrezast

Valor do ICMS relativo ao fundo de combate à pobreza ST

Decimal

basefundopobrezainterno

Base do ICMS relativo ao fundo de combate à pobreza interno

Decimal

percicmsfundopobrezainterno

Percentual do ICMS relativo ao fundo de combate à pobreza interno

Decimal

icmsfundopobrezainterno

Valor do ICMS relativo ao fundo de combate à pobreza interno

Decimal

basefcpstanterior

Percentual do ICMS relativo ao fundo de combate à pobreza interno retido anteriormente por ST

Decimal

valorfcpstanterior

Valor do ICMS relativo ao fundo de combate à pobreza interno retido anteriormente por ST

Decimal

idenquadramentoipi

ID do enquadramento do IPI

Inteiro

naopossuiicmsstnotaorigem

Não possui ICMS ST na nota de origem

Inteiro

aliquotapisretido

Percentual retenção PIS

Decimal

aliquotacofinsretido

Percentual retenção COFINS

Decimal

basepisretido

Base retenção PIS

Decimal

basecofinsretido

Base retenção COFINS

Decimal

pisretido

Valor retenção PIS

Decimal

cofinsretido

Valor retenção COFINS

Decimal

valoricmsdiferencialentrada

Valor do ICMS de diferencial de alíquota na entrada

Decimal

aliquotaicmsdiferencialentrada

Percentual do ICMS de diferencial de alíquota na entrada

Decimal

idobservacaolancamentofiscal

Observação do lançamento fiscal

Inteiro

idajustedocumentofiscal

Ajuste do lançamento fiscal

Inteiro

baseicmsefetivo

Base do ICMS efetivo

Decimal

aliquotaicmsefetivo

Percentual ICMS efetivo

Decimal

percentualredbaseicmsefetivo

Percentual de redução da base do ICMS efetiv

Decimal

valoricmsefetivo

Valor do ICMS efetivo

Decimal

aliquotafcpstanterior

Percentual FCP ST anterior

Decimal

aliquotaicmsstanterior

Percentual ICMS ST anterior

Decimal

informacaoadicional

Informação adicional

Caractere

500

motivodesoneracaoicmssemdesc

Motivo desoneração

Inteiro

1 – Taxi;
3 – Uso na agropecuária/Produtor Agropecuário;
4 – Frotista/Locadora;
5 – Diplomático/Consular;
6 – Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações);
7 – SUFRAMA;
8 – Venda a Órgão Público;
9 – Outros;
10 – Deficiente Condutor (Convênio ICMS 38/12);
11 – Deficiente Não Condutor (Convênio ICMS 38/12);
12 – Órgão de fomento e desenvolvimento agropecuário;
90 – Solicitado pelo fisco.

baseicmsdesoneradosemdesconto

Base ICMS desonerado

Decimal

aliquotaicmsdesoneradosemdesc

Percentual ICMS ICM desonerado

Decimal

valoricmsdesoneradosemdesconto

Valor ICMS desonerado

Decimal

baseicmsstpresumido

Base do ICMS ST presumido

Decimal

aliquotaicmsstpresumido

Percentual do ICMS ST presumido

Decimal

valoricmsstpresumido

Valor do ICMS ST presumido

Decimal

baseicmspresumido

Base do ICMS presumido

Decimal

aliquotaicmspresumido

Percentual do ICMS presumido

Decimal

valoricmspresumido

Valor do ICMS presumido

Decimal

percentualreducaoicmsvirtual

Percentual de redução do ICMS virtual

Decimal

baseicmsvirtual

Base do ICMS virtual

Decimal

percentualicmsvirtual

Percentual do ICMS virtual

Decimal

icmsvirtual

Valor do ICMS virtual

Decimal

basefundopobrezainternovirtual

Base do ICMS relativo ao Fundo de Combate à Pobreza interno virtual

Decimal

percicmsfundopobinternovirtual

Percentual do ICMS relativo ao Fundo de Combate à Pobreza interno virtual

Decimal

icmsfundopobrezainternovirtual

Valor do ICMS relativo ao Fundo de Combate à Pobreza interno virtual

Decimal

deducaoicmsbasepis

Valor da dedução do ICMS na base do PIS/COFINS

Decimal

deducaoicmsbasecofins

Valor da dedução do ICMS na base do PIS/COFINS

Decimal

baseicmsmonoproprio

Base ICMS monofásico próprio

Decimal

aliquotaicmsmonoproprio

Percentual ICMS monofásico próprio

Decimal

valoricmsmonoproprio

Valor ICMS monofásico próprio

Decimal

baseicmsmonoretencao

Base ICMS monofásico retenção

Decimal

aliquotaicmsmonoretencao

Percentual ICMS monofásico retenção

Decimal

valoricmsmonoretencao

Valor ICMS monofásico retenção

Decimal

baseicmsmonodiferido

Base ICMS monofásico diferido

Decimal

aliquotaicmsmonodiferido

Percentual ICMS monofásico diferido

Decimal

valoricmsmonodiferido

Valor ICMS monofásico diferido

Decimal

baseicmsmonoretanterior

Base ICMS monofásico retido anteriormente

Decimal

aliquotaicmsmonoretanterior

Percentual ICMS monofásico retido anteriormente

Decimal

valoricmsmonoretanterior

Valor ICMS monofásico retido anteriormente

Decimal

tributacaoissnacional

Tributação ISS NFS-e Nacional

Caractere

1 – Operação tributável;
2 – Imunidade;
3 – Exportação de serviço;
4 – Não Incidência.

numerobeneficioissnacional

Número benefício ISS NFS-e Nacional

Caractere

tiposuspensaoissnacional

Tipo suspensão ISS NFS-e Nacional

Caractere

1 – Exigibilidade Suspensa por Decisão Judicial;
2 – Exigibilidade Suspensa por Processo Administrativo.

tipoimunidadeissnacional

Tipo imunidade ISS NFS-e Nacional

Caractere

0 – Imunidade (tipo não informado na nota de origem;
1 – Patrimônio, renda ou serviços, uns dos outros (CF88, Art 150, VI, a);
2 – Templos de qualquer culto (CF88, Art 150, VI, b);
3 – Patrimônio, renda ou serviços dos partidos políticos, inclusive suas fundações, das entidades sindicais dos trabalhadores, das instituições de educação e de assistência social, sem fins lucrativos, atendidos os requisitos da lei (CF88, Art 150, VI, c);
4 – Livros, jornais, periódicos e o papel destinado a sua impressão (CF88, Art 150, VI, d).

tiporetencaoissnacional

Tipo imunidade ISS NFS-e Nacional

Caractere

1-Não Retido;
2-Retido pelo Tomador;
3-Retido pelo Intermediário.

numeroprocessoissnacional

Número processo ISS NFS-e Nacional

Caractere

Conteúdo Relacionado

Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda