Á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 é realizar a importação inclusão de pedidos de compras no ERP.

Chamada

POST api/v1/PedidoCompras/importarincluir-pedido-compra

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

TaxDTOIncluirPedidoCompraDto

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
company_division_numberCompany Division Number (Optional, but necessary for generating some taxes)
nroPedFornecedor

Número do pedido no fornecedor.

integerNão há.
number_companyCompany NumberintegerRequerido
cnpjEmpresa

CNPJ da empresa compradora.

stringNão há.
cnpjEmpresaFat

CNPJ da empresa que faturou o pedido.

string
number_customerDestination Customer Number (Optional)integer
Não há.
productsProduct InformationCollection of ProductRequeridoreg_number_legal_entityLegal Entity – Brazilian Registry of Corporate Taxpayers – (00.000.000/0001-00 or 00000000000000) – (Optional)
cnpjFornecedorCNPJ do Fornecedor.stringNão há.
apelidoComprador

Apelido do Comprador.

stringNão há.
tipoPedido

Tipo do pedido, 'C' = Compra, 'B' = Bonificação com incidência, 'E' = Bonificação sem incidência

stringNão há.
reg_number_physical_personPhysical Person – Individual Taxpayers – (000.000.000-00 or 00000000000) – (Optional)
dtaEmissao

Data que o pedido foi emitido.

stringNão há.
dtaRecebimento

Data em que o pedido será recebido.

stringNão há.
state_customerState Customer Acronym (Optional: if it is not passed, the client state will be used and if the client is not passed the state will be used) Valid States: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TOstringTamanho da String: inclusive between 0 and 2type_taxType tax (Optional) – ED = Distributor Entry, EI = Industry Entry, EM = Microenterprise Entry, EX = Exterior Entry, SD = Output Return Distributor, SI = Industry Return Delivery, SM = Microenterprise Return Delivery, SN = Non Contributing Output Default – “SN”stringTamanho da String: inclusive between 0 and 2

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

{
  "company_division_number": 3,
  "number_company": 4,
  "number_customer": 5,
  "products": [
    {
      "number_product": 1.0,
      "packing_quantity": 2.1,
      "sale_price": 3.1,
      "quantity": 4.1
    },
    {
      "number_product": 1.0,
      "packing_quantity": 2.1,
      "sale_price": 3.1,
      "quantity": 4.1
    }
  ],
  "reg_number_legal_entity": "sample string 6",
  "reg_number_physical_person": "sample string 7",
  "state_customer": "sample string 8",
  "type_tax": "sample string 9"
}

application/xml, text/xml

Exemplo (Sample):

<TaxDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns="http://schemas.datacontract.org/2004/07/SMProductsV3.Business.DTOs.Tax">
  <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
  <company_division_number>3</company_division_number>
  <number_company>4</number_company>
  <number_customer>5</number_customer>
  <products>
    <Product>
      <number_product>1</number_product>
      <packaging_quantity>2.1</packaging_quantity>
      <quantity>4.1</quantity>
      <sale_price>3.1</sale_price>
    </Product>
    <Product>
      <number_product>1</number_product>
      <packaging_quantity>2.1</packaging_quantity>
      <quantity>4.1</quantity>
      <sale_price>3.1</sale_price>
    </Product>
  </products>
  <reg_number_legal_entity>sample string 6</reg_number_legal_entity>
  <reg_number_physical_person>sample string 7</reg_number_physical_person>
  <state>sample string 8</state>
  <type_tax>sample string 9</type_tax>
</TaxDTO>

application/x-www-form-urlencoded

Exemplo (Sample):

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

TaxResponseDTO – Lista de produtos de acordo com os dados de entrada

Collection of TaxResponseDTO

...

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "number_product": 1.0,
    "number_taxation": 2,
    "packing_quantity": 3.1,
    "sale_price": 4.1,
    "icms_st_value": 1.1,
    "ipi_value": 1.1,
    "percent_icms": 1.1,
    "percent_pis": 1.1,
    "percent_cofins": 1.1,
    "type_tax": "sample string 5"
  },
  {
    "number_product": 1.0,
    "number_taxation": 2,
    "packing_quantity": 3.1,
    "sale_price": 4.1,
    "icms_st_value": 1.1,
    "ipi_value": 1.1,
    "percent_icms": 1.1,
    "percent_pis": 1.1,
    "percent_cofins": 1.1,
    "type_tax": "sample string 5"
  }
]

application/xml, text/xml

Exemplo (Sample):

...

dtaLimiteRecebto

Data limite para recebimento do pedido.

stringNão há.
tipoFrete

