timber-node 0.4.4 → 0.4.5

package/README.md

@@ -1,123 +1,123 @@
-# Timber SDK
-
-Official Node.js SDK for integrating with the Timber accounting backend API.
-
-Easily interact with Timber's core features like managing expenses, invoices, vendors, customers, payroll, and more using a unified SDK.
-
-## Installation
-
-```bash
-npm install timber-node
-```
-
-## Getting Started
-
-```typescript
-import { createClient } from 'timber-node';
-
-const client = createClient('your-api-key', {
-  baseURL: 'https://api.timber.me', // optional
-});
-
-// Example: List expenses
-const expenses = await client.expense.list({ page: 1, limit: 10 });
-console.log(expenses.data);
-```
-
-## Authentication
-
-Timber uses API Key-based authentication. Generate this API key from your Timber profile developer settings.
-
-```typescript
-const client = createClient('your-api-key');
-```
-
-You can also load your API key from environment variables using `dotenv`.
-
-## SDK Structure
-
-The SDK client exposes the following services:
-
-```typescript
-client.expense;
-client.expenseCategory;
-client.rawExpense;
-client.invoice;
-client.invoicePayment;
-client.vendorPayment;
-client.billPayment;
-client.customer;
-client.taxRate;
-client.salary;
-client.employee;
-client.bankStatement;
-client.cheque;
-```
-
-Each service provides common operations like `create`, `get`, `list`, `update`, and `delete` where applicable.
-
-## Usage Examples
-
-### Create an Expense
-
-```typescript
-const response = await client.expense.create({
-  type: 'Travel',
-  merchant: 'Uber',
-  category: 'Transportation',
-  date: '2025-06-23',
-  payment_method: 'cash',
-  amount: 45.75,
-});
-console.log(response.data);
-```
-
-### List Expenses
-
-```typescript
-const response = await client.expense.list({ page: 1, limit: 5 });
-console.log(response.data);
-```
-
-### Update an Expense
-
-```typescript
-const updates = { amount: 50.0 };
-const response = await client.expense.update('expense_id_here', updates);
-console.log(response.data);
-```
-
-### Delete an Expense
-
-```typescript
-const response = await client.expense.delete('expense_id_here');
-console.log(response.data.message);
-```
-
-## TypeScript Support
-
-The SDK includes full TypeScript support:
-
-```typescript
-import type { Expense, CreateExpenseRequest } from 'timber-node';
-```
-
-## Error Handling
-
-Errors are returned as Axios errors:
-
-```typescript
-import axios from 'axios';
-
-try {
-  await client.expense.get('invalid-id');
-} catch (err) {
-  if (axios.isAxiosError(err)) {
-    console.error(err.response?.status, err.response?.data);
-  }
-}
-```
-
-## Related Links
-
-- [Timber Website](https://timber.me)
+# Timber SDK
+
+Official Node.js SDK for integrating with the Timber accounting backend API.
+
+Easily interact with Timber's core features like managing expenses, invoices, vendors, customers, payroll, and more using a unified SDK.
+
+## Installation
+
+```bash
+npm install timber-node
+```
+
+## Getting Started
+
+```typescript
+import { createClient } from 'timber-node';
+
+const client = createClient('your-api-key', {
+  baseURL: 'https://api.timber.me', // optional
+});
+
+// Example: List expenses
+const expenses = await client.expense.list({ page: 1, limit: 10 });
+console.log(expenses.data);
+```
+
+## Authentication
+
+Timber uses API Key-based authentication. Generate this API key from your Timber profile developer settings.
+
+```typescript
+const client = createClient('your-api-key');
+```
+
+You can also load your API key from environment variables using `dotenv`.
+
+## SDK Structure
+
+The SDK client exposes the following services:
+
+```typescript
+client.expense;
+client.expenseCategory;
+client.rawExpense;
+client.invoice;
+client.invoicePayment;
+client.vendorPayment;
+client.billPayment;
+client.customer;
+client.taxRate;
+client.salary;
+client.employee;
+client.bankStatement;
+client.cheque;
+```
+
+Each service provides common operations like `create`, `get`, `list`, `update`, and `delete` where applicable.
+
+## Usage Examples
+
+### Create an Expense
+
+```typescript
+const response = await client.expense.create({
+  type: 'Travel',
+  merchant: 'Uber',
+  category: 'Transportation',
+  date: '2025-06-23',
+  payment_method: 'cash',
+  amount: 45.75,
+});
+console.log(response.data);
+```
+
+### List Expenses
+
+```typescript
+const response = await client.expense.list({ page: 1, limit: 5 });
+console.log(response.data);
+```
+
+### Update an Expense
+
+```typescript
+const updates = { amount: 50.0 };
+const response = await client.expense.update('expense_id_here', updates);
+console.log(response.data);
+```
+
+### Delete an Expense
+
+```typescript
+const response = await client.expense.delete('expense_id_here');
+console.log(response.data.message);
+```
+
+## TypeScript Support
+
+The SDK includes full TypeScript support:
+
+```typescript
+import type { Expense, CreateExpenseRequest } from 'timber-node';
+```
+
+## Error Handling
+
+Errors are returned as Axios errors:
+
+```typescript
+import axios from 'axios';
+
+try {
+  await client.expense.get('invalid-id');
+} catch (err) {
+  if (axios.isAxiosError(err)) {
+    console.error(err.response?.status, err.response?.data);
+  }
+}
+```
+
+## Related Links
+
+- [Timber Website](https://timber.me)

package/dist/company.d.ts

@@ -4,13 +4,26 @@ export interface CompanyData {
     currency: string;
     language: string;
     address: string;
+    address_details: Map<string, any>;
     city: string;
     state: string;
     zip_code: string;
-    country: string;
+    country: {
+        _id: string;
+        name: string;
+        country_code: string;
+        currency: string;
+        timezone: string;
+        logo: string;
+        is_active: boolean;
+        created_at: string;
+        updated_at: string;
+    };
     email: string;
     country_code: string;
     mobile: string;
+    is_zakat: boolean;
+    zakat_number: string;
     tax_number: string;
     financial_start_date: string;
     license_expiry: string;
@@ -25,6 +38,7 @@ export interface CompanyData {
     license_number: string;
     license_authority: string;
     trn: string;
+    crn: string;
 }
 export interface Company extends CompanyData {
     _id: string;

package/dist/customer.d.ts

@@ -8,6 +8,7 @@ export interface CustomerData {
     city: string;
     role: 'customer' | 'vendor' | 'biller';
     address: string;
+    address_details?: Record<string, string>;
     trn?: string;
     [key: string]: any;
 }

package/dist/customer.js

@@ -46,17 +46,36 @@ class CustomerService {
      */
     async create(data) {
         const { formData, headers } = await (0, getFormData_1.getFormData)();
-        Object.entries(data).forEach(([key, value]) => {
+        const appendFormData = (key, value) => {
+            if (value === undefined || value === null)
+                return;
             if (value instanceof File) {
                 formData.append(key, value);
+                return;
             }
-            else {
-                formData.append(key, value);
+            if (Array.isArray(value)) {
+                value.forEach((item, index) => {
+                    if (item instanceof File) {
+                        formData.append(key, item);
+                    }
+                    else {
+                        appendFormData(`${key}[${index}]`, item);
+                    }
+                });
+                return;
             }
+            if (typeof value === 'object') {
+                Object.entries(value).forEach(([childKey, childValue]) => {
+                    appendFormData(`${key}[${childKey}]`, childValue);
+                });
+                return;
+            }
+            formData.append(key, String(value));
+        };
+        Object.entries(data).forEach(([key, value]) => {
+            appendFormData(key, value);
         });
-        return await this.http.post('/customer/customer', formData, {
-            headers,
-        });
+        return await this.http.post('/customer/customer', formData, { headers });
     }
     /**
      * Update an existing customer.
@@ -74,17 +93,36 @@ class CustomerService {
      */
     async update(id, data) {
         const { formData, headers } = await (0, getFormData_1.getFormData)();
-        Object.entries(data).forEach(([key, value]) => {
+        const appendFormData = (key, value) => {
+            if (value === undefined || value === null)
+                return;
             if (value instanceof File) {
                 formData.append(key, value);
+                return;
             }
-            else {
-                formData.append(key, value);
+            if (Array.isArray(value)) {
+                value.forEach((item, index) => {
+                    if (item instanceof File) {
+                        formData.append(key, item);
+                    }
+                    else {
+                        appendFormData(`${key}[${index}]`, item);
+                    }
+                });
+                return;
             }
+            if (typeof value === 'object') {
+                Object.entries(value).forEach(([childKey, childValue]) => {
+                    appendFormData(`${key}[${childKey}]`, childValue);
+                });
+                return;
+            }
+            formData.append(key, String(value));
+        };
+        Object.entries(data).forEach(([key, value]) => {
+            appendFormData(key, value);
         });
-        return await this.http.put(`/customer/customer/${id}`, formData, {
-            headers,
-        });
+        return await this.http.put(`/customer/customer/${id}`, formData, { headers });
     }
     /**
      * Delete an customer by ID.

package/dist/index.d.ts

@@ -14,7 +14,7 @@ import { ChequeService } from './cheque';
 import { BankStatementService } from './bankStatement';
 import { CompanyService } from './company';
 import { InvoiceNumberService } from './invoiceNumber';
-import { InvoiceTemplateService } from './invoiceTemplates';
+import { InvoiceSettingsService } from './invoiceSettings';
 import { InvoiceItemService } from './invoiceItem';
 declare class TimberClient {
     auth: AuthService;
@@ -33,7 +33,7 @@ declare class TimberClient {
     bankStatement: BankStatementService;
     company: CompanyService;
     invoiceNumber: InvoiceNumberService;
-    invoiceTemplate: InvoiceTemplateService;
+    invoiceSettings: InvoiceSettingsService;
     invoiceItem: InvoiceItemService;
     constructor(apiKey: string, options?: {
         baseURL?: string;

package/dist/index.js

@@ -21,7 +21,7 @@ const cheque_1 = require("./cheque");
 const bankStatement_1 = require("./bankStatement");
 const company_1 = require("./company");
 const invoiceNumber_1 = require("./invoiceNumber");
-const invoiceTemplates_1 = require("./invoiceTemplates");
+const invoiceSettings_1 = require("./invoiceSettings");
 const invoiceItem_1 = require("./invoiceItem");
 class TimberClient {
     constructor(apiKey, options = {}) {
@@ -60,7 +60,7 @@ class TimberClient {
         this.bankStatement = new bankStatement_1.BankStatementService(http);
         this.company = new company_1.CompanyService(http);
         this.invoiceNumber = new invoiceNumber_1.InvoiceNumberService(http);
-        this.invoiceTemplate = new invoiceTemplates_1.InvoiceTemplateService(http);
+        this.invoiceSettings = new invoiceSettings_1.InvoiceSettingsService(http);
         this.invoiceItem = new invoiceItem_1.InvoiceItemService(http);
     }
 }

package/dist/invoice.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceService = void 0;
 const getFormData_1 = require("./utils/getFormData");
+const convertToFormData_1 = require("./utils/convertToFormData");
 /**
  * Service for Invoice
  *
@@ -49,45 +50,41 @@ class InvoiceService {
     }
     async create(data) {
         const { formData, headers } = await (0, getFormData_1.getFormData)();
-        for (const key in data) {
-            const value = data[key];
-            if (key === 'items' || key === 'customer' || key === 'biller') {
-                formData.append(key, JSON.stringify(value));
-            }
-            else if (key === 'logo' && value && typeof value.pipe === 'function') {
-                // This is a ReadStream
-                formData.append('logo', value);
-            }
-            else if (value instanceof Date) {
-                formData.append(key, value.toISOString());
-            }
-            else if (value !== undefined && value !== null) {
-                formData.append(key, value.toString());
-            }
-        }
-        return await this.http.post('/customer/invoice', formData, {
+        const formattedFormData = (0, convertToFormData_1.convertToFormData)(data, formData);
+        // for (const key in data) {
+        //   const value = (data as any)[key];
+        //   if (key === 'items' || key === 'customer' || key === 'biller') {
+        //     formattedFormData.append(key, JSON.stringify(value));
+        //   } else if (key === 'logo' && value && typeof value.pipe === 'function') {
+        //     // This is a ReadStream
+        //     formattedFormData.append('logo', value);
+        //   } else if (value instanceof Date) {
+        //     formattedFormData.append(key, value.toISOString());
+        //   } else if (value !== undefined && value !== null) {
+        //     formattedFormData.append(key, value.toString());
+        //   }
+        // }
+        return await this.http.post('/customer/invoice', formattedFormData, {
             headers,
         });
     }
     async update(id, data) {
         const { formData, headers } = await (0, getFormData_1.getFormData)();
-        for (const key in data) {
-            const value = data[key];
-            if (key === 'items' || key === 'customer' || key === 'biller') {
-                formData.append(key, JSON.stringify(value));
-            }
-            else if (key === 'logo' && value && typeof value.pipe === 'function') {
-                // This is a ReadStream
-                formData.append('logo', value);
-            }
-            else if (value instanceof Date) {
-                formData.append(key, value.toISOString());
-            }
-            else if (value !== undefined && value !== null) {
-                formData.append(key, value.toString());
-            }
-        }
-        return await this.http.put(`/customer/invoice/${id}`, data, {
+        const formattedFormData = (0, convertToFormData_1.convertToFormData)(data, formData);
+        // for (const key in data) {
+        //   const value = (data as any)[key];
+        //   if (key === 'items' || key === 'customer' || key === 'biller') {
+        //     formattedFormData.append(key, JSON.stringify(value));
+        //   } else if (key === 'logo' && value && typeof value.pipe === 'function') {
+        //     // This is a ReadStream
+        //     formattedFormData.append('logo', value);
+        //   } else if (value instanceof Date) {
+        //     formattedFormData.append(key, value.toISOString());
+        //   } else if (value !== undefined && value !== null) {
+        //     formattedFormData.append(key, value.toString());
+        //   }
+        // }
+        return await this.http.put(`/customer/invoice/${id}`, formattedFormData, {
             headers,
         });
     }

package/dist/{invoiceTemplates.d.ts → invoiceSettings.d.ts}

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
-export interface CreateInvoiceTemplateRequest {
+export interface CreateInvoiceSettingsRequest {
     terms: [
         {
             name: string;
@@ -14,8 +14,8 @@ export interface CreateInvoiceTemplateRequest {
     ];
     type?: 'terms' | 'notes';
 }
-export type UpdateInvoiceTemplateRequest = Partial<CreateInvoiceTemplateRequest>;
-export interface InvoiceTemplate {
+export type UpdateInvoiceSettingsRequest = Partial<CreateInvoiceSettingsRequest>;
+export interface InvoiceSettings {
     _id: string;
     company: string;
     terms: [
@@ -33,7 +33,7 @@ export interface InvoiceTemplate {
     created_at: string;
     updated_at: string;
 }
-export interface InvoiceTemplateQueryParams {
+export interface InvoiceSettingsQueryParams {
     page?: number;
     limit?: number;
     sort?: string;
@@ -47,11 +47,11 @@ export interface InvoiceTemplateQueryParams {
  * ```ts
  * const { createClient } = require('timber-sdk-dev');
  * const client = createClient('your-api-key');
- * const InvoiceTemplate = await client.InvoiceTemplate.list({ page: 1, limit: 10 });
- * console.log(InvoiceTemplate.data);
+ * const InvoiceSettings = await client.InvoiceSettings.list({ page: 1, limit: 10 });
+ * console.log(InvoiceSettings.data);
  * ```
  */
-export declare class InvoiceTemplateService {
+export declare class InvoiceSettingsService {
     private http;
     constructor(http: AxiosInstance);
     /**
@@ -61,11 +61,11 @@ export declare class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const invoiceTemplates = await client.InvoiceTemplate.list();
-     * console.log(invoiceTemplates.data);
+     * const invoiceSettingss = await client.InvoiceSettings.list();
+     * console.log(invoiceSettingss.data);
      * ```
      */
-    list(params: InvoiceTemplateQueryParams): Promise<AxiosResponse<InvoiceTemplate>>;
+    list(params: InvoiceSettingsQueryParams): Promise<AxiosResponse<InvoiceSettings>>;
     /**
      * Fetch a single invoice template by ID.
      *
@@ -74,10 +74,10 @@ export declare class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const invoiceTemplate = await client.InvoiceTemplate.get('invoice_template_id_here');
-     * console.log(invoiceTemplate.data);
+     * const invoiceSettings = await client.InvoiceSettings.get('invoice_template_id_here');
+     * console.log(invoiceSettings.data);
      * ```  */
-    get(id: string): Promise<AxiosResponse<InvoiceTemplate>>;
+    get(id: string): Promise<AxiosResponse<InvoiceSettings>>;
     /**
      * Create a new invoice template.
      *
@@ -86,7 +86,7 @@ export declare class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const newInvoiceTemplate = {
+     * const newInvoiceSettings = {
      * terms: [
      *   {
      *     name: "Terms",
@@ -100,11 +100,11 @@ export declare class InvoiceTemplateService {
      *   }
      * ]
      * };
-     * const response = await client.InvoiceTemplate.create(newInvoiceTemplate);
+     * const response = await client.InvoiceSettings.create(newInvoiceSettings);
      * console.log(response.data);
      * ```
      */
-    create(data: CreateInvoiceTemplateRequest): Promise<AxiosResponse<InvoiceTemplate>>;
+    create(data: CreateInvoiceSettingsRequest): Promise<AxiosResponse<InvoiceSettings>>;
     /**
      * Update an existing invoice template.
      *
@@ -120,11 +120,11 @@ export declare class InvoiceTemplateService {
      *     content: "Notes content"
      *   }
      * ]};
-     * const updated = await client.InvoiceTemplate.update('invoice_template_id_here', updates);
+     * const updated = await client.InvoiceSettings.update('invoice_template_id_here', updates);
      * console.log(updated.data);
      * ```
      */
-    update(id: string, data: CreateInvoiceTemplateRequest): Promise<AxiosResponse<InvoiceTemplate>>;
+    update(id: string, data: CreateInvoiceSettingsRequest): Promise<AxiosResponse<InvoiceSettings>>;
     /**
      * Delete an invoice template by ID.
      *
@@ -133,7 +133,7 @@ export declare class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const response = await client.InvoiceTemplate.delete('expense_category_id_here');
+     * const response = await client.InvoiceSettings.delete('expense_category_id_here');
      * console.log(response.data.message);
      * ```
      */

package/dist/{invoiceTemplates.js → invoiceSettings.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvoiceTemplateService = void 0;
+exports.InvoiceSettingsService = void 0;
 /**
  * Service for Invoice Template
  *
@@ -8,11 +8,11 @@ exports.InvoiceTemplateService = void 0;
  * ```ts
  * const { createClient } = require('timber-sdk-dev');
  * const client = createClient('your-api-key');
- * const InvoiceTemplate = await client.InvoiceTemplate.list({ page: 1, limit: 10 });
- * console.log(InvoiceTemplate.data);
+ * const InvoiceSettings = await client.InvoiceSettings.list({ page: 1, limit: 10 });
+ * console.log(InvoiceSettings.data);
  * ```
  */
-class InvoiceTemplateService {
+class InvoiceSettingsService {
     constructor(http) {
         this.http = http;
     }
@@ -23,12 +23,12 @@ class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const invoiceTemplates = await client.InvoiceTemplate.list();
-     * console.log(invoiceTemplates.data);
+     * const invoiceSettingss = await client.InvoiceSettings.list();
+     * console.log(invoiceSettingss.data);
      * ```
      */
     async list(params) {
-        return await this.http.get('/customer/invoice-template', {
+        return await this.http.get('/customer/invoice-settings', {
             params,
         });
     }
@@ -40,11 +40,11 @@ class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const invoiceTemplate = await client.InvoiceTemplate.get('invoice_template_id_here');
-     * console.log(invoiceTemplate.data);
+     * const invoiceSettings = await client.InvoiceSettings.get('invoice_template_id_here');
+     * console.log(invoiceSettings.data);
      * ```  */
     async get(id) {
-        return await this.http.get(`/customer/invoice-template/${id}`);
+        return await this.http.get(`/customer/invoice-settings/${id}`);
     }
     /**
      * Create a new invoice template.
@@ -54,7 +54,7 @@ class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const newInvoiceTemplate = {
+     * const newInvoiceSettings = {
      * terms: [
      *   {
      *     name: "Terms",
@@ -68,12 +68,12 @@ class InvoiceTemplateService {
      *   }
      * ]
      * };
-     * const response = await client.InvoiceTemplate.create(newInvoiceTemplate);
+     * const response = await client.InvoiceSettings.create(newInvoiceSettings);
      * console.log(response.data);
      * ```
      */
     async create(data) {
-        return await this.http.post('/customer/invoice-template', data);
+        return await this.http.post('/customer/invoice-settings', data);
     }
     /**
      * Update an existing invoice template.
@@ -90,12 +90,12 @@ class InvoiceTemplateService {
      *     content: "Notes content"
      *   }
      * ]};
-     * const updated = await client.InvoiceTemplate.update('invoice_template_id_here', updates);
+     * const updated = await client.InvoiceSettings.update('invoice_template_id_here', updates);
      * console.log(updated.data);
      * ```
      */
     async update(id, data) {
-        return await this.http.put(`/customer/invoice-template/${id}`, data);
+        return await this.http.put(`/customer/invoice-settings/${id}`, data);
     }
     /**
      * Delete an invoice template by ID.
@@ -105,12 +105,12 @@ class InvoiceTemplateService {
      *
      * @example
      * ```ts
-     * const response = await client.InvoiceTemplate.delete('expense_category_id_here');
+     * const response = await client.InvoiceSettings.delete('expense_category_id_here');
      * console.log(response.data.message);
      * ```
      */
     async delete(id) {
-        return await this.http.delete(`/customer/invoice-template/${id}`);
+        return await this.http.delete(`/customer/invoice-settings/${id}`);
     }
 }
-exports.InvoiceTemplateService = InvoiceTemplateService;
+exports.InvoiceSettingsService = InvoiceSettingsService;

package/dist/taxRate.d.ts

@@ -8,6 +8,7 @@ export interface TaxRateData {
     type: string;
     [key: string]: any;
 }
+export type TaxRateType = 'SALES' | 'PURCHASES';
 export interface TaxRate extends TaxRateData {
     _id: string;
     createdAt?: string;
@@ -16,16 +17,37 @@ export interface TaxRate extends TaxRateData {
 export interface TaxRateQueryParams {
     page?: number;
     limit?: number;
+    type?: TaxRateType;
 }
 /**
  * Service for Tax Rate
  *
+ * @remarks
+ * The `type` parameter is mandatory and determines the tax context:
+ *
+ * - `SALES` → Use this when creating or displaying **customer invoices**
+ * - `PURCHASES` → Use this when creating or displaying **vendor payments / expenses**
+ *
  * @example
  * ```ts
  * const { createClient } = require('timber-sdk-dev');
  * const client = createClient('your-api-key');
- * const taxRate = await client.taxRate.list({ page: 1, limit: 10 });
- * console.log(taxRate.data);
+ *
+ * // Fetch tax rates for invoices
+ * const salesTaxes = await client.taxRate.list({
+ *   page: 1,
+ *   limit: 10,
+ *   type: 'SALES'
+ * });
+ *
+ * // Fetch tax rates for vendor payments
+ * const purchaseTaxes = await client.taxRate.list({
+ *   page: 1,
+ *   limit: 10,
+ *   type: 'PURCHASES'
+ * });
+ *
+ * console.log(salesTaxes.data);
  * ```
  */
 export declare class TaxRateService {

package/dist/taxRate.js

@@ -4,12 +4,32 @@ exports.TaxRateService = void 0;
 /**
  * Service for Tax Rate
  *
+ * @remarks
+ * The `type` parameter is mandatory and determines the tax context:
+ *
+ * - `SALES` → Use this when creating or displaying **customer invoices**
+ * - `PURCHASES` → Use this when creating or displaying **vendor payments / expenses**
+ *
  * @example
  * ```ts
  * const { createClient } = require('timber-sdk-dev');
  * const client = createClient('your-api-key');
- * const taxRate = await client.taxRate.list({ page: 1, limit: 10 });
- * console.log(taxRate.data);
+ *
+ * // Fetch tax rates for invoices
+ * const salesTaxes = await client.taxRate.list({
+ *   page: 1,
+ *   limit: 10,
+ *   type: 'SALES'
+ * });
+ *
+ * // Fetch tax rates for vendor payments
+ * const purchaseTaxes = await client.taxRate.list({
+ *   page: 1,
+ *   limit: 10,
+ *   type: 'PURCHASES'
+ * });
+ *
+ * console.log(salesTaxes.data);
  * ```
  */
 class TaxRateService {

package/dist/utils/convertToFormData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a nested object to FormData
+ * @param obj - The object to convert
+ * @param formData - The FormData instance (optional, creates new if not provided)
+ * @param parentKey - The parent key for nested properties (used internally)
+ * @returns FormData instance
+ */
+export declare function convertToFormData(obj: any, formData?: FormData, parentKey?: string): FormData;

package/dist/utils/convertToFormData.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToFormData = convertToFormData;
+/**
+ * Converts a nested object to FormData
+ * @param obj - The object to convert
+ * @param formData - The FormData instance (optional, creates new if not provided)
+ * @param parentKey - The parent key for nested properties (used internally)
+ * @returns FormData instance
+ */
+function convertToFormData(obj, formData = new FormData(), parentKey = '') {
+    if (obj === null || obj === undefined) {
+        return formData;
+    }
+    Object.keys(obj).forEach(key => {
+        const value = obj[key];
+        const formKey = parentKey ? `${parentKey}[${key}]` : key;
+        // Handle null or undefined values - skip them
+        if (value === null || value === undefined) {
+            formData.append(formKey, '');
+            return;
+        }
+        // Handle File objects
+        if (value instanceof File) {
+            formData.append(formKey, value);
+        }
+        // Handle Blob objects
+        else if (value instanceof Blob) {
+            formData.append(formKey, value);
+        }
+        // Handle Date objects
+        else if (value instanceof Date) {
+            formData.append(formKey, value.toISOString());
+        }
+        // Handle Arrays
+        else if (Array.isArray(value)) {
+            // Handle empty arrays - mark them so backend can reconstruct
+            if (value.length === 0) {
+                formData.append(formKey, '[]');
+                return;
+            }
+            value.forEach((item, index) => {
+                const arrayKey = `${formKey}[${index}]`;
+                // If array item is an object, recurse
+                if (typeof item === 'object' &&
+                    item !== null &&
+                    !(item instanceof File) &&
+                    !(item instanceof Blob)) {
+                    convertToFormData(item, formData, arrayKey);
+                }
+                // If array item is a primitive or File/Blob, append with indexed key
+                else if (item !== null && item !== undefined) {
+                    formData.append(arrayKey, item);
+                }
+            });
+        }
+        // Handle nested objects (but not File/Blob/Date)
+        else if (typeof value === 'object' &&
+            !(value instanceof File) &&
+            !(value instanceof Blob) &&
+            !(value instanceof Date)) {
+            convertToFormData(value, formData, formKey);
+        }
+        // Handle primitives (string, number, boolean)
+        else {
+            // Convert booleans and numbers to strings
+            formData.append(formKey, String(value));
+        }
+    });
+    return formData;
+}

package/package.json

@@ -1,63 +1,63 @@
-{
-  "name": "timber-node",
-  "version": "0.4.4",
-  "description": "Simplifying accounting and tax filing for businesses",
-  "keywords": [
-    "timber"
-  ],
-  "homepage": "https://github.com/TImber-UAE/timber-be-sdk-s#readme",
-  "bugs": {
-    "url": "https://github.com/TImber-UAE/timber-be-sdk-s/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/TImber-UAE/timber-be-sdk-s.git"
-  },
-  "license": "MIT",
-  "author": "timberaccounting",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./dist/index.js",
-      "default": "./dist/index.js"
-    }
-  },
-  "scripts": {
-    "dev": "nodemon src/index.js",
-    "build": "tsc",
-    "docs": "typedoc",
-    "prepare": "husky",
-    "lint": "eslint . --ext .ts,.js",
-    "lint:fix": "eslint . --ext .ts,.js --fix"
-  },
-  "lint-staged": {
-    "*.{js,ts,json,md}": [
-      "prettier --write",
-      "eslint --fix"
-    ]
-  },
-  "dependencies": {
-    "axios": "^1.10.0",
-    "form-data": "^4.0.3",
-    "timber-node": "^0.0.5",
-    "typescript-eslint": "^8.35.0"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@types/node": "^24.0.4",
-    "@typescript-eslint/eslint-plugin": "^8.35.0",
-    "@typescript-eslint/parser": "^8.35.0",
-    "eslint": "^9.29.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-prettier": "^5.5.1",
-    "globals": "^16.2.0",
-    "husky": "^8.0.3",
-    "nodemon": "^3.1.10",
-    "prettier": "^3.6.2",
-    "typedoc": "^0.28.5",
-    "typedoc-plugin-markdown": "^4.7.0",
-    "typescript": "^5.8.3"
-  }
-}
+{
+  "name": "timber-node",
+  "version": "0.4.5",
+  "description": "Simplifying accounting and tax filing for businesses",
+  "keywords": [
+    "timber"
+  ],
+  "homepage": "https://github.com/TImber-UAE/timber-be-sdk-s#readme",
+  "bugs": {
+    "url": "https://github.com/TImber-UAE/timber-be-sdk-s/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TImber-UAE/timber-be-sdk-s.git"
+  },
+  "license": "MIT",
+  "author": "timberaccounting",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "dev": "nodemon src/index.js",
+    "build": "tsc",
+    "docs": "typedoc",
+    "prepare": "husky",
+    "lint": "eslint . --ext .ts,.js",
+    "lint:fix": "eslint . --ext .ts,.js --fix"
+  },
+  "lint-staged": {
+    "*.{js,ts,json,md}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "dependencies": {
+    "axios": "^1.10.0",
+    "form-data": "^4.0.3",
+    "timber-node": "^0.0.5",
+    "typescript-eslint": "^8.35.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@types/node": "^24.0.4",
+    "@typescript-eslint/eslint-plugin": "^8.35.0",
+    "@typescript-eslint/parser": "^8.35.0",
+    "eslint": "^9.29.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-prettier": "^5.5.1",
+    "globals": "^16.2.0",
+    "husky": "^8.0.3",
+    "nodemon": "^3.1.10",
+    "prettier": "^3.6.2",
+    "typedoc": "^0.28.5",
+    "typedoc-plugin-markdown": "^4.7.0",
+    "typescript": "^5.8.3"
+  }
+}