Documentação do banco de dados do CashPreview 3.0

Documentação do Banco de Dados do CashPreview

A seguir, passamos a documentar todas as tabelas do banco de dados do CashPreview que podem ser acessadas de modo seguro por desenvolvedores e os seus respectivos campos. Não recomendamos o usp de outras tabelas não citadas aqui para a geração de relatórios, pois há sutilezas que poderiam introduzir incoerências em seus relatórios.

Tabela Contas: usada para conter os cadastramentos da hierarquia das contas de capital.

Campos:

Id: campo de auto-numeração usado para identificar o registro da conta.

Codigo: texto com máximo de 31 caracteres onde cada três posições são separadas por um caractere de ponto e representa um nível na árvore de contas de capital. Cada três posições são usadas para conter as identificações dos itens pertencentes a um determinado nível. Como são três posições para cada nível, o limite de itens por nível é de 999, uma vez que a numeração dos itens em cada nível começa sempre de "001". Os números que identificam os itens em cada nível são preenchidos com zeros mais à esquerda quando necessário, ex: "001", "021". Para indicar um item na árvore, o campo Codigo contém a concatenação do código do seu item pai com o número que identifica o item no seu nível. Exemplo, para identificar o terceiro item no segundo nível que é filho do item "002" do primeiro nível, o código ficaria assim: "002.003". Para identificar o primeiro filho deste item, o código ficaria assim: "002.003.001".

Há uma exceção no primeiro nível, onde o item "000" já vem cadastrado por padrão e é usado como pai de todos os demais neste nível.

CodPai: o valor do campo Codigo do registro do item pai deste item.

DesConta: texto com máximo de 30 caracteres contendo o nome da conta.

Inativa: valor booleano que indica se a conta está inativa quando ligado.

Excluida: valor booleano que indica se a conta está excluída quando ligado.

Tabela TiposMovimentacoes : usada para conter os cadastramentos da árvore de receitas/despesas.

Campos:

Id: campo de auto-numeração usado para identificar o registro da receita/despesa.

Codigo: idêntico ao campo Codigo da tabela Contas. Apenas uma diferença: além do item "000" cadastrado por padrão no primeiro nível, também estão cadastrados os itens "001", "TRANSFERÊNCIAS ENTRE CONTAS" e o item "002", "AJUSTES DE SALDOS".

CodPai: o valor do campo Codigo do registro do item pai deste item.

DesMovimentacao: texto com máximo de 30 caracteres contendo o nome da receita/despesa.

Tipo: valor numérico de um byte que indica se devem ser aceitos lançamentos de entrada (valor 1), saída (valor 2) ou ambos (valor 0).

Inativo: valor booleano que indica que a receita/despesa está inativa quando ligado.

Excluido: valor que indica que a receita/despesa está excluída quando ligado.

Tabela CentrosDeCusto: usada para conter os cadastramentos da árvore de centros de custo/lucro.

Campos:

Id: campo de auto-numeração usado para identificar o registro do centro de custo/lucro.

Codigo: idêntico ao campo Codigo da tabela Contas.

CodPai: o valor do campo Codigo do registro do item pai deste item.

DesCentroDeCusto : texto com máximo de 30 caracteres contendo o nome do centro de custo/lucro.

Inativo: valor booleano que indica que o centro de custo/lucro está inativo quando ligado.

Excluido: valor que indica que o centro de custo/lucro está excluído quando ligado.

UltDataIdAtu: reservado para uso futuro.

Tabela ParceirosComerciais: usada para conter os cadastros de clientes e fornecedores.

Campos:

Id: campo de auto-numeração usado para identificar o registro do cliente/fornecedor.

TipoRelacionamento: valor numérico que indica se o parceiro é cliente (valor 1) ou fornecedor (valor 2).

Key: texto de 32 caracteres usado internamente pelo CashPreview.

Nome: texto de 40 caracteres.

Filial: texto de 30 caracteres contendo o nome da filial.

Desde : data em que o cliente/fornecedor passou a ter negócios com a empresa.

LimiteDeCredito: valor tipo moeda que indica o limite de crédito estipulado para o cliente.