Indica o tipo de frete praticado pelo fornecedor, 'C' = CIF, 'F' = FOB, 'S' = CSP ou 'R' = RETIRA.

stringNão há.
itensPedido

Itens do pedido.

ItensPedidoDto{...}]
Não há.Não há.
expandablesnullable: truestringNão há.

Parâmetros do Corpo

ItensPedidoDto

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
nroPedFornecedor

Número do pedido no fornecedor

stringNão há.
cnpjEmpresaCNPJ da empresa compradora.stringNão há.
codProduto

EAN, DUN ou código interno do produto.

integerPara considerar '0' (zeros) a esquerda do EAN, utilizar PD UTIL_EAN_ALFANUMERICO (EDI_PEDCOMPRA) = 'S'
                                                                                      PD IND_TIP_COD_PRODUTO (EDI_PEDCOMPRA) = 'C'
qtdSolicitada

Quantidade solicitada.

numberNão há.
qtdEmbalagem

Quantidade da embalagem de compra.

numberNão há.
vlrEmbItem

Valor do Item.

numberNão há.
vlrEmbIPI

Valor do IPI vinculado ao item.

numberNão há.
vlrEmbICMSST

Valor do ICMSST vinculado ao item.

numberNão há.
vlrEmbDespesa

Valor de despesa sobre o produto.

numberNão há.
vlrEmbVerbaCompra

Valor de verba de compra.

numberNão há.
dtaRecebtoItem

Data de recebimento do item.

stringNão há.
percDescFinancItem

Percentual do desconto financeiro do item.

numberNão há.
vlrEmbICMS

Valor do ICMS vinculado ao item.

numberNão há.
vlrEmbISS

Valor do ISS vinculado ao item.

numberNão há.
vlrEmbIRRF

Valor do IRRF vinculado ao item.

numberNão há.
vlrEmbFrete

Valor do Frete.

numberNão há.
vlrEmbVendor

Valor vendor do produto.

numberNão há.
vlrEmbDesconto

Valor do desconto sobre o produto.

numberNão há.
perDescDf

Percentual de desconto financeiro.

numberNão há.
vlrEmbVerbaComprAcr

Valor de verba de compra de acréscimo.

numberNão há.

Formatos da Requisição (Request Formats)

{
  "nroPedFornecedor"24,
  "cnpjEmpresa""39010418000115",
  "cnpjEmpresaFat""39010418000115",
  "cnpjFornecedor""19900000000842",
  "apelidoComprador""ANTONIO COMPRAD",
  "tipoPedido""c",
  "dtaEmissao""2020-09-25T20:31:55.408Z",
  "dtaRecebimento""2020-09-25T20:31:55.408Z",
  "dtaLimiteRecebto""2020-09-25T20:31:55.408Z",
  "tipoFrete""c",
  "itensPedido": [
    {
      "nroPedFornecedor""24",
      "cnpjEmpresa""39010418000115",
      "codProduto"7790070218216,
      "qtdSolicitada"1000,
      "qtdEmbalagem"1,
      "vlrEmbItem"100,
      "vlrEmbIPI"1.0,
      "vlrEmbICMSST"1.0,
      "vlrEmbDespesa"1.0,
      "vlrEmbVerbaCompra"1.0,
      "dtaRecebtoItem""2020-09-25T20:31:55.408Z",
      "percDescFinancItem"1.0,
      "vlrEmbICMS"1.0,
      "vlrEmbISS"1.0,
      "vlrEmbIRRF"1.0,
      "vlrEmbFrete"1.0,
      "vlrEmbVendor"1.0,
      "vlrEmbDesconto"1.0,
      "perDescDf"1.0,
      "vlrEmbVerbaComprAcr"1.0
    },
     {
      "nroPedFornecedor""24",
      "cnpjEmpresa""39010418000115",
      "codProduto"7800005082024,
      "qtdSolicitada"1000,
      "qtdEmbalagem"1,
      "vlrEmbItem"100,
      "vlrEmbIPI"1.0,
      "vlrEmbICMSST"1.0,
      "vlrEmbDespesa"1.0,
      "vlrEmbVerbaCompra"1.0,
      "dtaRecebtoItem""2020-09-25T20:31:55.408Z",
      "percDescFinancItem"1.0,
      "vlrEmbICMS"1.0,
      "vlrEmbISS"1.0,
      "vlrEmbIRRF"1.0,
      "vlrEmbFrete"1.0,
      "vlrEmbVendor"1.0,
      "vlrEmbDesconto"1.0,
      "perDescDf"1.0,
      "vlrEmbVerbaComprAcr"1.0
    }

  ]
}