Button

Cor	#FF0000
Texto	TDN MIGRADO FORMA PAGTO
Link	https://tdn.totvs.com/display/TVPO/Forma+de+pagamento

Este método é responsável pela criação de novos FormaPagto

...

Aviso
Para que a baixa do FormaPagto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 18 = FormaPagto

titleexpandtitleDefinição de requisição

Deck of Cards

id	versções

Card

label	V3.1 (V2)

Requisição

Section

Column

width	50%

Expandir

Exemplo de body da requisição

[
{
"codigoModalidadePagamento": 0,
"codigoSistemaExterno": "string",
"descricao": "string",
"descricaoFiscal": "string",
"formaPagtoModeloFiscal": [
{
"codigoFiscal": "string",
"

permiteTroco

descricaoFiscal":

0

"string",
"

idRetaguardaFormaPagTroco

idRetaguarda": "string",
"

valorMinimoAceito

idRetaguardaFormaPagto": "string",
"

codigoSistemaExterno

modeloFiscal": "string",
"situacao": 0
}
],
"formasPagtoCondicoes": [
{
"idRetaguarda": "string",
"

codigoModalidadePagamento

idRetaguardaCondicaoPagto":

0

"string",
"

tipo

idRetaguardaFormaPagto":

0

"string",
"

tipoCliente

situacao": 0
}
],
"

formasPagtoCondicoes

formasPagtoDadosComplementares": [
{
"idRetaguarda": "string",
"

idRetaguardaFormaPagto

idRetaguardaDadoComplementarPagto": "string",
"

idRetaguardaCondicaoPagto

idRetaguardaFormaPagto": "string",
"ordem": 0,
"situacao": 0
}
],
"

formasPagtoDadosComplementares

formasPagtoOperadoras": [
{
"idRetaguarda": "string",
"idRetaguardaFormaPagto": "string",
"

idRetaguardaDadoComplementarPagto

idRetaguardaOperadoraPagto": "string",
"situacao": 0
}
],
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaFormaPagTroco": "string",
"loteOrigem": "string",
"permiteTroco": 0,
"situacao": 0,
"tipo": 0,
"tipoCliente": 0,
"valorMinimoAceito": "string",

"clienteConsumidor": bool
}
]

Column

width	50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

string

Descrição da forma de pagamento

Sim

Tamanho Máximo: 50 caracteres

codigoModalidadePagamento

integer

Código da modalidade de pagamento

Não

codigoSistemaExterno

string

Código Sistema Externo

Sim

Tamanho Máximo: 50 caracteres

descricaoFiscal

string

Descrição fiscal da forma de pagamento

Sim

Tamanho Máximo: 50 caracteres

formaPagtoModeloFiscal

Lista de objetos

Lista de modelos fiscais

Não

formaPagtoModeloFiscal.codigoFiscal

string

Código fiscal

Não

Tamanho Máximo: 2 caracteres

formaPagtoModeloFiscal.descricaoFiscal

string

Descrição fiscal

Não

Tamanho Máximo: 30 caracteres

formaPagtoModeloFiscal.idRetaguarda

string

Identificador do modelo na retaguarda

Não

Tamanho Máximo: 100 caracteres

formaPagtoModeloFiscal.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formaPagtoModeloFiscal.modeloFiscal

string

Modelo fiscal

Não

Tamanho Máximo: 30 caracteres

formaPagtoModeloFiscal.situacao

integer

Situação do modelo fiscal

Não

0 - Inativo, 1 - Ativo

formasPagtoCondicoes

Lista de objetos

Lista de condições de forma de pagamento

Não

formasPagtoCondicoes.idRetaguarda

string

Identificador da condição na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoCondicoes.idRetaguardaCondicaoPagto

string

Identificador da condição de pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoCondicoes.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoCondicoes.situacao

integer

Situação da condição de pagamento (0 - Inativo, 1 - Ativo)

Não

formasPagtoDadosComplementares

Lista de objetos

Lista de Dados complementares da forma de pagamento

Não

formasPagtoDadosComplementares.idRetaguarda

string

Identificador do dado complementar na reguardar

Não

Tamanho Máximo: 100 caracteres

formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagto

string

Identificador do dado complementar pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoDadosComplementares.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoDadosComplementares.ordem

integer

Ordem do dado complementar

Não

formasPagtoDadosComplementares.situacao

integer

Situação do dado complementar (0 - Inativo, 1 - Ativo)

Não

formasPagtoOperadoras

Lista de objetos

Lista de operadoras da forma de pagamento

Não

formasPagtoOperadoras.idRetaguarda

string

Identificador da operadora na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoOperadoras.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoOperadoras.idRetaguardaOperadoraPagto