TipoPessoa: númerico de um byte que indica se é pessoa física (valor 1) ou jurídica (valor 2).

CNPJ_CNPF: texto de 15 caracteres para conter o CNPJ, no caso de pessoa jurídica, ou o CNPF, no caso de pessoa física.

IE: texto de 20 caracteres para conter a inscrição estadual do cliente/fornecedor no caso de pessoa jurídica.

RG: texto de 13 caracteres para conter o RG, no caso de pessoa física.

EmissorRG: texto de 10 caracteres para conter o órgão público emissor do RG quando informado.

Pai: texto de 40 caracteres para o nome do pai em caso de pessoa física.

Mae: texto de 40 caracteres para o nome da mãe em caso de pessoa física.

Profissao: número inteiro com a identificação da profissão no cadastro de profissões.

Instrucao: número de um byte indicativo do grau de instrução. 1, para nenhuma; 2, para primária; 3, para secundária; 4, para superior.

EstadoCivil: número de um byte indicando o estado civil. 1, para solteiro; 2, para casado; 3, para desquitado; 4, para divorciado; 5, para viuvo.

Sexo: número de um byte indicando o sexo. 1, para masculino; 2, para feminino.

DataDeNascimento: data de nascimento.

LocalDeNascimento: texto de 20 caracteres indicando o local de nascimento.

Nacionalidade: número que identifica a nacionalidade no cadastro de nacionalidades.

Porte: número de um byte que indica o porte da empresa cliente/fornecedora. 1, para micro; 2, pequeno; 3, para médio; 4, para grande.

RamoDeAtividade: número de um byte que indica o ramo de atividade. 1; para serviços; 2, para comércio; 3, para indústria; 4, para agricultura.

Inativo: valor booleano que indica se o cliente/fornecedor se encontra inativo no cadastro. Sim, para inativo; não, para ativo.

UltDataIdAtu: reservado para uso futuro.

IdConcorrencia:

Tabela Comentarios: contém os comentários relativos ao relacionamento com o cliente/fornecedor.

Campos:

Id: campo de auto-numeração usado para identificar o registro do comentário.

Key: texto de 32 caracteres de uso interno do CashPreview.

IdParceiro: número que identifica o cliente/fornecedor na tabela ParceirosComerciais.

DataHora: data e hora em que o comentário foi inserido ou alterado pela última vez.

Comentario: texto de 255 caracteres com o conteúdo do comentário.

IdUsuario: número que identifica, na tabela Usuarios, o usuário que criou ou modificou o comentário.

Usuario: texto de 40 caracteres com o nome do usuário identificado pelo campo acima.

IdConcorrencia: número usado para controle de versão do registro. É sempre acrescido de 1 quando o registro sofre qualquer modificação.

Tabela Contatos: contém os dados relativos aos contados nos clientes/fornecedores.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Key: texto de 32 caracteres de uso interno do CashPreview.

IdProprietario: número que identifica o cliente/fornecedor na tabela ParceirosComerciais.

TipoDeContato: número de 1 byte que indica o tipo de contato na tabela TiposDeContatos.

Nome: texto de 30 caracteres para o nome do contato.

Cargo: texto de 20 caracteres para o cargo do contato.

Email: texto de 60 caracteres para o e-mail do contato.

DDD1: texto de 4 caracteres para o DDD do primeiro telefone do contato.

Numero1: texto de 11 caracteres para o número do primeiro telefone do contato.

Ramal1: texto de 6 caracteres para o ramal do primeiro telefone do contato se for necessário.

DDD2: texto de 4 caracteres para o DDD do segundo telefone do contato.

Numero2: texto de 11 caracteres para o número do segundo telefone do contato.

Ramal2: texto de 6 caracteres para o ramal do segundo telefone do contato se for necessário.

IdConcorrencia: número usado para controle de versão do registro. É sempre acrescido de 1 quando o registro sofre qualquer modificação.

Tabela Emails:contém os e-mails dos clientes/fornecedores.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Key: texto de 32 caracteres de uso interno do CashPreview.

IdProprietario: número que identifica o cliente/fornecedor na tabela ParceirosComerciais.

