@cynco/sdk 0.1.1 → 0.2.0

package/dist/index.d.cts

@@ -129,48 +129,73 @@ interface ValidationDetail {
     message: string;
 }
 interface ListParams {
+    page?: number;
     limit?: number;
-    offset?: number;
     cursor?: string;
     sort?: string;
     order?: 'asc' | 'desc';
+    fields?: string;
 }
+/**
+ * Query params for GET /api/v1/invoices.
+ * Matches the Zod `listQuerySchema` in api.v1.invoices.tsx.
+ * Sort accepts: 'created_at' | 'due_date' | 'total'.
+ */
 interface InvoiceListParams extends ListParams {
     status?: InvoiceStatus;
-    customerId?: string;
-    dateFrom?: string;
-    dateTo?: string;
-    dueDateFrom?: string;
-    dueDateTo?: string;
+    created_from?: string;
+    created_to?: string;
+    due_from?: string;
+    due_to?: string;
+    min_amount?: number;
+    max_amount?: number;
     search?: string;
 }
+/**
+ * Query params for GET /api/v1/customers.
+ * Matches the Zod `listQuerySchema` in api.v1.customers.tsx.
+ * Sort accepts: 'name' | 'email' | 'created_at'.
+ */
 interface CustomerListParams extends ListParams {
+    status?: 'active' | 'inactive' | 'all';
     search?: string;
-    type?: 'individual' | 'company';
-    isActive?: boolean;
 }
+/**
+ * Query params for GET /api/v1/vendors.
+ * Matches the Zod `listQuerySchema` in api.v1.vendors.tsx.
+ * Sort accepts: 'name' | 'created_at' | 'total_amount'.
+ */
 interface VendorListParams extends ListParams {
+    status?: 'active' | 'inactive' | 'all';
+    category?: string;
     search?: string;
-    isActive?: boolean;
 }
+/**
+ * Query params for GET /api/v1/bills.
+ * Matches the Zod `listQuerySchema` in api.v1.bills.tsx.
+ * Sort accepts: 'created_at' | 'due_date' | 'total_amount' | 'bill_number'.
+ */
 interface BillListParams extends ListParams {
-    status?: BillStatus;
-    vendorId?: string;
-    dateFrom?: string;
-    dateTo?: string;
-    dueDateFrom?: string;
-    dueDateTo?: string;
+    status?: BillStatus | 'all';
     search?: string;
+    vendorId?: string;
+    startDate?: string;
+    endDate?: string;
 }
+/**
+ * Query params for GET /api/v1/items.
+ * Matches the Zod `listQuerySchema` in api.v1.items.tsx.
+ */
 interface ItemListParams extends ListParams {
     search?: string;
-    type?: 'product' | 'service';
-    isActive?: boolean;
 }
