Download OpenAPI specification:Download
API de integração com CISSLive
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| idProduto | number Identificador do produto interno no CissLive, somente usado para retorno. |
| SKU required | string [ 1 .. 60 ] characters Código SKU do produto. |
| dsProduto required | string [ 2 .. 100 ] characters Descrição principal do produto. |
| dsProdutoComplementar | string <= 100 characters Descrição complementar do produto. |
| dsProdutoResumida required | string [ 2 .. 40 ] characters Descrição resumida do produto que será impressa no cupom fiscal. |
| nrEan required | number <= 99999999999999 Código de barras principal do produto. Para relacionar mais EAN ao produto verifique o serviço de incluir multiplos EANs. |
| idMarca | number Código da marca do produto. |
| idSubGrupo required | number Código do subgrupo do produto. |
| fgEnviaParaBalanca required | boolean Informação se o produto deve ser enviado para gerar etiqueta de balança ou não. |
| fgSolicitaPesagem required | boolean Informação se o produto deve ser pesado na frente de caixa. |
| nrDiasValidade | integer <int32> [ 1 .. 999 ] Dias de validade do produto, quando enviado para balança. |
| nrCategoriaProduto required | string (CategoriaProduto) Enum: "00" "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "99" Tipo do item (produto) disponibilizado pela Sefaz. 00 - Mercadoria para Revenda 01 - Matéria-Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros insumos 99 - Outras |
| fgAtivo required | boolean Indica se o produto está ativo ou não. |
| fgAtivoVenda required | boolean Indica se o produto está ativo para venda ou não. |
| sgUnidadeMedida required | string Abreviação da unidade de medida do produto. |
| nrOrigemMercadoria required | integer (OrigemMercadoria) Enum: 0 1 2 3 4 5 6 7 8 Origem da mercadoria. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz. 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8. 1 - Estrangeira - Importação direta, exceto a indicada no código 6. 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7. 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%. 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes. 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%. 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural. 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural. 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%. |
| nrNcm | string^\d{8}$ Código da Nomenclatura Comum do Mercosul (NCM) do produto. Deve ser preenchido conforme a tabela padrão da NF-e, disponibilizada pela SEFAZ. Caso não informado, o valor padrão 00000000 será atribuído. |
| nrCest | string^\d{7}$ Código especificador da substituição tributária. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz. |
Array of objects Campos customizados para armazernar informações adicionais do produto. | |
object Figura de ICMS do produto. | |
object Figura de Pis/Cofins do produto. | |
object Figura de Ibs/Cbs do produto. | |
| vlMultiplicadorVenda | number Multiplicador de venda |
| qtMaximaVenda | number Quantidade maxima permitida para venda do produto |
| tipoProduto | string (TipoProduto) Enum: "NORMAL" "VASILHAME" |
| cdSkuVasilhame | string Sku do produto vasilhame associado a este item. |
| fgValidaPeso | boolean Indica se o peso será validado ou não. |
| peToleranciaPeso | number Percentual de tolerância na comparação de peso. |
| fgCombustivel | boolean Indica se o produto é do Tipo combustível. |
object (Anp) | |
Array of objects (ProdutoImagem) Somente serão aceitos links de imagem gravadas no CISSLive. |
{- "SKU": "123456789",
- "dsProduto": "Água Mineral 500ML",
- "dsProdutoComplementar": "Sem Gás",
- "dsProdutoResumida": "Água Mineral",
- "nrEan": 7894561230123,
- "idMarca": 1,
- "idSubGrupo": 1,
- "fgSolicitaPesagem": false,
- "fgEnviaParaBalanca": false,
- "nrDiasValidade": 5,
- "nrCategoriaProduto": "00",
- "fgAtivo": true,
- "fgAtivoVenda": true,
- "sgUnidadeMedida": "UN",
- "nrOrigemMercadoria": 0,
- "nrNcm": "22011000",
- "nrCest": "0000000",
- "vlMultiplicadorVenda": 15.55,
- "tipoProduto": "NORMAL",
- "cdSkuVasilhame": "5005174",
- "camposCustomizados": [
- {
- "campo": "L10"
}
], - "figuraIcms": {
- "cdFiguraIcms": "100",
- "dsFiguraIcms": "teste ronado 100"
}, - "figuraPisCofins": {
- "cdFiguraPisCofins": "100",
- "dsFiguraPisCofins": "teste ronado"
}, - "figuraIbsCbs": {
- "cdFiguraIbsCbs": "100",
- "dsFiguraIbsCbs": "Teste vitor"
}, - "qtMaximaVenda": 10,
- "fgValidaPeso": true,
- "peToleranciaPeso": 10.5,
- "fgCombustivel": true,
- "anp": {
- "cdAnp": "123456789",
- "dsAnp": "Alcool"
}, - "imagens": [
- {
- "fgPrincipal": true,
}
]
}{- "SKU": "123456789",
- "dsProduto": "Água Mineral 500ML",
- "dsProdutoComplementar": "Sem Gás",
- "dsProdutoResumida": "Água Mineral",
- "nrEan": 7894561230123,
- "idMarca": 1,
- "idSubGrupo": 1,
- "fgSolicitaPesagem": false,
- "fgEnviaParaBalanca": false,
- "nrDiasValidade": 5,
- "nrCategoriaProduto": "00",
- "fgAtivo": true,
- "fgAtivoVenda": true,
- "sgUnidadeMedida": "UN",
- "nrOrigemMercadoria": 0,
- "nrNcm": "22011000",
- "nrCest": "0000000",
- "vlMultiplicadorVenda": 15.55,
- "camposCustomizados": [
- {
- "campo": "L10"
}
], - "qtMaximaVenda": 10,
- "tipoProduto": "NORMAL",
- "cdSkuVasilhame": "5005174",
- "fgValidaPeso": true,
- "peToleranciaPeso": 10.5,
- "fgCombustivel": true,
- "figuraIbsCbs": {
- "cdFiguraIbsCbs": "100",
- "dsFiguraIbsCbs": "Teste vitor"
}, - "anp": {
- "cdAnp": "123456789",
- "dsAnp": "Alcool"
}
}| nrNsu required | integer >= 0 Example: nrNsu=5 Número sequencial único para busca de dados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idProduto": 1000000,
- "nrEan": "7891109367285",
- "dsProduto": "HAVAIANAS SLIM - S SLIM SEASON 33/34 LILAS BEBE",
- "dsProdutoComplementar": "S SLIM SEASON 33/34 LILAS BEBE",
- "dsProdutoResumida": "HAVAIANAS SLIM",
- "fgAtivo": false,
- "fgAtivoVenda": true,
- "nrNsu": 25,
- "SKU": "1000000",
- "vlMultiplicadorVenda": 15.55
}Permite alterar campos específicos de um produto. A resposta não retorna conteúdo.
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| SKU required | string [ 1 .. 60 ] characters Código SKU do produto. |
| dsProduto | string [ 2 .. 100 ] characters Descrição principal do produto. |
| dsProdutoComplementar | string <= 100 characters Descrição complementar do produto. |
| dsProdutoResumida | string [ 2 .. 40 ] characters Descrição resumida do produto que será impressa no cupom fiscal. |
| nrEan | number <= 99999999999999 Código de barras principal do produto. Para relacionar mais EAN ao produto verifique o serviço de incluir multiplos EANs. |
| idMarca | number Código da marca do produto. |
| idSubGrupo | number Código do subgrupo do produto. |
| fgEnviaParaBalanca | boolean Informação se o produto deve ser enviado para gerar etiqueta de balança ou não. |
| fgSolicitaPesagem | boolean Informação se o produto deve ser pesado na frente de caixa. |
| nrDiasValidade | integer <int32> [ 1 .. 999 ] Dias de validade do produto, quando enviado para balança. |
| nrCategoriaProduto | string (CategoriaProduto) Enum: "00" "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "99" Tipo do item (produto) disponibilizado pela Sefaz. 00 - Mercadoria para Revenda 01 - Matéria-Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros insumos 99 - Outras |
| fgAtivo | boolean Indica se o produto está ativo ou não. |
| fgAtivoVenda | boolean Indica se o produto está ativo para venda ou não. |
| sgUnidadeMedida | string Abreviação da unidade de medida do produto. |
| nrOrigemMercadoria | integer (OrigemMercadoria) Enum: 0 1 2 3 4 5 6 7 8 Origem da mercadoria. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz. 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8. 1 - Estrangeira - Importação direta, exceto a indicada no código 6. 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7. 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%. 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes. 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%. 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural. 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural. 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%. |
| nrNcm | string^\d{8}$ Código da Nomenclatura Comum do Mercosul (NCM) do produto. Deve ser preenchido conforme a tabela padrão da NF-e, disponibilizada pela SEFAZ. Caso não informado, o valor padrão 00000000 será atribuído. |
| nrCest | string^\d{7}$ Código especificador da substituição tributária. Preencher conforme tabela padrão da NF-e disponibilizada pela Sefaz. |
object Figura de ICMS do produto. | |
object Figura de Pis/Cofins do produto. | |
object Figura de Ibs/Cbs do produto. | |
| vlMultiplicadorVenda | number Multiplicador de venda |
Array of objects (ProdutoImagem) Somente serão aceitos links de imagem gravadas no CISSLive. |
{- "SKU": "123456789",
- "dsProduto": "Água Mineral 500ML",
- "dsProdutoComplementar": "Sem Gás",
- "dsProdutoResumida": "Água Mineral",
- "nrEan": 7894561230123,
- "idMarca": 1,
- "idSubGrupo": 1,
- "fgSolicitaPesagem": false,
- "fgEnviaParaBalanca": false,
- "nrDiasValidade": 5,
- "nrCategoriaProduto": "00",
- "fgAtivo": true,
- "fgAtivoVenda": true,
- "sgUnidadeMedida": "UN",
- "nrOrigemMercadoria": 0,
- "nrNcm": "22011000",
- "nrCest": "0000000",
- "vlMultiplicadorVenda": 15.55,
- "figuraIcms": {
- "cdFiguraIcms": "100",
- "dsFiguraIcms": "teste ronado 100"
}, - "figuraPisCofins": {
- "cdFiguraPisCofins": "100",
- "dsFiguraPisCofins": "teste ronado"
}, - "figuraIbsCbs": {
- "cdFiguraIbsCbs": "100",
- "dsFiguraIbsCbs": "Teste vitor"
}, - "imagens": [
- {
- "fgPrincipal": true,
}
]
}{- "error": "Credenciais Inválidas"
}| cdSku required | integer >= 0 Example: cdSku=5001142 Número indetificador único do produto |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
true| nrNsu required | integer >= 0 Example: nrNsu=5 Número sequencial único para busca de dados |
| nrCnpj required | integer Número CNPJ da loja para buscar os dados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idProduto": 129797,
- "cdSku": "129797",
- "nrEan": "7898043364325",
- "vlPreco": 21.9,
- "vlCusto": 14.7,
- "dhInicioPromocao": "2021-01-27T12:14:01.640",
- "dhFimPromocao": "2021-01-27T12:14:01.640",
- "vlPrecoPromocao": 0,
- "nrNsu": 12
}| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| nrCodigosBarras required | integer Example: nrCodigosBarras=00000000000000,3430493439830 Códigos de barras a serem buscados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "data": [
- {
- "idProduto": 1069,
- "nrEan": 789182301069,
- "dsProduto": "CRISTAL MIMOSA BOMBOM KG",
- "dsProdutoComplementar": "",
- "dsProdutoResumida": "CRISTAL MIMOSA BOMBOM KG",
- "fgAtivo": false,
- "fgAtivoVenda": true,
- "SKU": "1069",
- "idSubGrupo": 1,
- "nrCategoriaProduto": "10",
- "sgUnidadeMedida": "UN",
- "fgEnviaParaBalanca": false,
- "fgSolicitaPesagem": false,
- "nrOrigemMercadoria": 1
}, - {
- "idProduto": 1073,
- "sgUnidadeMedida": "UN",
- "fgEnviaParaBalanca": false,
- "fgSolicitaPesagem": false,
- "nrOrigemMercadoria": 1,
- "nrEan": 7891823010733,
- "dsProduto": "CRISTAL DUAS CARAS BOMBOM KG",
- "dsProdutoComplementar": "",
- "dsProdutoResumida": "CRISTAL DUAS CARAS BOMBOM KG",
- "fgAtivo": false,
- "fgAtivoVenda": true,
- "SKU": "1073",
- "idSubGrupo": 1,
- "nrCategoriaProduto": "10"
}
], - "total": -1,
- "hasNext": false
}| nrNsu required | integer >= 0 Example: nrNsu=5 Número sequencial único para busca de dados |
| nrCnpj required | integer Número CNPJ da loja para buscar os dados |
| idLocalEstoque required | integer Código do local de estoque para buscar os dados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idProduto": 119888,
- "cdSku": "119888",
- "nrEan": "7891109367285",
- "qtEstoque": 60,
- "nrNsu": 2
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| SKU required | string Código SKU do produto. |
| empresas required | Array of integers Código das empresas onde o custo médio do produto será alterado. |
| vlCustoMedio required | number Valor do custo médido do produto. |
{- "SKU": "123456789",
- "empresas": [
- 1,
- 2,
- 3
], - "vlCustoMedio": 5.99
}{- "SKU": "123456789",
- "empresas": [
- 1,
- 2,
- 3
], - "vlCustoMedio": 5.99
}| nrCnpj required | integer Número CNPJ da loja para buscar os dados |
| dhUltimaSincronizacao required | string <date-time> Example: dhUltimaSincronizacao=2023-01-01T01:00:00.000 Data e hora da última sincronização |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
[- {
- "idProduto": 42552,
- "nrEan": "736532833327",
- "dsProduto": "SUCO ABACAXI C/HORTELA 310ML DAHORTA",
- "dsProdutoComplementar": "Suco Abacaxi C/ Hortela 310ml DAHORTA",
- "dsProdutoResumida": "SUCO ABACAXI C/HORTELA 310ML DAHORTA DAH",
- "fgAtivo": true,
- "fgAtivoVenda": true,
- "nrNsu": 1566143,
- "vlPreco": 9.99,
- "vlCusto": 9.99,
- "vlPrecoPromocao": 7.99,
- "qtSaldoAtual": 60,
- "secao": {
- "idSecao": 39,
- "dsSecao": "REFRIGERADOS"
}, - "grupo": {
- "idGrupo": 139,
- "dsGrupo": "SUCOS/REFRIGERANTES - REFRIGERADOS"
}, - "subgrupo": {
- "idSubGrupo": 287,
- "dsSubGrupo": "SUCOS/REFRIGERANTES - REFRIGERADOS"
}, - "marca": {
- "idMarca": 423,
- "dsMarca": "DAHORTA"
}, - "unidadeMedida": {
- "idUnidadeMedida": 45,
- "dsAbreviacao": "UN"
}, - "SKU": "42552"
}
]Retorna qtSaldoAtual = 0 se menor ou igual a quantidade miníma configurada.
| nrCnpj required | integer Número CNPJ da loja para buscar os dados |
| dsTag required | string Example: dsTag=2023-01-01T01:00:00.000 Tag vinculada ao produto |
| dhUltimaSincronizacao required | string <date-time> Example: dhUltimaSincronizacao=2023-01-01T01:00:00.000 Data e hora da última sincronização |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
[- {
- "idProduto": 42552,
- "nrEan": "736532833327",
- "dsProduto": "SUCO ABACAXI C/HORTELA 310ML DAHORTA",
- "dsProdutoComplementar": "Suco Abacaxi C/ Hortela 310ml DAHORTA",
- "dsProdutoResumida": "SUCO ABACAXI C/HORTELA 310ML DAHORTA DAH",
- "fgAtivo": true,
- "fgAtivoVenda": true,
- "nrNsu": 1566143,
- "vlPreco": 9.99,
- "vlCusto": 9.99,
- "vlPrecoPromocao": 7.99,
- "qtSaldoAtual": 60,
- "secao": {
- "idSecao": 39,
- "dsSecao": "REFRIGERADOS"
}, - "grupo": {
- "idGrupo": 139,
- "dsGrupo": "SUCOS/REFRIGERANTES - REFRIGERADOS"
}, - "subgrupo": {
- "idSubGrupo": 287,
- "dsSubGrupo": "SUCOS/REFRIGERANTES - REFRIGERADOS"
}, - "marca": {
- "idMarca": 423,
- "dsMarca": "DAHORTA"
}, - "unidadeMedida": {
- "idUnidadeMedida": 45,
- "dsAbreviacao": "UN"
}, - "SKU": "42552"
}
]| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| SKU required | string [ 1 .. 60 ] characters Código SKU do produto. |
| empresas required | Array of integers Código das empresas onde o preço do produto será alterado. |
| nrEan required | number <= 99999999999999 Código de barras do preço em questão. |
| vlPreco required | number [ 0 .. 999999999.99 ] Preço de venda do produto. |
| peMargemLucro required | number [ -999999999.99 .. 999999999.99 ] Percentual de margem de lucro. |
| vlPrecoPromocao | number [ 0 .. 999999999.99 ] Valor de venda do produto em promoção. |
| dtInicioPromocao | string Data de início da vigência da promoção. |
| dtFimPromocao | string Data de termino da vigência da promoção. |
{- "SKU": "123456789",
- "empresas": [
- 1,
- 2,
- 3
], - "nrEan": 7894561230123,
- "vlPreco": 9.99,
- "peMargemLucro": 60,
- "vlPrecoPromocao": 7.99,
- "dtInicioPromocao": "2020-01-01",
- "dtFimPromocao": "2020-01-05"
}{- "SKU": "123456789",
- "empresas": [
- 1,
- 2,
- 3
], - "nrEan": 7894561230123,
- "vlPreco": 9.99,
- "peMargemLucro": 60,
- "vlPrecoPromocao": 7.99,
- "dtInicioPromocao": "2020-01-01",
- "dtFimPromocao": "2020-01-05"
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| cdFigura required | string <= 50 characters Código da Figura de ICMS. |
| dsFigura required | string <= 200 characters Descrição da Figura de ICMS. |
required | Array of objects (CenarioIcms) Cenários de ICMS da figura. |
{- "cdFigura": "09011110",
- "dsFigura": "Café em grão",
- "cenariosIcms": [
- {
- "dtInicioVigencia": "2020-08-25",
- "dtFimVigencia": "2020-08-25",
- "tpOperacao": "VENDA_MERCADORIA",
- "perfilOrigem": {
- "sgUf": "SP",
- "tpAtividade": "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "tpRegimeTributario": "LUCRO_REAL"
}, - "perfilDestino": {
- "sgUf": "SP",
- "tpAtividade": "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "tpRegimeTributario": "LUCRO_REAL"
}, - "idOrigemMercadoria": 0,
- "nrCst": "0",
- "nrCfop": "5102",
- "peIcms": 18,
- "peReducaoBaseIcms": 33.33,
- "peMvaIcmsSt": 40,
- "peReducaoBaseIcmsSt": 40,
- "idMotivoDesoneracaoIcms": 7,
- "peIcmsDesonerado": 15,
- "peFcep": 2,
- "nrCodigoBeneficioIcms": "RS051021",
- "nrNcmBeneficioIcms": "12345678"
}
]
}{- "cdFigura": "09011110",
- "dsFigura": "Café em grão",
- "cenariosIcms": [
- {
- "dtInicioVigencia": "2020-08-25",
- "dtFimVigencia": "2020-08-25",
- "tpOperacao": "VENDA_MERCADORIA",
- "perfilOrigem": {
- "sgUf": "SP",
- "tpAtividade": "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "tpRegimeTributario": "LUCRO_REAL"
}, - "perfilDestino": {
- "sgUf": "SP",
- "tpAtividade": "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "tpRegimeTributario": "LUCRO_REAL"
}, - "idOrigemMercadoria": 0,
- "nrCst": "0",
- "nrCfop": "5102",
- "peIcms": 18,
- "peReducaoBaseIcms": 33.33,
- "peMvaIcmsSt": 40,
- "peReducaoBaseIcmsSt": 40,
- "idMotivoDesoneracaoIcms": 7,
- "peIcmsDesonerado": 15,
- "peFcep": 2,
- "nrCodigoBeneficioIcms": "RS051021",
- "nrNcmBeneficioIcms": "12345678"
}
]
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| cdFigura required | string <= 50 characters Código da Figura de Ibs/Cbs. |
| dsFigura required | string <= 200 characters Descrição da Figura de Ibs/Cbs. |
required | Array of objects (CenarioIbsCbs) Cenários de Ibs/Cbs da figura. |
{- "cdFigura": "09011110",
- "dsFigura": "Café em grão",
- "cenariosIbsCbs": [
- {
- "dtInicioVigencia": "2020-08-25",
- "dtFimVigencia": "2020-08-25",
- "tpMovimentacao": "SAIDA",
- "cdCst": "000",
- "cdClassificaoTributaria": "000001",
- "peIbsEstadual": 1,
- "peCbs": 1,
- "tpOperacao": [
- "VENDA_MERCADORIA",
- "REMESSA_DE_BONIFICACAO_DOACAO_OU_BRINDE"
], - "perfilOrigem": {
- "sgUf": [
- "PR",
- "SP",
- "RS"
], - "tpAtividade": [
- "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "VAREJISTA"
], - "tpRegimeTributario": [
- "LUCRO_REAL",
- "SIMPLES_NACIONAL"
]
}, - "perfilDestino": {
- "sgUf": [
- "PR",
- "SP",
- "RS"
], - "tpAtividade": [
- "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "VAREJISTA"
], - "tpRegimeTributario": [
- "LUCRO_REAL",
- "SIMPLES_NACIONAL"
]
}, - "ibsMunicipal": [
- {
- "nrIbge": "4107207",
- "peIbsMunicipal": 1
}
]
}
]
}{- "cdFigura": "09011110",
- "dsFigura": "Café em grão",
- "cenariosIbsCbs": [
- {
- "dtInicioVigencia": "2020-08-25",
- "dtFimVigencia": "2020-08-25",
- "tpMovimentacao": "SAIDA",
- "cdCst": "000",
- "cdClassificaoTributaria": "000001",
- "peIbsEstadual": 1,
- "peCbs": 1,
- "tpOperacao": [
- "VENDA_MERCADORIA",
- "REMESSA_DE_BONIFICACAO_DOACAO_OU_BRINDE"
], - "perfilOrigem": {
- "sgUf": [
- "PR",
- "SP",
- "RS"
], - "tpAtividade": [
- "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "VAREJISTA"
], - "tpRegimeTributario": [
- "LUCRO_REAL",
- "SIMPLES_NACIONAL"
]
}, - "perfilDestino": {
- "sgUf": [
- "PR",
- "SP",
- "RS"
], - "tpAtividade": [
- "CONSUMIDOR_FINAL_NAO_CONTRIBUINTE",
- "VAREJISTA"
], - "tpRegimeTributario": [
- "LUCRO_REAL",
- "SIMPLES_NACIONAL"
]
}, - "ibsMunicipal": [
- {
- "nrIbge": "4107207",
- "peIbsMunicipal": 1
}
]
}
]
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| cdFigura required | string <= 50 characters Código da Figura de Pis/Cofins. |
| dsFigura required | string <= 200 characters Descrição da Figura de Pis/Cofins. |
required | Array of objects (CenarioPisCofins) Cenários de Pis/Cofins da figura. |
{- "cdFigura": "09011110",
- "dsFigura": "Café em grão",
- "cenariosPisCofins": [
- {
- "dtInicioVigencia": "2020-08-25",
- "dtFimVigencia": "2020-08-25",
- "tpOperacao": "VENDA_MERCADORIA",
- "tpRegimeTributario": "LUCRO_REAL",
- "nrCstPis": 50,
- "pePis": 1.65,
- "nrNaturezaReceitaPis": "101",
- "nrCstCofins": 50,
- "peCofins": 1.65,
- "nrNaturezaReceitaCofins": "101"
}
]
}{- "cdFigura": "09011110",
- "dsFigura": "Café em grão",
- "cenariosPisCofins": [
- {
- "dtInicioVigencia": "2020-08-25",
- "dtFimVigencia": "2020-08-25",
- "tpOperacao": "VENDA_MERCADORIA",
- "tpRegimeTributario": "LUCRO_REAL",
- "nrCstPis": 50,
- "pePis": 1.65,
- "nrNaturezaReceitaPis": "101",
- "nrCstCofins": 50,
- "peCofins": 1.65,
- "nrNaturezaReceitaCofins": "101"
}
]
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| nrCnpjFornecedor required | string CNPJ do fornecedor do pedido de compra. |
| idEmpresa required | number Código da empresa onde será disponibilizado o pedido de compra. |
| dtPedido required | string Data do pedido de compra. |
| dtPrevisaoEntrega | string Data da previsão de entrega. |
| cdReferencia | string Código de referência do pedido de compra. |
required | Array of objects (PedidoCompraProduto) Produtos do pedido de compra. |
{- "nrCnpjFornecedor": "00000000000000",
- "idEmpresa": 1,
- "dtPedido": "2020-05-13",
- "dtPrevisaoEntrega": "2020-06-13",
- "cdReferencia": "A1B2C3",
- "produtos": [
- {
- "SKU": "123456789",
- "sgUnidadeMedida": "UN",
- "vlCustoUnitario": 9.99,
- "qtProduto": 9.99
}
]
}{- "nrCnpjFornecedor": "00000000000000",
- "idEmpresa": 1,
- "dtPedido": "2020-05-13",
- "dtPrevisaoEntrega": "2020-06-13",
- "cdReferencia": "A1B2C3",
- "produtos": [
- {
- "SKU": "123456789",
- "sgUnidadeMedida": "UN",
- "vlCustoUnitario": 9.99,
- "qtProduto": 9.99
}
]
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| idTipoIntegracao required | integer <int64> Enum: 1 2 3 Código do tipo da integração. "1 - Venda", "2 - Venda Cancelada", "3 - Cancelamento" |
| idTipoEvento required | integer <int64> Enum: 1 2 3 4 5 Código do tipo do evento. 1 - Aguardando, 2 - Aguardando Reenvio, 3 - Envio, 4 - Sucesso, 5 - Erro |
| cdExterno required | string [ 1 .. 30 ] characters Código externo. |
| dsMensagem | string Mensagem ou conteúdo do evento de log. |
{- "idTipoIntegracao": 1,
- "idTipoEvento": 1,
- "cdExterno": 26685972,
- "dsMensagem": "Cancelamento processado com sucesso."
}{- "idTipoIntegracao": 1,
- "idTipoEvento": 1,
- "cdExterno": 26685972,
- "dsMensagem": "Cancelamento processado com sucesso."
}| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| dtMovimentacaoInicio required | string Example: dtMovimentacaoInicio=2020-08-25 Início da faixa de busca de movimentações. |
| dtMovimentacaoFim required | string Example: dtMovimentacaoFim=2020-08-26 Fim da faixa de busca de movimentações. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": -1,
- "hasNext": true,
- "data": [
- {
- "nrDocumento": 10,
- "dsSerie": 222,
- "nrModelo": 65,
- "vlTotalBruto": 9.99,
- "vlTotalLiquido": 9.99,
- "dhMovimentacao": "2020-08-25 16:53:11.424",
- "tpMovimento": "V"
}
]
}| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| dhMovimentacaoInicio required | string <date-time> Example: dhMovimentacaoInicio=2024-05-01T08:26:50.286 Início da faixa de busca de movimentações. |
| dhMovimentacaoFim required | string <date-time> Example: dhMovimentacaoFim=2024-05-28T08:26:50.286 Fim da faixa de busca de movimentações. |
| dhAlteracaoInicio | string <date-time> Example: dhAlteracaoInicio=2024-05-01T08:26:50.286 Início da faixa de busca de movimentações. |
| dhAlteracaoFim | string <date-time> Example: dhAlteracaoFim=2024-05-28T08:26:50.286 Fim da faixa de busca de movimentações. |
| tpMovimentacaoStatus | string Enum: "PENDENTE_ENVIO" "AUTORIZADA" "CANCELADA" "INUTILIZADA" "DENEGADA" "REJEITADA" "PENDENTE_CONSULTA" "PENDENTE_CANCELAMENTO" "PENDENTE_INUTILIZACAO" "SITUACAO_NAO_LOCALIZADA" "PENDENTE_INUTILIZACAO_CANCELAMENTO" Example: tpMovimentacaoStatus=AUTORIZADA Tipo do Status da Movimentação |
| tpOperacaoCategoria | string Enum: "COMPRA" "VENDA" "AJUSTE_ESTOQUE" "DEVOLUCAO_COMPRA" "RECEITAS_DIVERSAS" "DESPESAS_DIVERSAS" "TRANSFERENCIA_MERCADORIA" "DEVOLUCAO_VENDA" "ORCAMENTO" "ORIGEM_CUPOM" "COMPRA_USO_CONSUMO" "TRANSFERENCIA_USO_CONSUMO" "OUTRAS_SAIDAS" "CONTRA_NOTA_PRODUTOR_RURAL" "TRANSFORMACAO_PRODUTO_ENTRADA" "TRANSFORMACAO_PRODUTO_SAIDA" "ENCERRAMENTO_EXERCICIO" "OUTRAS_ENTRADAS" "NOTA_AJUSTE" "NOTA_ANULACAO" "NOTA_ENTRADA_SERVICO" Example: tpOperacaoCategoria=VENDA Tipo de Categoria de Operação |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": -1,
- "hasNext": true,
- "data": [
- {
- "idMovimentacao": 14950845,
- "nrMovimentacao": 1140,
- "dhMovimentacao": "2024-05-09T16:48:59.7596656",
- "dhAlteracao": "2024-05-09T19:48:59.8574245",
- "vlTotalLiquido": 35.62,
- "idOperacao": 1030,
- "dsSerie": "11",
- "nrModeloDocumentoFiscal": "55",
- "tpOperacaoCategoria": "VENDA",
- "tpMovimentacaoStatus": "AUTORIZADA"
}
]
}Este serviço tem o objetivo de buscar os dados da movimentação
| idMovimentacao required | integer Example: 123456 Identificador da movimentação |
| expand | string Example: expand=movimentacaoProdutoList.produto.producao,movimentacaoClubeBeneficio,movimentacaoPessoa.cliente Permite buscar informações detalhadas para objetos adicionais. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idMovimentacao": 123456,
- "idEmpresa": 123456,
- "nrCaixa": 123456,
- "dhMovimentacao": "2020-08-25T16:53:11.424",
- "nrMovimentacao": 123,
- "vlTotalLiquido": 23,
- "vlDesconto": 2.5,
- "vlDescontoFinanceiro": 1.25,
- "vlTotalDescontos": 3.75,
- "vlAcrescimo": 1.25,
- "vlTotalBruto": 36,
- "vlOutrasDespesasAcessorias": 0.5,
- "vlTotalAcrescimos": 1.75,
- "fgCancelado": false,
- "nrDocumentoCliente": "12345678909",
- "nrDocumentoEmpresa": "21426387002247",
- "tpOrigemPedido": 1,
- "movimentacaoProdutoList": [
- {
- "idMovimentacaoProduto": 123456,
- "cdSku": "CD00010",
- "idProduto": 789000123456,
- "nrCodBarras": 123456,
- "dsResumidaProduto": "Pack Coca Cola 200ml",
- "qtProduto": 2,
- "vlUnitarioBruto": 12.5,
- "vlTotalLiquido": 23,
- "vlDesconto": 2.5,
- "vlDescontoFinanceiro": 1.25,
- "vlTotalDescontos": 3.75,
- "vlAcrescimo": 1.25,
- "vlOutrasDespesasAcessorias": 0.5,
- "vlTotalAcrescimos": 1.75,
- "vlFrete": 1.75,
- "vlUnitarioLiquido": 10,
- "idProdutoCesta": 987654,
- "idUnidadeMedida": 1,
- "dsAbreviacao": "UN",
- "fiscal": {
- "nrCfop": "5102",
- "nrOrigemMercadoria": 0,
- "nrNcm": "81234781"
}, - "icms": {
- "idCstIcms": 1,
- "vlBaseCalculoIcms": 2000,
- "peIcms": 18,
- "vlIcms": 360,
- "nrCodigoBeneficioIcms": "RS052068",
- "peFcp": 2,
- "vlFcp": 0.2,
- "peReducaoBaseCalculoIcms": 10,
- "vlIcmsDesonerado": 0
}, - "pisCofins": {
- "idCstPis": 1,
- "vlBaseCalculoPis": 1000,
- "pePis": 1.65,
- "vlPis": 16.5,
- "idCstCofins": 1,
- "vlBaseCalculoCofins": 1000,
- "peCofins": 7.6,
- "vlCofins": 76
}, - "movimentacaoProdutoComboList": [
- {
- "idMovimentacaoProdutoCombo": 1251,
- "idMovimentacaoProduto": 15395743,
- "idProdutoCombo": 1085,
- "qtCombo": 2,
- "nrSequencia": 1,
- "idProduto": 5003921,
- "dsProduto": "Combo Nhás"
}
], - "produto": {
- "idProduto": 789000123456,
- "producao": {
- "extras": [
- {
- "idProdutoPrincipal": 1251,
- "idProduto": 5003921,
- "cdSku": "123456789",
- "dsProduto": "Produto Nhás",
- "qtProduto": 2,
- "vlVenda": 23,
- "dsAbreviacao": "KG"
}
], - "formulas": [
- {
- "idProdutoPrincipal": 1251,
- "idProduto": 5003921,
- "cdSku": "123456789",
- "dsProduto": "Produto Nhás",
- "qtProduto": 2,
- "vlVenda": 23,
- "dsAbreviacao": "KG"
}
]
}
}, - "vendedor": {
- "idVendedor": 2025,
- "dsVendedor": "João Oliveira",
- "dsDocumentoPrincipal": "12345678901"
}
}
], - "financeiroReceberList": [
- {
- "idFinanceiroReceber": 123456,
- "nrParcela": 1,
- "tpFormaPagamento": 0,
- "idFormaPagamento": 3,
- "dsFormaPagamento": "Cartão TEF",
- "cdFormaPagamento": "ZB01",
- "tpCartao": "C",
- "vlParcela": 23,
- "nrAutorizacao": "98453215",
- "nrNsu": "000023",
- "nrNsuHost": "000023",
- "nrBin": "987654",
- "nrFinalCartao": "4568",
- "idOperadoraCartao": 278,
- "dsOperadoraCartao": "SAFRA",
- "nrOperadoraCartao": 2,
- "idBandeiraCartao": 2,
- "dsBandeiraCartao": "VISA",
- "pessoaTitulo": {
- "idPessoa": 1918,
- "dsNome": "Ingrid",
- "dsDocumento": "32445469864"
}, - "nrBandeiraCartao": 2,
- "idBandeiraCartaoSefaz": 2,
- "dtVencimento": "2021-12-31T00:00:00",
- "financeiroReceberCheque": {
- "idFinanceiroReceberCheque": 10,
- "idFinanceiroReceber": "123456",
- "vlCheque": "116.27",
- "dsEmitente": "Emitente",
- "nrDocumentoEmitente": 191,
- "nrTelefone": "41999999999",
- "nrComp": "string",
- "nrBanco": "46",
- "nrAgencia": "1001",
- "nrConta": "100012",
- "nrDV": "4",
- "nrC1": "0",
- "nrC2": "0",
- "nrC3": "2",
- "nrSerie": "5",
- "nrCheque": "5",
- "dtEmissao": "2024-07-15",
- "dtBomPara": "2024-08-15",
- "nrParcelasCartao": 3
}, - "dsSerie": "1"
}
], - "movimentacaoPessoa": [
- {
- "idMovimentacaoPessoa": 234,
- "pessoa": {
- "idPessoa": 123,
- "dsNome": "SPAL INDUSTRIA BRASILEIRA DE BEBIDAS S/A",
- "dsNomeFantasia": "Spal Ind. Bras.Bebidas SA",
- "dsOperadorCaixa": "BOX",
- "cdOperadorExterno": "1234-DH",
- "nrCnpj": "12345678000199",
- "nrCpf": "12345678909",
- "dsEndereco": "Rua das Flores",
- "nrEndereco": "123",
- "dsBairro": "Centro",
- "nrIbge": "4106902",
- "dsCidade": "Curitiba",
- "sgEstado": "PR",
- "nrCep": "80230-000",
- "nrPais": "1058",
- "dsPais": "Brasil",
- "nrTelefone": "(41) 99999-9999",
- "dsEmail": "contato@spal.com.br",
- "nrInscricaoEstadual": "123456789"
}, - "cliente": {
- "cdClienteExterno": 234
}
}
], - "usuario": {
- "idPessoa": 123,
- "dsNome": "SPAL INDUSTRIA BRASILEIRA DE BEBIDAS S/A",
- "dsNomeFantasia": "Spal Ind. Bras.Bebidas SA",
- "dsOperadorCaixa": "BOX",
- "cdOperadorExterno": "1234-DH",
- "nrCnpj": "12345678000199",
- "nrCpf": "12345678909",
- "dsEndereco": "Rua das Flores",
- "nrEndereco": "123",
- "dsBairro": "Centro",
- "nrIbge": "4106902",
- "dsCidade": "Curitiba",
- "sgEstado": "PR",
- "nrCep": "80230-000",
- "nrPais": "1058",
- "dsPais": "Brasil",
- "nrTelefone": "(41) 99999-9999",
- "dsEmail": "contato@spal.com.br",
- "nrInscricaoEstadual": "123456789"
}, - "idOperacao": 1300,
- "tpOperacao": 96,
- "tpMovimentacao": "ENTRADA",
- "tpOrigemVenda": "SISTEMA",
- "cdIdentificadorDispositivo": "CD123",
- "tpMovimentacaoStatus": "AUTORIZADA",
- "movimentacaoFiscal": {
- "idMovimentacaoFiscal": 123456,
- "dhAutorizacao": "2023-06-20T15:30:20",
- "dsChave": "33230635539362003317654110000000851224779072",
- "dsChaveCancelamento": "35220461099008000000000000000000000000000001",
- "dsCodigoStatusSefaz": "Inutilizacao de numero homologado",
- "nrCodigoStatusSefaz": 102,
- "nrProtocoloAutorizacao": 333230000316710,
- "nrProtocoloCancelamento": 333230000323232,
- "nrModeloDocumentoFiscal": "65",
- "tpModeloDocumentoFiscal": "MODELO_65",
- "dsSerieSat": "900013760",
- "dsSerie": "1",
- "tpEmissaoDfe": 1,
- "dsTipoEmissaoDfe": "Contingência FS IA",
- "idTipoIndicadorPresenca": 1
}, - "movimentacaoPedido": {
- "idMovimentacaoPedido": 171,
- "nrPedido": "123456789",
- "dsOrigem": "ECOMMERCE",
- "dsTipoOrigemPedido": "Rappi"
}, - "movimentacaoClubeBeneficio": {
- "nrIdentificador": "29864460862",
- "nrIdentificador2": "",
- "nrTransacao": "0",
- "nrTransacao2": "",
- "nrTransacao3": ""
}, - "movimentacaoRecargaCelular": {
- "cdOperadoraCelular": "004",
- "dsOperadoraCelular": "Tim",
- "cdFilialOperadoraCelular": "00010000000",
- "nrNsuRecarga": 250028,
- "vlRecarga": 10
}, - "dsChaveAutorizacao": "35190721426387002247590005948840086905703051",
- "dsChaveCancelamento": "",
- "tipoOperacaoCategoria": "VENDA",
- "fgMovimentaFinanceiro": true,
- "fgAutorizado": true,
- "tpIntegracao": "CISSLIVE_PDV"
}Este serviço tem o objetivo de buscar os IDs movimentações de cupons que foram emitidos pelo Box e que estejam aprovados ou cancelados
| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idCaixa | integer Example: idCaixa=1 Código do caixa para buscar os dados |
| dtMovimento required | string <ISODate> Example: dtMovimento=2021-07-20 Data de movimento para buscar os dados |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": 3,
- "hasNext": true,
- "data": [
- 123456,
- 123789,
- 456123
]
}Este serviço tem o objetivo de buscar os IDs movimentações de cupons que foram emitidos pelo Box conforme o status da movimentação
| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idCaixa | integer Example: idCaixa=1 Código do caixa para buscar os dados |
| tpMovimentacaoStatus required | integer Example: tpMovimentacaoStatus=1 Código do status da movimentação |
| dhInicio required | string <ISODate> Example: dhInicio=2021-01-27T01:02:03.456Z Data de início (esta data deve ser informada padrão UTC 0) |
| dhFim required | string <ISODate> Example: dhFim=2021-01-27T01:02:03.456Z Data de fim (esta data deve ser informada padrão UTC 0) |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": 3,
- "hasNext": true,
- "data": [
- 123456,
- 123789,
- 456123
]
}Este serviço tem o objetivo de buscar os dados da movimentação de recarga de celular
| idMovimentacao required | integer Example: 123456 Identificador da movimentação |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idMovimentacao": 15407655,
- "idEmpresa": 102103,
- "dhMovimentacao": "2025-03-25T08:52:17",
- "vlTotalLiquido": 10,
- "vlTotalDescontos": 0,
- "vlTotalAcrescimos": 0,
- "tpOrigemPedido": 1,
- "movimentacaoRecargaCelular": {
- "cdOperadoraCelular": "004",
- "dsOperadoraCelular": "Tim",
- "cdFilialOperadoraCelular": "00010000000",
- "nrNsuRecarga": 250028,
- "vlRecarga": 10
}, - "financeiroReceberList": [
- {
- "idFinanceiroReceber": 123456,
- "nrParcela": 1,
- "tpFormaPagamento": 0,
- "idFormaPagamento": 3,
- "dsFormaPagamento": "Cartão TEF",
- "cdFormaPagamento": "ZB01",
- "tpCartao": "C",
- "vlParcela": 23,
- "nrAutorizacao": "98453215",
- "nrNsu": "000023",
- "nrNsuHost": "000023",
- "nrBin": "987654",
- "nrFinalCartao": "4568",
- "idOperadoraCartao": 278,
- "dsOperadoraCartao": "SAFRA",
- "nrOperadoraCartao": 2,
- "idBandeiraCartao": 2,
- "dsBandeiraCartao": "VISA",
- "pessoaTitulo": {
- "idPessoa": 1918,
- "dsNome": "Ingrid",
- "dsDocumento": "32445469864"
}, - "nrBandeiraCartao": 2,
- "idBandeiraCartaoSefaz": 2,
- "dtVencimento": "2021-12-31T00:00:00",
- "financeiroReceberCheque": {
- "idFinanceiroReceberCheque": 10,
- "idFinanceiroReceber": "123456",
- "vlCheque": "116.27",
- "dsEmitente": "Emitente",
- "nrDocumentoEmitente": 191,
- "nrTelefone": "41999999999",
- "nrComp": "string",
- "nrBanco": "46",
- "nrAgencia": "1001",
- "nrConta": "100012",
- "nrDV": "4",
- "nrC1": "0",
- "nrC2": "0",
- "nrC3": "2",
- "nrSerie": "5",
- "nrCheque": "5",
- "dtEmissao": "2024-07-15",
- "dtBomPara": "2024-08-15",
- "nrParcelasCartao": 3
}, - "dsSerie": "1"
}
], - "usuario": [
- {
- "idPessoa": 123,
- "dsNome": "SPAL INDUSTRIA BRASILEIRA DE BEBIDAS S/A",
- "dsNomeFantasia": "Spal Ind. Bras.Bebidas SA",
- "dsOperadorCaixa": "BOX",
- "cdOperadorExterno": "1234-DH",
- "nrCnpj": "12345678000199",
- "nrCpf": "12345678909",
- "dsEndereco": "Rua das Flores",
- "nrEndereco": "123",
- "dsBairro": "Centro",
- "nrIbge": "4106902",
- "dsCidade": "Curitiba",
- "sgEstado": "PR",
- "nrCep": "80230-000",
- "nrPais": "1058",
- "dsPais": "Brasil",
- "nrTelefone": "(41) 99999-9999",
- "dsEmail": "contato@spal.com.br",
- "nrInscricaoEstadual": "123456789"
}
], - "movimentacaoFiscal": {
- "dsSerie": "103"
}
}Este serviço tem o objetivo de buscar os dados da movimentação de título
| idMovimentacao required | integer Example: 123456 Identificador da movimentação |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idMovimentacao": 15407655,
- "idEmpresa": 102103,
- "dhMovimentacao": "2025-03-25T08:52:17",
- "vlTotalLiquido": 10,
- "vlTotalDescontos": 0,
- "vlTotalAcrescimos": 0,
- "tpOrigemPedido": 1,
- "movimentacaoTitulo": {
- "tpTitulo": "TRICARD",
- "nrNsu": "250028"
}, - "financeiroReceberList": [
- {
- "idFinanceiroReceber": 123456,
- "nrParcela": 1,
- "tpFormaPagamento": 0,
- "idFormaPagamento": 3,
- "dsFormaPagamento": "Cartão TEF",
- "cdFormaPagamento": "ZB01",
- "tpCartao": "C",
- "vlParcela": 23,
- "nrAutorizacao": "98453215",
- "nrNsu": "000023",
- "nrNsuHost": "000023",
- "nrBin": "987654",
- "nrFinalCartao": "4568",
- "idOperadoraCartao": 278,
- "dsOperadoraCartao": "SAFRA",
- "nrOperadoraCartao": 2,
- "idBandeiraCartao": 2,
- "dsBandeiraCartao": "VISA",
- "pessoaTitulo": {
- "idPessoa": 1918,
- "dsNome": "Ingrid",
- "dsDocumento": "32445469864"
}, - "nrBandeiraCartao": 2,
- "idBandeiraCartaoSefaz": 2,
- "dtVencimento": "2021-12-31T00:00:00",
- "financeiroReceberCheque": {
- "idFinanceiroReceberCheque": 10,
- "idFinanceiroReceber": "123456",
- "vlCheque": "116.27",
- "dsEmitente": "Emitente",
- "nrDocumentoEmitente": 191,
- "nrTelefone": "41999999999",
- "nrComp": "string",
- "nrBanco": "46",
- "nrAgencia": "1001",
- "nrConta": "100012",
- "nrDV": "4",
- "nrC1": "0",
- "nrC2": "0",
- "nrC3": "2",
- "nrSerie": "5",
- "nrCheque": "5",
- "dtEmissao": "2024-07-15",
- "dtBomPara": "2024-08-15",
- "nrParcelasCartao": 3
}, - "dsSerie": "1"
}
], - "usuario": [
- {
- "idPessoa": 123,
- "dsNome": "SPAL INDUSTRIA BRASILEIRA DE BEBIDAS S/A",
- "dsNomeFantasia": "Spal Ind. Bras.Bebidas SA",
- "dsOperadorCaixa": "BOX",
- "cdOperadorExterno": "1234-DH",
- "nrCnpj": "12345678000199",
- "nrCpf": "12345678909",
- "dsEndereco": "Rua das Flores",
- "nrEndereco": "123",
- "dsBairro": "Centro",
- "nrIbge": "4106902",
- "dsCidade": "Curitiba",
- "sgEstado": "PR",
- "nrCep": "80230-000",
- "nrPais": "1058",
- "dsPais": "Brasil",
- "nrTelefone": "(41) 99999-9999",
- "dsEmail": "contato@spal.com.br",
- "nrInscricaoEstadual": "123456789"
}
], - "movimentacaoFiscal": {
- "dsSerie": "103"
}
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idCaixa | integer Example: idCaixa=1 Código do caixa para buscar os dados |
| dtMovimento required | string <ISODate> Example: dtMovimento=2021-07-20 Data de movimento para buscar os dados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": -1,
- "hasNext": true,
- "data": [
- {
- "idEmpresa": 1,
- "idCaixa": 11,
- "dtMovimento": "2020-08-25",
- "qtVenda": 123,
- "vlVenda": 1499,
- "qtVendaCancelada": 5,
- "vlVendaCancelada": 325
}
]
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idCaixa required | integer Example: idCaixa=1 Código do caixa para buscar os dados |
| dtMovimento required | string <ISODate> Example: dtMovimento=2021-07-20 Data de movimento para buscar os dados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idEmpresa": 1,
- "idCaixa": 11,
- "dtMovimento": "2020-08-25",
- "qtVenda": 123,
- "vlVenda": 1499,
- "qtVendaCancelada": 5,
- "vlVendaCancelada": 325
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idCaixa | integer Example: idCaixa=1 Código do caixa para buscar os dados |
| dtMovimento required | string <ISODate> Example: dtMovimento=2021-07-20 Data de movimento para buscar os dados |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": -1,
- "hasNext": true,
- "data": [
- {
- "idEmpresa": 1,
- "idCaixa": 11,
- "dtMovimento": "2020-08-25"
}
]
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| dtCancelamento required | string <ISODate> Example: dtCancelamento=2021-01-27 Data de cancelamnto |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idEmpresa": 1,
- "idCaixa": 11,
- "dtMovimento": "2020-08-25",
- "qtVenda": 123,
- "vlVenda": 1499,
- "qtVendaCancelada": 5,
- "vlVendaCancelada": 325
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idCaixa required | integer Example: idCaixa=1 Código do caixa para buscar os dados |
| dtMovimento required | string <ISODate> Example: dtMovimento=2021-07-20 Data de movimento para buscar os dados |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "idEmpresa": 1,
- "idCaixa": 11,
- "dtMovimento": "2020-08-25",
- "qtVenda": 123,
- "vlVenda": 1499,
- "qtVendaCancelada": 5,
- "vlVendaCancelada": 325
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| idPromocao | number Código interno da promoção. |
| dsPromocao required | string [ 1 .. 200 ] characters Descrição da promoção. |
| idTipoPromocao required | integer (TipoPromocao) Enum: 1 2 3 4 Código do tipo de promoção 1 - Produto 2 - Forma Pagamento 3 - Faixas Desconto 4 - Combo |
| idTipoTemplatePromocao | integer (TipoTemplatePromocao) Enum: 1 2 3 4 5 Código do tipo de template para promoções. 1 - Desconto em determinados produtos 2 - Desconto em determinadas formas de pagamento 3 - Desconto em vendas a partir de determinada quantidade 4 - Brinde na venda de determinados produtos 5 - Desconto em vendas com combinações de produtos |
| idTipoOrigemIntegracao | integer (TipoOrigemIntegracao) Value: 1 Código da origem da integraçao. 1 - Scantech |
| dhInicioPromocao required | string <datetime> Data e hora de início da promoção. |
| dhFimPromocao required | string <datetime> Data e hora de fim da promoção. |
| fgAtivo required | boolean Flag para ativar ou desativar a promoção. |
| fgTodosClientes required | boolean Flag para indicar que a promoção é para todos os clientes. |
| peDesconto required | number Percentual de desconto a ser aplicado nesta promoção. |
| vlDesconto required | number Valor de desconto a ser aplicado nesta promoção. |
| idPessoa | number Id da pessoa que criou / alterou a promoção. |
| idEmpresaList required | Array of arrays Código das empresas as quais será aplicada a promoção. |
Array of objects (FormaPagamentoDto) Lista de forma de pagamento que a promoção deve ser aplicada. | |
object (PromocaoCombo) Dados para as promoções do tipo de combo, devem ser informados para os templates 3, 4 e 5. | |
Array of objects (PromocaoComboAtributo) Atributos da promoção do tipo combo. Utilizado para permitir condições adicionais na promoção. |
{- "idPromocao": 10004,
- "dsPromocao": "Promoção de batatas",
- "idTipoPromocao": 1,
- "idTipoTemplatePromocao": 1,
- "idTipoOrigemIntegracao": 1,
- "dhInicioPromocao": "2021-09-09T00:00:00",
- "dhFimPromocao": "2021-09-09T23:59:59",
- "fgAtivo": "true / false",
- "fgTodosClientes": "true / false",
- "peDesconto": 10.7,
- "vlDesconto": 5.1,
- "idPessoa": 100,
- "idEmpresaList": [
- 123456,
- 123789,
- 456123
], - "formaPagamentoList": [
- {
- "cdFormaPagamento": "FP01"
}
], - "promocaoCombo": {
- "idPromocaoCombo": 10004,
- "idTipoPromocaoCombo": 1,
- "idPromocao": 10004,
- "qtMinimo": 0,
- "fgAtivo": "true / false",
- "fgAcumulaQuantidade": "true / false",
- "qtLimiteRepeticoes": 5
}, - "promocaoComboAtributoList": [
- {
- "dsPromocaoComboAtributo": "Promocoes apenas para cartoes Mastercard.",
- "idTipoAtributo": 1,
- "dsInstrucao": 454234,
- "fgAtivo": true
}
]
}{- "idPromocao": 1263,
- "dsPromocao": "Nova promo API 2",
- "idTipoTemplatePromocao": 4,
- "idTipoOrigemIntegracao": 1,
- "idTipoPromocao": 4,
- "dhInicioPromocao": "2021-09-09T00:00:00",
- "dhFimPromocao": "2021-09-09T23:59:59",
- "fgAtivo": true,
- "fgTodosClientes": true,
- "vlDesconto": 0,
- "peDesconto": 0,
- "idPessoa": 2089,
- "idEmpresaList": [
- 102103,
- 101658
], - "promocaoCombo": {
- "idPromocaoCombo": 10398,
- "idTipoPromocaoCombo": 5,
- "fgAcumulaQuantidade": false,
- "qtLimiteRepeticoes": 1,
- "qtMinimo": 2,
- "fgAtivo": true,
- "idPromocao": 1263
}, - "promocaoComboAtributoList": [
- {
- "dsPromocaoComboAtributo": "Mastercard DEBITO",
- "dsInstrucao": "434323",
- "idTipoAtributo": 1,
- "fgAtivo": true
}, - {
- "dsPromocaoComboAtributo": "Mastercard CREDITO",
- "dsInstrucao": "545323",
- "idTipoAtributo": 1,
- "fgAtivo": true
}
]
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| idPromocao required | number ID da promoção a qual o produto será vinculado. |
| idProduto required | number ID do produto que será adicionado à promoção. |
| idTipoDescontoPromocaoProduto required | integer (TipoDescontoPromocaoProduto) Value: 1 Código do tipo de desconto a ser aplicado no produto da promoção. 1 - Quantidade |
| vlMinimo | number Valor mínimo necessário para ativar a promoção neste produto (utilizado em determinados tipos de promoção). |
| vlMaximo | number Valor máximo para ativar a promoção neste produto (utilizado em determinados tipos de promoção). |
| vlDesconto required | number Valor do desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção). |
| peDesconto required | number Percentual de desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção). |
| fgAtivo required | boolean Flag para ativar ou desativar a participação do produto na promoção. |
| vlPrecoPromocao required | number Valor a ser aplicado neste produto nesta promoção (utilizado em determinados tipos de promoção). |
[- {
- "idPromocao": 100,
- "idProduto": 100,
- "idTipoDescontoPromocaoProduto": 1,
- "vlMinimo": 10.7,
- "vlMaximo": 5.2,
- "vlDesconto": 12.3,
- "peDesconto": 16.4,
- "fgAtivo": "true / false",
- "vlPrecoPromocao": 5.8
}
][- {
- "idPromocao": 100,
- "idProduto": 100,
- "idTipoDescontoPromocaoProduto": 1,
- "vlMinimo": 10.7,
- "vlMaximo": 5.2,
- "vlDesconto": 12.3,
- "peDesconto": 16.4,
- "fgAtivo": "true / false",
- "vlPrecoPromocao": 5.8
}
]| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| idPromocaoCombo required | number ID da promoção do tipo combo a qual o produto será vinculado. |
| idProduto required | number Id do produto que será adicionado à promoção do tipo combo. |
| idTipoPromocaoComboProduto required | integer (TipoPromocaoComboProduto) Enum: 1 2 Código do tipo de produto para produtos de promoção combo. 1 - Produto de Venda 2 - Produto de Brinde |
| nrCombinacao required | number <integer> Número da combinação para promoção de combinação de produtos. |
| nrConjunto required | number Número do conjunto para promoção de combinação de produtos. |
| qtVenda required | number Quantidade de venda do produto necessária para aplicar a promoção de combinação de produtos. |
| vlDesconto required | number Valor do desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção). |
| peDesconto required | number Percentual de desconto a ser aplicado neste produto (utilizado em determinados tipos de promoção). |
| idTipoDescontoPromocaoCombo required | integer (TipoDescontoPromocaoComboProduto) Enum: 1 2 Código do tipo de desconto a ser aplicado no produto da promoção combo. 1 - Total 2 - Unitário |
| idTipoOperadorLogico | integer (TipoOperadorLogico) Enum: 1 2 Código do tipo de promoção combo. Definido a partir do template da promoção. 1 - E 2 - OU |
| fgAtivo required | boolean Flag para ativar ou desativar a participação do produto na promoção combo. |
[- {
- "idPromocaoCombo": 100,
- "idProduto": 100,
- "idTipoPromocaoComboProduto": 1,
- "nrCombinacao": 100,
- "nrConjunto": 100,
- "qtVenda": 12.3,
- "vlDesconto": 12.3,
- "peDesconto": 16.4,
- "idTipoDescontoPromocaoCombo": 1,
- "idTipoOperadorLogico": 1,
- "fgAtivo": "true / false"
}
][- {
- "idPromocaoCombo": 100,
- "idProduto": 100,
- "idTipoPromocaoComboProduto": 1,
- "nrCombinacao": 100,
- "nrConjunto": 100,
- "qtVenda": 12.3,
- "vlDesconto": 12.3,
- "peDesconto": 16.4,
- "idTipoDescontoPromocaoCombo": 1,
- "idTipoOperadorLogico": 1,
- "fgAtivo": "true / false"
}
]| idPromocao required | integer Example: 1 Código da promoção |
| fgAtivo required | boolean Example: true / false Flag ativo true / false |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "error": "Credenciais Inválidas"
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| idMovimentacao required | integer Example: idMovimentacao=1 Código da movimentação para buscar os dados |
| idsFormaPagamento required | integer Example: idsFormaPagamento=1,2,3 Lista de código de formas de pagamento para buscar os dados |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": -1,
- "hasNext": true,
- "data": [
- {
- "idMovimentacao": 123456,
- "dtMovimentacao": "2020-08-25",
- "nrMovimentacao": 123,
- "nrModeloDocumentoFiscal": "59",
- "dsSerie": "2",
- "dsSerieSat": "900013760",
- "nrCnpj": "11111111111111",
- "financeiroReceberList": [
- {
- "idMovimentacao": 123456,
- "nrParcelas": 2,
- "vlParcelas": 100,
- "nrNsu": "654321",
- "nrAutorizacao": "654321",
- "tpCartao": 2,
- "dsAdministradora": "REDE",
- "dsBandeira": "VISA",
- "dsFormaPagamento": "Cartão TEF",
- "cdReferenciaPedido": "PED-1234-CV",
- "dsNomeUsuario": "USUARIO 1",
- "fgVendaPos": false,
- "fgConcilia": true
}
]
}
]
}| idEmpresa required | integer Example: idEmpresa=1 Código da empresa para buscar os dados |
| dhAlteracao required | string <date-time> Example: dhAlteracao=2021-01-27T12:14:01.640 Data e hora da última consulta |
| page | integer [ 1 .. 999999999 ] Default: 1 Example: page=1 Número da página na paginação. |
| limit | integer [ 1 .. 100 ] Default: 25 Example: limit=100 Limite de registros por página. |
| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
{- "total": -1,
- "hasNext": true,
- "data": [
- {
- "idProduto": 2009,
- "qtSaldoAtual": 25,
- "nrCodigo": "123456789",
- "qtEstoqueMinimo": 11,
- "dhAlteracao": "2020-08-25 16:53:11.424"
}
]
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| Accept-Language | string Example: en-US Locale para tradução de mensagens. |
| SKU required | string [ 1 .. 60 ] characters Código SKU do produto. |
| empresas required | Array of integers Código das empresas onde o preço do produto será alterado. |
| vlPreco required | number [ 0 .. 999999999.99 ] Preço de venda do produto. |
| dhInicioVigencia required | string <datetime> Data e hora que o preço será alterado. |
{- "SKU": "123456789",
- "empresas": [
- 1,
- 2,
- 3
], - "vlPreco": 5.99,
- "dhInicioVigencia": "2023-01-01T00:00:00"
}{- "SKU": "123456789",
- "empresas": [
- 1,
- 2,
- 3
], - "vlPreco": 5.99,
- "dhInicioVigencia": "2023-01-01T00:00:00"
}| Authorization required | string Example: Berear ... Token para autenticação com a API. |
| image | string <binary> |
{- "imageName": "bfb118c5d87aaa436855e4756868aabge7641ac5.png"
}