Árvore de páginas

Versões comparadas

Chave

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

(aviso)

Button
Cor#FF0000
TextoTDN MIGRADO OPERADORA
Linkhttps://tdn.totvs.com/display/TVPO/Operadora#v1--1106098588

Este método é responsável pela criação de novas operadoras

...

Aviso

Para que a baixa da Operadora criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  15 = Operadora

titleexpandtitleDefinição de requisição
Deck of Cards
idversções
Card
labelV3.1 (V2)

Requisição

Section
Column
width50%
Expandir

Exemplo de body da requisição

[
    {
        "administradora": "string",
        "codigoTef": "string",
        "descricao": "string",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "loteOrigem": "string",
        "situacao": 0,
        "tipoTransacao": 0
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

String

Descrição da operadora de pagamento

Sim

Tamanho máximo: 100 caracteres

administradoraStringAdministradora da operadora de pagamento

Sim

Tamanho máximo: 100 caracteres

codigoTefStringCódigo Tef da operadora de pagamento

Sim

Tamanho máximo: 30 caracteres

idInquilinoStringIdentificador do inquilinoSim
idProprietarioStringIdentificador do proprietárioSim
idRetaguardaStringIdentificador da operadora na retaguardaSim
loteOrigemStringIdentificador do lote em que serão enviados os dadosSim
situacaoIntSituação da operadora

Não

0 - Inativo, 1 - Ativo

Caso não enviado será cadastrado como 0

tipoTransacaoIntTipo de transação (Descrição abaixo)Não
CódigoTipo
0Credito
1Debito



Retorno

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

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
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

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
Card
labelV3.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
width50%

Exemplo de body da requisição

[
    {
        "administradora": "string",
       

"tipoTransacao": 0,
   

"codigoTef": "string",
        "descricao": "string",
        "idInquilino": "string",
        "

idRetaguarda

idProprietario": "string",
        "

idProprietario

idRetaguarda": "string",
        "loteOrigem": "string",
        "situacao": 0,
        "tipoTransacao": 0
    }
]

Column
width
50%

Definições dos campos

do body

Campo

Tipo

Descrição

Obrigatório

Observações

Obrigatório

descricaoStringDescrição da operadora de pagamento

Sim

Tamanho máximo: 100 caracteres

Sim

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

Sim

0 - Inativo, 1 - Ativo

Sim

codigoTefStringCódigo Tef da operadora de pagamento

Não

Tamanho máximo: 30 caracteres

Não

administradoraStringAdministradora da operadora de pagamento

Não

Tamanho máximo: 100 caracteres

Não

tipoTransacaoIntTipo de transação 

CódigoTipo0Credito1Debito



Sim
CódigoTipo
0Credito
1Debito
Sim
idInquilinoStringIdentificador do
inquilin
inquilinoSim
idRetaguardaStringIdentificador da operadora na retaguardaSimTamanho máximo: 100 caracteres
idProprietarioStringIdentificador do proprietárioSim
loteOrigemStringIdentificador do lote em que serão enviados os dadosSim
expand


Retornos

Deck of Cards
titleDefinição dos campos de retorno
titleexpandtitle
idretornos
Card
label
Expandir
200 - Ok
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

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
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

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