Skip to main content

API

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

Interfaces​

IDateTypeFilterOptions​

interface IDateTypeFilterOptions {
  label?: string;
  value?: string;
}

IPaymentMethodFilterOptions​

interface IPaymentMethodFilterOptions {
  control: PAYMENTS_METHODS;
  label: string;
  tooltip?: string;
}

FormItem​

interface FormItem {
  label: string;
  value: (value?: any) => any;
  invalid: (value?: any) => boolean;
  class?: string;
}

BillDetail​

interface BillDetail {
  external_data: BillExternalData;
}

BillExternalData​

interface BillExternalData {
  bill_fine?: number;
  discount_value?: number;
  due_at?: string;
  emit_at?: string;
  interest?: number;
  is_recurrent?: boolean;
  maximum_delay?: number;
  maximum_discount?: number;
  number?: number;
  value?: number;
}

AvailableStep​

interface AvailableStep {
  icon: string;
  key: CHARGE_STEP;
  stepName: string;
  title: string;
  progress: number;
}

DateTypeOptions​

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

ChargeInformationField​

interface ChargeInformationField {
  label: string;
  chargeField: CHARGE_INFORMATION_FIELD_ENUM;
}

ChargeListColumn​

interface ChargeListColumn {
  label: string;
  columnEnum: CHARGE_LIST_TABLE_COLUMN;
}

RenderedService​

interface RenderedService {
  pk?: string;
  value?: number;
  quantity?: number;
  payment_type?: RECURRENCE_TYPE;
  cost_center_pk?: string;
  installments_number?: number;
}

RedirectOption​

interface RedirectOption {
  label: string;
  url: string;
  tracking?: TRACKING_MODELS;
}

UploadBottom​

interface UploadBottom {
  routerLink?: {
    title: string;
    link: string[];
  };
  modelFile?: UploadModelFile[];
}

UploadModelFile​

interface UploadModelFile {
  source: string;
  downloadableFile: string;
}

CompanyRelatedCreation​

interface CompanyRelatedCreation {
  pk?: string;
  name?: string;
  identity?: {
    identity_type: number;
    number: number;
  };
}

Contacts​

interface Contacts {
  pk: string;
  email: string;
  phone_area_code?: string;
  phone_number?: string;
}

Step​

interface Step {
  icon: string;
  title: string;
  stepName?: string;
  progress: number;
}
interface DropdownOption {
  key: any;
  label: string;
}

Enums​

PAYMENT_AUTHORIZATION​

enum PAYMENT_AUTHORIZATION {
  waiting = "waiting",
  authorized = "authorized",
  denied = "denied",
  canceled = "canceled",
}

CHARGE_STEP​

enum CHARGE_STEP {
  thirdParty,
  renderedServices,
  chargeInfo,
  finesAndDiscounts,
  paymentSplit,
  taxInfo,
  summary,
}

CHARGE_INFORMATION_FIELD_ENUM​

enum CHARGE_INFORMATION_FIELD_ENUM {
  total_value,
  charge_quantity,
  charge_recurrence,
}

CHARGE_LIST_TYPE​

enum CHARGE_LIST_TYPE {
  charges = 0,
  invoices = 1,
  creditCard = 6,
}

INSTALLMENTS_SPLIT_FIELDS​

enum INSTALLMENTS_SPLIT_FIELDS {
  input,
  dropdown,
}

CHARGE_LIST_TABLE_COLUMN​

enum CHARGE_LIST_TABLE_COLUMN {
  status,
  client,
  emit_at,
  due_at,
  paid_at,
  payment_method,
  charge_recurrence,
  email,
  value,
}