string

Identificador da Operadora pagamento na retaguarda

Não

Tamanho Máximo: 100 caracteres

formasPagtoOperadoras.situacao

integer

Situação da operadora (0 - Inativo, 1 - Ativo)

Não

idInquilino

string

Identificador do inquilino

Sim

idProprietario

string

Identificador do proprietário

Sim

idRetaguarda

string

Identificador da forma de pagamento na retaguarda

Sim

Tamanho Máximo: 100 caracteres

idRetaguardaFormaPagTroco

string

Identificador da forma de pagamento troco na retaguarda

Sim

Tamanho Máximo: 100 caracteres

loteOrigem

string

Identificador do lote

Sim

permiteTroco

Int

Indica se a forma de pagamento permite troco (0 - Não; 1 - Sim)

Sim

situacao

integer

Situação da forma de pagamento (0 - Inativo, 1 - Ativo)

Não

Caso não enviado será cadastrado como 0

tipo

integer

Tipo da forma de pagamento

Sim

Código	Tipo
0	Outros
1	Dinheiro
2	Credito
3	Debito
4	Cheque
5	POS
6	Troca
8	Gift
10	QRCode

tipoCliente

integer

Tipo cliente

Não

valorMinimoAceito

string

Valor mínimo aceita para a forma de pagamento

Não

Tamanho Máximo: 50 caracteres

clienteConsumidor

bool

Habilita forma de pagamento para aquela forma de pagamento

Não

true/false

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
Success	bool	Indica se a criação do compartilhamento foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
Data	objeto	Objeto compartilhamento criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
code	string	Código de erro
message	string	Mensagem do erro
detailedMessage	string	Detalhamento do erro
helpUrl	string	url de ajuda
TotalTime	string	Tempo total de busca
details	lista de objeto	Lista de objeto de erros
details.guid	string	Identificador do erro
details.code	string	Código do erro
details.message	string	Mensagem do erro
details.detailedMessage	string	Detalhamento do erro

Card

label	V3.2

Informações
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.

Requisição

Section

Column

width	50%

Exemplo de body da requisição

[
{
"codigoModalidadePagamento": 0,
"codigoSistemaExterno": "string",
"descricao": "string",
"descricaoFiscal": "string",
"formaPagtoModeloFiscal": [
{
"codigoFiscal": "string",
"descricaoFiscal": "string",
"idRetaguarda": "string",
"idRetaguardaFormaPagto": "string",
"modeloFiscal": "string",
"situacao": 0
}
],
"

formasPagtoOperadoras

formasPagtoCondicoes": [
{
"idRetaguarda": "string",
"

idRetaguardaFormaPagto

idRetaguardaCondicaoPagto": "string",
"

idRetaguardaOperadoraPagto

idRetaguardaFormaPagto": "string",
"situacao": 0
}
],
"

formaPagtoModeloFiscal

formasPagtoDadosComplementares": [
{
"idRetaguarda": "string",
"idRetaguardaDadoComplementarPagto": "string",
"idRetaguardaFormaPagto": "string",
"ordem": 0,
"

modeloFiscal

situacao": 0
}
],
"formasPagtoOperadoras": [
{
"idRetaguarda": "string",
"

codigoFiscal

idRetaguardaFormaPagto": "string",
"

descricaoFiscal

idRetaguardaOperadoraPagto": "string",
"situacao": 0
}
],
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"

idProprietario

idRetaguardaFormaPagTroco": "string",
"loteOrigem": "string",
"permiteTroco": 0,
"situacao": 0,
"tipo": 0,
"tipoCliente": 0,
"valorMinimoAceito": "string"

"clienteConsumidor": bool
}
]

Column

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Observações	Obrigatório
descricao	string	Descrição da forma de pagamento

Obrigatório

	Tamanho Máximo: 50 caracteres	Sim
descricaoFiscal	string	Descrição fiscal da forma de pagamento

Obrigatório

Tamanho Máximo:

50 caracteres

30 caracteres	Sim
pagamentoValorTotal	int	Configuraçã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
permiteTroco	Int	Indica se a forma de pagamento permite

troco (

troco

0 - Não; 1 - Sim

)

Obrigatório

Sim
idRetaguardaFormaPagTroco	string	Identificador da forma de pagamento troco na retaguarda

Obrigatório

Tamanho Máximo: 100 caracteres	Sim
valorMinimoAceito	string	Valor mínimo aceita para a forma de pagamento

Opcional

	Não
codigoSistemaExterno	string	Código Sistema Externo

Obrigatório

	Tamanho Máximo: 50 caracteres	Sim
situacao	integer	Situação da forma de

