Pular para o conteúdo principal

Compras

Pedidos de compra e os itens de cada pedido. Exigem o recurso Pedidos de Compra no plano.

Pedidos de compra​

Recurso do plano: Pedidos de Compra.

MétodoRotaO que faz
GET/external/v1/purchase-ordersLista com paginação
GET/external/v1/purchase-orders/:idBusca um registro pelo ID
POST/external/v1/purchase-ordersCria um registro
PUT/external/v1/purchase-orders/:idAtualiza um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

curl -G "https://erp-api.ideros.api.br/external/v1/purchase-orders" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/purchase-orders/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
supplierIdstringSimID de pessoa.
buyerIdstringSimID de usuário da empresa.
workspaceIdstringNãoID de workspace.
businessUnitIdstringNãoID de unidade de negócio.
projectIdstringNãoID de projeto.
dealIdstringNãoID de negócio. Vincula a ordem de compra a uma venda/serviço (Deal), de forma independente do projectId.
requisitionIdstringNãoID de requisição de compra.
orderCodestringNãoCódigo único da ordem de compra. Gerado automaticamente pelo sistema se omitido.
titlestringSimTítulo da ordem de compra.
descriptionstringNãoDescrição detalhada da ordem de compra.
expectedDeliveryDatestring (data ISO 8601)NãoData esperada para entrega dos itens.
notesstringNãoObservações adicionais sobre a ordem de compra.
totalAmountnumberSimValor total da ordem de compra.
paymentTermsstringNãoCondições de pagamento da ordem de compra.
deliveryTermsstringNãoCondições de entrega da ordem de compra.
warrantyTermsstringNãoTermos de garantia dos itens.
requiresApprovalbooleanNãoPedir aprovação mesmo assim: força o fluxo de aprovação mesmo abaixo da trava de valor da empresa. Só tem efeito se houver fluxo de aprovação configurado para Pedidos de Compra.
defaultPurchaseNatureenumNãoNatureza (destinação) PADRÃO herdada pelos itens deste pedido de compra. Cada item pode ter natureza própria — esta é apenas a sugestão inicial. Valores: RESALE, INDUSTRIALIZATION, PACKAGING, SERVICE_MATERIAL_ICMS, SERVICE_MATERIAL_ISS, CONSUMPTION, FIXED_ASSET, FREE_SAMPLE, CONSIGNMENT_IN, TOLLING_IN, TOLLING_RETURN, TRANSFER_IN, RETURN_IN, SERVICE, OTHER.
costCenterIdstringNãoID de centro de custo.

Atualizar​

Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.

Itens do pedido de compra​

Itens podem ser listados, consultados e criados. Não há rota de atualização.

Recurso do plano: Pedidos de Compra.

MétodoRotaO que faz
GET/external/v1/purchase-order-itemsLista com paginação
GET/external/v1/purchase-order-items/:idBusca um registro pelo ID
POST/external/v1/purchase-order-itemsCria um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"purchaseOrderId":"ID_DO_PEDIDO"}}):

curl -G "https://erp-api.ideros.api.br/external/v1/purchase-order-items" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"purchaseOrderId":"ID_DO_PEDIDO"}}'

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/purchase-order-items/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
purchaseOrderIdstringSimID de pedido de compra.
productIdstringNãoID de produto.
productPriceTableIdstringNãoID da tabela de preço (ProductPriceTable) de origem do unitPrice. Opcional — registra de qual tabela o preço foi tirado para rastreabilidade.
descriptionstringSimDescrição do item.
itemTypeenumNãoTipo do item (Produto, Serviço, Mão de obra, Outros). Valores: LABOR, SERVICE, PARTS, OTHERS.
valueTypeenumNãoFormato do preço. AMOUNT (padrão): unitPrice é valor em reais. PERCENTAGE: unitPrice é percentual sobre originalUnitPrice. Valores: PERCENTAGE, AMOUNT.
quantitynumberSimQuantidade do item a ser comprada.
originalUnitPricenumberNãoPreço unitário cheio/base. Obrigatório quando valueType=PERCENTAGE. Se omitido, assume o unitPrice.
unitPricenumberSimPreço unitário do item.
totalPricenumberSimPreço total calculado (quantidade * preço unitário).
discountnumberNãoValor de desconto aplicado ao item.
discountPercentagenumberNãoPercentual de desconto aplicado ao item.
purchaseNatureenumNãoNatureza (destinação) da compra deste item: revenda, industrialização, uso e consumo, ativo imobilizado, material aplicado em serviço, entre outras. Determina o CFOP de entrada, o direito a crédito e a natureza com que o item entra no estoque. Quando omitida, herda a natureza padrão do pedido de compra. Valores: RESALE, INDUSTRIALIZATION, PACKAGING, SERVICE_MATERIAL_ICMS, SERVICE_MATERIAL_ISS, CONSUMPTION, FIXED_ASSET, FREE_SAMPLE, CONSIGNMENT_IN, TOLLING_IN, TOLLING_RETURN, TRANSFER_IN, RETURN_IN, SERVICE, OTHER.
unitstringNãoUnidade de COMPRA do item, que pode ser diferente da unidade de estoque do produto.
conversionFactornumberNãoFator de conversão da unidade de compra para a unidade de estoque do produto. Comprar uma caixa com 12 unidades corresponde ao fator 12.
ncmstringNãoCódigo NCM do item. Quando omitido, é herdado do cadastro do produto.
cfopstringNãoCFOP de entrada do item. Quando omitido, é derivado da natureza da compra. Informe manualmente para operações que o sistema não cobre automaticamente.
stockLocationIdstringNãoID de local de estoque. Depósito de destino previsto para o item. Só utilizado quando a empresa habilita o controle de depósitos.
costCenterIdstringNãoID de centro de custo.
Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.