Home

Série 1

Páginas filhas
  • Order - Version 1.0

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Parâmetros

Nome

Descrição

Formato do campo

Tipo

iniDate

Data de emissão inicial

yyyyMMdd

Data

endDate

Data de emissão final

yyyyMMdd

Data

 

Campos do retorno

Nome

Descrição

Tamanho do campo

Tipo

Obrigatório

Mais detalhes

type

Tipo do pedido

1

Caracter

 

 

customerId

ID do cliente

6

Caracter

X

Vide API de Cliente

customerType

Tipo do cliente

1

Caracter

 

 

class

Espécie

5

Caracter

 

 

createdAt

Data de emissão

8

Data

 

 

paymentRecalc

Recálculo de pagamento

1

Caracter

 

 

invoiceMessage

Mensagem da NF

400

Caracter

 

 

priceTableId

Tabela de Preço

3

Caracter

 

Vide API de Tabela de Preço

carrier

Transportadora

6

Caracter

 

Vide API de Pessoa

parcelQuantity

Quantidade de Volume

6

Numérico

 

 

parcelType

Tipo do Volume

20

Caracter

 

 

stamp

Marca

20

Caracter

 

 

clientOrder

Pedido do Cliente

15

Caracter

 

 

parcelId

Numeração dos volumes transportados

15

Caracter

 

 

rawWeight

Peso Bruto

12

Numérico

 

 

netWeight

Peso Líquido

12

Numérico

 

 

shipType

Tipo do frete

1

Caracter

 

 

contact

Contato

45

Caracter

 

 

defaultRelease

Lançamento Padrão

3

Caracter

 

 

defaultMessage1

Mensagem Padrão 1

3

Caracter

 

 

defaultMessage2

Mensagem Padrão 2

3

Caracter

 

 

defaultMessage3

Mensagem Padrão 3

3

Caracter

 

 

defaultMessage4

Mensagem Padrão 4

3

Caracter

 

 

defaultMessage5

Mensagem Padrão 5

3

Caracter

 

 

ANTTCode

Código da ANTT

20

Caracter

 

 

carPlate

Placa do Veículo

7

Caracter

 

 

carState

Estado da placa do veículo

2

Caracter

 

 

seller1Id

 

Código de Vendedor

6

Caracter

 

 

seler1Comission

 

Comissão do Vendedor 1

6

Numérico

 

 

seller1EmissionRate

Percentual na Emissão 1

6

Numérico

 

 

seller1IssueRate

Percentual na Baixa 1

6

Numérico

 

 

seller2Id

Código do Vendedor 2

6

Caracter

 

 

seller2Comission

Comissão do Vendedor 2

6

Numérico

 

 

seller2EmissionRate

Percentual na Emissão 2

6

Numérico

 

 

seller2IssueRate

Percentual na Baixa 2

6

Numérico

 

 

selle3Id

Código do Vendedor 3

6

Caracter

 

 

seller3Comission

Comissão do Vendedor 3

6

Numérico

 

 

seller3EmissionRate

Percentual na Emissão 3

6

Numérico

 

 

seller3IssueRate

Percentual na Baixa 3

6

Numérico

 

 

clientComission

Comissão do Cliente

6

Numérico

 

 

outputDate

Data da saída

8

Data

 

 

outputHour

Hora da saída

5

Caracter

 

 

cityProvided

Município da Prestação do Serviço

7

 

Caracter

 

 

cityName

Descrição do Município

35

Caracter

 

 

shipmentState

Estado de Embarque

2

Caracter

 

 

shipmentLocal

Local de Embarque

60

Caracter

 

 

addressId

Endereço Alternativo

3

Caracter

 

 

targetState

Estado de Destino

3

Caracter

 

 

wordCode

Código da Obra

15

Caracter

 

 

ARTCode

Código ART

15

Caracter

 

 

note

Observação

400

Caracter

 

 

buyerPresent

Indicador de presença do comprador no estabelecimento comercial no momento da operação

1

Caracter

 

 

collectISS

Indica se o ISS será recolhido

1

Caracter

 

 

orderItems

Itens do pedido

-

Array

 

 

productId

ID do produto

15

Caracter

X

Vide API de Produtos

measureId

Código da Unidade de Medida

2

 

Caracter

X

Vide API de Unidade de Medida

quantity

Quantidade

14

Numérico

X

 

measure2Id

Quantidade da Segunda Unidade de Medida

14

Numérico

 

 

price

Preço unitário

14

Numérico

X

 

categoryID

ID da Categoria Financeira

10

Caracter

 

 

operation

Operação

2

Caracter

 

 

fiscalType

TES

3

Caracter

X

Vide API de TES

CFOP

