Á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 é possibilitar a consulta de Impostos sobre Produtos.

Chamada

POST api/v2/sm_products/tax

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo Corpo (Body Parameters)

TaxDTO

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
company_division_numberCompany Division Number (Optional, but necessary for generating some taxes)integerNão há.
number_companyCompany NumberintegerRequerido
number_customerDestination Customer Number (Optional)integerNão há.
productsProduct InformationCollection of ProductRequerido
reg_number_legal_entityLegal Entity – Brazilian Registry of Corporate Taxpayers – (00.000.000/0001-00 or 00000000000000) – (Optional)stringNão há.
reg_number_physical_personPhysical Person – Individual Taxpayers – (000.000.000-00 or 00000000000) – (Optional)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 2
type_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 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 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 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

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
number_productProduct Numberdecimal numberNão há.
number_taxationNumber Taxation – Note: This Taxation is in Accordance with [SEQ_FAMILY] of Product and [NUMBER_DIVISION] of CompanyintegerNão há.
packing_quantityPacking Quantitydecimal numberNão há.
sale_priceSale Pricedecimal numberNão há.
icms_st_valueICMS STdecimal numberNão há.
ipi_valueIPIdecimal numberNão há.
percent_icms% ICMSdecimal numberNão há.
percent_pis% PISdecimal numberNão há.
percent_cofins% COFINSdecimal numberNão há.
type_taxType taxstringNão há.

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):

<ArrayOfTaxResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns="http://schemas.datacontract.org/2004/07/SMProductsV3.Business.DTOs.Tax">
  <TaxResponseDTO>
    <icms_st_value>1.1</icms_st_value>
    <ipi_value>1.1</ipi_value>
    <number_company>8</number_company>
    <number_customer>9</number_customer>
    <number_product>1</number_product>
    <number_taxation>2</number_taxation>
    <packing_quantity>3.1</packing_quantity>
    <percent_cofins>1.1</percent_cofins>
    <percent_icms>1.1</percent_icms>
    <percent_pis>1.1</percent_pis>
    <quantity>7.1</quantity>
    <sale_price>4.1</sale_price>
    <state>sample string 6</state>
    <type_tax>sample string 5</type_tax>
  </TaxResponseDTO>
  <TaxResponseDTO>
    <icms_st_value>1.1</icms_st_value>
    <ipi_value>1.1</ipi_value>
    <number_company>8</number_company>
    <number_customer>9</number_customer>
    <number_product>1</number_product>
    <number_taxation>2</number_taxation>
    <packing_quantity>3.1</packing_quantity>
    <percent_cofins>1.1</percent_cofins>
    <percent_icms>1.1</percent_icms>
    <percent_pis>1.1</percent_pis>
    <quantity>7.1</quantity>
    <sale_price>4.1</sale_price>
    <state>sample string 6</state>
    <type_tax>sample string 5</type_tax>
  </TaxResponseDTO>
</ArrayOfTaxResponseDTO>