Histórico da Página

...

Expandir

title	Definição dos campos de requisição

Campo	Tipo	Descrição	Obrigatório	Observações
idInquilino	string	idInquilino gerado na criação do inquilino	X	Não Nulo
tipoLote	Lista de string	Lista dos tipos de dados a serem enviados. São aceitos vários tipos. (Tipos na seção Tipos Lote)	X	Não nulo
status	string	Status do lote, na abertura sempre enviar 0 - Inicio Envio	X	Não nulo

Expandir

title	Tipos Lote

Os tipos de dados passados na requisição são os seguintes:

Cliente = 0
Loja = 1
Motivo = 2
Perfil = 3
Usuario = 4
FcpProduto = 5
Compartilhamento = 6
Imposto = 7
Ncm = 8
PisCofins = 9
TributoNcm = 10
ClassificacaoProduto = 11
Produto = 12
Preco = 13
Estoque = 14
Operadora = 15
DadoComplementarPagto = 16
CondicaoPagto = 17
FormaPagto = 18
CanalVenda = 24
AlteracaoCliente = 40
AlteracaoImposto = 47
AlteracaoNcm = 48
AlteracaoPisCofins = 49
AlteracaoTributoNcm = 50
AlteracaoClassificacaoProduto = 51
AlteracaoProduto = 52
AlteracaoPreco = 53
AlteracaoEstoque = 54
PreVenda = 55
ClienteEndereco = 56

Definição dos campos de retornoIdentificador do lote no banco

Expandir

Retorno da requisição

title		Definição dos campos de retorno

Expandir

title	200 - Ok

Campo	Tipo	Descrição
Success	bool	Indica se a criação do lote foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do lote eles serão enviados nesse campo
Data	objeto	Objeto lote criado
Data.LoteOrigem	string	Número de identificação do lote
Data.Mensagem	string
Data.Status	int	Status do lote
Data.TipoLote	List String	Lista de tipos de dados que serão enviados no lote
Data.IdInquilino	string	idInquilino vinculado ao lote
Data.DataAtualização	datetime	Data da ultima atualização do registo
Data.DataCadastro	datetime	Data de criação do lote
Data.Id	string	Identificador do lote no banco

Expandir

title	Body de retorno

{
"success": true,
"message": "",
"data": {
"loteOrigem": "{LoteOrigem}",
"mensagem": null,
"status": 0,
"tipoLote": [
"17"
],
"idInquilino": "{IdInquilino

)

}",
"dataAtualizacao": "{DataAtualizacao}",
"dataCadastro": "{DataCadastro}",
"id": "{Identificador}",
"_expandables": []
}
}

Expandir

title

400 - Bad Request

Campo	Tipo	Descrição

Success

success

bool

Indica se a criação do lote foi feita com sucesso

Message

message

string

Caso ocorra erros durante a criação do lote eles serão enviados nesse campo

Data

data

objeto

string

Objeto lote criado

Data.LoteOrigem

errors

string

Número de identificação do lote

Data.Mensagem

string

Data.Status

int

Status do lote

Data.TipoLote

List String

Lista de tipos de dados que serão enviados no lote

Data.IdInquilino

string

idInquilino vinculado ao lote

Data.DataAtualização

datetime

Data da ultima atualização do registo

Data.DataCadastro

datetime

Data de criação do lote

Data.Id

string

Objeto com Detalhamento do erro
errors.inquilino	string	Inquilino responsável pela aberturado lote
errors.tipodado	string	Tipo do lote aberto
errors.lote	string	Numero do Lote que apresentou erro
error.errorCode	number	Código do erro - 3 para erro na abertura
error.errorDetail	string	Descrição detalhada do erro
totalTime	number	Tempo de resposta
numberOfRecords	number	Numero de registros

Expandir

title	Body de retorno

{
"success": false,
"message": "Não é possível solicitar um novo lote. Lote {NumeroDoLote} em andamento",
"data": null,
"errors": {
"inquilino": "{IdInquilino}",
"tipoDado": "0",
"lote": "{NumeroDoLote}",
"errorCode": 3,
"errorDetail": "Não é possível solicitar um novo lote. Lote {NumeroDoLote} em andamento"
},
"totalTime": 0,
"numberOfRecords": 0
}

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 5

Chave