Pedido de Compra

pedidoCompra

Cadastrar um Pedido de Compra

put

https://localhost/compras/v20http://localhost/compras/v20

/pedidoCompra

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codFornecedorintegerOpcional

Código do Fornecedor

codCompradorintegerOpcional

Código do Comprador

codTransportadoraintegerOpcional

Código da Transportadora

codLocalEntregaintegerOpcional

Código do Local de Entrega

condicaoPagamentointegerOpcional

Código da Condição de Pagamento

codLocalCobrancaintegerOpcional

Código do Local de Cobrança

percDescontonumberOpcional

Percentual de Desconto

valorDescontonumberOpcional

Valor de Desconto

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:

valorFretenumberOpcional

Valor do Frete

codMoedaintegerOpcional

Código da Moeda

cotacaoMoedanumberOpcional

Valor da Cotação

opcaoTipoFreteintegerOpcional

Opção de Tipo de Frete

percFretenumberOpcional

Percentual de Frete Sobre o Valor das Mercadorias

percSeguronumberOpcional

Percentual do Seguro Sobre o Valor das Mercadorias

valorSeguronumberOpcional

Valor do Seguro Sobre o Valor das Mercadorias

percDespesasAcessoriasnumberOpcional

Percentual de Despesas Acessórias

valorDespesasAcessoriasnumberOpcional

Valor de Despesas Acessórias

codPerfilCompradorintegerOpcional

Código do Perfil do Comprador

finalidadenumberOpcional

Finalidade da compra

dataPrevisaostring · dateOpcional

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

diaEntgPosFaturaintegerOpcional

Dias Entrega pós Faturamento

codPolFluxoAprintegerOpcional

Política do Fluxo de Aprovação

Respostas

200

OK

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/pedidoCompra

HTTPcURLJavaScriptPython

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

