Skip to main content

API

This section describes the API of the ui-cash-flow library.

Interfaces​

ListConciliationGroupTable​

interface ListConciliationGroupTable {
  label: string;
  toolTip?: string;
  align?: string;
  tableProperty: LIST_CONCILIATION_GROUP_PROPERTY_COLUMN;
}

LayoutData​

export interface LayoutData {
  title?: string;
  companyName?: string;
}

Keychain​

interface Keychain {
  company_pk?: string;
  aux_text?: string;
  first_aux_text?: string;
  is_active?: boolean;
  pk?: string;
  second_aux_text?: string;
  service_name?: KEYCHAINS;
  status?: number;
  third_aux_text?: string;
  certification_url?: string;
  expires_at?: string;
  password?: string;
  token?: string;
  username?: string;
  main_checking_account?: string;
  automatic_transfer_checking_account?: string;
  credit_card_checking_account?: string;
  bill_checking_account?: string;
  cash_checking_account?: string;
  documents?: string[];
}

CheckingAccount​

interface CheckingAccount {
  pk?: string;
  account_type?: number;
  bank_account_balance?: number;
  bank_account_current_balance?: number;
  bank_account_digit?: string;
  bank_account?: string;
  bank_branch?: string;
  bank_id?: BANK;
  company_pk?: string;
  company_related_pk?: string;
  covenant_number?: string;
  description?: string;
  is_active?: boolean;
  is_last_statement_conciliated?: boolean;
  is_released?: boolean;
  landmark_date?: string;
  last_statement_at?: string;
  last_statement_balance?: string;
  last_statement_url?: string;
  name?: string;
  overdraft_value?: string;
  pixs?: Pix[];
  agreement_type: number;
  agreement_code: number;
}

Pix​

interface Pix {
  pk?: string;
  pix_key?: string;
  key_type?: PIX_KEY_TYPE;
}

GroupOptions​

interface GroupOptions {
  key: string;
  label: string;
}

FinancialRecord​

interface FinancialRecord {
  accrual_basis_month?: number;
  accrual_basis_year?: number;
  amount_value?: number;
  amounts?: string[];
  approval_message?: string;
  approval_status?: RECORD_APPROVAL_STATUS;
  authorized_by?: any;
  bank_account?: string;
  bank_id?: string;
  bank_is_active?: boolean;
  bank_name?: string;
  checking_account_name?: string;
  checking_account_pk?: string;
  checking_account?: string;
  classified_amounts?: number;
  coa_index?: string;
  coa_level?: string;
  coa_name?: string;
  coa_pk?: string;
  company_pk?: string;
  company?: string;
  compensation_date?: string;
  cost_center_pk?: string;
  created_at?: string;
  created_by?: {
    pk?: string;
    first_name?: string;
    last_name?: string;
  };
  deleted_by?: any;
  deleted?: string;
  description?: string;
  document_pk?: string;
  document_types?: DOCUMENT_TYPES[];
  documents_count?: number;
  documents?: string[];
  due_at?: string;
  external_id?: string;
  first_document_url?: string;
  has_custom_classification?: boolean;
  has_observations?: boolean;
  index?: number;
  is_charge?: boolean;
  is_conciliation_possibility?: boolean;
  is_late_paid?: boolean;
  is_late?: boolean;
  is_pending?: boolean;
  is_predicted?: boolean;
  is_review?: boolean;
  last_comment?: any;
  name?: string;
  not_classified_amounts?: number;
  open_at?: string;
  origin?: FINANCIAL_RECORD_ORIGIN;
  paid_at?: string;
  payment_authorization?: PAYMENT_AUTHORIZATION;
  payment_method?: PAYMENTS_METHODS;
  pending_description?: boolean;
  pk?: string;
  scheduled_at?: string;
  scheduled_date?: string;
  to_check?: boolean;
  updated_at?: string;
  value?: number;
}

FinancialRecordListItem​