CFOP

5

Caracter

 

Vide API de TES

discountValue

Valor do Desconto

5

Numérico

 

 

discountRate

Percentual de Desconto

6

Numérico

 

 

discountCalculated

Desconto Calculado

23

Numérico

 

 

IPIRate

Alíquota do IPI

5

Numérico

 

Vide API de TES

ICMSRate

Alíquota do ICMS

5

Numérico

 

Vide API de TES

IPIBase

Base do IPI

14

Numérico

 

Vide API de TES

ICMSBase

Base do ICMS

14

Numérico

 

Vide API de TES

warehouseId

Local do Armazém

2

Caracter

 

 

ICMSSTValue

Base do ICMS Retido

14

Numérico

 

Vide API de TES

ICMSSBase

Base do ICMS Solidário

14

Numérico

 

Vide API de TES

ISSBase

Base do ISS

14

Numérico

 

Vide API de TES

ISSRate

Alíquota do ISS

14

Numérico

 

Vide API de TES

ISSValue

Valor do ISS

14

Numérico

 

Vide API de TES

INSSBase

Base do INSS

14

Numérico

 

Vide API de TES

INSSValue

Valor do INSS

14

Numérico

 

Vide API de TES

IRRFBase

Base do IRRF

14

Numérico

 

Vide API de TES

IRRFRate

Alíquota do IRRF

14

Numérico

 

Vide API de TES

IRRFValue

Valor do IRRF

14

Numérico

 

Vide API de TES

deliveryDate

Data de Entrega

8

 

 

 

fiscalClass

Classificação Fiscal do Produto

3

Caracter

 

 

CSLLValue

Valor do CSLL

14

Numérico

 

Vide API de TES

CSLLBase

Base do CSLL

14

Numérico

 

Vide API de TES

lot

Lote

10

Caracter

 

 

CSOSN

CSOSN

3

 

 

Vide API de TES

deferredICMS

ICMS Diferido

14

Numérico

 

Vide API de TES

length

Comprimento

14

Numérico

 

 

height

Altura

14

Numérico

 

 

depth

Profundidade

14

Numérico

 

 

fullPrice

Preço Bruto

14

Numérico

 

 

drawback

DRAWEX

15

Caracter

 

 

priceTable

Tabela de Preço

3

Caracter

 

Vide API de Tabela de Preço

orderBills

Títulos do Pedido

-

Array

 

 

dueId

Número da Parcela

2

Caracter

 

 

dueDate

Data de vencimento

2

Data

 

 

value

Valor

17

Numérico

 

 

pdvId

Código do PDV

3

Caracter

 

 

receiptDate

Data do comprovante

8

Data

 

 

transactionId

ID da transação

12

Caracter

 

 

authorizationId

ID da autorização

10

Caracter

 

 

shippingCost

Frete

-

Numérico

 

 

otherExpenses

Despesas

-

Numérico

 

 

totalDiscount

Valor total de descontos

-

Numérico

 

 

 

Alguns campos, ao serem usados no método de POST, precisam vir na ordem descrita abaixo para que não conflitem entre si, gerando problemas como por exemplo erro de gravação.

- qtScUM, quantity: Ao serem usados ao mesmo tempo os campos conflitam com o totalizador. Utilize apenas se no cadastro de produtos houver a proporção entre ambos.

-CFOP: Entra em conflito, caso seja informado antes do campo TES. Informe o campo de TES antes.

-Informe quantity antes de preço

-Ordem que devem ser informados os impostos:

IPIRate

ICMSRate

discountValue

discountRate

IPIBase

ICMSBase

ICMSSTValue

ICMSSBase

ISSRate

ISSBase

ISSValue

IRRAliq

IRRFBase

IRRFValue

INSSBase

INSSValue

CSLLBase

CSLLValue

ICMSValue

ICMSBase

 

Exemplos de uso:

Obtendo o GET

/first/api/v1/Order

Retorno:

