Skip to main content

API

This section describes the API of the ui-acquiring library.

Interfaces​

SalesTotal​

interface SalesTotal {
  label: string;
  value: string;
  percentage?: string;
  classColor?: string;
}

ProgressBarData​

interface ProgressBarData {
  label: string;
  value: string;
  percentage: string;
}

ProgressBar​

interface ProgressBar {
  sale_type: SALE_TYPE_PROGRESS_BAR;
  data: Record<PROGRESS_BAR_ITEM_TYPE, ProgressBarData>;
}

AppliedFilters​

interface AppliedFilters {
  label: string;
  keys: string[];
}

AcquiringFiltersBase​

interface AcquiringFiltersBase {
  establishment_code?: any[];
  card_brand?: any[];
  payment_method?: number[];
  start_period?: string;
  end_period?: string;
}

SalesItem​

interface SalesItem {
  date_time: string;
  card_number: string;
  receipt: string;
  cod_product_transaction: string;
  modality: number;
  order: string;
  terminal_description: string;
  paid_at: string;
  value: string;
  installment: string;
  installment_brute_value: string;
  external_id: string;
}

ReceivablesItem​

interface ReceivablesItem {
  pk: string;
  processor: string;
  card_brand_description: string;
  payment_method: string;
  value: number;
  date: string;
  paid_at: string;
  installment: string;
  establishment_code: string;
  bank_id?: string;
  financial_record_pk: string;
  installment_brute_value: string;
  installment_total_value: string;
}

GroupedSalesByDate​

interface GroupedSalesByDate {
  date: string;
  sales: (SalesItem & ReceivablesItem)[];
  total: number;
}

EcManagement​

interface EcManagement {
  id?: string;
  acquirer?: string;
  name?: string;
  number?: number;
  rental_amount?: number;
  rental_status: string;
}

Enums​

TOTAL_TYPE​

enum TOTAL_TYPE {
  salesNumber = 'sales_number',
  salesTotalConfirmed = 'sales_total_confirmed',
  salesNumberConfirmed = 'sales_number_confirmed',
  salesTotalCanceled = 'sales_total_canceled',
  salesNumberCanceled = 'sales_number_canceled',
  salesTotalReceived = 'sales_total_received',
  salesNumberReceived = 'sales_number_received',
  salesTotalPending = 'sales_total_pending',
  salesNumberPending = 'sales_number_pending',
  salesTotalBrute = 'sales_total_brute',
  salesTotalLiquid = 'sales_total_liquid',
  salesTotalTax = 'sales_total_tax',
}

RECEIVABLES_OPTIONS​

enum RECEIVABLES_OPTIONS {
  received = 'received',
  pending = 'pending',
  confirmed = 'received,pending',
  canceled = 'canceled',
}

SALES_PAYMENT_METHOD​

enum SALES_PAYMENT_METHOD {
  card,
  pix,
  all,
}

FILTER_PARAMS​

enum FILTER_PARAMS {
  dueAt = 'due_at',
  paidAt = 'paid_at',
  accountingDatetime = 'accounting_datetime',
}

SALE_TYPE_PROGRESS_BAR​

enum SALE_TYPE_PROGRESS_BAR {
  sales = 'sales',
  receivables = 'receivables',
}

SALES_ITEM_FIELDS​

enum SALES_ITEM_FIELDS {
  dateTime = 'date_time',
  cardNumber = 'card_number',
  receipt = 'receipt',
  authorizationCode = 'authorization_code',
  modality = 'modality',
  card_brand_description = 'card_brand_description',
  externalId = 'external_id',
  terminalDescription = 'terminal_description',
  dueAt = 'due_at',
  installmentTotalValue = 'installment_total_value',
  installment = 'installment',
  installmentBruteValue = 'installment_brute_value',
  establishmentCode = 'establishment_code',
  saleStatus = 'sale_status',
}

RECEIVABLES_ITEM_FIELDS​

enum RECEIVABLES_ITEM_FIELDS {
  processor = 'processor',
  establishmentCode = 'establishment_code',
  cardBrand = 'card_brand_description',
  paymentType = 'payment_method',
  value = 'value',
  dateTime = 'date_time',
  paidAt = 'paid_at',
  installment = 'installment',
  installmentBruteValue = 'installment_brute_value',
  installmentTotalValue = 'installment_total_value',
}