export interface FinancialRecordListItem {
  pk?: string;
  name?: string;
  value?: string;
  coa_name?: string;
  coa_index?: string;
  origin?: number;
  description?: string | null;
  open_at?: string | null;
  payment_method?: number;
  due_at?: string;
  paid_at?: string | null;
  scheduled_date?: string;
  scheduled_at?: string | null;
  compensation_date?: string | null;
  is_pending?: boolean;
  is_review?: boolean;
  is_predicted?: boolean;
  to_check?: boolean;
  pending_description?: string | null;
  company?: string;
  amounts?: string[];
  checking_account?: string;
  bank_name?: string;
  bank_id?: string;
  bank_account?: string;
  index?: string | null;
  documents?: any[];
  document_types?: any[];
  updated_at?: string;
  created_at?: string;
  created_by?: {
    pk?: string;
    first_name?: string;
    last_name?: string;
  };
  authorized_by?: string | null;
  first_document_url?: string;
  deleted?: string | null;
  documents_count?: number;
  bank_is_active?: boolean;
  classified_amounts?: number;
  not_classified_amounts?: number;
  deleted_by?: string | null;
  last_comment?: {
    pk?: string;
    text?: string;
    seen_at?: string | null;
  };
  approval_status?: number;
  approval_message?: string | null;
  has_custom_classification?: boolean;
  has_observations?: boolean;
  external_id?: string | null;
  is_late?: boolean;
  is_late_paid?: boolean;
  payment_authorization?: number;
  is_conciliation_possibility?: boolean;
  group?: string | null;
  consent?: string | null;
  company_related_pk?: string | null;
  is_partially_classified?: boolean;
  merged_to?: string | null;
  accounting_datetime?: string | null;
  card_brand?: string | null;
  card_brand_description?: string | null;
  installment_number?: string | null;
  installment_quantity?: string | null;
  installment_total_value?: string | null;
  installment_brute_value?: string | null;
  card_number?: string | null;
  terminal_number?: string | null;
  terminal_type?: string | null;
  terminal_description?: string | null;
  order?: string | null;
  cod_product_transaction?: string | null;
  establishment_code?: string | null;
  processor?: string | null;
  is_charge?: boolean;
}

DocumentsFieldsOption​

interface DocumentsFieldsOption {
  label: string;
  formControlName: string;
  mask?: string;
  suffix?: string;
}

Document​

interface Document {
  barcode?: any;
  document_type?: number;
  emit_at?: any;
  filename?: string;
  keychain?: string;
  mime_type?: string;
  ocr_result?: any;
  origin?: number;
  pk?: string;
  status?: any;
  url?: string;
}

BalanceConfig​

interface BalanceConfig {
  type: string;
  isCustom: false;
}

ListItemOptions​

export interface ListItemOptions {
  late?: boolean;
  modal?: boolean;
  selectionEnabled?: boolean;
  columns: ColumnItem[];
  editable?: boolean;
}

HistorySummaryCard​

export interface HistorySummaryCard extends SummaryCard {
  status: CONCILIATION_GROUP_STATUS;

}

info

SummaryCard is imported from @celerofinancas/ui-common

CONCILIATION_GROUP_STATUS is imported from @celerofinancas/core-ts

PaymentInfoField​

export interface PaymentInfoField {
  key: FINANCIAL_RECORD_PAYMENT_INFO_FIELDS;
  order: number;
  editable: boolean;
  label?: string | string[];
  showTooltip?: boolean;
}

export type PaymentInfoFields = PaymentInfoField[][];

FinancialRecordAmountFormField​

export interface FinancialRecordAmountFormField {
  key: FINANCIAL_RECORD_AMOUNT_FORM_FIELDS;
  order: number;
  label?: string;
  labelNote?: string;
  editable?: boolean;
  required?: boolean;
}

export type FinancialRecordAmountFormFields = FinancialRecordAmountFormField[];

Enums​

LIST_CONCILIATION_GROUP_PROPERTY_COLUMN​

enum LIST_CONCILIATION_GROUP_PROPERTY_COLUMN {
  registry_name,
  paid_at,
  bank_account,
  registries,
  value,
}

PIX_KEY_TYPE​

enum PIX_KEY_TYPE {
  cpfCnpj = 1,
  email = 2,
  phoneNumber = 3,
  randomKey = 4,
  branchAndAccount = 5,
}

CashFlowSidebarSection​

enum CashFlowSidebarSection {
  RECORDS = "records",
  FILTERS = "filters",
}

CONCILIATION_GROUP_TABS​

enum CONCILIATION_GROUP_TABS {
  grouping = 1,
  history = 2,
}

CONCILIATION_GROUP_ACTION​

enum CONCILIATION_GROUP_ACTION {
  accept = 0,
  decline = 1,
  undo_accept = 2,
  undo_decline = 3,
}

YIELD_ITEM_ORDER_FIELDS​

export enum YIELD_ITEM_ORDER_FIELDS {
  checkbox,
  tooltip,
  name,
  due_at,
  paid_at,
  value,
}

HeaderTabs​

export enum HeaderTabs {
  INDIVIDUAL_RECORD = 'INDIVIDUAL_RECORD',
  MASSIVE_RECORD = 'MASSIVE_RECORD',
}

RECURRENCY_TYPE​

export enum RECURRENCY_TYPE {
  no_repeat = 0,
  recurring = 1,
  parceled = 2,
}

FINANCIAL_RECORD_PAYMENT_INFO_FIELDS​

export enum FINANCIAL_RECORD_PAYMENT_INFO_FIELDS {
  DUE_AT = 'due-at',
  SCHEDULED_AT_DATE = 'scheduled-at-date',
  SCHEDULED_IN_DATE = 'scheduled-in-date',
  PAID_AT = 'paid-at',
  COMPENSATION_DATE = 'compensation-date',
  PAYMENT_METHOD = 'payment-method',
  CHECKING_ACCOUNT = 'checking-account',
}