# Models ## The ListaNotaCancelamentoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaNotaCancelamentoPut":{"type":"object","properties":{"notasCancelamento":{"type":"array","items":{"$ref":"#/components/schemas/NotaCancelamentoPut"}}}},"NotaCancelamentoPut":{"type":"object","required":["dataEmissao","numeroDocumento","tipoDocumento","codECF"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"tipoDocumento":{"type":"integer","description":"Tipo do documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"motivoCancelamento":{"type":"string","maxLength":30,"description":"Motivo do cancelamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaCancelamentoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"NotaCancelamentoPut":{"type":"object","required":["dataEmissao","numeroDocumento","tipoDocumento","codECF"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"tipoDocumento":{"type":"integer","description":"Tipo do documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"motivoCancelamento":{"type":"string","maxLength":30,"description":"Motivo do cancelamento"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaNotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaNotaDevolucaoPut":{"type":"object","properties":{"notasDevolucao":{"type":"array","items":{"$ref":"#/components/schemas/NotaDevolucaoPut"}}}},"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"CNPJ/CPF do cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44},"tipoDevolucao":{"type":"integer","description":"Tipo de devolução (0 - Própria, 1 - Cliente)","enum":[0,1]},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"itensDevolucao":{"type":"array","description":"Itens da devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"CNPJ/CPF do cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44},"tipoDevolucao":{"type":"integer","description":"Tipo de devolução (0 - Própria, 1 - Cliente)","enum":[0,1]},"serieFiscal":{"type":"integer","maximum":999,"description":"Série Fiscal"},"itensDevolucao":{"type":"array","description":"Itens da devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço unitário liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total liquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS isentas"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"CST do ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"CST do IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"CST do PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de emissão da nota de devolução (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"integer","maximum":999999999,"description":"Número da nota devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The MovimentoEstoquePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"MovimentoEstoquePut":{"type":"object","required":["codProduto","saldo","dataMovimento"],"properties":{"codProduto":{"type":"string","minLength":1,"maxLength":20,"description":"Código do Produto"},"saldo":{"type":"number","maximum":9999999.999,"multipleOf":0.001,"description":"Saldo do Estoque do Produto"},"dataMovimento":{"type":"string","format":"date","description":"Data da Movimentação de Estoque (YYYY-MM-DD)"}}}}}} ``` ## The ListaMovimentoEstoquePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaMovimentoEstoquePut":{"type":"object","properties":{"produtos":{"type":"array","description":"Lista de Movimentação de Estoque","items":{"$ref":"#/components/schemas/MovimentoEstoquePut"}}}},"MovimentoEstoquePut":{"type":"object","required":["codProduto","saldo","dataMovimento"],"properties":{"codProduto":{"type":"string","minLength":1,"maxLength":20,"description":"Código do Produto"},"saldo":{"type":"number","maximum":9999999.999,"multipleOf":0.001,"description":"Saldo do Estoque do Produto"},"dataMovimento":{"type":"string","format":"date","description":"Data da Movimentação de Estoque (YYYY-MM-DD)"}}}}}} ``` ## The ImportacaoChequePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ImportacaoChequePut":{"type":"object","required":["CNPJCPFCliente","codBanco","dataEntrada","dataVencimento","tipoEmitente","valorCheque"],"properties":{"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"codBanco":{"type":"integer","minimum":1,"maximum":999,"description":"Código do Banco"},"numeroAgencia":{"type":"integer","minimum":1,"maximum":9999,"description":"Número da Agência"},"numeroConta":{"type":"integer","minimum":1,"maximum":99999999,"description":"Número da Conta"},"numeroCheque":{"type":"integer","minimum":1,"maximum":999999,"description":"Número do Cheque"},"codCompensacao":{"type":"integer","minimum":1,"maximum":999,"description":"Código da Compensação"},"valorCheque":{"type":"number","maximum":99999999999.99,"multipleOf":0.01,"description":"Valor do Cheque"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento (YYYY-MM-DD)"},"tipoEmitente":{"type":"integer","description":"Tipo do Emitente (1 - Cliente, 2 - Terceiro)","enum":[1,2]},"CNPJCPFEmitente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Emitente"},"nomeEmitente":{"type":"string","description":"Nome do Emitente"},"telefoneEmitente":{"type":"string","description":"Telefone do Emitente"}}}}}} ``` ## The ListaImportacaoChequePut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaImportacaoChequePut":{"type":"object","properties":{"cheques":{"type":"array","description":"Lista de Importação de Cheques","items":{"$ref":"#/components/schemas/ImportacaoChequePut"}}}},"ImportacaoChequePut":{"type":"object","required":["CNPJCPFCliente","codBanco","dataEntrada","dataVencimento","tipoEmitente","valorCheque"],"properties":{"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"codBanco":{"type":"integer","minimum":1,"maximum":999,"description":"Código do Banco"},"numeroAgencia":{"type":"integer","minimum":1,"maximum":9999,"description":"Número da Agência"},"numeroConta":{"type":"integer","minimum":1,"maximum":99999999,"description":"Número da Conta"},"numeroCheque":{"type":"integer","minimum":1,"maximum":999999,"description":"Número do Cheque"},"codCompensacao":{"type":"integer","minimum":1,"maximum":999,"description":"Código da Compensação"},"valorCheque":{"type":"number","maximum":99999999999.99,"multipleOf":0.01,"description":"Valor do Cheque"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"dataVencimento":{"type":"string","format":"date","description":"Data de Vencimento (YYYY-MM-DD)"},"tipoEmitente":{"type":"integer","description":"Tipo do Emitente (1 - Cliente, 2 - Terceiro)","enum":[1,2]},"CNPJCPFEmitente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Emitente"},"nomeEmitente":{"type":"string","description":"Nome do Emitente"},"telefoneEmitente":{"type":"string","description":"Telefone do Emitente"}}}}}} ``` ## The ListaAceiteNotaPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaAceiteNotaPut":{"type":"object","properties":{"aceiteNota":{"type":"array","items":{"$ref":"#/components/schemas/AceiteNotaPut"}}}},"AceiteNotaPut":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"dataAceiteNota":{"type":"string","format":"date","description":"Data do aceite de nota (YYYY-MM-DD)"},"numeroNotaAceite":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número da nota do aceite"},"CNPJEmissorNota":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ emissão da nota"},"transferenciaLojas":{"type":"integer","description":"Transferência entre lojas (0 - Não, 1 - Sim | Quando a nota foi emitida pela Loja, esse campo deve ser repassado como SIM. Caso contrário o sistema irá buscar uma pendência no módulo de aceite no ERP Consistem)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The AceiteNotaPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"AceiteNotaPut":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"dataAceiteNota":{"type":"string","format":"date","description":"Data do aceite de nota (YYYY-MM-DD)"},"numeroNotaAceite":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número da nota do aceite"},"CNPJEmissorNota":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ emissão da nota"},"transferenciaLojas":{"type":"integer","description":"Transferência entre lojas (0 - Não, 1 - Sim | Quando a nota foi emitida pela Loja, esse campo deve ser repassado como SIM. Caso contrário o sistema irá buscar uma pendência no módulo de aceite no ERP Consistem)","enum":[0,1]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaNotaTransferencia object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaNotaTransferencia":{"type":"object","properties":{"notaTransferencia":{"type":"array","items":{"$ref":"#/components/schemas/NotaTransferencia"}}}},"NotaTransferencia":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"codItemPai":{"type":"string","description":"Código do item pai"},"descProduto":{"type":"string","description":"Descrição do produto"},"unidadeMedida":{"type":"string","description":"Unidade de medida"},"ncm":{"type":"string","description":"Código da NCM"},"codItemFilho":{"type":"string","description":"Código do item filho"},"codCor":{"type":"string","description":"Código da cor"},"descCor":{"type":"string","description":"Descrição da cor"},"tamanho":{"type":"string","description":"Código do tamanho"},"tag":{"type":"string","description":"Código da TAG"},"codEPC":{"type":"string","description":"Código do EPC"},"codBarras":{"type":"string","description":"Código de barras"},"preco":{"type":"string","description":"Preço da peça"},"codQualidade":{"type":"string","description":"Código da qualidade"},"descQualidade":{"type":"string","description":"Descrição da qualidade"},"skuItemEditado":{"type":"string","description":"SKU item editado"},"qtdeFaturada":{"type":"string","description":"Quantidade faturada"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotaTransferencia object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"NotaTransferencia":{"type":"object","required":["numeroNotaAceite","dataAceiteNota","CNPJEmissorNota"],"properties":{"codItemPai":{"type":"string","description":"Código do item pai"},"descProduto":{"type":"string","description":"Descrição do produto"},"unidadeMedida":{"type":"string","description":"Unidade de medida"},"ncm":{"type":"string","description":"Código da NCM"},"codItemFilho":{"type":"string","description":"Código do item filho"},"codCor":{"type":"string","description":"Código da cor"},"descCor":{"type":"string","description":"Descrição da cor"},"tamanho":{"type":"string","description":"Código do tamanho"},"tag":{"type":"string","description":"Código da TAG"},"codEPC":{"type":"string","description":"Código do EPC"},"codBarras":{"type":"string","description":"Código de barras"},"preco":{"type":"string","description":"Preço da peça"},"codQualidade":{"type":"string","description":"Código da qualidade"},"descQualidade":{"type":"string","description":"Descrição da qualidade"},"skuItemEditado":{"type":"string","description":"SKU item editado"},"qtdeFaturada":{"type":"string","description":"Quantidade faturada"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaBaixaTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaBaixaTitulosPut":{"type":"object","properties":{"baixaTitulos":{"type":"array","items":{"$ref":"#/components/schemas/BaixaTitulosPut"}}}},"BaixaTitulosPut":{"type":"object","required":["numeroTitulo","dataBaixa","codRecebimento","vlrBaixa"],"properties":{"numeroTitulo":{"type":"string","maxLength":12,"description":"Número do título"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The BaixaTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"BaixaTitulosPut":{"type":"object","required":["numeroTitulo","dataBaixa","codRecebimento","vlrBaixa"],"properties":{"numeroTitulo":{"type":"string","maxLength":12,"description":"Número do título"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaBaixaDocumentoTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaBaixaDocumentoTitulosPut":{"type":"object","properties":{"baixaDocumentoTitulos":{"type":"array","items":{"$ref":"#/components/schemas/BaixaDocumentoTitulosPut"}}}},"BaixaDocumentoTitulosPut":{"type":"object","required":["dataEmissao","numeroDocumento","serieFiscal","sequeciaParcela","vlrBaixa","dataBaixa","codRecebimento"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data da emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"sequeciaParcela":{"type":"integer","minimum":1,"maximum":99,"description":"Sequencial da parcela"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The BaixaDocumentoTitulosPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"BaixaDocumentoTitulosPut":{"type":"object","required":["dataEmissao","numeroDocumento","serieFiscal","sequeciaParcela","vlrBaixa","dataBaixa","codRecebimento"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data da emissão (YYYY-MM-DD)"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"sequeciaParcela":{"type":"integer","minimum":1,"maximum":99,"description":"Sequencial da parcela"},"vlrBaixa":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da baixa"},"vlrJuros":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do juros"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do desconto"},"dataBaixa":{"type":"string","format":"date","description":"Data da baixa (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1-Dinheiro, 2-Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"CNPJEmpresaTitulo":{"type":"string","minLength":14,"maxLength":14,"description":"CNPJ da empresa do título"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ListaDocumentoFiscalPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ListaDocumentoFiscalPut":{"type":"object","properties":{"documentosFiscais":{"type":"array","items":{"$ref":"#/components/schemas/DocumentoFiscalPut"}}}},"DocumentoFiscalPut":{"type":"object","required":["dataEmissao","tipoDocumento","codECF","numeroDocumento","tipoCliente","CNPJCPFCliente"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"tipoDocumento":{"type":"integer","description":"Tipo de documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"tipoCliente":{"type":"integer","description":"Tipo do cliente (1-CNPJ, 2-CPF, 3-Exterior)","enum":[1,2,3]},"CNPJCPFCliente":{"type":"string","minLength":1,"maxLength":14,"description":"CNPJ/CPF do cliente - Para ECF repassar Zeros / Para Exterior repassar o código RUC"},"valorTotalNota":{"type":"number","multipleOf":0.01,"maximum":999999999.99,"description":"Valor total da nota"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"observacao":{"type":"string","maxLength":1000,"description":"Observação"},"modeloDocumento":{"type":"integer","description":"Modelo do documento (55 – NF-e, 59 – CF-e SAT, 65 – NFC-e (Não repassar para ECF))","enum":[55,59,65]},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44,"maxLength":44},"situacaoNota":{"type":"integer","description":"Situação da nota (0-Emitida, 1-Cancelada, 2-Inutilizada, 3-Contingência)","enum":[0,1,2,3]},"numeroSerieEquipamentoSAT":{"type":"integer","maximum":999999999,"description":"Número de série do equipamento SAT - Somente obrigatório para modelos de documento = 59 – CF-e SAT"},"protocoloAurizacao":{"type":"string","maxLength":36,"description":"Protocolo da autorização"},"protocoloCancelamento":{"type":"string","maxLength":36,"description":"Protocolo de cancelamento"},"motivoCancelamento":{"type":"string","maxLength":80,"description":"Motivo de cancelamento"},"dataCancelamento":{"type":"string","format":"date","description":"Data de cancelamento (YYYY-MM-DD)"},"pesoLiquido":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso liquido"},"pesoBruto":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso bruto"},"especieVolumes":{"type":"string","maxLength":80,"description":"Espécie dos volumes"},"quantidadeVolumes":{"type":"integer","maximum":999999999,"description":"Quantidade de volumes"},"notaFiscalComplemento":{"type":"integer","description":"Nota fiscal de complemento? (0-Não, 1-Sim)","enum":[0,1]},"itensDocumentoFiscal":{"type":"array","description":"Itens do documento fiscal","items":{"$ref":"#/components/schemas/ItensDocumentoFiscal"}},"duplicatasDocumentoFiscal":{"type":"array","description":"Duplicatas do documento fiscal","items":{"$ref":"#/components/schemas/duplicatasDocumentoFiscal"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The DocumentoFiscalPut object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"DocumentoFiscalPut":{"type":"object","required":["dataEmissao","tipoDocumento","codECF","numeroDocumento","tipoCliente","CNPJCPFCliente"],"properties":{"dataEmissao":{"type":"string","format":"date","description":"Data de emissão (YYYY-MM-DD)"},"tipoDocumento":{"type":"integer","description":"Tipo de documento (1-NF, 2-ECF)","enum":[1,2]},"codECF":{"type":"integer","maximum":999999999,"description":"Código do ECF"},"numeroDocumento":{"type":"integer","minimum":1,"maximum":999999999,"description":"Número do documento"},"tipoCliente":{"type":"integer","description":"Tipo do cliente (1-CNPJ, 2-CPF, 3-Exterior)","enum":[1,2,3]},"CNPJCPFCliente":{"type":"string","minLength":1,"maxLength":14,"description":"CNPJ/CPF do cliente - Para ECF repassar Zeros / Para Exterior repassar o código RUC"},"valorTotalNota":{"type":"number","multipleOf":0.01,"maximum":999999999.99,"description":"Valor total da nota"},"serieFiscal":{"type":"integer","minimum":1,"maximum":999,"description":"Série fiscal"},"observacao":{"type":"string","maxLength":1000,"description":"Observação"},"modeloDocumento":{"type":"integer","description":"Modelo do documento (55 – NF-e, 59 – CF-e SAT, 65 – NFC-e (Não repassar para ECF))","enum":[55,59,65]},"chaveNFeNFCe":{"type":"string","description":"Chave NFe/NFCe","minLength":44,"maxLength":44},"situacaoNota":{"type":"integer","description":"Situação da nota (0-Emitida, 1-Cancelada, 2-Inutilizada, 3-Contingência)","enum":[0,1,2,3]},"numeroSerieEquipamentoSAT":{"type":"integer","maximum":999999999,"description":"Número de série do equipamento SAT - Somente obrigatório para modelos de documento = 59 – CF-e SAT"},"protocoloAurizacao":{"type":"string","maxLength":36,"description":"Protocolo da autorização"},"protocoloCancelamento":{"type":"string","maxLength":36,"description":"Protocolo de cancelamento"},"motivoCancelamento":{"type":"string","maxLength":80,"description":"Motivo de cancelamento"},"dataCancelamento":{"type":"string","format":"date","description":"Data de cancelamento (YYYY-MM-DD)"},"pesoLiquido":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso liquido"},"pesoBruto":{"type":"number","maximum":9999999.99,"multipleOf":0.01,"description":"Peso bruto"},"especieVolumes":{"type":"string","maxLength":80,"description":"Espécie dos volumes"},"quantidadeVolumes":{"type":"integer","maximum":999999999,"description":"Quantidade de volumes"},"notaFiscalComplemento":{"type":"integer","description":"Nota fiscal de complemento? (0-Não, 1-Sim)","enum":[0,1]},"itensDocumentoFiscal":{"type":"array","description":"Itens do documento fiscal","items":{"$ref":"#/components/schemas/ItensDocumentoFiscal"}},"duplicatasDocumentoFiscal":{"type":"array","description":"Duplicatas do documento fiscal","items":{"$ref":"#/components/schemas/duplicatasDocumentoFiscal"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}}}}} ``` ## The duplicatasDocumentoFiscal object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"duplicatasDocumentoFiscal":{"type":"object","description":"Não Repassar esses dados caso a nota esteja Cancelada.","required":["sequenciaDuplicata","valorParcela","quantidade"],"properties":{"sequenciaDuplicata":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência da duplicata"},"valorParcela":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor da parcela"},"dataVencimento":{"type":"string","format":"date","description":"Data de vencimento (YYYY-MM-DD)"},"codRecebimento":{"type":"integer","description":"Código do tipo de recebimento (1 – Dinheiro, 2 – Cheque, 3 – Cartão)","enum":[1,2,3]},"codOperadoraCartao":{"type":"integer","minimum":1,"maximum":99,"description":"Código da operadora do cartão"},"codPortador":{"type":"integer","minimum":1,"maximum":9999,"description":"Código do portador"},"tipoCobranca":{"type":"integer","minimum":1,"maximum":99,"description":"Tipo de cobrança"},"numBancario":{"type":"string","maxLength":20,"description":"Número bancário"},"carteira":{"type":"string","maxLength":3,"description":"Carteira"},"contaBancaria":{"type":"string","maxLength":10,"description":"Conta bancária"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDocumentoFiscal object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"ItensDocumentoFiscal":{"type":"object","required":["sequenciaItem","codProdutoTag","quantidade"],"properties":{"sequenciaItem":{"type":"integer","minimum":1,"maximum":999,"description":"Sequência do item"},"codProdutoTag":{"type":"string","maxLength":24,"description":"Código do produto da TAG"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade do produto"},"precoUnitarioBruto":{"type":"number","maximum":999999999.99999,"multipleOf":0.01,"description":"Preço unitário - As casas decimais podem variar de 2 à 5 casas decimais, conforme a configuração no ERP Consistem."},"vlrTotalBruto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor total bruto"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de ICMS"},"valorICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ICMS"},"valorICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS isenta"},"valorICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ICMS outras"},"cstICMS":{"type":"string","maxLength":2,"description":"Código CST ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de IPI"},"valorIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI"},"valorIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI isentas"},"valorIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de IPI outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código do CST IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código CST PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de PIS"},"valorPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código do CST COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Aliquota de COFINS"},"valorCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"valorDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL do remetente"},"valorDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL destinatário"},"valorDIFALFCP":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor DIFAL FCP"},"valorOutrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de outras despesas"},"valorFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de ST"},"valorST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de ST"},"percentualFCPICMS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Base de ST"},"valorFCPICMS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ICMS"},"percentualFCPST":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Percentual FCP ST"},"valorFCPST":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor FCP ST"},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Loja","version":"1.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/loja-v1.0/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.