Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

Obrigatório

descricaostringDescrição da forma de pagamento
Obrigatório

Tamanho Máximo: 50 caracteres

Sim

descricaoFiscalstringDescrição fiscal da forma de pagamento

Obrigatório

Tamanho Máximo:

50 caracteres

30 caracteres

Sim

pagamentoValorTotalintConfiguração da forma de pagamento para que a mesma permita o pagamento do valor total da venda utilizando a mesma. Ou seja, se o carrinho tiver o valor de R$100,00 e a forma de pagamento DINHEIRO não permitir o pagamento total da venda, você não irá conseguir fechar a venda com o pagamento de R$100,00 em DINHEIRO. É necessário informar um pagamento inferior em DINHEIRO e o restante em outra forma de pagamento.
Não
permiteTrocoIntIndica se a forma de pagamento permite
troco (
troco 0 - Não; 1 - Sim
)
Obrigatório
Sim
idRetaguardaFormaPagTrocostringIdentificador da forma de pagamento troco na retaguarda
Obrigatório

Tamanho Máximo: 100 caracteres

Sim

valorMinimoAceitostringValor mínimo aceita para a forma de pagamento
Opcional

Não
codigoSistemaExternostringCódigo Sistema Externo

Obrigatório

Tamanho Máximo: 50 caracteres

Sim

situacaointegerSituação da forma de
pagamento (
pagamento 

0 - Inativo, 1 - Ativo)

Caso não enviado será cadastrado como 0

Sim

codigoModalidadePagamentointeger
Código da modalidade de pagamento
DEFASADO
Não
Opcional
tipointegerTipo da forma de pagamento
(Descrição abaixo)
CódigoTipo
0Outros
1Dinheiro
2Credito
3Debito
4Cheque
5POS
6Troca
7Fidelidade
8Gift
9Cliente
10QRCode
11Todos
Sim
Obrigatório
tipoClienteinteger
Tipo cliente
Identifica se a forma de pagamento é uma forma utilizada para clientes cadastrados, como por exemplo, promissoria ou crédito empresa
Não
Opcional
formasPagtoCondicoesLista de objetosLista de condições de forma de pagamento
Opcional

Não
formasPagtoCondicoes.idRetaguardastringIdentificador da condição na retaguarda
Opcional

Não
formasPagtoCondicoes.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguarda
Opcional

Não
formasPagtoCondicoes.idRetaguardaCondicaoPagtostringIdentificador da condição de pagamento na retaguarda
Opcional

Não
formasPagtoCondicoes.situacaointegerSituação da condição de
pagamento (
pagamento 0 - Inativo, 1 - Ativo
)
Opcional
Não
formasPagtoDadosComplementaresLista de objetosLista de Dados complementares da forma de pagamento
Opcional

Não
formasPagtoDadosComplementares.idRetaguardastringIdentificador do dado complementar na reguardar
Opcional

Não
formasPagtoDadosComplementares.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguarda
Opcional

Não
formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagtostringIdentificador do dado complementar pagamento na retaguarda
Opcional

Não
formasPagtoDadosComplementares.situacaointegerSituação do dado
complementar (
complementar 0 - Inativo, 1 - Ativo
)
Opcional
Não
formasPagtoDadosComplementares.ordemintegerOrdem do dado complementar
Opcional

Não
formasPagtoOperadorasLista de objetosLista de operadoras da forma de pagamento
Opcional

Não
formasPagtoOperadoras.idRetaguardastringIdentificador da operadora na retaguarda
Opcional

Não
formasPagtoOperadoras.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguarda
Opcional

Não
formasPagtoOperadoras.idRetaguardaOperadoraPagtostringIdentificador da Operadora pagamento na retaguarda
Opcional

Não
formasPagtoOperadoras.situacaointegerSituação da
operadora (
operadora 0 - Inativo, 1 - Ativo
)
Opcional
Não
formaPagtoModeloFiscalLista de objetosLista de modelos fiscais
Opcional

Não
formaPagtoModeloFiscal.idRetaguardastringIdentificador do modelo na retaguarda
Opcional

Não
formaPagtoModeloFiscal.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguarda
Opcional

Não
formaPagtoModeloFiscal.modeloFiscalstringModelo fiscal
Opcional

Não
formaPagtoModeloFiscal.codigoFiscalstringCódigo fiscal
Opcional

Não
formaPagtoModeloFiscal.descricaoFiscalstringDescrição fiscal
Opcional

Não
formaPagtoModeloFiscal.situacaointegerSituação do modelo fiscal
(
0 - Inativo, 1 - Ativo
)
Opcional
Não
idInquilinostringIdentificador do inquilino
Obrigatório

Sim
idRetaguardastringIdentificador da forma de pagamento na retaguarda
Obrigatório
Tamanho máximo: 100 caracteresSim
idProprietariostringIdentificador do proprietário
ObrigatórioCódigoTipo0Outros1Dinheiro2Credito3Debito4Cheque5POS6Troca8Gift10QRCode

Sim
loteOrigemstring

Identificador do lote

Obrigatório para a integração
Expandir
titleTipoFormaPagto

Sim



Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandir
titleBody de retorno

{
    "success": true,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Expandir
title400 - Bad Request

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro