voltar

API Referências: Assinatura | ApagarCobrancasAtrasadas

post /api/Assinatura/ApagarCobrancasAtrasadas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdAssinatura: varchar,
     IdEmpresa: varchar,
     NrDias: int,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | AtualizarPosPagamento

post /api/Assinatura/AtualizarPosPagamento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdPedido: nvarchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | AtualizarTitulo

post /api/Assinatura/AtualizarTitulo?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assinatura: varchar,
     Empresa: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | GerarComissoesMensalidades

post /api/Assinatura/GerarComissoesMensalidades?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdAssinatura: varchar,
     IdUsuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | GerarProximasCobrancas

post /api/Assinatura/GerarProximasCobrancas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assinatura: varchar,
     Empresa: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | InativarClientesInativos

post /api/Assinatura/InativarClientesInativos?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: InativarClientesInativos não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | ListarRelatorioPrincipal

post /api/Assinatura/ListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Assinatura: uniqueidentifier,
          Ativo: string,
          AtivoValor: bit,
          AutonumeracaoEmpresa: int,
          Cadastro: string,
          CadastroValor: datetime,
          Cancelamento: string,
          CancelamentoValor: smalldatetime,
          Cliente: string,
          ClienteDsEmail: string,
          ClienteValor: uniqueidentifier,
          CobrancasAtraso: int,
          CobrancasDuracao: int,
          CobrancasPagas: int,
          Empresa: uniqueidentifier,
          Incidencia: string,
          IncidenciaValor: smalldatetime,
          PlanoComercial: string,
          PlanoComercialValor: uniqueidentifier,
          Privado: bit,
          UsuarioCriacao: uniqueidentifier,
          Valor: string,
          ValorDecimal: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | RegerarTodasCobrancas

post /api/Assinatura/RegerarTodasCobrancas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assinatura: varchar,
     Empresa: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | RelatorioAssinaturasInativasListarRelatorioPrincipal

post /api/Assinatura/RelatorioAssinaturasInativasListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | RelatorioAssinaturasTodasListarRelatorioPrincipal

post /api/Assinatura/RelatorioAssinaturasTodasListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | Consultar

post /api/Assinatura/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Hash: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Ativo: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Cancelamento: smalldatetime,
          Categoria: int,
          Cliente: uniqueidentifier,
          ClienteDescricao: string,
          DebitoAutomaticoCartaoCredito: bit,
          Detalhe: string,
          Empresa: uniqueidentifier,
          Frequencia: int,
          Hash: uniqueidentifier,
          Incidencia: smalldatetime,
          Inicio: smalldatetime,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Pedido: uniqueidentifier,
          Periodicidade: int,
          PlanoComercial: uniqueidentifier,
          Privado: bit,
          Recorrencia: uniqueidentifier,
          Termino: smalldatetime,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          Valor: decimal(18,2),
          VirtualAssinaturaCobranca: text,
          VirtualAssinaturaComissao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | Excluir

post /api/Assinatura/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | Listar

post /api/Assinatura/Listar?token=[SEU-TOKEN-SECRETO]

Request

Querystring parameters names Type
token string required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Ativo: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Cancelamento: smalldatetime,
          Categoria: int,
          Cliente: uniqueidentifier,
          DebitoAutomaticoCartaoCredito: bit,
          Detalhe: string,
          Empresa: uniqueidentifier,
          Frequencia: int,
          Hash: uniqueidentifier,
          Incidencia: smalldatetime,
          Inicio: smalldatetime,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Pedido: uniqueidentifier,
          Periodicidade: int,
          PlanoComercial: uniqueidentifier,
          Privado: bit,
          Recorrencia: uniqueidentifier,
          Termino: smalldatetime,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: decimal(18,2),
          VirtualAssinaturaCobranca: text,
          VirtualAssinaturaComissao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Assinatura | Salvar

post /api/Assinatura/Salvar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Ativo: bit,
     CamposAtualizados: nvarchar,
     Cancelamento: smalldatetime,
     Categoria: int,
     Cliente: uniqueidentifier,
     ConsultarPorCampo: varchar,
     DebitoAutomaticoCartaoCredito: bit,
     Detalhe: varchar,
     Empresa: varchar,
     Frequencia: int,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Incidencia: smalldatetime,
     Inicio: smalldatetime,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Pedido: uniqueidentifier,
     Periodicidade: int,
     PlanoComercial: uniqueidentifier,
     Privado: bit,
     Recorrencia: uniqueidentifier,
     RetornarDataSet: bit,
     Termino: smalldatetime,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     Valor: decimal,
     ValorConsultaPorCampo: varchar,
     VirtualAssinaturaCobranca: text,
     VirtualAssinaturaComissao: text,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json Consultar: https://api.tempbox.com.br/referencias/assinatura?key=Consultar

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token