@smartbills/sdk 1.1.0-alpha.16 → 1.1.0-alpha.18

package/dist/types/index.d.ts

@@ -1393,7 +1393,7 @@ interface SBSubscription {
     canceledAt?: string;
 }
 /** Represents a billing invoice issued to the business. */
-interface SBInvoice {
+interface SBBillingInvoice {
     id: string;
     number?: string;
     status: string;
@@ -1416,10 +1416,10 @@ interface SBUpcomingInvoice {
     currency: string;
     periodStart?: string;
     periodEnd?: string;
-    lines?: SBInvoiceLine[];
+    lines?: SBBillingInvoiceLine[];
 }
-/** A single line item on an invoice. */
-interface SBInvoiceLine {
+/** A single line item on a billing invoice. */
+interface SBBillingInvoiceLine {
     description?: string;
     amount: number;
     currency: string;
@@ -1455,7 +1455,7 @@ interface SBPortalSession {
     url: string;
 }
 /** Query parameters for listing billing invoices. */
-interface InvoiceListRequest {
+interface BillingInvoiceListRequest {
     page?: number;
     pageSize?: number;
 }
@@ -1508,9 +1508,9 @@ declare class BillingService extends BaseService {
     /** Validates whether the business can downgrade to a lower plan without losing features. */
     validateDowngrade(data: UpgradeSubscriptionRequest, options?: RequestOptions): Promise<SBDowngradeValidation>;
     /** Lists billing invoices for the business with pagination support. */
-    listInvoices(params?: InvoiceListRequest, options?: RequestOptions): Promise<SBListResponse<SBInvoice>>;
+    listInvoices(params?: BillingInvoiceListRequest, options?: RequestOptions): Promise<SBListResponse<SBBillingInvoice>>;
     /** Retrieves a specific billing invoice by its Stripe ID. */
-    getInvoice(invoiceId: string, options?: RequestOptions): Promise<SBInvoice>;
+    getInvoice(invoiceId: string, options?: RequestOptions): Promise<SBBillingInvoice>;
     /** Retrieves the upcoming invoice preview based on the current subscription. */
     getUpcomingInvoice(options?: RequestOptions): Promise<SBUpcomingInvoice>;
     /** Retrieves current usage across all quota keys for the business. */
@@ -6209,80 +6209,108 @@ declare class DepartmentService extends BaseService {
     delete(id: number, options?: RequestOptions): Promise<void>;
 }
 
-/** Represents a product or service offered by the business. */
 interface SBProduct extends SBEntity, SBTimestamps {
     name: string;
     description?: string;
     price?: number;
+    compareAtPrice?: number;
+    cost?: number;
     sku?: string;
+    barcode?: string;
+    image?: string;
+    images?: SBProductImage[];
+    category?: string;
+    isActive?: boolean;
+    taxable?: boolean;
+    taxCode?: string;
+    trackInventory?: boolean;
+    stockQuantity?: number;
+    lowStockThreshold?: number;
+    weight?: number;
+    weightUnit?: string;
+    currency?: string;
+    status?: string;
+    active?: boolean;
+}
+interface SBProductImage {
+    id?: number;
+    src: string;
+    position?: number;
 }
-/** Query parameters for listing products with optional search. */
 interface ProductListRequest extends PaginationRequest {
     search?: string;
 }
+interface ProductCreateRequest {
+    name: string;
+    description?: string;
+    price?: number;
+    compareAtPrice?: number;
+    cost?: number;
+    sku?: string;
+    barcode?: string;
+    category?: string;
+    taxable?: boolean;
+    taxCode?: string;
+    trackInventory?: boolean;
+    stockQuantity?: number;
+}
+interface ProductUpdateRequest {
+    name?: string;
+    description?: string;
+    price?: number;
+    compareAtPrice?: number;
+    cost?: number;
+    sku?: string;
+    barcode?: string;
+    category?: string;
+    taxable?: boolean;
+    taxCode?: string;
+    trackInventory?: boolean;
+    stockQuantity?: number;
+}
 
-/**
- * Service for managing products within a business.
- *
- * Products represent the goods or services sold by the business
- * and appear on receipts and invoices.
- */
 declare class ProductService extends BaseService {
-    /**
-     * Retrieves a paginated list of products.
-     *
-     * @param params - Optional filters, search, and pagination parameters
-     * @param options - Request options including business context and abort signal
-     * @returns A paginated list of products
-     */
     list(params?: ProductListRequest, options?: RequestOptions): Promise<SBListResponse<SBProduct>>;
-    /**
-     * Retrieves a single product by ID.
-     *
-     * @param id - The product ID
-     * @param options - Request options including business context and abort signal
-     * @returns The product
-     * @throws {SmartbillsNotFoundError} If the product is not found
-     */
     getById(id: number, options?: RequestOptions): Promise<SBProduct>;
+    create(data: ProductCreateRequest, options?: RequestOptions): Promise<SBProduct>;
+    update(id: number, data: ProductUpdateRequest, options?: RequestOptions): Promise<SBProduct>;
+    delete(id: number, options?: RequestOptions): Promise<void>;
 }
 
-/** Represents a tax rate configured for a business. */
 interface SBTax extends SBEntity, SBTimestamps {
     name: string;
-    rate: number;
-    code?: string;
-    isDefault?: boolean;
+    percentage: number;
+    description?: string;
+    country?: string;
+    state?: string;
+    jurisdiction?: string;
+    type?: string;
+    inclusive?: boolean;
+    isActive?: boolean;
+    taxIdentificationNumber?: string;
 }
-/** Query parameters for listing tax rates with optional search. */
 interface TaxListRequest extends PaginationRequest {
     search?: string;
 }
+interface TaxCreateRequest {
+    name: string;
+    percentage: number;
+    description?: string;
+    country?: string;
+    state?: string;
+    jurisdiction?: string;
+    type?: string;
+    inclusive?: boolean;
+    taxIdentificationNumber?: string;
+}
+type TaxUpdateRequest = Partial<TaxCreateRequest>;
 
-/**
- * Service for managing tax configurations within a business.
- *
- * Taxes define the tax rates applied to receipts, invoices, and
- * expense items (e.g., GST, HST, PST, VAT).
- */
 declare class TaxService extends BaseService {
-    /**
-     * Retrieves a paginated list of tax configurations.
-     *
-     * @param params - Optional filters and pagination parameters
-     * @param options - Request options including business context and abort signal
-     * @returns A paginated list of tax configurations
-     */
     list(params?: TaxListRequest, options?: RequestOptions): Promise<SBListResponse<SBTax>>;
-    /**
-     * Retrieves a single tax configuration by ID.
-     *
-     * @param id - The tax ID
-     * @param options - Request options including business context and abort signal
-     * @returns The tax configuration
-     * @throws {SmartbillsNotFoundError} If the tax is not found
-     */
     getById(id: number, options?: RequestOptions): Promise<SBTax>;
+    create(data: TaxCreateRequest, options?: RequestOptions): Promise<SBTax>;
+    update(id: number, data: TaxUpdateRequest, options?: RequestOptions): Promise<SBTax>;
+    delete(id: number, options?: RequestOptions): Promise<void>;
 }
 
 /** Represents a promotional code that can be applied to receipts or transactions. */
@@ -6311,7 +6339,10 @@ declare class PromoCodeService extends BaseService {
     getById(id: number, options?: RequestOptions): Promise<SBPromoCode>;
 }
 
-/** Represents an expense category used to classify and organize expenses. */
+interface CategoryListRequest extends PaginationRequest {
+    search?: string;
+    isVisible?: boolean;
+}
 interface SBCategory extends SBEntity, SBTimestamps {
     name: string;
     code?: string;
@@ -6319,27 +6350,16 @@ interface SBCategory extends SBEntity, SBTimestamps {
     businessId?: number;
     userId?: number;
 }
-/** Payload for creating a new expense category. */
 interface CategoryCreateRequest {
     name: string;
     code?: string;
     isVisible?: boolean;
 }
-/** Payload for updating an existing expense category. */
 interface CategoryUpdateRequest {
     name?: string;
     code?: string;
     isVisible?: boolean;
 }
-/** Query parameters for listing categories with optional filters. */
-interface CategoryListRequest extends PaginationRequest {
-    search?: string;
-    isVisible?: boolean;
-}
-/** Request parameters for listing expense categories. */
-interface CategoryListRequest {
-    search?: string;
-}
 
 /**
  * Service for managing expense categories within a business.
@@ -6840,6 +6860,466 @@ declare class LoyaltyService extends BaseService {
     delete(id: string, options?: RequestOptions): Promise<void>;
 }
 
+declare enum InvoiceStatus {
+    DRAFT = "Draft",
+    SENT = "Sent",
+    VIEWED = "Viewed",
+    PARTIALLY_PAID = "PartiallyPaid",
+    PAID = "Paid",
+    MARKED_PAID = "MarkedPaid",
+    OVERDUE = "Overdue",
+    CANCELLED = "Cancelled",
+    VOID = "Void"
+}
+interface SBInvoiceCustomer {
+    id?: number;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phoneNumber?: string;
+    company?: string;
+}
+interface SBInvoiceLineItemTax {
+    id?: number;
+    name?: string;
+    rate?: number;
+    amount?: SBMoney;
+    taxId?: number;
+}
+interface SBInvoiceLineItem {
+    id?: number;
+    description?: string;
+    quantity?: number;
+    unitPrice?: number;
+    price?: SBMoney;
+    subTotal?: SBMoney;
+    total?: SBMoney;
+    amount?: number;
+    productId?: number;
+    product?: {
+        id?: number;
+        name?: string;
+        sku?: string;
+    };
+    taxable?: boolean;
+    taxIds?: number[];
+    taxes?: SBInvoiceLineItemTax[];
+}
+interface SBInvoice extends SBEntity, SBTimestamps {
+    invoiceNumber?: string;
+    billStatus?: string;
+    dueDate?: string;
+    date?: string;
+    billingPeriodStartDate?: string;
+    billingPeriodEndDate?: string;
+    autoPaymentDate?: string;
+    amountDue?: SBMoney;
+    balanceForward?: SBMoney;
+    isOverdue?: boolean;
+    isPaid?: boolean;
+    paymentLinkToken?: string;
+    paymentLinkUrl?: string;
+    stripePaymentIntentId?: string;
+    sentAt?: string;
+    viewedAt?: string;
+    voidedAt?: string;
+    paidOn?: string;
+    customerId?: number;
+    vendorId?: number;
+    total?: SBMoney;
+    subTotal?: SBMoney;
+    totalTaxes?: SBMoney;
+    totalDiscounts?: SBMoney;
+    totalFees?: SBMoney;
+    totalBeforeTax?: SBMoney;
+    currency?: string;
+    hostedUrl?: string;
+    shortUrl?: string;
+    note?: string;
+    lineItems?: SBInvoiceLineItem[];
+    billingAddress?: SBAddress;
+    shippingAddress?: SBAddress;
+    reminders?: InvoiceReminder[];
+    customer?: SBInvoiceCustomer;
+}
+interface InvoiceListRequest extends PaginationRequest {
+    status?: string;
+    customerId?: number;
+    dateFrom?: string;
+    dateTo?: string;
+    minAmount?: number;
+    maxAmount?: number;
+    search?: string;
+}
+declare enum InvoiceReminderFrequency {
+    ONCE = "ONCE",
+    WEEKLY = "WEEKLY",
+    BIWEEKLY = "BIWEEKLY",
+    MONTHLY = "MONTHLY"
+}
+declare enum InvoiceReminderTiming {
+    BEFORE_DUE = "BEFORE_DUE",
+    ON_DUE = "ON_DUE",
+    AFTER_DUE = "AFTER_DUE"
+}
+interface InvoiceReminder {
+    id?: number;
+    enabled: boolean;
+    timing: InvoiceReminderTiming;
+    daysOffset: number;
+    frequency: InvoiceReminderFrequency;
+    maxReminders: number;
+    message?: string;
+}
+interface InvoiceCreateRequest {
+    invoiceNumber?: string;
+    date?: string;
+    dueDate?: string;
+    billingPeriodStartDate?: string;
+    billingPeriodEndDate?: string;
+    autoPaymentDate?: string;
+    amountDue?: SBMoney;
+    balanceForward?: SBMoney;
+    paymentLinkUrl?: string;
+    customerId?: number;
+    vendorId?: number;
+    currency?: string;
+    note?: string;
+    lineItems?: Omit<SBInvoiceLineItem, "id" | "product" | "taxes" | "price" | "subTotal" | "total">[];
+    billingAddress?: SBAddress;
+    shippingAddress?: SBAddress;
+    reminders?: InvoiceReminder[];
+}
+type InvoiceUpdateRequest = Partial<InvoiceCreateRequest>;
+interface InvoiceSummary {
+    totalRevenue: number;
+    outstanding: number;
+    overdueCount: number;
+    paidThisMonth: number;
+    totalCount: number;
+    draftCount: number;
+    sentCount: number;
+    paidCount: number;
+}
+
+declare class InvoiceService extends BaseService {
+    list(params?: InvoiceListRequest, options?: RequestOptions): Promise<SBListResponse<SBInvoice>>;
+    getById(id: number, options?: RequestOptions): Promise<SBInvoice>;
+    create(data: InvoiceCreateRequest, options?: RequestOptions): Promise<SBInvoice>;
+    update(id: number, data: InvoiceUpdateRequest, options?: RequestOptions): Promise<SBInvoice>;
+    delete(id: number, options?: RequestOptions): Promise<void>;
+    send(id: number, options?: RequestOptions): Promise<SBInvoice>;
+    void(id: number, options?: RequestOptions): Promise<SBInvoice>;
+    markPaid(id: number, options?: RequestOptions): Promise<SBInvoice>;
+    duplicate(id: number, options?: RequestOptions): Promise<SBInvoice>;
+    getSummary(options?: RequestOptions): Promise<InvoiceSummary>;
+    downloadPdf(id: number, options?: RequestOptions): Promise<Blob>;
+    getByPaymentToken(token: string): Promise<SBInvoice>;
+}
+
+declare enum ConnectedAccountStatus {
+    PENDING = "PENDING",
+    RESTRICTED = "RESTRICTED",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    REJECTED = "REJECTED"
+}
+declare enum ConnectedAccountType {
+    EXPRESS = "EXPRESS",
+    STANDARD = "STANDARD",
+    CUSTOM = "CUSTOM"
+}
+interface SBConnectedAccount extends SBEntity, SBTimestamps {
+    businessId: number;
+    stripeAccountId?: string;
+    accountType: ConnectedAccountType;
+    status: ConnectedAccountStatus;
+    chargesEnabled: boolean;
+    payoutsEnabled: boolean;
+    detailsSubmitted: boolean;
+    businessName?: string;
+    businessUrl?: string;
+    country?: string;
+    defaultCurrency?: string;
+    email?: string;
+    applicationFeePercent: number;
+    applicationFeeFixedAmount: number;
+    applicationFeeCurrency: string;
+    disabledReason?: string;
+    currentlyDue?: string;
+    pastDue?: string;
+    bankAccountLast4?: string;
+    bankAccountBankName?: string;
+    bankAccountCurrency?: string;
+    bankAccountCountry?: string;
+    bankAccountRoutingLast4?: string;
+    stripeDashboardUrl?: string;
+    acceptedPaymentMethods: string;
+    defaultPaymentTermsDays: number;
+    smsNotificationsEnabled: boolean;
+    automaticTaxEnabled: boolean;
+}
+interface ConnectedAccountOnboardingRequest {
+    returnUrl: string;
+    refreshUrl: string;
+    businessName?: string;
+    email?: string;
+    country?: string;
+    businessUrl?: string;
+}
+interface ConnectedAccountOnboardingResult {
+    onboardingUrl: string;
+    expiresAt: string;
+    account: SBConnectedAccount;
+}
+interface FeeConfigurationRequest {
+    applicationFeePercent: number;
+    applicationFeeFixedAmount: number;
+    applicationFeeCurrency: string;
+}
+interface ConnectedAccountSettingsRequest {
+    acceptedPaymentMethods?: string;
+    defaultPaymentTermsDays?: number;
+    smsNotificationsEnabled?: boolean;
+    automaticTaxEnabled?: boolean;
+}
+
+declare class ConnectedAccountService extends BaseService {
+    get(options?: RequestOptions): Promise<SBConnectedAccount>;
+    getStatus(options?: RequestOptions): Promise<SBConnectedAccount>;
+    createOnboardingLink(data: ConnectedAccountOnboardingRequest, options?: RequestOptions): Promise<ConnectedAccountOnboardingResult>;
+    refreshOnboardingLink(data: Pick<ConnectedAccountOnboardingRequest, "returnUrl" | "refreshUrl">, options?: RequestOptions): Promise<{
+        url: string;
+    }>;
+    createLoginLink(options?: RequestOptions): Promise<{
+        url: string;
+    }>;
+    updateFees(data: FeeConfigurationRequest, options?: RequestOptions): Promise<SBConnectedAccount>;
+    updateSettings(data: ConnectedAccountSettingsRequest, options?: RequestOptions): Promise<SBConnectedAccount>;
+    disable(options?: RequestOptions): Promise<void>;
+}
+
+declare enum InvoicePaymentStatus {
+    PENDING = "Pending",
+    PROCESSING = "Processing",
+    SUCCEEDED = "Succeeded",
+    FAILED = "Failed",
+    CANCELED = "Canceled",
+    REFUNDED = "Refunded",
+    PARTIALLY_REFUNDED = "PartiallyRefunded",
+    DISPUTED = "Disputed",
+    EXPIRED = "Expired"
+}
+interface SBInvoicePayment extends SBEntity, SBTimestamps {
+    connectedAccountId: number;
+    businessId: number;
+    invoiceId: number;
+    externalInvoiceId?: string;
+    status: InvoicePaymentStatus;
+    amount: number;
+    tipAmount: number;
+    applicationFeeAmount: number;
+    netAmount: number;
+    currency: string;
+    stripePaymentIntentId?: string;
+    stripeCheckoutSessionId?: string;
+    checkoutUrl?: string;
+    paymentMethodType?: string;
+    paymentMethodLast4?: string;
+    paymentMethodBrand?: string;
+    customerEmail?: string;
+    customerName?: string;
+    failureCode?: string;
+    failureMessage?: string;
+    clientSecret?: string;
+    paidAt?: string;
+}
+interface CheckoutLineItem {
+    description: string;
+    quantity: number;
+    unitAmount: number;
+    taxRateIds?: string[];
+}
+interface InvoicePaymentCreateRequest {
+    invoiceId: number;
+    amount: number;
+    tipAmount?: number;
+    currency?: string;
+    customerEmail?: string;
+    customerName?: string;
+    successUrl?: string;
+    cancelUrl?: string;
+    invoiceNumber?: string;
+    lineItems?: CheckoutLineItem[];
+}
+interface InvoicePaymentFilterRequest {
+    status?: InvoicePaymentStatus;
+    dateFrom?: string;
+    dateTo?: string;
+    page?: number;
+    pageSize?: number;
+}
+interface SBRefund extends SBEntity, SBTimestamps {
+    invoicePaymentId: number;
+    stripeRefundId?: string;
+    amount: number;
+    currency: string;
+    reason?: string;
+    status: string;
+    failureReason?: string;
+    notes?: string;
+    applicationFeeReversed: boolean;
+}
+interface RefundCreateRequest {
+    amount?: number;
+    reason?: string;
+    notes?: string;
+}
+interface SBDispute extends SBEntity, SBTimestamps {
+    invoicePaymentId: number;
+    stripeDisputeId?: string;
+    amount: number;
+    currency: string;
+    reason?: string;
+    status: string;
+    evidenceDueBy?: string;
+    isEvidenceSubmitted: boolean;
+}
+interface DisputeEvidenceRequest {
+    uncategorizedText?: string;
+    customerCommunication?: string;
+    serviceDocumentation?: string;
+}
+interface LedgerSummary {
+    grossRevenue: number;
+    smartbillsFees: number;
+    stripeProcessingFees: number;
+    refundsIssued: number;
+    disputedAmount: number;
+    netRevenue: number;
+    currency: string;
+    periodStart: string;
+    periodEnd: string;
+}
+interface LedgerEntry {
+    id: number;
+    type: string;
+    description: string;
+    invoicePaymentId?: number;
+    grossAmount: number;
+    feeAmount: number;
+    netAmount: number;
+    currency: string;
+    status: string;
+    stripeId?: string;
+    createdAt: string;
+}
+interface Payout {
+    stripePayoutId: string;
+    amount: number;
+    currency: string;
+    status: string;
+    arrivalDate?: string;
+    bankAccountLast4?: string;
+    description?: string;
+    createdAt: string;
+}
+interface PagedResult<T> {
+    items: T[];
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+
+declare class InvoicePaymentService extends BaseService {
+    create(data: InvoicePaymentCreateRequest, options?: RequestOptions): Promise<SBInvoicePayment>;
+    list(params?: InvoicePaymentFilterRequest, options?: RequestOptions): Promise<PagedResult<SBInvoicePayment>>;
+    getById(id: number, options?: RequestOptions): Promise<SBInvoicePayment>;
+    cancel(id: number, options?: RequestOptions): Promise<SBInvoicePayment>;
+    createRefund(paymentId: number, data: RefundCreateRequest, options?: RequestOptions): Promise<SBRefund>;
+    listRefunds(paymentId: number, options?: RequestOptions): Promise<SBRefund[]>;
+    listDisputes(params?: {
+        page?: number;
+        pageSize?: number;
+    }, options?: RequestOptions): Promise<SBDispute[]>;
+    submitEvidence(disputeId: number, data: DisputeEvidenceRequest, options?: RequestOptions): Promise<SBDispute>;
+    acceptDispute(disputeId: number, options?: RequestOptions): Promise<SBDispute>;
+    getLedgerSummary(from: string, to: string, options?: RequestOptions): Promise<LedgerSummary>;
+    getLedgerEntries(params?: Record<string, unknown>, options?: RequestOptions): Promise<LedgerEntry[]>;
+    getPayouts(params?: Record<string, unknown>, options?: RequestOptions): Promise<Payout[]>;
+    exportLedgerCsv(from: string, to: string, options?: RequestOptions): Promise<Blob>;
+}
+
+declare enum PayoutStatus {
+    PAID = "paid",
+    PENDING = "pending",
+    IN_TRANSIT = "in_transit",
+    CANCELED = "canceled",
+    FAILED = "failed"
+}
+declare enum PayoutInterval {
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly",
+    MANUAL = "manual"
+}
+interface SBPayout {
+    id: string;
+    amount: number;
+    currency: string;
+    status: string;
+    arrivalDate: string;
+    method?: string;
+    description?: string;
+    failureCode?: string;
+    failureMessage?: string;
+    createdAt: string;
+}
+interface PayoutListRequest {
+    page?: number;
+    pageSize?: number;
+    startingAfter?: string;
+    endingBefore?: string;
+}
+interface PayoutListResponse {
+    data: SBPayout[];
+    hasMore: boolean;
+}
+interface CreatePayoutRequest {
+    amount: number;
+    currency?: string;
+    description?: string;
+}
+interface PayoutSchedule {
+    interval: string;
+    delayDays?: number;
+    weeklyAnchor?: string;
+    monthlyAnchor?: number;
+}
+interface UpdatePayoutScheduleRequest {
+    interval: string;
+    weeklyAnchor?: string;
+    monthlyAnchor?: number;
+    delayDays?: number;
+}
+interface BalanceAmount {
+    amount: number;
+    currency: string;
+}
+interface SBBalance {
+    available: BalanceAmount[];
+    pending: BalanceAmount[];
+}
+
+declare class PayoutService extends BaseService {
+    list(params?: PayoutListRequest, options?: RequestOptions): Promise<PayoutListResponse>;
+    create(data: CreatePayoutRequest, options?: RequestOptions): Promise<SBPayout>;
+    getSchedule(options?: RequestOptions): Promise<PayoutSchedule>;
+    updateSchedule(data: UpdatePayoutScheduleRequest, options?: RequestOptions): Promise<PayoutSchedule>;
+    getBalance(options?: RequestOptions): Promise<SBBalance>;
+}
+
 /**
  * Configuration options for initializing a {@link SmartbillsClient}.
  */
@@ -6920,6 +7400,10 @@ declare class SmartbillsClient {
     readonly emailForwarding: EmailForwardingService;
     readonly authorizedSenders: AuthorizedSenderService;
     readonly loyalty: LoyaltyService;
+    readonly invoices: InvoiceService;
+    readonly connectedAccounts: ConnectedAccountService;
+    readonly invoicePayments: InvoicePaymentService;
+    readonly payouts: PayoutService;
     /**
      * Creates a new Smartbills client instance.
      *
@@ -7111,5 +7595,5 @@ declare function isRetryableError(error: unknown): boolean;
 
 declare function uploadFileToS3(uploadUrl: string, file: Blob | ArrayBuffer, contentType: string): Promise<void>;
 
-export { AccessToken, AppInstallationService, AppInstallationStatus, ApprobationService, AttachmentService, AuthorizedSenderService, BaseService, BillApprovalStatus, BillApprovalType, BillService, BillStatus, BillingService, BusinessService, BusinessUserService, CategoryService, CheckoutDocumentType, CheckoutPaymentStatus, CheckoutService, CheckoutStatus, ConnectAccountStatus, ConnectService, CustomerService, DEFAULT_BASE_URL, DepartmentService, EmailAccountService, EmailAccountStatus, EmailAccountSyncStatus, EmailAccountType, EmailForwardingService, EmployeeService, ErrorCode, ExpenseItemStatus, ExpenseJobService, ExpenseReportAuditLogAction, ExpenseReportExpenseService, ExpenseReportPaymentService, ExpenseReportService, ExpenseReportStatus, ExpenseService, ExpenseSplitType, HttpClient, IntegrationService, IntegrationStatus, InvitationService, InvitationStatus, LocationService, LoyaltyService, MailboxType, MembershipRole, MembershipService, NotificationService, NotificationType, PayerType, PaymentMethodService, ProductService, PromoCodeService, ReceiptPaymentStatus, ReceiptPaymentType, ReceiptService, ReceiptSource, ReceiptType, ReportingService, SmartbillsApiError, SmartbillsAuthenticationError, SmartbillsClient, SmartbillsConflictError, SmartbillsError, SmartbillsNetworkError, SmartbillsNotFoundError, SmartbillsPermissionError, SmartbillsQuotaError, SmartbillsRateLimitError, SmartbillsValidationError, SyncTriggerType, TableService, TaxService, TransactionService, TransactionType, UserService, VendorConnectionService, VendorConnectionStatus, VendorService, WorkflowService, WorkflowTriggerType, isApiError, isAuthenticationError, isConflictError, isNetworkError, isNotFoundError, isPermissionError, isQuotaError, isRateLimitError, isRetryableError, isSmartbillsError, isValidationError, uploadFileToS3 };
-export type { AddExpenseToReportRequest, AddExpensesToReportBatchRequest, ApprobationListRequest, AssociateExpenseReportUpdateRequest, AttachmentListRequest, AttachmentRenameRequest, BillApprovalRequest, BillBatchUpdateRequest, BillCancelRequest, BillCreateRequest, BillListRequest, BillMarkPaidRequest, BillReschedulePaymentRequest, BillRetryPaymentRequest, BillSchedulePaymentRequest, BillSubmitForApprovalRequest, BillTransitionRequest, BillUpdateRequest, BulkApproveApprobationsRequest, BulkAssignCategoryRequest, BulkAssignExpenseReportRequest, BulkAssignPayerTypeRequest, BulkAssignReportCategoryRequest, BulkAssignVendorRequest, BulkBillApproveRequest, BulkBillCancelPaymentRequest, BulkBillDeleteRequest, BulkBillMarkPaidRequest, BulkBillRemindRequest, BulkBillRetryPaymentRequest, BulkBillSchedulePaymentRequest, BulkBillUnscheduleRequest, BulkBillUpdateRequest, BulkDeleteExpenseReportsRequest, BulkDeleteExpensesRequest, BulkDeleteVendorsRequest, BulkMarkReimbursedApprobationsRequest, BulkPlanReimbursementApprobationsRequest, BulkRecallExpenseReportsRequest, BulkRejectApprobationsRequest, BulkRemoveReportExpensesRequest, BulkRequestChangesApprobationsRequest, BulkRevertToReviewApprobationsRequest, BulkSetNoteRequest, BulkSubmitExpenseReportsRequest, BusinessBatchUpdateRequest, BusinessBrandCreateRequest, BusinessBrandUpdateRequest, BusinessCreateRequest, BusinessUpdateRequest, CategoryCreateRequest, CategoryListRequest, CategoryUpdateRequest, ConfirmUploadFileRequest, ConfirmUploadRequest, ConnectOnboardingRequest, CreateAuthorizedSenderRequest, CreateCheckoutPaymentIntentRequest, CreatePaymentMethodRequest, CreatePortalSessionRequest, CredentialProvider, CustomerCreateRequest, CustomerListRequest, CustomerUpdateRequest, DepartmentCreateRequest, DepartmentListRequest, DepartmentUpdateRequest, EditExpenseInReportRequest, EmailAccountImapCreateRequest, EmailAccountListRequest, EmailAccountOAuth2CreateRequest, EmailAccountUpdateRequest, EmailForwardingConfigRequest, EmployeeBulkAssignManagerRequest, EmployeeCreateRequest, EmployeeListRequest, EmployeeSetManagerRequest, EmployeeUpdateRequest, ErrorCodeType, ExpenseAttachmentDownloadRequest, ExpenseCategoryUpdateRequest, ExpenseExportRequest, ExpenseJobListRequest, ExpenseListRequest, ExpenseNoteUpdateRequest, ExpenseOverTimeRequest, ExpenseReportApproveRequest, ExpenseReportAssignLedgerAccountRequest, ExpenseReportCommentCreateRequest, ExpenseReportCreateRequest, ExpenseReportExportRequest, ExpenseReportListRequest, ExpenseReportPartialReimburseRequest, ExpenseReportPlanReimbursementRequest, ExpenseReportRecallRequest, ExpenseReportReimburseRequest, ExpenseReportRejectRequest, ExpenseReportRequestChangesRequest, ExpenseReportUpdateRequest, ExpenseReviewUpdateRequest, ExpenseSplitItem, ExpenseSplitLineItem, ExpenseSplitRequest, HistoricalSyncRequest, HttpClientConfig, IntegrationCallbackRequest, IntegrationListRequest, InvitationCreateRequest, InvitationListRequest, InvoiceListRequest, LocationBatchCreateRequest, LocationBatchUpdateRequest, LocationCreateRequest, LocationImageUrlRequest, LocationListRequest, LocationUpdateRequest, LoyaltyProgramCreateRequest, LoyaltyProgramListRequest, LoyaltyProgramStatus, LoyaltyProgramUpdateRequest, LoyaltyRewardType, LoyaltyRuleType, MailboxUpdateRequest, MembershipCreateRequest, MembershipEmailInviteRequest, MembershipListRequest, MembershipRoleUpdateRequest, NotificationListRequest, PaginateBusinessRequest, PaginateTransactionRequest, PaginationRequest, PaymentMethodListRequest, PresignedUploadFileRequest, PresignedUploadFileResponse, PresignedUploadRequest, PresignedUploadResponse, ProductListRequest, ReceiptCreateRequest, ReceiptListRequest, ReceiptOCRCreateRequest, ReceiptUpdateRequest, RefundCheckoutPaymentRequest, ReportDateRange, ReportingRequest, RequestOptions, SBAddress, SBAppInstallation, SBApprobationSummary, SBAttachment, SBAuthorizedSender, SBBatchResponse, SBBill, SBBillApproval, SBBillApprovalHistoryItem, SBBillAttachment, SBBillBulkActionResponse, SBBillLineItem, SBBillStatusSummary, SBBillTax, SBBillTransitionResponse, SBBillingAddress, SBBillingPaymentMethod, SBBillingPlan, SBBillingUsage, SBBulkActionResponse, SBBulkActionResult, SBBusiness, SBBusinessBrand, SBBusinessPlan, SBCategory, SBCategoryRuleData, SBCheckoutLineItem, SBCheckoutPayment, SBCheckoutPaymentDispute, SBCheckoutPaymentRefund, SBCheckoutTax, SBCheckoutTransactionResponse, SBConnectAccount, SBConnectAccountRequirements, SBConnectDashboardResponse, SBConnectOnboardingResponse, SBCoordinate, SBCreateCheckoutPaymentIntentResponse, SBCustomer, SBDepartment, SBDepartmentMember, SBDowngradeValidation, SBEmailAccount, SBEmailAccountAuthorizeResponse, SBEmailForwardingConfig, SBEmployee, SBEmployeeCategoryBreakdownReport, SBEmployeeDepartment, SBEmployeeLocation, SBEmployeeManager, SBEntity, SBExpenseBulkActionResponse, SBExpenseByCategoryReport, SBExpenseByDayReport, SBExpenseByEmployeeReport, SBExpenseByVendorReport, SBExpenseJob, SBExpenseMonthlySummary, SBExpenseOverTimeDataPoint, SBExpenseOverTimeReport, SBExpenseReport, SBExpenseReportAuditLogEntry, SBExpenseReportBulkActionResponse, SBExpenseReportComment, SBExpenseReportItem, SBExpenseReportSummary, SBExpenseReportTimelineEntry, SBExpenseValidateResponse, SBFileDownloadResponse, SBHistoricalSyncResponse, SBIntegration, SBIntegrationAuthorizeResponse, SBInvitation, SBInvoice, SBInvoiceLine, SBItemVariationRuleData, SBListResponse, SBLocation, SBLocationImage, SBLoyaltyProgram, SBLoyaltyRule, SBLoyaltyRuleBase, SBMailbox, SBMarketplaceApp, SBMembership, SBMembershipBusinessSummary, SBMembershipUserSummary, SBMerchantLedger, SBMoney, SBNotification, SBPagination, SBPaymentMethod, SBPaymentMethodBillingDetails, SBPaymentMethodSetupIntentResponse, SBPortalSession, SBProduct, SBPromoCode, SBReceipt, SBReceiptBarcode, SBReceiptBusiness, SBReceiptCustomer, SBReceiptDiscount, SBReceiptDocument, SBReceiptFee, SBReceiptLineItem, SBReceiptPayment, SBReceiptPaymentCard, SBReceiptRefund, SBReceiptTax, SBReceiptTransaction, SBReceiptVendor, SBSessionTokenResponse, SBSetupIntent, SBSharedMailbox, SBSpendRuleData, SBSubscription, SBSyncSession, SBTable, SBTableColumn, SBTableRow, SBTax, SBTaxByCategoryReport, SBTaxByTypeReport, SBTaxByVendorReport, SBTaxSummaryReport, SBTimestamps, SBTransaction, SBTransactionAttachment, SBTransactionMerchant, SBTransactionTax, SBTransactionUploadResponse, SBTransactionVendor, SBUpcomingInvoice, SBUserAccount, SBValidateEmailResponse, SBValidateSharedMailboxResponse, SBVendor, SBVendorBulkActionResponse, SBVendorConnectResponse, SBVendorConnection, SBVendorImportResult, SBVisitRuleData, SBWorkflow, SBWorkflowCondition, SBWorkflowStep, SBWorkflowTestResponse, SmartbillsClientOptions, SmartbillsFieldError, SubmitDisputeEvidenceRequest, SyncSessionListRequest, TableCreateRequest, TableListRequest, TableUpdateRequest, TaxListRequest, TransactionBatchUpdateRequest, TransactionUpdateRequest, UpdateInstallationStatusRequest, UpgradeSubscriptionRequest, UsageHistoryRequest, UserUpdateRequest, VendorBatchUpdateRequest, VendorConnectRequest, VendorCreateRequest, VendorListRequest, VendorMergeRequest, VendorUpdateRequest, WorkflowCreateRequest, WorkflowListRequest, WorkflowTestRequest, WorkflowUpdateRequest };
+export { AccessToken, AppInstallationService, AppInstallationStatus, ApprobationService, AttachmentService, AuthorizedSenderService, BaseService, BillApprovalStatus, BillApprovalType, BillService, BillStatus, BillingService, BusinessService, BusinessUserService, CategoryService, CheckoutDocumentType, CheckoutPaymentStatus, CheckoutService, CheckoutStatus, ConnectAccountStatus, ConnectService, ConnectedAccountService, ConnectedAccountStatus, ConnectedAccountType, CustomerService, DEFAULT_BASE_URL, DepartmentService, EmailAccountService, EmailAccountStatus, EmailAccountSyncStatus, EmailAccountType, EmailForwardingService, EmployeeService, ErrorCode, ExpenseItemStatus, ExpenseJobService, ExpenseReportAuditLogAction, ExpenseReportExpenseService, ExpenseReportPaymentService, ExpenseReportService, ExpenseReportStatus, ExpenseService, ExpenseSplitType, HttpClient, IntegrationService, IntegrationStatus, InvitationService, InvitationStatus, InvoicePaymentService, InvoicePaymentStatus, InvoiceReminderFrequency, InvoiceReminderTiming, InvoiceService, InvoiceStatus, LocationService, LoyaltyService, MailboxType, MembershipRole, MembershipService, NotificationService, NotificationType, PayerType, PaymentMethodService, PayoutInterval, PayoutService, PayoutStatus, ProductService, PromoCodeService, ReceiptPaymentStatus, ReceiptPaymentType, ReceiptService, ReceiptSource, ReceiptType, ReportingService, SmartbillsApiError, SmartbillsAuthenticationError, SmartbillsClient, SmartbillsConflictError, SmartbillsError, SmartbillsNetworkError, SmartbillsNotFoundError, SmartbillsPermissionError, SmartbillsQuotaError, SmartbillsRateLimitError, SmartbillsValidationError, SyncTriggerType, TableService, TaxService, TransactionService, TransactionType, UserService, VendorConnectionService, VendorConnectionStatus, VendorService, WorkflowService, WorkflowTriggerType, isApiError, isAuthenticationError, isConflictError, isNetworkError, isNotFoundError, isPermissionError, isQuotaError, isRateLimitError, isRetryableError, isSmartbillsError, isValidationError, uploadFileToS3 };
+export type { AddExpenseToReportRequest, AddExpensesToReportBatchRequest, ApprobationListRequest, AssociateExpenseReportUpdateRequest, AttachmentListRequest, AttachmentRenameRequest, BalanceAmount, BillApprovalRequest, BillBatchUpdateRequest, BillCancelRequest, BillCreateRequest, BillListRequest, BillMarkPaidRequest, BillReschedulePaymentRequest, BillRetryPaymentRequest, BillSchedulePaymentRequest, BillSubmitForApprovalRequest, BillTransitionRequest, BillUpdateRequest, BillingInvoiceListRequest, BulkApproveApprobationsRequest, BulkAssignCategoryRequest, BulkAssignExpenseReportRequest, BulkAssignPayerTypeRequest, BulkAssignReportCategoryRequest, BulkAssignVendorRequest, BulkBillApproveRequest, BulkBillCancelPaymentRequest, BulkBillDeleteRequest, BulkBillMarkPaidRequest, BulkBillRemindRequest, BulkBillRetryPaymentRequest, BulkBillSchedulePaymentRequest, BulkBillUnscheduleRequest, BulkBillUpdateRequest, BulkDeleteExpenseReportsRequest, BulkDeleteExpensesRequest, BulkDeleteVendorsRequest, BulkMarkReimbursedApprobationsRequest, BulkPlanReimbursementApprobationsRequest, BulkRecallExpenseReportsRequest, BulkRejectApprobationsRequest, BulkRemoveReportExpensesRequest, BulkRequestChangesApprobationsRequest, BulkRevertToReviewApprobationsRequest, BulkSetNoteRequest, BulkSubmitExpenseReportsRequest, BusinessBatchUpdateRequest, BusinessBrandCreateRequest, BusinessBrandUpdateRequest, BusinessCreateRequest, BusinessUpdateRequest, CategoryCreateRequest, CategoryListRequest, CategoryUpdateRequest, CheckoutLineItem, ConfirmUploadFileRequest, ConfirmUploadRequest, ConnectOnboardingRequest, ConnectedAccountOnboardingRequest, ConnectedAccountOnboardingResult, ConnectedAccountSettingsRequest, CreateAuthorizedSenderRequest, CreateCheckoutPaymentIntentRequest, CreatePaymentMethodRequest, CreatePayoutRequest, CreatePortalSessionRequest, CredentialProvider, CustomerCreateRequest, CustomerListRequest, CustomerUpdateRequest, DepartmentCreateRequest, DepartmentListRequest, DepartmentUpdateRequest, DisputeEvidenceRequest, EditExpenseInReportRequest, EmailAccountImapCreateRequest, EmailAccountListRequest, EmailAccountOAuth2CreateRequest, EmailAccountUpdateRequest, EmailForwardingConfigRequest, EmployeeBulkAssignManagerRequest, EmployeeCreateRequest, EmployeeListRequest, EmployeeSetManagerRequest, EmployeeUpdateRequest, ErrorCodeType, ExpenseAttachmentDownloadRequest, ExpenseCategoryUpdateRequest, ExpenseExportRequest, ExpenseJobListRequest, ExpenseListRequest, ExpenseNoteUpdateRequest, ExpenseOverTimeRequest, ExpenseReportApproveRequest, ExpenseReportAssignLedgerAccountRequest, ExpenseReportCommentCreateRequest, ExpenseReportCreateRequest, ExpenseReportExportRequest, ExpenseReportListRequest, ExpenseReportPartialReimburseRequest, ExpenseReportPlanReimbursementRequest, ExpenseReportRecallRequest, ExpenseReportReimburseRequest, ExpenseReportRejectRequest, ExpenseReportRequestChangesRequest, ExpenseReportUpdateRequest, ExpenseReviewUpdateRequest, ExpenseSplitItem, ExpenseSplitLineItem, ExpenseSplitRequest, FeeConfigurationRequest, HistoricalSyncRequest, HttpClientConfig, IntegrationCallbackRequest, IntegrationListRequest, InvitationCreateRequest, InvitationListRequest, InvoiceCreateRequest, InvoiceListRequest, InvoicePaymentCreateRequest, InvoicePaymentFilterRequest, InvoiceReminder, InvoiceSummary, InvoiceUpdateRequest, LedgerEntry, LedgerSummary, LocationBatchCreateRequest, LocationBatchUpdateRequest, LocationCreateRequest, LocationImageUrlRequest, LocationListRequest, LocationUpdateRequest, LoyaltyProgramCreateRequest, LoyaltyProgramListRequest, LoyaltyProgramStatus, LoyaltyProgramUpdateRequest, LoyaltyRewardType, LoyaltyRuleType, MailboxUpdateRequest, MembershipCreateRequest, MembershipEmailInviteRequest, MembershipListRequest, MembershipRoleUpdateRequest, NotificationListRequest, PagedResult, PaginateBusinessRequest, PaginateTransactionRequest, PaginationRequest, PaymentMethodListRequest, Payout, PayoutListRequest, PayoutListResponse, PayoutSchedule, PresignedUploadFileRequest, PresignedUploadFileResponse, PresignedUploadRequest, PresignedUploadResponse, ProductCreateRequest, ProductListRequest, ProductUpdateRequest, ReceiptCreateRequest, ReceiptListRequest, ReceiptOCRCreateRequest, ReceiptUpdateRequest, RefundCheckoutPaymentRequest, RefundCreateRequest, ReportDateRange, ReportingRequest, RequestOptions, SBAddress, SBAppInstallation, SBApprobationSummary, SBAttachment, SBAuthorizedSender, SBBalance, SBBatchResponse, SBBill, SBBillApproval, SBBillApprovalHistoryItem, SBBillAttachment, SBBillBulkActionResponse, SBBillLineItem, SBBillStatusSummary, SBBillTax, SBBillTransitionResponse, SBBillingAddress, SBBillingInvoice, SBBillingInvoiceLine, SBBillingPaymentMethod, SBBillingPlan, SBBillingUsage, SBBulkActionResponse, SBBulkActionResult, SBBusiness, SBBusinessBrand, SBBusinessPlan, SBCategory, SBCategoryRuleData, SBCheckoutLineItem, SBCheckoutPayment, SBCheckoutPaymentDispute, SBCheckoutPaymentRefund, SBCheckoutTax, SBCheckoutTransactionResponse, SBConnectAccount, SBConnectAccountRequirements, SBConnectDashboardResponse, SBConnectOnboardingResponse, SBConnectedAccount, SBCoordinate, SBCreateCheckoutPaymentIntentResponse, SBCustomer, SBDepartment, SBDepartmentMember, SBDispute, SBDowngradeValidation, SBEmailAccount, SBEmailAccountAuthorizeResponse, SBEmailForwardingConfig, SBEmployee, SBEmployeeCategoryBreakdownReport, SBEmployeeDepartment, SBEmployeeLocation, SBEmployeeManager, SBEntity, SBExpenseBulkActionResponse, SBExpenseByCategoryReport, SBExpenseByDayReport, SBExpenseByEmployeeReport, SBExpenseByVendorReport, SBExpenseJob, SBExpenseMonthlySummary, SBExpenseOverTimeDataPoint, SBExpenseOverTimeReport, SBExpenseReport, SBExpenseReportAuditLogEntry, SBExpenseReportBulkActionResponse, SBExpenseReportComment, SBExpenseReportItem, SBExpenseReportSummary, SBExpenseReportTimelineEntry, SBExpenseValidateResponse, SBFileDownloadResponse, SBHistoricalSyncResponse, SBIntegration, SBIntegrationAuthorizeResponse, SBInvitation, SBInvoice, SBInvoiceCustomer, SBInvoiceLineItem, SBInvoiceLineItemTax, SBInvoicePayment, SBItemVariationRuleData, SBListResponse, SBLocation, SBLocationImage, SBLoyaltyProgram, SBLoyaltyRule, SBLoyaltyRuleBase, SBMailbox, SBMarketplaceApp, SBMembership, SBMembershipBusinessSummary, SBMembershipUserSummary, SBMerchantLedger, SBMoney, SBNotification, SBPagination, SBPaymentMethod, SBPaymentMethodBillingDetails, SBPaymentMethodSetupIntentResponse, SBPayout, SBPortalSession, SBProduct, SBProductImage, SBPromoCode, SBReceipt, SBReceiptBarcode, SBReceiptBusiness, SBReceiptCustomer, SBReceiptDiscount, SBReceiptDocument, SBReceiptFee, SBReceiptLineItem, SBReceiptPayment, SBReceiptPaymentCard, SBReceiptRefund, SBReceiptTax, SBReceiptTransaction, SBReceiptVendor, SBRefund, SBSessionTokenResponse, SBSetupIntent, SBSharedMailbox, SBSpendRuleData, SBSubscription, SBSyncSession, SBTable, SBTableColumn, SBTableRow, SBTax, SBTaxByCategoryReport, SBTaxByTypeReport, SBTaxByVendorReport, SBTaxSummaryReport, SBTimestamps, SBTransaction, SBTransactionAttachment, SBTransactionMerchant, SBTransactionTax, SBTransactionUploadResponse, SBTransactionVendor, SBUpcomingInvoice, SBUserAccount, SBValidateEmailResponse, SBValidateSharedMailboxResponse, SBVendor, SBVendorBulkActionResponse, SBVendorConnectResponse, SBVendorConnection, SBVendorImportResult, SBVisitRuleData, SBWorkflow, SBWorkflowCondition, SBWorkflowStep, SBWorkflowTestResponse, SmartbillsClientOptions, SmartbillsFieldError, SubmitDisputeEvidenceRequest, SyncSessionListRequest, TableCreateRequest, TableListRequest, TableUpdateRequest, TaxCreateRequest, TaxListRequest, TaxUpdateRequest, TransactionBatchUpdateRequest, TransactionUpdateRequest, UpdateInstallationStatusRequest, UpdatePayoutScheduleRequest, UpgradeSubscriptionRequest, UsageHistoryRequest, UserUpdateRequest, VendorBatchUpdateRequest, VendorConnectRequest, VendorCreateRequest, VendorListRequest, VendorMergeRequest, VendorUpdateRequest, WorkflowCreateRequest, WorkflowListRequest, WorkflowTestRequest, WorkflowUpdateRequest };