Para abrir um lote é necessário fazer uma requisição POST para InquilinoLoteExterno, para ver mais sobre a requisição.

O retorno dessa requisição gerará um código chamado loteOrigem, ele é de suma importância, pois, esse código identifica qual o lote que pertence o(s) dado(s) e deverá ser passado no envio dos dados para que a integração funcione corretamente.


{
    "status": 0,
    "tipoLote": [
        17
    ],
    "idInquilino": "{{IdInquilino}}"
}

Campo

Tipo

Descrição

Obrigatório

Observações

idInquilino

stringidInquilino gerado na criação do inquilinoSimNão Nulo 

tipoLote

Lista de stringLista dos tipos de dados a serem enviados. São aceitos vários tipos. (Tipos  na seção Tipos Lote)NãoNão nulo

status

stringStatus do lote, na abertura sempre enviar 0 - Inicio EnvioSimNão nulo

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
    Grupo = 21
    CanalVenda = 24
    PrecoPromocional = 28
    PreVenda = 55
    ClienteEndereco = 56
    RamoAtividade = 58
    Regiao = 100

{
    "success": true,
    "message": "",
    "data": {
        "loteOrigem": "{LoteOrigem}",
        "mensagem": null,
        "status": 0,
        "tipoLote": [
            "17"
        ],
        "idInquilino": "{IdInquilino)",
        "dataAtualizacao": "{DataAtualizacao}",
        "dataCadastro": "{DataCadastro}",
        "id": "{Identificador}",
        "_expandables": []
    }
}

Campo

Tipo

Descrição

SuccessboolIndica se a criação do lote foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do lote eles serão enviados nesse campo
DataobjetoObjeto lote criado

Data.LoteOrigem

stringNúmero de identificação do lote

Data.Mensagem

string

Data.Status

intStatus do lote
Data.TipoLoteList StringLista de tipos de dados que serão enviados no lote

Data.IdInquilino

stringidInquilino vinculado ao lote

Data.DataAtualização

datetimeData da ultima atualização do registo

Data.DataCadastro

datetimeData de criação do lote

Data.Id

stringIdentificador do lote no banco


O retorno dessa requisição gerará um código chamado loteOrigem, ele é de suma importância, pois, esse código identifica qual o lote que pertence o(s) dado(s) e deverá ser passado no envio dos dados para que a integração funcione corretamente.