Pedido de Compra

pedidoCompra

Obter Listagem de Pedidos de Compra

get
/pedidoCompra
Autorizações
AuthorizationstringObrigatório
Parâmetros de consulta
dataEmissaoIniciostring · dateOpcional

Data de Emissão (Inicio) (YYYY-MM-DD)

dataEmissaoFimstring · dateOpcional

Data de Emissão (Fim) (YYYY-MM-DD)

fornecedoresinteger[]Opcional

Array de Código de Fornecedores

compradoresinteger[]Opcional

Array de Código de Comprador

produtosstring[]Opcional

Array de Código de Produtos

continuationTokenstringOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

application/json
get
/pedidoCompra
GET /compras/v10/pedidoCompra HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*
{
  "continuationToken": "text",
  "data": [
    {
      "codPedido": 1,
      "codFornecedor": 1,
      "dataEmissao": "2025-11-27",
      "codComprador": 1,
      "codTransportadora": 1,
      "condicaoFrete": 1,
      "codLocalEntrega": 1,
      "condicaoPagamento": 1,
      "codLocalCobranca": 1,
      "percDespesaFinanceira": 1,
      "valorDespesaFinanceira": 1,
      "percDesconto": 1,
      "valorDesconto": 1,
      "valorPedido": 1,
      "dataRecebimento": "2025-11-27",
      "situacaoPedido": 0,
      "observacao": "text",
      "situacaoQtoEntrada": 1,
      "tipoDescontoEspecial": 0,
      "valorDespesaAcessoria": 1,
      "tipoPedido": 1,
      "codPedidoComplementar": 1,
      "codMensagemPadrao": 1,
      "codPortador": 1,
      "situacaoImpresso": true,
      "condicaoPagamentoEspecial": 1,
      "condicaoPagamentoEspecial1": 1,
      "condicaoPagamentoEspecial2": 1,
      "condicaoPagamentoEspecial3": 1,
      "condicaoPagamentoEspecial4": 1,
      "pedidoBloqueado": true,
      "motivoCancelamento": "text",
      "dataHoraCancelamento": "2025-11-27T20:15:05.249Z",
      "operadorCancelamento": "text",
      "valorFrete": 1,
      "mascaraComprador": 1,
      "flagPedido": 1,
      "pedidoAutomatico": true,
      "pedidoIntegracao": "text",
      "numControle": "text",
      "finalidade": 1,
      "codMoedaEstrangeira": 1,
      "dataCotacao": "2025-11-27",
      "valorPedidoMoedaEstrangeira": 1,
      "valorDespFinanceiraMoedaEstrang": 1,
      "valorDespAcessoriaMoedaEstrange": 1,
      "valorFreteMoedaEstrangeira": 1,
      "valorDescontoMoedaEstrangeira": 1,
      "pedidoGrade": true,
      "rotinaGeradoraPedido": "text",
      "situacaoAceitePortal": 1,
      "codCotacao": 1,
      "dataLimite": "2025-11-27",
      "motivoLiberacao": "text",
      "valorCotacaoMoeda": 1,
      "situacaoBloqueio": 0,
      "opcaoTipoFrete": "text",
      "dataPrevisaoInicial": "2025-11-27",
      "dataPrevisaoAtual": "2025-11-27",
      "percFrete": 1,
      "valorFixoFrete": 1,
      "percSeguro": 1,
      "valorSeguro": 1,
      "percDesconto2": 1,
      "valorDesconto2": 1,
      "percDespesasAcessorias": 1,
      "valorDespesasAcessorias": 1,
      "codPerfilComprador": 1,
      "dataHoraSituacao": "2025-11-27T20:15:05.249Z",
      "dataHoraBloqueio": "2025-11-27T20:15:05.249Z",
      "dataHoraLiberacao": "2025-11-27T20:15:05.249Z",
      "dataHoraEnvio": "2025-11-27T20:15:05.249Z",
      "dataHoraAceite": "2025-11-27T20:15:05.249Z",
      "situacaoAceite": 0,
      "codUsuario": 1,
      "nomeContato": "text",
      "telefoneContato": "text",
      "emailContato": "text",
      "emailCopiaContato": "text",
      "itemPedidoCompra": [
        {
          "percAliquotaICMS": 1,
          "codProduto": "text",
          "codPedido": 1,
          "itemPedido": 1,
          "quantidade": 1,
          "qtdeAtendida": 1,
          "qtdeCancelada": 1,
          "qtdeSaldo": 1,
          "situacao": 0,
          "precoUnitario": 1,
          "percIPI": 1,
          "percDesconto": 1,
          "loteProducao": "text",
          "dataPrevisao": "2025-11-27",
          "centroCusto": "text",
          "solicCompras": 1,
          "itemSolicCompras": 1,
          "itemDespesa": 1,
          "itemIntegracao": "text",
          "ultSeqAtendida": 1,
          "unidadeMedida": "text",
          "composicaoIPI": "text",
          "impressoComunicacao": true,
          "valorFrete": 1,
          "valorFreteMoedaEstrangeira": 1,
          "dataLimiteEntrega": "2025-11-27",
          "pedidoFornecedor": "text",
          "referenciaFornecedor": "text",
          "dataEntregaOriginal": "2025-11-27",
          "codFinalidade": 1,
          "codOS": 1,
          "precoUnitarioMoedaEstrangeira": 1,
          "contaContabil": "text",
          "contaContabilC": "text",
          "numControle": "text",
          "dataHoraCancelamentoItem": "2025-11-27T20:15:05.249Z",
          "motivoCancelamentoItem": "text",
          "operadorCancelamentoItem": "text",
          "codUnidadeCompra": "text",
          "fatorConversaoCompra": "text",
          "fatorConversaoQuantidade": 1,
          "fatorConversaoOperador": 1,
          "baseCalculoICMSST": 1,
          "aliquotaICMSST": 1,
          "valorICMSST": 1,
          "percDiferencialAliquota": 1,
          "valorDiferencialAliquota": 1,
          "descricaoProduto": "text",
          "rateioCentrosDeCusto": true,
          "codFamilia": 1,
          "codSubFamilia": 1,
          "codContrato": 1,
          "seqProdutoContrato": 1,
          "codCotacao": 1,
          "seqEnvioCotacao": 1,
          "seqFornecedorCotacao": 1,
          "seqProdutoCotacao": 1,
          "dataHoraSituacaoItem": "2025-11-27T20:15:05.249Z",
          "dataPrevisaoInicial": "2025-11-27",
          "percAliquotaPIS": 1,
          "percAliquotaCOFINS": 1,
          "valorUnitarioICMSST": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ],
          "itensPedidoContaContabilCentrosCustosRateio": [
            {
              "contaContabil": 1,
              "percentualProporcao": 1,
              "contaContabilCentroCusto": [
                {
                  "centroCustos": "text",
                  "percentualProporcao": 1
                }
              ]
            }
          ]
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}
Deprecated

Cadastrar um Pedido de Compra

put
/pedidoCompra
Autorizações
AuthorizationstringObrigatório
Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Corpo
codPedidointegerOpcional

Código do Pedido de Compra

codFornecedorintegerOpcional

Código do Fornecedor

dataEmissaostring · dateOpcional

Data da Emissão (YYYY-MM-DD)

codCompradorintegerOpcional

Código do Comprador

codTransportadoraintegerOpcional

Código da Transportadora

condicaoFreteintegerOpcional

Código da Condição de Frete

codLocalEntregaintegerOpcional

Código do Local de Entrega

condicaoPagamentointegerOpcional

Código da Condição de Pagamento

codLocalCobrancaintegerOpcional

Código do Local de Cobrança

percDespesaFinanceiranumberOpcional

Percentual de Despesa Financeira

valorDespesaFinanceiranumberOpcional

Valor de Despesa Financeira

percDescontonumberOpcional

Percentual de Desconto

valorDescontonumberOpcional

Valor de Desconto

valorPedidonumberObrigatório

Valor Total do Pedido

dataRecebimentostring · dateOpcional

Data de Recebimento (YYYY-MM-DD)

situacaoPedidointeger · enumOpcional

Situação (0 - Aberto, 1 - Atendido, 2 - Atendido parte, 3 - Cancelado)

Valores possíveis:
observacaostring · máx: 160Opcional

Observação

situacaoQtoEntradaintegerOpcional

Situação Quanto a Entrada

tipoDescontoEspecialinteger · enumOpcional

Tipo do Desconto Especial (0 - Em dias, 1 - Em data específica)

Valores possíveis:
valorDespesaAcessorianumberOpcional

Valor de Despesa Acessória

tipoPedidointeger · enumOpcional

Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)

Valores possíveis:
codPedidoComplementarintegerOpcional

Código do Pedido Complementar

codMensagemPadraointegerOpcional

Código da Mensagem Padrão

codPortadorintegerOpcional

Código do Portador

situacaoImpressobooleanOpcional

Situação da Impressão (0 - Não Impresso, 1 - Impresso)

condicaoPagamentoEspecialintegerOpcional

Código da Segunda Condição de Pagamento Especial

condicaoPagamentoEspecial1integerOpcional

Código da Terceira Condição de Pagamento Especial

condicaoPagamentoEspecial2integerOpcional

Código da Quarta Condição de Pagamento Especial

condicaoPagamentoEspecial3integerOpcional

Código da Quinta Condição de Pagamento Especial

condicaoPagamentoEspecial4integerOpcional

Código da Sexta Condição de Pagamento Especial

pedidoBloqueadobooleanOpcional

Pedido esta Bloqueado? (0 - Não, 1 - Sim)

motivoCancelamentostring · máx: 105Opcional

Motivo Descritivo do Cancelamento do Pedido

dataHoraCancelamentostring · date-timeOpcional

Data e Hora do Cancelamento do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

operadorCancelamentostring · máx: 30Opcional

Operador do Cancelamento do Pedido

valorFretenumberOpcional

Valor do Frete

mascaraCompradorintegerOpcional

Código da Máscara do Comprador

flagPedidointeger · enumOpcional

Flag do Pedido 1 - Liberado, 2 - Liberado com Restrição, 3 - Cancelado

Valores possíveis:
pedidoAutomaticobooleanOpcional

Pedido Automático? (0 - Não, 1 - Sim)

pedidoIntegracaostring · máx: 30Opcional

Número do Pedido Importado de Outros Sistemas para Integração com o Sistema Consistem

numControlestring · máx: 10Opcional

Número do Controle

finalidadeintegerOpcional

Código da Finalidade

codMoedaEstrangeiraintegerOpcional

Código da Moeda Estrangeira

dataCotacaostring · dateOpcional

Data da Cotação (YYYY-MM-DD)

valorPedidoMoedaEstrangeiranumberOpcional

Valor do Pedido em Moeda Estrangeira

valorDespFinanceiraMoedaEstrangnumberOpcional

Valor de Despesas Financeiras em Moeda Estrangeira

valorDespAcessoriaMoedaEstrangenumberOpcional

Valor de Despesas Acessórias em Moeda Estrangeira

valorFreteMoedaEstrangeiranumberOpcional

Valor do Frete em Moeda Estrangeira

valorDescontoMoedaEstrangeiranumberOpcional

Valor do Desconto em Moeda Estrangeira

pedidoGradebooleanOpcional

Pedido por Grade (0 - Não, 1 - Sim)

rotinaGeradoraPedidostringOpcional

Rotina Geradora do Pedido

situacaoAceitePortalinteger · enumOpcional

Situação do Aceite no Portal (1 - Gerado, 2 - Em Aceite, 3 - Aceito, 4 - Não Aceito)

Valores possíveis:
codCotacaointegerOpcional

Código da Cotação

dataLimitestring · dateOpcional

Data Limite para Aceite do Pedido (YYYY-MM-DD)

motivoLiberacaostring · máx: 160Opcional

Motivo da Liberação

valorCotacaoMoedanumberOpcional

Valor da Cotação da Moeda

situacaoBloqueiointeger · enumOpcional

Situação do Bloqueio (0 - Liberado, 1 - Bloqueado, 2 - Digitado, 3- Retornado)

Valores possíveis:
opcaoTipoFretestring · máx: 10Opcional

Opção de Tipo de Frete

dataPrevisaoInicialstring · dateOpcional

Data de Previsão de Entrega Inicial (YYYY-MM-DD)

dataPrevisaoAtualstring · dateOpcional

Data de Previsão de Entrega Atual (YYYY-MM-DD)

percFretenumberOpcional

Percentual de Frete Sobre o Valor das Mercadorias

valorFixoFretenumberOpcional

Valor Fixo do Frete a ser Somado no Valor do Pedido

percSeguronumberOpcional

Percentual do Seguro Sobre o Valor das Mercadorias

valorSeguronumberOpcional

Valor do Seguro Sobre o Valor das Mercadorias

percDesconto2numberOpcional

Segundo Percentual de Desconto

valorDesconto2numberOpcional

Segundo Valor de Desconto

percDespesasAcessoriasnumberOpcional

Percentual de Despesas Acessórias

valorDespesasAcessoriasnumberOpcional

Valor de Despesas Acessórias

codPerfilCompradorintegerOpcional

Código do Perfil do Comprador

dataHoraSituacaostring · date-timeOpcional

Data e Hora da Atualização da Situação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraBloqueiostring · date-timeOpcional

Data e Hora do Bloqueio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraLiberacaostring · date-timeOpcional

Data e Hora da Liberação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraEnviostring · date-timeOpcional

Data e Hora do Envio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraAceitestring · date-timeOpcional

Data e Hora do Aceite do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

situacaoAceiteinteger · enumOpcional

Situação do Aceite do Pedido (0 - Não Enviado, 1 - Enviado, 2 - Aceito, 3 - Rejeitado)

Valores possíveis:
codUsuariointegerOpcional

Código do Usuário

nomeContatostring · máx: 30Opcional

Nome do Contato

telefoneContatostring · máx: 18Opcional

Telefone do Contato

emailContatostring · máx: 50Opcional

E-mail do Contato

emailCopiaContatostring · máx: 50Opcional

E-mail para Cópia do Contato

Respostas
200

OK

Sem conteúdo

put
/pedidoCompra
PUT /compras/v10/pedidoCompra HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 3759

{
  "codPedido": 1,
  "codFornecedor": 1,
  "dataEmissao": "2025-11-27",
  "codComprador": 1,
  "codTransportadora": 1,
  "condicaoFrete": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDespesaFinanceira": 1,
  "valorDespesaFinanceira": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "valorPedido": 1,
  "dataRecebimento": "2025-11-27",
  "situacaoPedido": 0,
  "observacao": "text",
  "situacaoQtoEntrada": 1,
  "tipoDescontoEspecial": 0,
  "valorDespesaAcessoria": 1,
  "tipoPedido": 1,
  "codPedidoComplementar": 1,
  "codMensagemPadrao": 1,
  "codPortador": 1,
  "situacaoImpresso": true,
  "condicaoPagamentoEspecial": 1,
  "condicaoPagamentoEspecial1": 1,
  "condicaoPagamentoEspecial2": 1,
  "condicaoPagamentoEspecial3": 1,
  "condicaoPagamentoEspecial4": 1,
  "pedidoBloqueado": true,
  "motivoCancelamento": "text",
  "dataHoraCancelamento": "2025-11-27T20:15:05.249Z",
  "operadorCancelamento": "text",
  "valorFrete": 1,
  "mascaraComprador": 1,
  "flagPedido": 1,
  "pedidoAutomatico": true,
  "pedidoIntegracao": "text",
  "numControle": "text",
  "finalidade": 1,
  "codMoedaEstrangeira": 1,
  "dataCotacao": "2025-11-27",
  "valorPedidoMoedaEstrangeira": 1,
  "valorDespFinanceiraMoedaEstrang": 1,
  "valorDespAcessoriaMoedaEstrange": 1,
  "valorFreteMoedaEstrangeira": 1,
  "valorDescontoMoedaEstrangeira": 1,
  "pedidoGrade": true,
  "rotinaGeradoraPedido": "text",
  "situacaoAceitePortal": 1,
  "codCotacao": 1,
  "dataLimite": "2025-11-27",
  "motivoLiberacao": "text",
  "valorCotacaoMoeda": 1,
  "situacaoBloqueio": 0,
  "opcaoTipoFrete": "text",
  "dataPrevisaoInicial": "2025-11-27",
  "dataPrevisaoAtual": "2025-11-27",
  "percFrete": 1,
  "valorFixoFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDesconto2": 1,
  "valorDesconto2": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "dataHoraSituacao": "2025-11-27T20:15:05.249Z",
  "dataHoraBloqueio": "2025-11-27T20:15:05.249Z",
  "dataHoraLiberacao": "2025-11-27T20:15:05.249Z",
  "dataHoraEnvio": "2025-11-27T20:15:05.249Z",
  "dataHoraAceite": "2025-11-27T20:15:05.249Z",
  "situacaoAceite": 0,
  "codUsuario": 1,
  "nomeContato": "text",
  "telefoneContato": "text",
  "emailContato": "text",
  "emailCopiaContato": "text",
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "itemPedido": 1,
      "quantidade": 1,
      "situacao": 0,
      "precoUnitario": 1,
      "percIPI": 1,
      "percDesconto": 1,
      "loteProducao": "text",
      "dataPrevisao": "2025-11-27",
      "centroCusto": "text",
      "solicCompras": 1,
      "itemSolicCompras": 1,
      "itemDespesa": 1,
      "itemIntegracao": "text",
      "ultSeqAtendida": 1,
      "unidadeMedida": "text",
      "composicaoIPI": "text",
      "impressoComunicacao": true,
      "valorFrete": 1,
      "valorFreteMoedaEstrangeira": 1,
      "dataLimiteEntrega": "2025-11-27",
      "pedidoFornecedor": "text",
      "referenciaFornecedor": "text",
      "dataEntregaOriginal": "2025-11-27",
      "codFinalidade": 1,
      "codOS": 1,
      "precoUnitarioMoedaEstrangeira": 1,
      "contaContabil": "text",
      "contaContabilC": "text",
      "numControle": "text",
      "dataHoraCancelamentoItem": "2025-11-27T20:15:05.249Z",
      "motivoCancelamentoItem": "text",
      "operadorCancelamentoItem": "text",
      "codUnidadeCompra": "text",
      "fatorConversaoCompra": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 1,
      "baseCalculoICMSST": 1,
      "aliquotaICMSST": 1,
      "valorICMSST": 1,
      "percDiferencialAliquota": 1,
      "valorDiferencialAliquota": 1,
      "descricaoProduto": "text",
      "rateioCentrosDeCusto": true,
      "codFamilia": 1,
      "codSubFamilia": 1,
      "codContrato": 1,
      "seqProdutoContrato": 1,
      "codCotacao": 1,
      "seqEnvioCotacao": 1,
      "seqFornecedorCotacao": 1,
      "seqProdutoCotacao": 1,
      "dataHoraSituacaoItem": "2025-11-27T20:15:05.249Z",
      "dataPrevisaoInicial": "2025-11-27",
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "valorUnitarioICMSST": 1,
      "itensContaContabilCentroCustosRateio": [
        {
          "contaContabil": 1,
          "percentualProporcao": 1,
          "contaContabilCentroCusto": [
            {
              "centroCustos": "text",
              "percentualProporcao": 1
            }
          ]
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "parcelasPedido": [
    {
      "qtdeDiasParcela": 1,
      "valProporcao": 1,
      "dataPagamento": "2025-11-27",
      "valorPagamento": 1
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Sem conteúdo

Obter um Pedido de Compra

get
/pedidoCompra/{id}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
idstringObrigatório

Código do Pedido de Compra

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

application/json
get
/pedidoCompra/{id}
GET /compras/v10/pedidoCompra/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*
[
  {
    "codPedido": 1,
    "codFornecedor": 1,
    "dataEmissao": "2025-11-27",
    "codComprador": 1,
    "codTransportadora": 1,
    "condicaoFrete": 1,
    "codLocalEntrega": 1,
    "condicaoPagamento": 1,
    "codLocalCobranca": 1,
    "percDespesaFinanceira": 1,
    "valorDespesaFinanceira": 1,
    "percDesconto": 1,
    "valorDesconto": 1,
    "valorPedido": 1,
    "dataRecebimento": "2025-11-27",
    "situacaoPedido": 0,
    "observacao": "text",
    "situacaoQtoEntrada": 1,
    "tipoDescontoEspecial": 0,
    "valorDespesaAcessoria": 1,
    "tipoPedido": 1,
    "codPedidoComplementar": 1,
    "codMensagemPadrao": 1,
    "codPortador": 1,
    "situacaoImpresso": true,
    "condicaoPagamentoEspecial": 1,
    "condicaoPagamentoEspecial1": 1,
    "condicaoPagamentoEspecial2": 1,
    "condicaoPagamentoEspecial3": 1,
    "condicaoPagamentoEspecial4": 1,
    "pedidoBloqueado": true,
    "motivoCancelamento": "text",
    "dataHoraCancelamento": "2025-11-27T20:15:05.249Z",
    "operadorCancelamento": "text",
    "valorFrete": 1,
    "mascaraComprador": 1,
    "flagPedido": 1,
    "pedidoAutomatico": true,
    "pedidoIntegracao": "text",
    "numControle": "text",
    "finalidade": 1,
    "codMoedaEstrangeira": 1,
    "dataCotacao": "2025-11-27",
    "valorPedidoMoedaEstrangeira": 1,
    "valorDespFinanceiraMoedaEstrang": 1,
    "valorDespAcessoriaMoedaEstrange": 1,
    "valorFreteMoedaEstrangeira": 1,
    "valorDescontoMoedaEstrangeira": 1,
    "pedidoGrade": true,
    "rotinaGeradoraPedido": "text",
    "situacaoAceitePortal": 1,
    "codCotacao": 1,
    "dataLimite": "2025-11-27",
    "motivoLiberacao": "text",
    "valorCotacaoMoeda": 1,
    "situacaoBloqueio": 0,
    "opcaoTipoFrete": "text",
    "dataPrevisaoInicial": "2025-11-27",
    "dataPrevisaoAtual": "2025-11-27",
    "percFrete": 1,
    "valorFixoFrete": 1,
    "percSeguro": 1,
    "valorSeguro": 1,
    "percDesconto2": 1,
    "valorDesconto2": 1,
    "percDespesasAcessorias": 1,
    "valorDespesasAcessorias": 1,
    "codPerfilComprador": 1,
    "dataHoraSituacao": "2025-11-27T20:15:05.249Z",
    "dataHoraBloqueio": "2025-11-27T20:15:05.249Z",
    "dataHoraLiberacao": "2025-11-27T20:15:05.249Z",
    "dataHoraEnvio": "2025-11-27T20:15:05.249Z",
    "dataHoraAceite": "2025-11-27T20:15:05.249Z",
    "situacaoAceite": 0,
    "codUsuario": 1,
    "nomeContato": "text",
    "telefoneContato": "text",
    "emailContato": "text",
    "emailCopiaContato": "text",
    "itemPedidoCompra": [
      {
        "percAliquotaICMS": 1,
        "codProduto": "text",
        "codPedido": 1,
        "itemPedido": 1,
        "quantidade": 1,
        "qtdeAtendida": 1,
        "qtdeCancelada": 1,
        "qtdeSaldo": 1,
        "situacao": 0,
        "precoUnitario": 1,
        "percIPI": 1,
        "percDesconto": 1,
        "loteProducao": "text",
        "dataPrevisao": "2025-11-27",
        "centroCusto": "text",
        "solicCompras": 1,
        "itemSolicCompras": 1,
        "itemDespesa": 1,
        "itemIntegracao": "text",
        "ultSeqAtendida": 1,
        "unidadeMedida": "text",
        "composicaoIPI": "text",
        "impressoComunicacao": true,
        "valorFrete": 1,
        "valorFreteMoedaEstrangeira": 1,
        "dataLimiteEntrega": "2025-11-27",
        "pedidoFornecedor": "text",
        "referenciaFornecedor": "text",
        "dataEntregaOriginal": "2025-11-27",
        "codFinalidade": 1,
        "codOS": 1,
        "precoUnitarioMoedaEstrangeira": 1,
        "contaContabil": "text",
        "contaContabilC": "text",
        "numControle": "text",
        "dataHoraCancelamentoItem": "2025-11-27T20:15:05.249Z",
        "motivoCancelamentoItem": "text",
        "operadorCancelamentoItem": "text",
        "codUnidadeCompra": "text",
        "fatorConversaoCompra": "text",
        "fatorConversaoQuantidade": 1,
        "fatorConversaoOperador": 1,
        "baseCalculoICMSST": 1,
        "aliquotaICMSST": 1,
        "valorICMSST": 1,
        "percDiferencialAliquota": 1,
        "valorDiferencialAliquota": 1,
        "descricaoProduto": "text",
        "rateioCentrosDeCusto": true,
        "codFamilia": 1,
        "codSubFamilia": 1,
        "codContrato": 1,
        "seqProdutoContrato": 1,
        "codCotacao": 1,
        "seqEnvioCotacao": 1,
        "seqFornecedorCotacao": 1,
        "seqProdutoCotacao": 1,
        "dataHoraSituacaoItem": "2025-11-27T20:15:05.249Z",
        "dataPrevisaoInicial": "2025-11-27",
        "percAliquotaPIS": 1,
        "percAliquotaCOFINS": 1,
        "valorUnitarioICMSST": 1,
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ],
        "itensPedidoContaContabilCentrosCustosRateio": [
          {
            "contaContabil": 1,
            "percentualProporcao": 1,
            "contaContabilCentroCusto": [
              {
                "centroCustos": "text",
                "percentualProporcao": 1
              }
            ]
          }
        ]
      }
    ],
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]
Deprecated

Alterar um Pedido de Compra

put
/pedidoCompra/{id}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
idstringObrigatório

Código do Pedido de Compra

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Corpo
codPedidointegerOpcional

Código do Pedido de Compra

codFornecedorintegerOpcional

Código do Fornecedor

dataEmissaostring · dateOpcional

Data da Emissão (YYYY-MM-DD)

codCompradorintegerOpcional

Código do Comprador

codTransportadoraintegerOpcional

Código da Transportadora

condicaoFreteintegerOpcional

Código da Condição de Frete

codLocalEntregaintegerOpcional

Código do Local de Entrega

condicaoPagamentointegerOpcional

Código da Condição de Pagamento

codLocalCobrancaintegerOpcional

Código do Local de Cobrança

percDespesaFinanceiranumberOpcional

Percentual de Despesa Financeira

valorDespesaFinanceiranumberOpcional

Valor de Despesa Financeira

percDescontonumberOpcional

Percentual de Desconto

valorDescontonumberOpcional

Valor de Desconto

valorPedidonumberObrigatório

Valor Total do Pedido

dataRecebimentostring · dateOpcional

Data de Recebimento (YYYY-MM-DD)

situacaoPedidointeger · enumOpcional

Situação (0 - Aberto, 1 - Atendido, 2 - Atendido parte, 3 - Cancelado)

Valores possíveis:
observacaostring · máx: 160Opcional

Observação

situacaoQtoEntradaintegerOpcional

Situação Quanto a Entrada

tipoDescontoEspecialinteger · enumOpcional

Tipo do Desconto Especial (0 - Em dias, 1 - Em data específica)

Valores possíveis:
valorDespesaAcessorianumberOpcional

Valor de Despesa Acessória

tipoPedidointeger · enumOpcional

Tipo do Pedido (1 - Normal, 2- Complemento, 3 - Serviço, 4 - Terceirização, 5 -Consignação, 6 - Mostruário, 7 - Importação)

Valores possíveis:
codPedidoComplementarintegerOpcional

Código do Pedido Complementar

codMensagemPadraointegerOpcional

Código da Mensagem Padrão

codPortadorintegerOpcional

Código do Portador

situacaoImpressobooleanOpcional

Situação da Impressão (0 - Não Impresso, 1 - Impresso)

condicaoPagamentoEspecialintegerOpcional

Código da Segunda Condição de Pagamento Especial

condicaoPagamentoEspecial1integerOpcional

Código da Terceira Condição de Pagamento Especial

condicaoPagamentoEspecial2integerOpcional

Código da Quarta Condição de Pagamento Especial

condicaoPagamentoEspecial3integerOpcional

Código da Quinta Condição de Pagamento Especial

condicaoPagamentoEspecial4integerOpcional

Código da Sexta Condição de Pagamento Especial

pedidoBloqueadobooleanOpcional

Pedido esta Bloqueado? (0 - Não, 1 - Sim)

motivoCancelamentostring · máx: 105Opcional

Motivo Descritivo do Cancelamento do Pedido

dataHoraCancelamentostring · date-timeOpcional

Data e Hora do Cancelamento do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

operadorCancelamentostring · máx: 30Opcional

Operador do Cancelamento do Pedido

valorFretenumberOpcional

Valor do Frete

mascaraCompradorintegerOpcional

Código da Máscara do Comprador

flagPedidointeger · enumOpcional

Flag do Pedido 1 - Liberado, 2 - Liberado com Restrição, 3 - Cancelado

Valores possíveis:
pedidoAutomaticobooleanOpcional

Pedido Automático? (0 - Não, 1 - Sim)

pedidoIntegracaostring · máx: 30Opcional

Número do Pedido Importado de Outros Sistemas para Integração com o Sistema Consistem

numControlestring · máx: 10Opcional

Número do Controle

finalidadeintegerOpcional

Código da Finalidade

codMoedaEstrangeiraintegerOpcional

Código da Moeda Estrangeira

dataCotacaostring · dateOpcional

Data da Cotação (YYYY-MM-DD)

valorPedidoMoedaEstrangeiranumberOpcional

Valor do Pedido em Moeda Estrangeira

valorDespFinanceiraMoedaEstrangnumberOpcional

Valor de Despesas Financeiras em Moeda Estrangeira

valorDespAcessoriaMoedaEstrangenumberOpcional

Valor de Despesas Acessórias em Moeda Estrangeira

valorFreteMoedaEstrangeiranumberOpcional

Valor do Frete em Moeda Estrangeira

valorDescontoMoedaEstrangeiranumberOpcional

Valor do Desconto em Moeda Estrangeira

pedidoGradebooleanOpcional

Pedido por Grade (0 - Não, 1 - Sim)

rotinaGeradoraPedidostringOpcional

Rotina Geradora do Pedido

situacaoAceitePortalinteger · enumOpcional

Situação do Aceite no Portal (1 - Gerado, 2 - Em Aceite, 3 - Aceito, 4 - Não Aceito)

Valores possíveis:
codCotacaointegerOpcional

Código da Cotação

dataLimitestring · dateOpcional

Data Limite para Aceite do Pedido (YYYY-MM-DD)

motivoLiberacaostring · máx: 160Opcional

Motivo da Liberação

valorCotacaoMoedanumberOpcional

Valor da Cotação da Moeda

situacaoBloqueiointeger · enumOpcional

Situação do Bloqueio (0 - Liberado, 1 - Bloqueado, 2 - Digitado, 3- Retornado)

Valores possíveis:
opcaoTipoFretestring · máx: 10Opcional

Opção de Tipo de Frete

dataPrevisaoInicialstring · dateOpcional

Data de Previsão de Entrega Inicial (YYYY-MM-DD)

dataPrevisaoAtualstring · dateOpcional

Data de Previsão de Entrega Atual (YYYY-MM-DD)

percFretenumberOpcional

Percentual de Frete Sobre o Valor das Mercadorias

valorFixoFretenumberOpcional

Valor Fixo do Frete a ser Somado no Valor do Pedido

percSeguronumberOpcional

Percentual do Seguro Sobre o Valor das Mercadorias

valorSeguronumberOpcional

Valor do Seguro Sobre o Valor das Mercadorias

percDesconto2numberOpcional

Segundo Percentual de Desconto

valorDesconto2numberOpcional

Segundo Valor de Desconto

percDespesasAcessoriasnumberOpcional

Percentual de Despesas Acessórias

valorDespesasAcessoriasnumberOpcional

Valor de Despesas Acessórias

codPerfilCompradorintegerOpcional

Código do Perfil do Comprador

dataHoraSituacaostring · date-timeOpcional

Data e Hora da Atualização da Situação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraBloqueiostring · date-timeOpcional

Data e Hora do Bloqueio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraLiberacaostring · date-timeOpcional

Data e Hora da Liberação do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraEnviostring · date-timeOpcional

Data e Hora do Envio do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraAceitestring · date-timeOpcional

Data e Hora do Aceite do Pedido (YYYY-MM-DDTHH:mm:ss.sssZ)

situacaoAceiteinteger · enumOpcional

Situação do Aceite do Pedido (0 - Não Enviado, 1 - Enviado, 2 - Aceito, 3 - Rejeitado)

Valores possíveis:
codUsuariointegerOpcional

Código do Usuário

nomeContatostring · máx: 30Opcional

Nome do Contato

telefoneContatostring · máx: 18Opcional

Telefone do Contato

emailContatostring · máx: 50Opcional

E-mail do Contato

emailCopiaContatostring · máx: 50Opcional

E-mail para Cópia do Contato

Respostas
200

OK

application/json
put
/pedidoCompra/{id}
PUT /compras/v10/pedidoCompra/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 3759

{
  "codPedido": 1,
  "codFornecedor": 1,
  "dataEmissao": "2025-11-27",
  "codComprador": 1,
  "codTransportadora": 1,
  "condicaoFrete": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDespesaFinanceira": 1,
  "valorDespesaFinanceira": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "valorPedido": 1,
  "dataRecebimento": "2025-11-27",
  "situacaoPedido": 0,
  "observacao": "text",
  "situacaoQtoEntrada": 1,
  "tipoDescontoEspecial": 0,
  "valorDespesaAcessoria": 1,
  "tipoPedido": 1,
  "codPedidoComplementar": 1,
  "codMensagemPadrao": 1,
  "codPortador": 1,
  "situacaoImpresso": true,
  "condicaoPagamentoEspecial": 1,
  "condicaoPagamentoEspecial1": 1,
  "condicaoPagamentoEspecial2": 1,
  "condicaoPagamentoEspecial3": 1,
  "condicaoPagamentoEspecial4": 1,
  "pedidoBloqueado": true,
  "motivoCancelamento": "text",
  "dataHoraCancelamento": "2025-11-27T20:15:05.249Z",
  "operadorCancelamento": "text",
  "valorFrete": 1,
  "mascaraComprador": 1,
  "flagPedido": 1,
  "pedidoAutomatico": true,
  "pedidoIntegracao": "text",
  "numControle": "text",
  "finalidade": 1,
  "codMoedaEstrangeira": 1,
  "dataCotacao": "2025-11-27",
  "valorPedidoMoedaEstrangeira": 1,
  "valorDespFinanceiraMoedaEstrang": 1,
  "valorDespAcessoriaMoedaEstrange": 1,
  "valorFreteMoedaEstrangeira": 1,
  "valorDescontoMoedaEstrangeira": 1,
  "pedidoGrade": true,
  "rotinaGeradoraPedido": "text",
  "situacaoAceitePortal": 1,
  "codCotacao": 1,
  "dataLimite": "2025-11-27",
  "motivoLiberacao": "text",
  "valorCotacaoMoeda": 1,
  "situacaoBloqueio": 0,
  "opcaoTipoFrete": "text",
  "dataPrevisaoInicial": "2025-11-27",
  "dataPrevisaoAtual": "2025-11-27",
  "percFrete": 1,
  "valorFixoFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDesconto2": 1,
  "valorDesconto2": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "dataHoraSituacao": "2025-11-27T20:15:05.249Z",
  "dataHoraBloqueio": "2025-11-27T20:15:05.249Z",
  "dataHoraLiberacao": "2025-11-27T20:15:05.249Z",
  "dataHoraEnvio": "2025-11-27T20:15:05.249Z",
  "dataHoraAceite": "2025-11-27T20:15:05.249Z",
  "situacaoAceite": 0,
  "codUsuario": 1,
  "nomeContato": "text",
  "telefoneContato": "text",
  "emailContato": "text",
  "emailCopiaContato": "text",
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "itemPedido": 1,
      "quantidade": 1,
      "situacao": 0,
      "precoUnitario": 1,
      "percIPI": 1,
      "percDesconto": 1,
      "loteProducao": "text",
      "dataPrevisao": "2025-11-27",
      "centroCusto": "text",
      "solicCompras": 1,
      "itemSolicCompras": 1,
      "itemDespesa": 1,
      "itemIntegracao": "text",
      "ultSeqAtendida": 1,
      "unidadeMedida": "text",
      "composicaoIPI": "text",
      "impressoComunicacao": true,
      "valorFrete": 1,
      "valorFreteMoedaEstrangeira": 1,
      "dataLimiteEntrega": "2025-11-27",
      "pedidoFornecedor": "text",
      "referenciaFornecedor": "text",
      "dataEntregaOriginal": "2025-11-27",
      "codFinalidade": 1,
      "codOS": 1,
      "precoUnitarioMoedaEstrangeira": 1,
      "contaContabil": "text",
      "contaContabilC": "text",
      "numControle": "text",
      "dataHoraCancelamentoItem": "2025-11-27T20:15:05.249Z",
      "motivoCancelamentoItem": "text",
      "operadorCancelamentoItem": "text",
      "codUnidadeCompra": "text",
      "fatorConversaoCompra": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 1,
      "baseCalculoICMSST": 1,
      "aliquotaICMSST": 1,
      "valorICMSST": 1,
      "percDiferencialAliquota": 1,
      "valorDiferencialAliquota": 1,
      "descricaoProduto": "text",
      "rateioCentrosDeCusto": true,
      "codFamilia": 1,
      "codSubFamilia": 1,
      "codContrato": 1,
      "seqProdutoContrato": 1,
      "codCotacao": 1,
      "seqEnvioCotacao": 1,
      "seqFornecedorCotacao": 1,
      "seqProdutoCotacao": 1,
      "dataHoraSituacaoItem": "2025-11-27T20:15:05.249Z",
      "dataPrevisaoInicial": "2025-11-27",
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "valorUnitarioICMSST": 1,
      "itensContaContabilCentroCustosRateio": [
        {
          "contaContabil": 1,
          "percentualProporcao": 1,
          "contaContabilCentroCusto": [
            {
              "centroCustos": "text",
              "percentualProporcao": 1
            }
          ]
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "parcelasPedido": [
    {
      "qtdeDiasParcela": 1,
      "valProporcao": 1,
      "dataPagamento": "2025-11-27",
      "valorPagamento": 1
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}
{
  "codPedido": 1,
  "codFornecedor": 1,
  "dataEmissao": "2025-11-27",
  "codComprador": 1,
  "codTransportadora": 1,
  "condicaoFrete": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDespesaFinanceira": 1,
  "valorDespesaFinanceira": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "valorPedido": 1,
  "dataRecebimento": "2025-11-27",
  "situacaoPedido": 0,
  "observacao": "text",
  "situacaoQtoEntrada": 1,
  "tipoDescontoEspecial": 0,
  "valorDespesaAcessoria": 1,
  "tipoPedido": 1,
  "codPedidoComplementar": 1,
  "codMensagemPadrao": 1,
  "codPortador": 1,
  "situacaoImpresso": true,
  "condicaoPagamentoEspecial": 1,
  "condicaoPagamentoEspecial1": 1,
  "condicaoPagamentoEspecial2": 1,
  "condicaoPagamentoEspecial3": 1,
  "condicaoPagamentoEspecial4": 1,
  "pedidoBloqueado": true,
  "motivoCancelamento": "text",
  "dataHoraCancelamento": "2025-11-27T20:15:05.249Z",
  "operadorCancelamento": "text",
  "valorFrete": 1,
  "mascaraComprador": 1,
  "flagPedido": 1,
  "pedidoAutomatico": true,
  "pedidoIntegracao": "text",
  "numControle": "text",
  "finalidade": 1,
  "codMoedaEstrangeira": 1,
  "dataCotacao": "2025-11-27",
  "valorPedidoMoedaEstrangeira": 1,
  "valorDespFinanceiraMoedaEstrang": 1,
  "valorDespAcessoriaMoedaEstrange": 1,
  "valorFreteMoedaEstrangeira": 1,
  "valorDescontoMoedaEstrangeira": 1,
  "pedidoGrade": true,
  "rotinaGeradoraPedido": "text",
  "situacaoAceitePortal": 1,
  "codCotacao": 1,
  "dataLimite": "2025-11-27",
  "motivoLiberacao": "text",
  "valorCotacaoMoeda": 1,
  "situacaoBloqueio": 0,
  "opcaoTipoFrete": "text",
  "dataPrevisaoInicial": "2025-11-27",
  "dataPrevisaoAtual": "2025-11-27",
  "percFrete": 1,
  "valorFixoFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDesconto2": 1,
  "valorDesconto2": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "dataHoraSituacao": "2025-11-27T20:15:05.249Z",
  "dataHoraBloqueio": "2025-11-27T20:15:05.249Z",
  "dataHoraLiberacao": "2025-11-27T20:15:05.249Z",
  "dataHoraEnvio": "2025-11-27T20:15:05.249Z",
  "dataHoraAceite": "2025-11-27T20:15:05.249Z",
  "situacaoAceite": 0,
  "codUsuario": 1,
  "nomeContato": "text",
  "telefoneContato": "text",
  "emailContato": "text",
  "emailCopiaContato": "text",
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "codPedido": 1,
      "itemPedido": 1,
      "quantidade": 1,
      "qtdeAtendida": 1,
      "qtdeCancelada": 1,
      "qtdeSaldo": 1,
      "situacao": 0,
      "precoUnitario": 1,
      "percIPI": 1,
      "percDesconto": 1,
      "loteProducao": "text",
      "dataPrevisao": "2025-11-27",
      "centroCusto": "text",
      "solicCompras": 1,
      "itemSolicCompras": 1,
      "itemDespesa": 1,
      "itemIntegracao": "text",
      "ultSeqAtendida": 1,
      "unidadeMedida": "text",
      "composicaoIPI": "text",
      "impressoComunicacao": true,
      "valorFrete": 1,
      "valorFreteMoedaEstrangeira": 1,
      "dataLimiteEntrega": "2025-11-27",
      "pedidoFornecedor": "text",
      "referenciaFornecedor": "text",
      "dataEntregaOriginal": "2025-11-27",
      "codFinalidade": 1,
      "codOS": 1,
      "precoUnitarioMoedaEstrangeira": 1,
      "contaContabil": "text",
      "contaContabilC": "text",
      "numControle": "text",
      "dataHoraCancelamentoItem": "2025-11-27T20:15:05.249Z",
      "motivoCancelamentoItem": "text",
      "operadorCancelamentoItem": "text",
      "codUnidadeCompra": "text",
      "fatorConversaoCompra": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 1,
      "baseCalculoICMSST": 1,
      "aliquotaICMSST": 1,
      "valorICMSST": 1,
      "percDiferencialAliquota": 1,
      "valorDiferencialAliquota": 1,
      "descricaoProduto": "text",
      "rateioCentrosDeCusto": true,
      "codFamilia": 1,
      "codSubFamilia": 1,
      "codContrato": 1,
      "seqProdutoContrato": 1,
      "codCotacao": 1,
      "seqEnvioCotacao": 1,
      "seqFornecedorCotacao": 1,
      "seqProdutoCotacao": 1,
      "dataHoraSituacaoItem": "2025-11-27T20:15:05.249Z",
      "dataPrevisaoInicial": "2025-11-27",
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "valorUnitarioICMSST": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ],
      "itensPedidoContaContabilCentrosCustosRateio": [
        {
          "contaContabil": 1,
          "percentualProporcao": 1,
          "contaContabilCentroCusto": [
            {
              "centroCustos": "text",
              "percentualProporcao": 1
            }
          ]
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Exclui um Pedido de Compra

delete
/pedidoCompra/{id}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
idstringObrigatório

Código do Pedido de Compra

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

Sem conteúdo

delete
/pedidoCompra/{id}
DELETE /compras/v10/pedidoCompra/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Atualizado