Como Utilizar?

 

A API pode ser acessada de diferentes formas, permitindo a obtenção dos dados desejados.

 

Uma maneira é realizar chamadas HTTP diretamente à API usando diversas ferramentas ou linguagens de programação. Por exemplo, é possível utilizar o cURL, um comando de linha amplamente utilizado para enviar requisições HTTP. Com o cURL, você pode fazer uma solicitação GET para a URL da API e receberá os dados de resposta.

 

Outra opção é utilizar ferramentas de desenvolvimento, como o Postman. Essa ferramenta oferece uma interface amigável que permite enviar requisições HTTP e visualizar as respostas de forma mais clara e organizada do que usando o cURL.

 

Além disso, existe o Swagger, uma ferramenta que fornece uma interface web intuitiva para interagir com a API. Ao acessar o Swagger, você verá campos e botões que facilitam a consulta e exibição dos dados desejados.

 

Em resumo, para acessar os dados da API, você pode usar chamadas HTTP com ferramentas como cURL, ferramentas de desenvolvimento como o Postman ou a interface web do Swagger. A escolha da ferramenta depende das suas preferências e conhecimentos técnicos.

 

Como fazer as consultas?

 

Versão 1:

 

•Para fazer a consulta, informe o valor do DOMÍNIO da Ordem. Assim, serão retornadas informações de todos os embarques relacionados a essa release.

•Também é possível fazer a consulta com o valor do Xid do Embarque para filtrar os registros relacionados apenas ao embarque referente a esse XId.

•Por fim, existe a possibilidade de obter as informações de impostos da Ordem com base no XID da Ordem informada como parâmetro.

 

 

Exemplo de retorno dos dados pela API

 

Observação: Os campos numéricos possuem 2 casas decimais e utilizam o ponto como separador decimal. Se o valor retornado for inteiro, ele não terá separador decimal e será apresentado no formato de número inteiro, sem casas decimais.

 

{

"domain": "string", // O campo de texto "domain" representa o domínio do embarque.

"shipmentXid": "string", // O campo de texto "shipmentXid" representa o identificador do embarque.

"releaseXid": "string", // O campo de texto "releaseXid" representa o identificador da liberação.

"taxTariff": true, // O campo booleano "taxTariff" indica se a tarifa de imposto está sendo aplicada (Verdadeiro ou Falso).

"additionalData": "string", // O campo de texto "additionalData" representa dados adicionais relacionados ao embarque.

"totalValue": 0, // O campo numérico "totalValue" representa o valor total do embarque.

"calculatedToll": 0, // O campo numérico "calculatedToll" representa o valor do pedágio calculado.

"releaseTaxes": [ // O campo "releaseTaxes" é uma lista de objetos que contém informações sobre os impostos da liberação.

 {

 "gris": 0, // O campo numérico "gris" representa o valor do Gris.

 "adValorem": 0, // O campo numérico "adValorem" representa o valor ad valorem.

 "cst": 0, // O campo numérico "cst" representa o código da situação tributária.

 "baseCalculation": 0, // O campo numérico "baseCalculation" representa o valor da base de cálculo do imposto.

 "baseCalculationReducedValue": 0, // O campo numérico "baseCalculationReducedValue" representa o valor reduzido da base de cálculo do imposto.

 "aliquotValue": 0, // O campo numérico "aliquotValue" representa o valor da alíquota do imposto.

 "reductionAliquot": 0, // O campo numérico "reductionAliquot" representa a redução da alíquota do imposto.

 "value": 0, // O campo numérico "value" representa o valor do imposto.

 "type": 0, // O campo numérico "type" representa o tipo do imposto. 1 = ICMS e 2 = ISS.

 "hasRetention": true, // O campo booleano "hasRetention" indica se há retenção de impostos (ISS) (Verdadeiro ou Falso).

 "releaseId": "string" // O campo de texto "releaseId" representa o identificador da liberação.

 }

]

}

 

Versão 2:

 

•Para efetuar esse consulta deve ser informado o valor do Xid do Embarque que será utilizado para filtrar os registros, dessa forma ira ser retornado a lista de informações de imposto de imposto do Pré-Documento e seus eventos complementares com base no XID do Embarque informado como parâmetro.

 

 

Exemplo de retorno dos dados pela API

 

Observação: Os campos numéricos possuem 2 casas decimais e utilizam o ponto como separador decimal. Se o valor retornado for inteiro, ele não terá separador decimal e será apresentado no formato de número inteiro, sem casas decimais.

 

{

"domain": "string", //O campo de TEXTO "domain" que representa o domínio do embarque.      

"shipmentXid": "string", //O campo de TEXTO "shipmentXid" que representa o identificador do embarque.

"calculatedToll": 0, // O campo NUMÉRICO "calculatedToll" representa o valor do pedágio calculado.

"preDocuments": //O campo "preDocuments" representa os pré-documentos relacionados ao embarque. É uma lista de objetos.

[

       {

        "groupId": "string", //O campo de TEXTO "groupId" representa o identificador do grupo de pré-documentos.

        "taxTariff": true, //O campo de BOOLEANO "taxTariff" indica se o pré-documento está relacionado a uma tarifa de imposto. (Verdadeiro ou Falso)

        "additionalData": "string", //O campo de TEXTO "additionalData" representa dados adicionais do pré-documento.

        "baseCalculation": 0, // O campo NUMERICO "baseCalculation" representa o valor da base de cálculo do imposto.

        "baseCalculationReducedValue": 0,  // O campo NUMERICO "baseCalculationReducedValue" representa o valor reduzido da base de cálculo do imposto.

        "aliquotValue": 0, //O campo NUMERICO "aliquotValue" representa o valor da alíquota do imposto.

        "reductionAliquot": 0, // O campo NUMERICO "reductionAliquot" representa a redução da alíquota do imposto.

        "value": 0, // O campo NUMERICO "value" representa o valor do imposto.  

        "cst": 0, // O campo NUMERICO "cst" representa o código da situação tributária.

        "gris": 0, //O campo NUMERICO "gris" representa o valor do Gris.

        "adValorem": 0, // O Campo NUMERICO AdValorem.

        "totalValue": 0, // O campo NUMERICO "totalValue" representa o valor total do pré-documento. (serviços mais impostos)

        "servicesValue": 0, // O campo NUMERICO "servicesValue" representa o valor total apenas dos serviços, sem impostos

        "releases": // O campo "releases" representa as liberações relacionadas ao pré-documento. É uma Lista das Releases / Ordens que compõem o Embarque

        "taxType": 0, // O campo NUMERICO "taxType" representa o Tipo do Imposto. 1 = ICMS e 2 = ISS

        "hasRetention": true, //O campo BOOLEANO "hasRetention" indica se há retenção de impostos(ISS) (Verdadeiro ou Falso)

        "preDocumentComplementaries": //Lista de eventos dos custos acessórios (CT-e Complementar, DPA e NFS-e) após Embarcado

       }

]

}