pagamento (

pagamento

0 - Inativo, 1 - Ativo)

Caso não enviado será cadastrado como 0

Sim
codigoModalidadePagamento	integer

Código da modalidade de pagamento

DEFASADO

Não

Opcional


tipo	integer	Tipo da forma de pagamento

(Descrição abaixo)

Código	Tipo
0	Outros
1	Dinheiro
2	Credito
3	Debito
4	Cheque
5	POS
6	Troca
7	Fidelidade
8	Gift
9	Cliente
10	QRCode
11	Todos

Sim

Obrigatório


tipoCliente	integer

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


formasPagtoCondicoes	Lista de objetos	Lista de condições de forma de pagamento

Opcional

	Não
formasPagtoCondicoes.idRetaguarda	string	Identificador da condição na retaguarda

Opcional

	Não
formasPagtoCondicoes.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda

Opcional

	Não
formasPagtoCondicoes.idRetaguardaCondicaoPagto	string	Identificador da condição de pagamento na retaguarda

Opcional

	Não
formasPagtoCondicoes.situacao	integer	Situação da condição de

pagamento (

pagamento

0 - Inativo, 1 - Ativo

)

Opcional

Não
formasPagtoDadosComplementares	Lista de objetos	Lista de Dados complementares da forma de pagamento

Opcional

	Não
formasPagtoDadosComplementares.idRetaguarda	string	Identificador do dado complementar na reguardar

Opcional

	Não
formasPagtoDadosComplementares.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda

Opcional

	Não
formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagto	string	Identificador do dado complementar pagamento na retaguarda

Opcional

	Não
formasPagtoDadosComplementares.situacao	integer	Situação do dado

complementar (

complementar

0 - Inativo, 1 - Ativo

)

Opcional

Não
formasPagtoDadosComplementares.ordem	integer	Ordem do dado complementar

Opcional

	Não
formasPagtoOperadoras	Lista de objetos	Lista de operadoras da forma de pagamento

Opcional

	Não
formasPagtoOperadoras.idRetaguarda	string	Identificador da operadora na retaguarda

Opcional

	Não
formasPagtoOperadoras.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda

Opcional

	Não
formasPagtoOperadoras.idRetaguardaOperadoraPagto	string	Identificador da Operadora pagamento na retaguarda

Opcional

	Não
formasPagtoOperadoras.situacao	integer	Situação da

operadora (

operadora

0 - Inativo, 1 - Ativo

)

Opcional

Não
formaPagtoModeloFiscal	Lista de objetos	Lista de modelos fiscais

Opcional

	Não
formaPagtoModeloFiscal.idRetaguarda	string	Identificador do modelo na retaguarda

Opcional

	Não
formaPagtoModeloFiscal.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda

Opcional

	Não
formaPagtoModeloFiscal.modeloFiscal	string	Modelo fiscal

Opcional

	Não
formaPagtoModeloFiscal.codigoFiscal	string	Código fiscal

Opcional

	Não
formaPagtoModeloFiscal.descricaoFiscal	string	Descrição fiscal

Opcional

	Não
formaPagtoModeloFiscal.situacao	integer	Situação do modelo fiscal

(

0 - Inativo, 1 - Ativo

)

Opcional

Não
idInquilino	string	Identificador do inquilino

Obrigatório

	Sim
idRetaguarda	string	Identificador da forma de pagamento na retaguarda

Obrigatório

	Tamanho máximo: 100 caracteres	Sim
idProprietario	string	Identificador do proprietário

Obrigatório

	Sim
loteOrigem	string	Identificador do lote

Obrigatório para a integração Expandir

title	TipoFormaPagto

		Sim
clienteConsumidor	bolean	Habilita forma de pagamento para aquele cliente	true/false	Não

Retornos

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Definições dos campos do retorno

CódigoTipo0Outros1Dinheiro2Credito3Debito4Cheque5POS6Troca8Gift10QRCode Expandir

title	Definição dos campos de retorno

200 - Okexpandtitle

Expandir

title

Campo
Tipo
Descrição
Success bool Indica se a criação do compartilhamento foi feita com sucesso
Message string Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
Data objeto Objeto compartilhamento criado
Errors Lista Listas com os erros encontrados no processo
TotalTime int tempo da requisição
NumberOfRecords int número de dados inseridos

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
code	string	Código de erro
message	string	Mensagem do erro
detailedMessage	string	Detalhamento do erro
helpUrl	string	url de ajuda
TotalTime	string	Tempo total de busca
details	lista de objeto	Lista de objeto de erros
details.guid	string	Identificador do erro
details.code	string	Código do erro
details.message	string	Mensagem do erro
details.detailedMessage	string	Detalhamento do erro

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno