@zeniai/client-epic-state 5.1.42 → 5.1.43-betaAK1

package/lib/entity/invoicing/dunningCase/dunningCaseState.d.ts

@@ -0,0 +1,28 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingDunningStatus } from './dunningCasePayload';
+export interface InvoicingDunningCase {
+    id: ID;
+    status: InvoicingDunningStatus;
+    amount?: Amount;
+    attempts?: number;
+    createdAt?: ZeniDate;
+    currencyCode?: string;
+    customer?: string;
+    customerEmail?: string;
+    customerID?: ID;
+    daysPastDue?: number;
+    failureReason?: string;
+    initials?: string;
+    invoiceID?: ID;
+    lastAttempt?: ZeniDate;
+    maxAttempts?: number;
+    nextRetry?: ZeniDate;
+    pausedReason?: string;
+    pausedUntil?: ZeniDate;
+    subscriptionID?: ID;
+}
+export interface InvoicingDunningCaseState {
+    dunningCaseByID: Record<ID, InvoicingDunningCase>;
+}

package/lib/entity/invoicing/dunningCase/dunningCaseState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/entity/invoicing/invoice/invoicePayload.d.ts

@@ -0,0 +1,100 @@
+import { InvoicingBillingAddressPayload, InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingInvoice, InvoicingInvoiceKPIs } from './invoiceState';
+export type InvoicingInvoiceStatus = 'paid' | 'partially_paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending' | 'draft';
+export interface InvoicingLineItemPayload {
+    amount: number;
+    description: string;
+    quantity: number;
+    unit_amount: number;
+    date_from?: string;
+    date_to?: string;
+    discount_amount?: number;
+    entity_description?: string;
+    entity_type?: string;
+    id?: string;
+    is_taxed?: boolean;
+    item_level_discount_amount?: number;
+    subscription_id?: string;
+    tax_amount?: number;
+    tax_exempt_reason?: string;
+    tax_rate?: number;
+    usage_percentage?: number;
+}
+export interface InvoicingLinkedPaymentPayload {
+    applied_amount: number;
+    txn_id: string;
+    applied_at?: string;
+    txn_amount?: number;
+    txn_date?: string;
+    txn_status?: string;
+}
+export interface InvoicingIssuedCreditNotePayload {
+    cn_id: string;
+    cn_status: string;
+    cn_total: number;
+}
+export interface InvoicingDunningAttemptPayload {
+    attempt: number;
+    created_at?: string;
+    dunning_type?: string;
+    transaction_id?: string;
+}
+export interface InvoicingInvoiceNotePayload {
+    note: string;
+    entity_id?: string;
+    entity_type?: string;
+}
+export interface InvoicingInvoicePayload {
+    customer_id: string;
+    date: string;
+    id: string;
+    status: InvoicingInvoiceStatus;
+    total: number;
+    adjustment_credit_notes?: string[];
+    amount_adjusted?: number;
+    amount_due?: number;
+    amount_paid?: number;
+    amount_to_collect?: number;
+    billing_address?: InvoicingBillingAddressPayload;
+    created_at?: string;
+    credits_applied?: number;
+    currency_code?: string;
+    customer_email?: string;
+    customer_name?: string;
+    due_date?: string;
+    dunning_attempts?: InvoicingDunningAttemptPayload[];
+    dunning_status?: string;
+    first_invoice?: boolean;
+    generated_at?: string;
+    has_advance_charges?: boolean;
+    invoice_number?: string;
+    invoice_type?: 'one_time' | 'recurring';
+    issued_credit_notes?: InvoicingIssuedCreditNotePayload[];
+    line_items?: InvoicingLineItemPayload[];
+    linked_payments?: InvoicingLinkedPaymentPayload[];
+    net_term_days?: number;
+    next_retry_at?: string;
+    notes?: InvoicingInvoiceNotePayload[];
+    paid_at?: string;
+    pdf_file_id?: string;
+    pdf_url?: string;
+    po_number?: string;
+    price_type?: InvoicingPriceType;
+    recurring?: boolean;
+    round_off_amount?: number;
+    shipping_address?: InvoicingBillingAddressPayload;
+    sub_total?: number;
+    subscription_id?: string;
+    subscription_name?: string;
+    tax?: number;
+    updated_at?: string;
+    write_off_amount?: number;
+}
+export interface InvoicingInvoiceKPIsPayload {
+    due_total: number;
+    paid_total: number;
+    pending_total: number;
+    total_invoiced: number;
+}
+export declare const mapInvoicingInvoicePayloadToState: (payload: InvoicingInvoicePayload) => InvoicingInvoice;
+export declare const mapInvoicingInvoiceKPIsPayloadToState: (payload: InvoicingInvoiceKPIsPayload) => InvoicingInvoiceKPIs;