{

    "pk": "000002",

    "id": "000002",

    "type": "1",

    "customerId": "000136",

    "customerType": "",

    "class": "NF",

    "createdAt": "2012-09-08T00:00:00",

    "paymentRecalc": "1",

    "invoiceMessage": "",

    "priceTableId": "001",

    "carrier": "",

    "parcelQuantity": 0,

    "parcelType": "FD",

    "stamp": "VIP PAPEIS",

    "clientOrder": "",

    "parcelId": "",

    "rawWeight": 75.9,

    "netWeight": 70.7,

    "shipType": "",

    "contact": "MARCELO",

    "defaultMessage1": "",

    "defaultMessage2": "",

    "defaultMessage3": "",

    "defaultMessage4": "",

    "defaultMessage5": "",

    "ANTTCode": "",

    "carPlate": "",

    "carState": "",

    "seller1Id": "000002",

    "seler1Comission": 1,

    "seller1EmissionRate": 100,

    "seller1IssueRate": 0,

    "seller2Id": "",

    "seller2Comission": 0,

    "seller2EmissionRate": 0,

    "seller2IssueRate": 0,

    "selle3Id": "",

    "seller3Comission": 0,

    "seller3EmissionRate": 0,

    "seller3IssueRate": 0,

    "clientComission": 0,

    "outputDate": "0000-00-00T00:00:00",

    "outputHour": "00:00",

    "cityProvided": "11001",

    "cityName": "",

    "shipmentState": "",

    "shipmentLocal": "",

    "addressId": "",

    "targetState": "",

    "wordCode": "",

    "ARTCode": "",

    "note": "",

    "buyerPresent": "",

    "collectISS": "1",

    "orderItems": {

        "url": "/first/api/v1/orderItems?orderId=000002"

    },

    "orderBills": {

        "url": "/first/api/v1/orderBills?orderId=000002"

    }

}

 

Incluindo um registro (POST)

/first/api/v1/Order

Requisição:

{

type: "1",

customerId: "000001",

tpCustomer: "1",

kind: "SPED",

createdAt: "20150820",

paymentRecalc: "1",

seller1Id: "000001",

seler1Comission: 1,

invoiceMessage: "mensagem",

parcelQuantity: 2,

parcelType: "FD",

stamp: "VIPPAPEIS",

rawWeight: 1,

netWeight: 1,

shipType: "1",

contact: "CARLOS VINICIUS",

defaultMessage1: "001",

defaultMessage2: "001",

defaultMessage3: "001",

defaultMessage4: "001",

defaultMessage5: "001",

seller1EmissionRate: 100,

seller1IssueRate: 0,

seller2Id: "000090",

seller2Comission: 1,

seller2EmissionRate: 100,

seller2IssueRate: 0,

selle3Id: "000003",

seller3Comission: 3,

seller3EmissionRate: 100,

seller3IssueRate: 0,

clientComission: 0,

outputHour: "00:00",

cityProvided: "20937",

cityName: "MUNICIPIO",

OrderItems:

[ {

productId: "00011",

measureId: "CX",

quantity: 10,

price: 10,

categoryID: "010101",

fiscalType: "501",

} ]

}

 

Retorno:

{

  "url": "/first/api/v1/Order/2377",

  "id": "2377"

}

 

Incluindo um registro com impostos

/first/api/v1/Order

Requisição:

{

type: "1",

customerId: "000001",

tpCustomer: "1",

kind: "SPED",

createdAt: "20150820",

paymentRecalc: "1",

seller1Id: "000001",

seler1Comission: 1,

invoiceMessage: "mensagem",

parcelQuantity: 2,

parcelType: "FD",

stamp: "VIPPAPEIS",

rawWeight: 1,

netWeight: 1,

shipType: "1",

contact: "CARLOS VINICIUS",

defaultMessage1: "001",

defaultMessage2: "001",

defaultMessage3: "001",

defaultMessage4: "001",

defaultMessage5: "001",

seller1EmissionRate: 100,

seller1IssueRate: 0,

seller2Id: "000090",

seller2Comission: 1,

seller2EmissionRate: 100,

seller2IssueRate: 0,

selle3Id: "000003",

seller3Comission: 3,

seller3EmissionRate: 100,

seller3IssueRate: 0,

clientComission: 0,

outputHour: "00:00",

cityProvided: "20937",

cityName: "MUNICIPIO",

OrderItems:

[ {

productId: "00011",

measureId: "CX",

quantity: 10,

price: 10,

categoryID: "010101",

fiscalType: "501",

IPIRate: 5.95,

ICMSRate: 1,

discountValue: 1,

discountRate: 1,

IPIBase: 2,

ICMSBase: 2,

ICMSSTValue: 1,

ICMSSBase: 3,

ISSRate: 5,

ISSBase: 4,

ISSVal: 10,

IRRFRate: 1,

IRRFBase: 1,

IRRFValue: 10,

INSSBase: 10,

INSSValue: 15,

CSLLBase: 1,

CSLLValue: 2,

} ]

}

 

Retorno:

{

  "url": "/first/api/v1/Order/2378",

  "id": "2378"

}

 

Alteração de registro (PUT)

/first/api/v1/Order/2377

Requisição:

{

dscCounty: "ALTERANDO MUNICIPIO"

}

 

Excluindo registros

/first/api/v1/Order/2377

Retorno:

{

  "url": "/first/api/v1/Order/2377",

  "id": "2377"

}