Tipo: número de um byte que indica o tipo de e-mail. 1, para profissional; 2, para pessoal.

Email: texto de 60 caracteres para conter o e-mail.

Descricao: texto de 60 caracteres para algum detalhe opcional sobre o e-mail.

IdConcorrencia: número usado para controle de versão do registro. É sempre

acrescido de 1 quando o registro sofre qualquer modificação.

Tabela Enderecos: endereços de clientes/fornecedores.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Key: texto de 32 caracteres de uso interno do CashPreview.

IdProprietario: número que identifica o cliente/fornecedor na tabela ParceirosComerciais.

Tipo: número de um byte que indica o tipo de endereço. 1, para comercial; 2, para residencial.

Logradouro: texto de 30 caracteres com o nome da rua, avenida, praça.

Numero: texto de 6 caracteres para conter o número do endereço.

Complemento: texto de 10 caracteres para conter o complemento, ex: apto., casa, sala, etc.

Bairro: texto de 20 caracteres para o bairro.

Cidade: texto de 20 caracteres para a cidade.

Estado: texto de 2 caracteres para a sigla do estado.

CEP: texto de 8 caracteres para o CEP.

Descricao: texto de 60 caracteres para algum comentário adicional sobre o endereço.

IdConcorrencia: número usado para controle de versão do registro. É sempre acrescido de 1 quando o registro sofre qualquer modificação.

Tabela Telefones: contém os telefones dos clientes/fornecedores.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Key: texto de 32 caracteres de uso interno do CashPreview.

IdProprietario: número que identifica o cliente/fornecedor na tabela ParceirosComerciais.

Tipo: número de um byte que indica o tipo de telefone. 1, para comercial fixo; 2, para comercial celular; 3, para pessoal fixo; 4, para pessoal celular.

DDD: texto de 4 caracteres.

Numero: texto de 11 caracteres.

Ramal: texto de 6 caracteres.

Descricao: texto de 60 caracteres.

IdConcorrencia: número usado para controle de versão do registro. É sempre acrescido de 1 quando o registro sofre qualquer modificação.

Tabela TiposDeContatos: contém os tipos de contatos nos clientes/fornecedores.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Key: texto de 32 caracteres de uso interno do CashPreview.

Tipo: texto de 20 que nomeia o tipo de contato.

Descricao: texto de 60 que descreve o tipo de contato.

Inativo: valor booleano que indica se o contato está inativo.

IdConcorrencia: número usado para controle de versão do registro. É sempre acrescido de 1 quando o registro sofre qualquer modificação.

Tabela Lancamentos: contém os lançamentos das previsões de entradas e saídas de capital nas contas de capital, nas receitas/despesas, nos centros de custo/lucro, nos clientes/fornecedores.

Campos:

Id: campo numérico usado para identificar o registro na tabela. Não é de auto-numeração, mas obtido somando-se 1 ao último valor do campo Serial na tabela auxiliar Serial descrita mais abaixo.

CodConta; texto de 31 caracteres que identifica a conta de capital na tabela Contas. Corresponde ao campo "Codigo" naquela tabela.

CodRecDesp: texto de 31 caracteres que identifica a receita/despesa na tabela TiposMovimentacoes. Corresponde ao campo "Codigo" naquela tabela.

CodCentroCusto: texto de 31 caracteres que identifica o centro de custo/lucro na tabela CentrosDeCusto. Corresponde ao campo "Codigo" naquela tabela.

IdParceiroComl: número que identifica o cliente/fornecedor na tabela ParceirosComerciais. Corresponde ao campo Id naquela tabela.

Documento: texto de 20 caracteres usado opcionalmente para conter um número de documento ao qual o lançamento se refere.

Valor: valor do lançamento.

ValorPago: para uso futuro, não está em uso presentemente.

Data: dia previsto para a realização da movimentação correspondente ao lançamento.

DataReferência: dia a que se refere a movimentação lançada.

DataVencimento: para uso futuro, por enquanto, o valor de Data representa a data de vencimento e realização.

Historico: texto de 50 caracteres usado para conter uma descrição do lançamento. Não informe valores que tenham mais de 25 caracteres contínuos sem espaço.