package/lib/entity/invoicing/invoice/invoicePayload.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingInvoiceKPIsPayloadToState = exports.mapInvoicingInvoicePayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const DEFAULT_CURRENCY_CODE = 'USD';
+const DEFAULT_CURRENCY_SYMBOL = '$';
+const mapLineItem = (payload, currencyCode, currencySymbol) => ({
+    amount: (0, amount_1.toAmount)(payload.amount, currencyCode, currencySymbol),
+    description: payload.description,
+    quantity: payload.quantity,
+    unitAmount: (0, amount_1.toAmount)(payload.unit_amount, currencyCode, currencySymbol),
+    dateFrom: payload.date_from != null ? (0, zeniDayJS_1.date)(payload.date_from) : undefined,
+    dateTo: payload.date_to != null ? (0, zeniDayJS_1.date)(payload.date_to) : undefined,
+    discountAmount: payload.discount_amount != null
+        ? (0, amount_1.toAmount)(payload.discount_amount, currencyCode, currencySymbol)
+        : undefined,
+    entityDescription: payload.entity_description,
+    entityType: payload.entity_type,
+    id: payload.id,
+    isTaxed: payload.is_taxed,
+    itemLevelDiscountAmount: payload.item_level_discount_amount != null
+        ? (0, amount_1.toAmount)(payload.item_level_discount_amount, currencyCode, currencySymbol)
+        : undefined,
+    subscriptionID: payload.subscription_id,
+    taxAmount: payload.tax_amount != null
+        ? (0, amount_1.toAmount)(payload.tax_amount, currencyCode, currencySymbol)
+        : undefined,
+    taxExemptReason: payload.tax_exempt_reason,
+    taxRate: payload.tax_rate,
+    usagePercentage: payload.usage_percentage,
+});
+const mapLinkedPayment = (payload, currencyCode, currencySymbol) => ({
+    appliedAmount: (0, amount_1.toAmount)(payload.applied_amount, currencyCode, currencySymbol),
+    txnID: payload.txn_id,
+    appliedAt: payload.applied_at != null ? (0, zeniDayJS_1.date)(payload.applied_at) : undefined,
+    txnAmount: payload.txn_amount != null
+        ? (0, amount_1.toAmount)(payload.txn_amount, currencyCode, currencySymbol)
+        : undefined,
+    txnDate: payload.txn_date != null ? (0, zeniDayJS_1.date)(payload.txn_date) : undefined,
+    txnStatus: payload.txn_status,
+});
+const mapIssuedCreditNote = (payload, currencyCode, currencySymbol) => ({
+    cnID: payload.cn_id,
+    cnStatus: payload.cn_status,
+    cnTotal: (0, amount_1.toAmount)(payload.cn_total, currencyCode, currencySymbol),
+});
+const mapDunningAttempt = (payload) => ({
+    attempt: payload.attempt,
+    createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+    dunningType: payload.dunning_type,
+    transactionID: payload.transaction_id,
+});
+const mapInvoiceNote = (payload) => ({
+    note: payload.note,
+    entityID: payload.entity_id,
+    entityType: payload.entity_type,
+});
+const mapInvoicingInvoicePayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? DEFAULT_CURRENCY_CODE;
+    const currencySymbol = DEFAULT_CURRENCY_SYMBOL;
+    const toAmt = (value) => (0, amount_1.toAmount)(value, currencyCode, currencySymbol);
+    return {
+        customerID: payload.customer_id,
+        date: (0, zeniDayJS_1.date)(payload.date),
+        id: payload.id,
+        status: payload.status,
+        total: toAmt(payload.total),
+        adjustmentCreditNotes: payload.adjustment_credit_notes,
+        amountAdjusted: payload.amount_adjusted != null
+            ? toAmt(payload.amount_adjusted)
+            : undefined,
+        amountDue: payload.amount_due != null ? toAmt(payload.amount_due) : undefined,
+        amountPaid: payload.amount_paid != null ? toAmt(payload.amount_paid) : undefined,
+        amountToCollect: payload.amount_to_collect != null
+            ? toAmt(payload.amount_to_collect)
+            : undefined,
+        billingAddress: payload.billing_address,
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        creditsApplied: payload.credits_applied != null
+            ? toAmt(payload.credits_applied)
+            : undefined,
+        currencyCode: payload.currency_code,
+        customerEmail: payload.customer_email,
+        customerName: payload.customer_name,
+        dueDate: payload.due_date != null ? (0, zeniDayJS_1.date)(payload.due_date) : undefined,
+        dunningAttempts: payload.dunning_attempts?.map(mapDunningAttempt),
+        dunningStatus: payload.dunning_status,
+        firstInvoice: payload.first_invoice,
+        generatedAt: payload.generated_at != null ? (0, zeniDayJS_1.date)(payload.generated_at) : undefined,
+        hasAdvanceCharges: payload.has_advance_charges,
+        issuedCreditNotes: payload.issued_credit_notes?.map((note) => mapIssuedCreditNote(note, currencyCode, currencySymbol)),
+        lineItems: payload.line_items?.map((item) => mapLineItem(item, currencyCode, currencySymbol)),
+        linkedPayments: payload.linked_payments?.map((payment) => mapLinkedPayment(payment, currencyCode, currencySymbol)),
+        netTermDays: payload.net_term_days,
+        nextRetryAt: payload.next_retry_at != null ? (0, zeniDayJS_1.date)(payload.next_retry_at) : undefined,
+        notes: payload.notes?.map(mapInvoiceNote),
+        paidAt: payload.paid_at != null ? (0, zeniDayJS_1.date)(payload.paid_at) : undefined,
+        pdfFileId: payload.pdf_file_id,
+        pdfUrl: payload.pdf_url,
+        invoiceNumber: payload.invoice_number,
+        poNumber: payload.po_number,
+        priceType: payload.price_type,
+        invoiceType: payload.invoice_type,
+        recurring: payload.recurring,
+        roundOffAmount: payload.round_off_amount != null
+            ? toAmt(payload.round_off_amount)
+            : undefined,
+        shippingAddress: payload.shipping_address,
+        subscriptionID: payload.subscription_id,
+        subscriptionName: payload.subscription_name,
+        subTotal: payload.sub_total != null ? toAmt(payload.sub_total) : undefined,
+        tax: payload.tax != null ? toAmt(payload.tax) : undefined,
+        updatedAt: payload.updated_at != null ? (0, zeniDayJS_1.date)(payload.updated_at) : undefined,
+        writeOffAmount: payload.write_off_amount != null
+            ? toAmt(payload.write_off_amount)
+            : undefined,
+    };
+};
+exports.mapInvoicingInvoicePayloadToState = mapInvoicingInvoicePayloadToState;
+const mapInvoicingInvoiceKPIsPayloadToState = (payload) => ({
+    dueTotal: (0, amount_1.toAmount)(payload.due_total, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    paidTotal: (0, amount_1.toAmount)(payload.paid_total, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    pendingTotal: (0, amount_1.toAmount)(payload.pending_total, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    totalInvoiced: (0, amount_1.toAmount)(payload.total_invoiced, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+});
+exports.mapInvoicingInvoiceKPIsPayloadToState = mapInvoicingInvoiceKPIsPayloadToState;

package/lib/entity/invoicing/invoice/invoiceReducer.d.ts

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingInvoicePayload } from './invoicePayload';
+import { InvoiceState } from './invoiceState';
+export declare const initialState: InvoiceState;
+export declare const updateInvoices: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingInvoicePayload[], updateType?: UpdateType | undefined], InvoicingInvoicePayload[], "invoicingInvoice/updateInvoices", never, {
+    updateType: UpdateType;
+}>, removeInvoice: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingInvoice/removeInvoice">, clearAllInvoices: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingInvoice/clearAllInvoices">;
+declare const _default: import("redux").Reducer<InvoiceState>;
+export default _default;

package/lib/entity/invoicing/invoice/invoiceReducer.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoices = exports.removeInvoice = exports.updateInvoices = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const invoicePayload_1 = require("./invoicePayload");
+exports.initialState = {
+    invoiceByID: {},
+};
+const invoice = (0, toolkit_1.createSlice)({
+    name: 'invoicingInvoice',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoices: {
+            reducer(draft, action) {
+                doUpdateInvoices(draft.invoiceByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoice(draft, action) {
+            delete draft.invoiceByID[action.payload];
+        },
+        clearAllInvoices(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoice.actions, exports.updateInvoices = _a.updateInvoices, exports.removeInvoice = _a.removeInvoice, exports.clearAllInvoices = _a.clearAllInvoices;
+exports.default = invoice.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoices(draft, payload, updateType) {
+    payload.forEach((invoicePayload) => {
+        const latestInvoice = (0, invoicePayload_1.mapInvoicingInvoicePayloadToState)(invoicePayload);
+        if (latestInvoice.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestInvoice.id], latestInvoice, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestInvoice.id] = latestInvoice;
+        }
+    });
+}

package/lib/entity/invoicing/invoice/invoiceSelector.d.ts

@@ -0,0 +1,5 @@
+import { ID } from '../../../commonStateTypes/common';
+import { RootState } from '../../../reducer';
+import { InvoicingInvoice } from './invoiceState';
+export declare const getInvoiceById: (state: RootState, invoiceId: ID) => InvoicingInvoice | undefined;
+export declare const getInvoicesByIds: (state: RootState, invoiceIds: ID[]) => InvoicingInvoice[];

package/lib/entity/invoicing/invoice/invoiceSelector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicesByIds = exports.getInvoiceById = void 0;
+const getInvoiceById = (state, invoiceId) => state.invoicingInvoiceState.invoiceByID[invoiceId];
+exports.getInvoiceById = getInvoiceById;
+const getInvoicesByIds = (state, invoiceIds) => invoiceIds
+    .map((id) => state.invoicingInvoiceState.invoiceByID[id])
+    .filter((invoice) => invoice != null);
+exports.getInvoicesByIds = getInvoicesByIds;

package/lib/entity/invoicing/invoice/invoiceState.d.ts

@@ -0,0 +1,103 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingBillingAddressPayload, InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingInvoiceStatus } from './invoicePayload';
+export interface InvoicingLineItem {
+    amount: Amount;
+    description: string;
+    quantity: number;
+    unitAmount: Amount;
+    dateFrom?: ZeniDate;
+    dateTo?: ZeniDate;
+    discountAmount?: Amount;
+    entityDescription?: string;
+    entityType?: string;
+    id?: ID;
+    isTaxed?: boolean;
+    itemLevelDiscountAmount?: Amount;
+    subscriptionID?: ID;
+    taxAmount?: Amount;
+    taxExemptReason?: string;
+    taxRate?: number;
+    usagePercentage?: number;
+}
+export interface InvoicingLinkedPayment {
+    appliedAmount: Amount;
+    txnID: ID;
+    appliedAt?: ZeniDate;
+    txnAmount?: Amount;
+    txnDate?: ZeniDate;
+    txnStatus?: string;
+}
+export interface InvoicingIssuedCreditNote {
+    cnID: ID;
+    cnStatus: string;
+    cnTotal: Amount;
+}
+export interface InvoicingDunningAttempt {
+    attempt: number;
+    createdAt?: ZeniDate;
+    dunningType?: string;
+    transactionID?: ID;
+}
+export interface InvoicingInvoiceNote {
+    note: string;
+    entityID?: ID;
+    entityType?: string;
+}
+export interface InvoicingInvoice {
+    customerID: ID;
+    date: ZeniDate;
+    id: ID;
+    status: InvoicingInvoiceStatus;
+    total: Amount;
+    adjustmentCreditNotes?: ID[];
+    amountAdjusted?: Amount;
+    amountDue?: Amount;
+    amountPaid?: Amount;
+    amountToCollect?: Amount;
+    billingAddress?: InvoicingBillingAddressPayload;
+    createdAt?: ZeniDate;
+    creditsApplied?: Amount;
+    currencyCode?: string;
+    customerEmail?: string;
+    customerName?: string;
+    dueDate?: ZeniDate;
+    dunningAttempts?: InvoicingDunningAttempt[];
+    dunningStatus?: string;
+    firstInvoice?: boolean;
+    generatedAt?: ZeniDate;
+    hasAdvanceCharges?: boolean;
+    invoiceNumber?: string;
+    invoiceType?: 'one_time' | 'recurring';
+    issuedCreditNotes?: InvoicingIssuedCreditNote[];
+    lineItems?: InvoicingLineItem[];
+    linkedPayments?: InvoicingLinkedPayment[];
+    netTermDays?: number;
+    nextRetryAt?: ZeniDate;
+    notes?: InvoicingInvoiceNote[];
+    paidAt?: ZeniDate;
+    pdfFileId?: ID;
+    pdfUrl?: string;
+    poNumber?: string;
+    priceType?: InvoicingPriceType;
+    recurring?: boolean;
+    roundOffAmount?: Amount;
+    shippingAddress?: InvoicingBillingAddressPayload;
+    subscriptionID?: ID;
+    subscriptionName?: string;
+    subTotal?: Amount;
+    tax?: Amount;
+    updatedAt?: ZeniDate;
+    writeOffAmount?: Amount;
+}
+export interface InvoicingInvoiceKPIs {
+    dueTotal: Amount;
+    paidTotal: Amount;
+    pendingTotal: Amount;
+    totalInvoiced: Amount;
+}
+export interface InvoiceState {
+    invoiceByID: Record<ID, InvoicingInvoice>;
+}

package/lib/entity/invoicing/invoice/invoiceState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/entity/invoicing/invoicingCommonPayload.d.ts

@@ -0,0 +1,67 @@
+export interface InvoicingBillingAddressPayload {
+    city?: string;
+    company?: string;
+    country?: string;
+    email?: string;
+    first_name?: string;
+    last_name?: string;
+    line1?: string;
+    line2?: string;
+    phone?: string;
+    state_code?: string;
+    validation_status?: 'not_validated' | 'valid' | 'partially_valid' | 'invalid';
+    zip?: string;
+}
+export type InvoicingPriceType = 'tax_exclusive' | 'tax_inclusive';
+/**
+ * A single select-field option (label + typed value) owned by CES so the value
+ * sets that back string-union domain fields live next to those unions and are
+ * passed to the form views, rather than being hardcoded in web-components.
+ */
+export interface InvoicingFormOption<T extends string = string> {
+    label: string;
+    value: T;
+}
+/** Status -> count map for list tab badges; always includes an `all` total. */
+export type InvoicingListCounts = Record<string, number> & {
+    all: number;
+};
+/** Cursor-paginated list envelope returned by Invoicing list endpoints. */
+export interface InvoicingPaginatedList<T> {
+    items: T[];
+    next_cursor: string | null;
+}
+export interface InvoicingSettingsPayload {
+    accent_color?: string;
+    address?: string;
+    address_enabled?: boolean;
+    auto_collection?: 'on' | 'off';
+    chargebee_connected?: boolean;
+    chargebee_site?: string;
+    company_name?: string;
+    currency?: string;
+    currency_code?: string;
+    currency_symbol?: string;
+    date_format?: string;
+    default_memo?: string;
+    dunning_max_attempts?: number;
+    dunning_retry_interval?: number;
+    email?: string;
+    id?: string;
+    invoice_prefix?: string;
+    logo_file_id?: string;
+    logo_url?: string;
+    net_term_days?: number;
+    payment_terms?: string;
+    phone?: string;
+    phone_enabled?: boolean;
+    show_service_periods?: boolean;
+    show_tax_id?: boolean;
+    stripe_connected?: boolean;
+    stripe_connected_account_id?: string;
+    stripe_publishable_key?: string;
+    tax_enabled?: boolean;
+    tax_id?: string;
+    tax_rate?: number;
+    timezone?: string;
+}

package/lib/entity/invoicing/invoicingCommonPayload.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/entity/invoicing/invoicingCommonState.d.ts

@@ -0,0 +1,40 @@
+import { ID } from '../../commonStateTypes/common';
+import { ZeniUrl } from '../../zeniUrl';
+export interface InvoicingBillingAddress {
+    city?: string;
+    company?: string;
+    country?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    line1?: string;
+    line2?: string;
+    phone?: string;
+    stateCode?: string;
+    validation_status?: 'not_validated' | 'valid' | 'partially_valid' | 'invalid';
+    zip?: string;
+}
+export interface InvoicingSettings {
+    addressEnabled: boolean;
+    autoCollection: 'on' | 'off';
+    chargebeeConnected: boolean;
+    chargebeeSite: string;
+    companyName: string;
+    dateFormat: string;
+    defaultMemo: string;
+    phoneEnabled: boolean;
+    taxEnabled: boolean;
+    accentColor?: string;
+    address?: InvoicingBillingAddress;
+    dunningMaxAttempts?: number;
+    dunningRetryInterval?: number;
+    email?: string;
+    id?: ID;
+    invoicePrefix?: string;
+    logoUrl?: ZeniUrl;
+    phone?: string;
+    stripeConnectedAccountId?: ID;
+    stripePublishableKey?: ID;
+    taxId?: ID;
+    taxRate?: number;
+}

package/lib/entity/invoicing/invoicingCommonState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerPayload.d.ts

@@ -0,0 +1,55 @@
+import { InvoicingBillingAddressPayload, InvoicingListCounts } from '../invoicingCommonPayload';
+import { InvoicingSubscriptionPayload } from '../invoicingSubscription/invoicingSubscriptionPayload';
+import { InvoicingCustomer } from './invoicingCustomerState';
+export interface InvoicingCustomerPayload {
+    id: string;
+    arr?: number;
+    auto_collection?: 'on' | 'off';
+    billing_address?: InvoicingBillingAddressPayload;
+    billing_address_id?: string;
+    card_status?: 'no_card' | 'valid' | 'expiring' | 'expired';
+    company?: string;
+    consolidated_invoicing?: boolean;
+    created_at?: string;
+    customer_type?: 'residential' | 'business';
+    default_payment_method_id?: string;
+    email?: string;
+    excess_payments?: number;
+    first_name?: string;
+    fraud_flag?: 'safe' | 'suspicious' | 'fraudulent';
+    initials?: string;
+    invoice_notes?: string;
+    is_at_risk?: boolean;
+    last_name?: string;
+    lifetime_value?: number;
+    locale?: string;
+    mrr?: number;
+    net_term_days?: number;
+    payment_method?: string;
+    payment_method_last4?: string;
+    payment_method_type?: 'ach' | 'card' | 'none';
+    phone?: string;
+    plan?: string;
+    plan_name?: string;
+    preferred_currency_code?: string;
+    preferred_currency_symbol?: string;
+    promotional_credits?: number;
+    refundable_credits?: number;
+    status?: string;
+    stripe_customer_id?: string;
+    subscriptions?: InvoicingSubscriptionPayload[];
+    taxability?: 'taxable' | 'exempt';
+    total_receivable?: number;
+    unbilled_charges?: number;
+    updated_at?: string;
+    vat_number?: string;
+}
+export interface InvoicingCustomerCounts extends InvoicingListCounts {
+    active: number;
+    at_risk: number;
+    churned: number;
+    not_churned: number;
+    total: number;
+    trial: number;
+}
+export declare const mapInvoicingCustomerPayloadToState: (payload: InvoicingCustomerPayload) => InvoicingCustomer;