+/**
+ * Query params for GET /api/v1/accounts.
+ * Matches the Zod `listQuerySchema` in api.v1.accounts.tsx.
+ */
 interface AccountListParams extends ListParams {
-    search?: string;
-    type?: AccountType;
-    isActive?: boolean;
+    account_type?: AccountType;
+    active_only?: 'true' | 'false';
 }
 interface JournalEntryListParams extends ListParams {
     dateFrom?: string;
@@ -193,146 +218,156 @@ interface BankTransactionListParams extends ListParams {
 interface WebhookListParams extends ListParams {
     isActive?: boolean;
 }
-interface InvoiceCreateInput {
-    customerId: string;
-    issueDate: string;
-    dueDate: string;
-    lineItems: InvoiceLineItemInput[];
-    currency?: string;
-    notes?: string;
-    reference?: string;
-    taxInclusive?: boolean;
-}
+/**
+ * Invoice update input.
+ * Matches the Zod `updateInvoiceSchema` in invoice.schemas.ts.
+ * Note: Invoice create is not yet exposed via API (Phase 2).
+ */
 interface InvoiceUpdateInput {
-    customerId?: string;
-    issueDate?: string;
-    dueDate?: string;
-    lineItems?: InvoiceLineItemInput[];
-    currency?: string;
-    notes?: string;
-    reference?: string;
-    taxInclusive?: boolean;
-}
-interface InvoiceLineItemInput {
-    itemId?: string;
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    taxRate?: number;
-    accountId?: string;
+    memo?: string | null;
+    paymentTerms?: string | null;
+    dueDate?: string | null;
 }
+/**
+ * Customer create input.
+ * Matches the Zod `createCustomerSchema` in customer.schemas.ts.
+ */
 interface CustomerCreateInput {
     name: string;
     email?: string;
     phone?: string;
-    type?: 'individual' | 'company';
-    taxNumber?: string;
-    currency?: string;
-    billingAddress?: Address;
-    shippingAddress?: Address;
+    address?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    registrationNumber?: string;
+    taxId?: string;
+    website?: string;
+    paymentTerms?: string;
+    preferredPaymentMethod?: string;
+    preferredCurrency?: string;
+    creditLimit?: string;
+    category?: string;
     notes?: string;
 }
+/**
+ * Customer update input.
+ * Matches the Zod `updateCustomerSchema` in customer.schemas.ts.
+ * All create fields are optional, plus `isActive`.
+ */
 interface CustomerUpdateInput {
     name?: string;
     email?: string;
     phone?: string;
-    type?: 'individual' | 'company';
-    taxNumber?: string;
-    currency?: string;
-    billingAddress?: Address;
-    shippingAddress?: Address;
+    address?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    registrationNumber?: string;
+    taxId?: string;
+    website?: string;
+    paymentTerms?: string;
+    preferredPaymentMethod?: string;
+    preferredCurrency?: string;
+    creditLimit?: string;
+    category?: string;
     notes?: string;
+    isActive?: boolean;
 }
+/**
+ * Vendor create input.
+ * Matches the Zod `createVendorSchema` in vendor.schemas.ts.
+ */
 interface VendorCreateInput {
     name: string;
     email?: string;
     phone?: string;
-    taxNumber?: string;
-    currency?: string;
-    address?: Address;
-    bankDetails?: BankDetails;
+    address?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    registrationNumber?: string;
+    taxId?: string;
+    website?: string;
+    paymentTerms?: string;
+    preferredPaymentMethod?: string;
+    bankAccountNumber?: string;
+    bankName?: string;
+    bankBranch?: string;
+    category?: string;
     notes?: string;
+    defaultExpenseAccountId?: string;
+    defaultPayableAccountId?: string;
 }
+/**
+ * Vendor update input.
+ * Matches the Zod `updateVendorSchema` in vendor.schemas.ts.
+ * All create fields are optional, plus `isActive`.
+ */
 interface VendorUpdateInput {
     name?: string;
     email?: string;
     phone?: string;
-    taxNumber?: string;
-    currency?: string;
-    address?: Address;
-    bankDetails?: BankDetails;
-    notes?: string;
-}
-interface BillCreateInput {
-    vendorId: string;
-    issueDate: string;
-    dueDate: string;
-    lineItems: BillLineItemInput[];
-    currency?: string;
+    address?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    registrationNumber?: string;
+    taxId?: string;
+    website?: string;
+    paymentTerms?: string;
+    preferredPaymentMethod?: string;
+    bankAccountNumber?: string;
+    bankName?: string;
+    bankBranch?: string;
+    category?: string;
     notes?: string;
-    reference?: string;
-    taxInclusive?: boolean;
+    defaultExpenseAccountId?: string;
+    defaultPayableAccountId?: string;
+    isActive?: boolean;
 }
+/**
+ * Bill update input.
+ * Matches the Zod `updateBillSchema` in bill.schemas.ts.
+ * Note: Bill create is not yet exposed via API.
+ */
 interface BillUpdateInput {
     vendorId?: string;
-    issueDate?: string;
-    dueDate?: string;
-    lineItems?: BillLineItemInput[];
+    billNumber?: string;
+    referenceNumber?: string;
+    status?: BillStatus;
     currency?: string;
+    dueDate?: string;
+    issueDate?: string;
+    category?: string;
+    memo?: string;
     notes?: string;
-    reference?: string;
-    taxInclusive?: boolean;
-}
-interface BillLineItemInput {
-    itemId?: string;
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    taxRate?: number;
-    accountId?: string;
 }
+/**
+ * Item create input.
+ * Matches the Zod `createItemSchema` in item.schemas.ts.
+ */
 interface ItemCreateInput {
     name: string;
-    type: 'product' | 'service';
     description?: string;
-    unitPrice?: number;
-    cost?: number;
+    unitPrice: number;
     taxRate?: number;
-    sku?: string;
-    unit?: string;
-    incomeAccountId?: string;
-    expenseAccountId?: string;
+    discountRate?: number;
 }
+/**
+ * Item update input.
+ * Matches the Zod `updateItemSchema` in item.schemas.ts.
+ */
 interface ItemUpdateInput {
     name?: string;
-    type?: 'product' | 'service';
     description?: string;
     unitPrice?: number;
-    cost?: number;
     taxRate?: number;
-    sku?: string;
-    unit?: string;
-    incomeAccountId?: string;
-    expenseAccountId?: string;
-}
-interface AccountCreateInput {
-    name: string;
-    code: string;
-    type: AccountType;
-    subType?: string;
-    description?: string;
-    currency?: string;
-    taxRate?: number;
-    isActive?: boolean;
-}
-interface AccountUpdateInput {
-    name?: string;
-    code?: string;
-    subType?: string;
-    description?: string;
-    currency?: string;
-    taxRate?: number;
-    isActive?: boolean;
+    discountRate?: number;
 }
 interface JournalEntryCreateInput {
     date: string;
@@ -382,128 +417,155 @@ interface WebhookUpdateInput {
     description?: string;
     isActive?: boolean;
 }
+/**
+ * Invoice as returned by the API.
+ * Matches `serializeInvoice()` in invoice.serializer.ts.
+ */
 interface Invoice {
     id: string;
     invoiceNumber: string;
-    customerId: string;
-    customer?: Customer;
-    status: InvoiceStatus;
-    issueDate: string;
-    dueDate: string;
-    lineItems: InvoiceLineItem[];
-    subtotal: number;
-    taxTotal: number;
-    total: number;
-    amountDue: number;
+    status: string;
+    customerId: string | null;
+    customerName: string | null;
+    customerEmail: string | null;
     currency: string;
-    notes: string | null;
-    reference: string | null;
-    taxInclusive: boolean;
-    pdfUrl: string | null;
+    lineItems: unknown[];
+    taxes: number;
+    totalAmount: number | null;
+    paidAmount: number;
+    hasDeposit: boolean;
+    depositAmount: number;
+    dueDate: string | null;
+    paymentTerms: string | null;
+    memo: string | null;
+    source: string;
     createdAt: string;
     updatedAt: string;
 }
-interface InvoiceLineItem {
-    id: string;
-    itemId: string | null;
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    taxRate: number;
-    amount: number;
-    accountId: string | null;
-}
-type InvoiceStatus = 'draft' | 'sent' | 'viewed' | 'partially_paid' | 'paid' | 'overdue' | 'voided';
+type InvoiceStatus = 'draft' | 'finalized' | 'paid' | 'overdue' | 'partially_paid' | 'deposit_paid' | 'deposit_due';
+/**
+ * Customer as returned by the API.
+ * Matches `serializeCustomer()` in customer.serializer.ts.
+ */
 interface Customer {
     id: string;
     name: string;
     email: string | null;
     phone: string | null;
-    type: 'individual' | 'company';
-    taxNumber: string | null;
-    currency: string;
-    billingAddress: Address | null;
-    shippingAddress: Address | null;
+    address: string | null;
+    city: string | null;
+    state: string | null;
+    zip: string | null;
+    country: string | null;
+    registrationNumber: string | null;
+    taxId: string | null;
+    website: string | null;
+    paymentTerms: string | null;
+    preferredPaymentMethod: string | null;
+    preferredCurrency: string | null;
+    creditLimit: number | null;
+    category: string | null;
     notes: string | null;
     isActive: boolean;
-    outstandingBalance: number;
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Vendor as returned by the API.
+ * Matches `serializeVendor()` in vendor.serializer.ts.
+ */
 interface Vendor {
     id: string;
     name: string;
     email: string | null;
     phone: string | null;
-    taxNumber: string | null;
-    currency: string;
-    address: Address | null;
-    bankDetails: BankDetails | null;
+    address: string | null;
+    city: string | null;
+    state: string | null;
+    zip: string | null;
+    country: string | null;
+    registrationNumber: string | null;
+    taxId: string | null;
+    website: string | null;
+    paymentTerms: string | null;
+    preferredPaymentMethod: string | null;
+    preferredCurrency: string | null;
+    creditLimit: number | null;
+    category: string | null;
     notes: string | null;
     isActive: boolean;
-    outstandingBalance: number;
+    totalAmount: number;
+    totalPayments: number;
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Bill as returned by the API.
+ * Matches `serializeBill()` in bill.serializer.ts.
+ */
 interface Bill {
     id: string;
-    billNumber: string;
-    vendorId: string;
-    vendor?: Vendor;
-    status: BillStatus;
-    issueDate: string;
-    dueDate: string;
-    lineItems: BillLineItem[];
-    subtotal: number;
-    taxTotal: number;
-    total: number;
-    amountDue: number;
+    billNumber: string | null;
+    referenceNumber: string | null;
+    vendorId: string | null;
+    vendorName: string | null;
+    status: string;
     currency: string;
+    subtotalAmount: number | null;
+    taxAmount: number | null;
+    totalAmount: number | null;
+    issueDate: string | null;
+    dueDate: string | null;
+    category: string | null;
+    memo: string | null;
     notes: string | null;
-    reference: string | null;
-    taxInclusive: boolean;
+    source: string | null;
+    lineItems: unknown[] | null;
     createdAt: string;
     updatedAt: string;
 }
-interface BillLineItem {
-    id: string;
-    itemId: string | null;
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    taxRate: number;
-    amount: number;
-    accountId: string | null;
-}
-type BillStatus = 'draft' | 'received' | 'partially_paid' | 'paid' | 'overdue' | 'voided';
+type BillStatus = 'draft' | 'in_review' | 'pending_approval' | 'approved' | 'awaiting_payment' | 'scheduled' | 'paid' | 'rejected' | 'void';
+/**
+ * Item as returned by the API.
+ * Matches `serializeItem()` in item.serializer.ts.
+ */
 interface Item {
     id: string;
     name: string;
-    type: 'product' | 'service';
     description: string | null;
-    unitPrice: number | null;
-    cost: number | null;
-    taxRate: number | null;
-    sku: string | null;
-    unit: string | null;
-    incomeAccountId: string | null;
-    expenseAccountId: string | null;
-    isActive: boolean;
+    unitPrice: number;
+    taxRate: number;
+    discountRate: number;
     createdAt: string;
     updatedAt: string;
 }
-type AccountType = 'asset' | 'liability' | 'equity' | 'revenue' | 'expense';
+/**
+ * Account type values accepted by the accounts API.
+ * Matches the `account_type` enum in the accounts route listQuerySchema.
+ */
+type AccountType = 'asset' | 'liability' | 'equity' | 'revenue' | 'expense' | 'contra_asset' | 'contra_liability' | 'contra_equity' | 'contra_revenue' | 'contra_expense';
+/**
+ * Account as returned by the API.
+ * Matches `serializeAccount()` in api.v1.accounts.tsx.
+ */
 interface Account {
     id: string;
-    name: string;
-    code: string;
-    type: AccountType;
-    subType: string | null;
-    description: string | null;
-    currency: string;
-    taxRate: number | null;
+    accountCode: string;
+    accountName: string;
+    accountType: string;
+    normalBalance: string | null;
+    parentAccountId: string | null;
+    path: string | null;
+    level: number;
     isActive: boolean;
-    balance: number;
+    isSystemAccount: boolean;
+    isHeaderAccount: boolean;
+    isCashAccount: boolean;
+    isBankAccount: boolean;
+    taxRelated: boolean;
+    defaultTaxRate: number | null;
+    taxCode: string | null;
+    description: string | null;
     createdAt: string;
     updatedAt: string;
 }
@@ -632,20 +694,6 @@ interface ReportRow {
     amount: number;
     previousAmount?: number;
 }
-interface Address {
-    line1: string;
-    line2?: string;
-    city: string;
-    state?: string;
-    postalCode: string;
-    country: string;
-}
-interface BankDetails {
-    bankName: string;
-    accountNumber: string;
-    routingNumber?: string;
-    swiftCode?: string;
-}
 
 /**
  * Low-level HTTP client that handles authentication, retries, rate limiting,
@@ -786,9 +834,7 @@ declare class Invoices {
     list(params?: InvoiceListParams): PagePromise<Invoice>;
     /** Retrieve a single invoice by ID. */
     retrieve(id: string): Promise<Invoice>;
-    /** Create a new invoice. */
-    create(data: InvoiceCreateInput, options?: RequestOptions): Promise<Invoice>;
-    /** Update an existing invoice. */
+    /** Update an existing invoice (memo, paymentTerms, dueDate only). */
     update(id: string, data: InvoiceUpdateInput, options?: RequestOptions): Promise<Invoice>;
     /** Delete an invoice. Only draft invoices can be deleted. */
     delete(id: string, options?: RequestOptions): Promise<void>;
@@ -868,8 +914,6 @@ declare class Bills {
     list(params?: BillListParams): PagePromise<Bill>;
     /** Retrieve a single bill by ID. */
     retrieve(id: string): Promise<Bill>;
-    /** Create a new bill. */
-    create(data: BillCreateInput, options?: RequestOptions): Promise<Bill>;
     /** Update an existing bill. */
     update(id: string, data: BillUpdateInput, options?: RequestOptions): Promise<Bill>;
     /** Delete a bill. Only draft bills can be deleted. */
@@ -910,23 +954,18 @@ declare class Accounts {
     private readonly _client;
     constructor(_client: CyncoClient);
     /**
-     * List chart of accounts with pagination.
+     * List chart of accounts.
      *
      * ```ts
-     * for await (const account of cynco.accounts.list({ type: 'revenue' })) {
-     *   console.log(`${account.code} — ${account.name}`);
+     * const page = await cynco.accounts.list({ account_type: 'revenue' });
+     * for (const account of page.data) {
+     *   console.log(`${account.accountCode} — ${account.accountName}`);
      * }
      * ```
      */
     list(params?: AccountListParams): PagePromise<Account>;
     /** Retrieve a single account by ID. */
     retrieve(id: string): Promise<Account>;
-    /** Create a new account. */
-    create(data: AccountCreateInput, options?: RequestOptions): Promise<Account>;
-    /** Update an existing account. */
-    update(id: string, data: AccountUpdateInput, options?: RequestOptions): Promise<Account>;
-    /** Delete an account. Only unused accounts can be deleted. */
-    delete(id: string, options?: RequestOptions): Promise<void>;
 }
 
 declare class JournalEntries {
@@ -1210,4 +1249,4 @@ declare class Cynco {
     constructor(apiKey: string, options?: CyncoClientOptions);
 }
 
-export { type Account, type AccountCreateInput, type AccountListParams, type AccountType, type AccountUpdateInput, Accounts, type Address, AuthenticationError, type BalanceSheetReport, type BankAccount, type BankAccountCreateInput, type BankAccountListParams, type BankAccountUpdateInput, BankAccounts, type BankDetails, type BankTransaction, type BankTransactionListParams, type Bill, type BillCreateInput, type BillLineItem, type BillLineItemInput, type BillListParams, type BillStatus, type BillUpdateInput, Bills, ConflictError, ConnectionError, CursorPage, CursorPagePromise, type CursorPaginatedResponse, type CursorPagination, type Customer, type CustomerCreateInput, type CustomerListParams, type CustomerUpdateInput, Customers, Cynco, CyncoClient, type CyncoClientOptions, CyncoError, type CyncoResponse, type ErrorResponse, InternalError, type Invoice, type InvoiceCreateInput, type InvoiceLineItem, type InvoiceLineItemInput, type InvoiceListParams, type InvoiceStatus, type InvoiceUpdateInput, Invoices, type Item, type ItemCreateInput, type ItemListParams, type ItemUpdateInput, Items, JournalEntries, type JournalEntry, type JournalEntryCreateInput, type JournalEntryLine, type JournalEntryLineInput, type JournalEntryListParams, type JournalEntryUpdateInput, type ListParams, NotFoundError, type OffsetPagination, Page, PagePromise, type PaginatedResponse, type PaginationLinks, PermissionError, type ProfitAndLossReport, RateLimitError, type RateLimitInfo, type ReportParams, type ReportRow, type ReportSection, Reports, type RequestOptions, type ResponseMeta, TimeoutError, type TrialBalanceReport, type TrialBalanceRow, type ValidationDetail, ValidationError, type Vendor, type VendorCreateInput, type VendorListParams, type VendorUpdateInput, Vendors, type Webhook, type WebhookCreateInput, type WebhookEvent, type WebhookListParams, type WebhookPayload, type WebhookUpdateInput, Webhooks, Cynco as default, webhookVerifier };
+export { type Account, type AccountListParams, type AccountType, Accounts, AuthenticationError, type BalanceSheetReport, type BankAccount, type BankAccountCreateInput, type BankAccountListParams, type BankAccountUpdateInput, BankAccounts, type BankTransaction, type BankTransactionListParams, type Bill, type BillListParams, type BillStatus, type BillUpdateInput, Bills, ConflictError, ConnectionError, CursorPage, CursorPagePromise, type CursorPaginatedResponse, type CursorPagination, type Customer, type CustomerCreateInput, type CustomerListParams, type CustomerUpdateInput, Customers, Cynco, CyncoClient, type CyncoClientOptions, CyncoError, type CyncoResponse, type ErrorResponse, InternalError, type Invoice, type InvoiceListParams, type InvoiceStatus, type InvoiceUpdateInput, Invoices, type Item, type ItemCreateInput, type ItemListParams, type ItemUpdateInput, Items, JournalEntries, type JournalEntry, type JournalEntryCreateInput, type JournalEntryLine, type JournalEntryLineInput, type JournalEntryListParams, type JournalEntryUpdateInput, type ListParams, NotFoundError, type OffsetPagination, Page, PagePromise, type PaginatedResponse, type PaginationLinks, PermissionError, type ProfitAndLossReport, RateLimitError, type RateLimitInfo, type ReportParams, type ReportRow, type ReportSection, Reports, type RequestOptions, type ResponseMeta, TimeoutError, type TrialBalanceReport, type TrialBalanceRow, type ValidationDetail, ValidationError, type Vendor, type VendorCreateInput, type VendorListParams, type VendorUpdateInput, Vendors, type Webhook, type WebhookCreateInput, type WebhookEvent, type WebhookListParams, type WebhookPayload, type WebhookUpdateInput, Webhooks, Cynco as default, webhookVerifier };