voltar

API Referências: ContaReceber | AtualizarTitulo

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

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Hash: 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: ContaReceber | ContaReceberEsteMesListarRelatorioPrincipal

post /api/ContaReceber/ContaReceberEsteMesListarRelatorioPrincipal?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: ContaReceber | ContaReceberGeralListarRelatorioPrincipal

post /api/ContaReceber/ContaReceberGeralListarRelatorioPrincipal?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: ContaReceber | GerarRecorrencia

post /api/ContaReceber/GerarRecorrencia?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: GerarRecorrencia 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: ContaReceber | ListarRelatorioPrincipal

post /api/ContaReceber/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
{
     [
          AnoReferente: int,
          AutonumeracaoEmpresa: int,
          ContaReceber: uniqueidentifier,
          DataPagamento: smalldatetime,
          Empresa: uniqueidentifier,
          Incidencia: smalldatetime,
          MesReferente: string,
          MesReferenteValor: int,
          Periodo: string,
          PeriodoValor: int,
          Realizado: string,
          RealizadoValor: bit,
          RealizadoValor: bit,
          ReferentePagador: string,
          ReferentePagadorLink: string,
          ReferentePagadorSubDescricao: string,
          ReferentePagadorSubDescricao: string,
          ReferentePagadorValor: uniqueidentifier,
          RegrasDatas: string,
          TipoConta: string,
          Valor: 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: ContaReceber | Consultar

post /api/ContaReceber/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,
          AnoReferente: int,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          ClienteContaVinculada: uniqueidentifier,
          DataPagamento: smalldatetime,
          Detalhe: string,
          Empresa: uniqueidentifier,
          Frequencia: int,
          Hash: uniqueidentifier,
          Incidencia: smalldatetime,
          Inicio: smalldatetime,
          MesReferente: int,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Periodicidade: int,
          Privado: bit,
          Realizado: bit,
          Recorrencia: uniqueidentifier,
          Referente: uniqueidentifier,
          ReferenteContaReceber: uniqueidentifier,
          ReferenteDescricao: string,
          ReferentePagador: uniqueidentifier,
          ReferentePagadorDescricao: string,
          ReferenteTipo: string,
          Termino: smalldatetime,
          TipoConta: uniqueidentifier,
          TipoContaDescricao: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          Valor: 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: ContaReceber | Excluir

post /api/ContaReceber/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: ContaReceber | Listar

post /api/ContaReceber/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,
          AnoReferente: int,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          ClienteContaVinculada: uniqueidentifier,
          DataPagamento: smalldatetime,
          Detalhe: string,
          Empresa: uniqueidentifier,
          Frequencia: int,
          Hash: uniqueidentifier,
          Incidencia: smalldatetime,
          Inicio: smalldatetime,
          MesReferente: int,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Periodicidade: int,
          Privado: bit,
          Realizado: bit,
          Recorrencia: uniqueidentifier,
          Referente: uniqueidentifier,
          ReferenteContaReceber: uniqueidentifier,
          ReferentePagador: uniqueidentifier,
          Termino: smalldatetime,
          TipoConta: uniqueidentifier,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: 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: ContaReceber | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     AnoReferente: int,
     CamposAtualizados: nvarchar,
     Categoria: int,
     ClienteContaVinculada: uniqueidentifier,
     ConsultarPorCampo: varchar,
     DataPagamento: smalldatetime,
     Detalhe: varchar,
     Empresa: varchar,
     Frequencia: int,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Incidencia: smalldatetime,
     Inicio: smalldatetime,
     MesReferente: int,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Periodicidade: int,
     Privado: bit,
     Realizado: bit,
     Recorrencia: uniqueidentifier,
     Referente: uniqueidentifier,
     ReferenteContaReceber: uniqueidentifier,
     ReferentePagador: uniqueidentifier,
     RetornarDataSet: bit,
     Termino: smalldatetime,
     TipoConta: uniqueidentifier,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     Valor: decimal,
     ValorConsultaPorCampo: varchar,
}

 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/contareceber?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

API Referências: ContaReceber | PeriodoPorTipoConta

post /api/ContaReceber/PeriodoPorTipoConta?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Cliente: varchar,
     IdEmpresa: varchar,
     Inicio: varchar,
     Realizado: varchar,
     Termino: varchar,
}

 json required

Response


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

array json
{
     [
          Hash: uniqueidentifier,
          Realizado: string,
          Titulo: string,
          Valor: decimal(38,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