Estorno: valor booleano que indica se o lançamento é um estorno de outro.

DataId: texto de 17 caracteres formado com a combinação da data invertida do lançamento no formato aaaammdd com o valor do campo Id formatado em nove posições com preenchimento de zeros mais à esquerda. Ex: 20061231000000001.

SaldoConta: o saldo da conta de capital computado somando-se todos os lançamentos anteriores feitos na conta e nas suas subcontas mais o valor do lançamento. Não são computados os lançamentos estornados nem os baixados como não-realizados.

SaldoRecDesp: o saldo da receita/despesa computado somando-se todos os lançamentos anteriores feitos nela nos seus subitens mais o valor do lançamento. Não são computados os lançamentos estornados nem os baixados como não-realizados.

SaldoCentroCusto: o saldo do centro de custo/lucro computado somando-se todos os lançamentos anteriores feitos nele nos seus subitens mais o valor do lançamento. Não são computados os lançamentos estornados nem os baixados como não-realizados.

SaldoParceiroComl: o saldo do cliente/fornecedor computado somando-se todos os lançamentos anteriores feitos nele mais o valor do lançamento. Não são computados os lançamentos estornados nem os baixados como não-realizados.

SaldoGlobal: o saldo somado de todas as contas de capital de primeiro nível computado somando-se todos os lançamentos anteriores mais o valor do lançamento. Não são computados os lançamentos estornados nem os baixados como não-realizados.

Estornado: valor booleano que indica se o lançamento foi estornado por outro.

Realizado: texto de 1 caractere que indica se o lançamento está pendente para baixa (?); baixado como relalizado (S); baixado como não-realizado (N); ou está estornado ou é um estorno (E).

Transferencia: número de 1 byte que indica se o lançamento faz parte de uma transferência e se é o lançamento de saída da conta de origem (valor 1) ou o lançamento de entrada na conta de destino (valor 2).

IdUsuario: número que identifica o usuário que fez o lançamento na tabela Usuarios.

IdConcorrencia: número usado para controle de versão do registro. É sempre acrescido de 1 quando o registro sofre qualquer modificação.

Tabela Transferencias: contém os identificadores dos lançamentos que fazem parte de cada transferência.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

SerialSai: número que corresponde, na tabela Lancamentos, ao campo Id do lançamento de saída da conta de origem da transferência.

SerialEntra: número que corresponde, na tabela Lancamentos, ao campo Id do lançamento de entrada na conta de destino da transferência.

Tabela Serial: tabela auxiliar contendo apenas um registro e usada na numeração dos lançamentos e também para armazenar algumas opções de uso do sistema.

Campos:

Serial: número com o valor do campo Id do último lançamento incluído na tabela Lancamentos.

RecDespSoSubniveis: indica se apenas as receitas/despesas sem subitens devem ser exibidas na janela onde se faz os lançamentos.

ContasSoSubniveis: indica se apenas as contas de capital sem subitens devem ser exibidas na janela onde se faz os lançamentos.

CCustosSoSubniveis: indica se apenas os centros de custo/lucro sem subitens devem ser exibidos na janela onde se faz os lançamentos.

Tabela Nacionalidades: contém as nacionalidades cadastradas para serem mostradas no cadastramento de clientes/fornecedores do tipo pessoa física.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Nacionalidade: texto de 20 caracteres.

Key: texto de 32 caracteres de uso interno do CashPreview.

Inativo: valor booleano indicando se a nacionalidade está inativa. Se estiver, não será mostrada no momento de se cadastrar um novo cliente/fornecedor.

Tabela Profissoes: contém as profissões cadastradas para serem mostradas no cadastramento de clientes/fornecedores do tipo pessoa física.

Campos:

Id: campo de auto-numeração usado para identificar o registro na tabela.

Profissao: texto de 20 caracteres.

Key: texto de 32 caracteres de uso interno do CashPreview.

Inativo: valor booleano indicando se a profissão está inativa. Se estiver, não será mostrada no momento de se cadastrar um novo cliente/fornecedor.

Tabela Versao: contém apenas um registro e identifica a versão do banco de dados.

Campos:

Versao: texto de 8 caracteres.