{
  "codFornecedor": 1,
  "codComprador": 1,
  "codTransportadora": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "observacoesPadrao": [
    {
      "codObservacao": 1
    }
  ],
  "tipoPedido": 1,
  "valorFrete": 1,
  "codMoeda": 1,
  "cotacaoMoeda": 1,
  "opcaoTipoFrete": 1,
  "percFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "finalidade": 1,
  "dataPrevisao": "2025-11-29",
  "condicaoPagtoInfo": [
    {
      "dias": 1,
      "data": "2025-11-29",
      "proporcao": 1,
      "valor": 1
    }
  ],
  "diaEntgPosFatura": 1,
  "codPolFluxoApr": 1,
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "precoUnitario": 1,
      "percAliquotaIPI": 1,
      "dataPrevisao": "2025-11-29",
      "centroCusto": 1,
      "contaContabilC": "text",
      "numControle": "text",
      "valorICMSST": 1,
      "ratearCusto": true,
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "numOS": 1,
      "descricaoItemC": "text",
      "observacoesItem": [
        {
          "observaoItem": "text"
        }
      ],
      "rateioCusto": [
        {
          "centroCustos": "text",
          "percProporcaoCCusto": 1,
          "contaContabil": "text",
          "percProporcaoConta": 1
        }
      ],
      "unidadeCompra": "text",
      "quantidade": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "observacoes": [
    {
      "observacao": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Sem conteúdo

Alterar um Pedido de Compra

post

https://localhost/compras/v20http://localhost/compras/v20

/pedidoCompra/{id}

Autorizações

csw_auth

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

application/json

codFornecedorintegerOpcional

Código do Fornecedor

codCompradorintegerOpcional

Código do Comprador

codTransportadoraintegerOpcional

Código da Transportadora

codLocalEntregaintegerOpcional

Código do Local de Entrega

condicaoPagamentointegerOpcional

Código da Condição de Pagamento

codLocalCobrancaintegerOpcional

Código do Local de Cobrança

percDescontonumberOpcional

Percentual de Desconto

valorDescontonumberOpcional

Valor de Desconto

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:

valorFretenumberOpcional

Valor do Frete

codMoedaintegerOpcional

Código da Moeda

cotacaoMoedanumberOpcional

Valor da Cotação

opcaoTipoFreteintegerOpcional

Opção de Tipo de Frete

percFretenumberOpcional

Percentual de Frete Sobre o Valor das Mercadorias

percSeguronumberOpcional

Percentual do Seguro Sobre o Valor das Mercadorias

valorSeguronumberOpcional

Valor do Seguro Sobre o Valor das Mercadorias

percDespesasAcessoriasnumberOpcional

Percentual de Despesas Acessórias

valorDespesasAcessoriasnumberOpcional

Valor de Despesas Acessórias

codPerfilCompradorintegerOpcional

Código do Perfil do Comprador

finalidadenumberOpcional

Finalidade da compra

dataPrevisaostring · dateOpcional

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

diaEntgPosFaturaintegerOpcional

Dias Entrega pós Faturamento

codPolFluxoAprintegerOpcional

Política do Fluxo de Aprovação

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoCompra/{id}

HTTPcURLJavaScriptPython

POST /compras/v20/pedidoCompra/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "codFornecedor": 1,
  "codComprador": 1,
  "codTransportadora": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "observacoesPadrao": [
    {
      "codObservacao": 1
    }
  ],
  "tipoPedido": 1,
  "valorFrete": 1,
  "codMoeda": 1,
  "cotacaoMoeda": 1,
  "opcaoTipoFrete": 1,
  "percFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "finalidade": 1,
  "dataPrevisao": "2025-11-29",
  "condicaoPagtoInfo": [
    {
      "dias": 1,
      "data": "2025-11-29",
      "proporcao": 1,
      "valor": 1
    }
  ],
  "diaEntgPosFatura": 1,
  "codPolFluxoApr": 1,
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "precoUnitario": 1,
      "percAliquotaIPI": 1,
      "dataPrevisao": "2025-11-29",
      "centroCusto": 1,
      "contaContabilC": "text",
      "numControle": "text",
      "valorICMSST": 1,
      "ratearCusto": true,
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "numOS": 1,
      "descricaoItemC": "text",
      "observacoesItem": [
        {
          "observaoItem": "text"
        }
      ],
      "rateioCusto": [
        {
          "centroCustos": "text",
          "percProporcaoCCusto": 1,
          "contaContabil": "text",
          "percProporcaoConta": 1
        }
      ],
      "unidadeCompra": "text",
      "quantidade": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "observacoes": [
    {
      "observacao": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codFornecedor": 1,
  "codComprador": 1,
  "codTransportadora": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "observacoesPadrao": [
    {
      "codObservacao": 1
    }
  ],
  "tipoPedido": 1,
  "valorFrete": 1,
  "codMoeda": 1,
  "cotacaoMoeda": 1,
  "opcaoTipoFrete": 1,
  "percFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "finalidade": 1,
  "dataPrevisao": "2025-11-29",
  "condicaoPagtoInfo": [
    {
      "dias": 1,
      "data": "2025-11-29",
      "proporcao": 1,
      "valor": 1
    }
  ],
  "diaEntgPosFatura": 1,
  "codPolFluxoApr": 1,
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "precoUnitario": 1,
      "percAliquotaIPI": 1,
      "dataPrevisao": "2025-11-29",
      "centroCusto": 1,
      "contaContabilC": "text",
      "numControle": "text",
      "valorICMSST": 1,
      "ratearCusto": true,
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "numOS": 1,
      "descricaoItemC": "text",
      "observacoesItem": [
        {
          "observaoItem": "text"
        }
      ],
      "rateioCusto": [
        {
          "centroCustos": "text",
          "percProporcaoCCusto": 1,
          "contaContabil": "text",
          "percProporcaoConta": 1
        }
      ],
      "unidadeCompra": "text",
      "quantidade": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "observacoes": [
    {
      "observacao": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Solicitar Liberação de um Pedido de Compra

post

https://localhost/compras/v20http://localhost/compras/v20

/pedidoCompraSolicitarLiberacao/{id}

Autorizações

csw_auth

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

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoCompraSolicitarLiberacao/{id}

HTTPcURLJavaScriptPython

POST /compras/v20/pedidoCompraSolicitarLiberacao/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codFornecedor": 1,
  "codComprador": 1,
  "codTransportadora": 1,
  "codLocalEntrega": 1,
  "condicaoPagamento": 1,
  "codLocalCobranca": 1,
  "percDesconto": 1,
  "valorDesconto": 1,
  "observacoesPadrao": [
    {
      "codObservacao": 1
    }
  ],
  "tipoPedido": 1,
  "valorFrete": 1,
  "codMoeda": 1,
  "cotacaoMoeda": 1,
  "opcaoTipoFrete": 1,
  "percFrete": 1,
  "percSeguro": 1,
  "valorSeguro": 1,
  "percDespesasAcessorias": 1,
  "valorDespesasAcessorias": 1,
  "codPerfilComprador": 1,
  "finalidade": 1,
  "dataPrevisao": "2025-11-29",
  "condicaoPagtoInfo": [
    {
      "dias": 1,
      "data": "2025-11-29",
      "proporcao": 1,
      "valor": 1
    }
  ],
  "diaEntgPosFatura": 1,
  "codPolFluxoApr": 1,
  "itemPedidoCompra": [
    {
      "percAliquotaICMS": 1,
      "codProduto": "text",
      "precoUnitario": 1,
      "percAliquotaIPI": 1,
      "dataPrevisao": "2025-11-29",
      "centroCusto": 1,
      "contaContabilC": "text",
      "numControle": "text",
      "valorICMSST": 1,
      "ratearCusto": true,
      "percAliquotaPIS": 1,
      "percAliquotaCOFINS": 1,
      "numOS": 1,
      "descricaoItemC": "text",
      "observacoesItem": [
        {
          "observaoItem": "text"
        }
      ],
      "rateioCusto": [
        {
          "centroCustos": "text",
          "percProporcaoCCusto": 1,
          "contaContabil": "text",
          "percProporcaoConta": 1
        }
      ],
      "unidadeCompra": "text",
      "quantidade": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "observacoes": [
    {
      "observacao": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}