Merge pull request #73 from mathewmeconry/feat/bills-v4-implementation

feat: implement bexio Bills V4 API endpoint

Author: mathewmeconry

.github/workflows/nightly.yml

@@ -15,6 +15,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v6
+      with:
+        node-version: ${{ matrix.node-version }}
+        
+    - name: Enable corepack
+      run: corepack enable
+      
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v6
       with:

.github/workflows/test.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

.yarnrc.yml

@@ -1,6 +1,6 @@
 {
   "name": "bexio",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "NPM Package for the api of bexio.com",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -79,5 +79,6 @@
     "roots": [
       "./src"
     ]
-  }
+  },
+  "packageManager": "yarn@4.12.0"
 }

package.json

@@ -16,6 +16,7 @@ import Users from "./resources/Users";
 import Items from "./resources/Items";
 import Invoices from "./resources/Invoices";
 import Currencies from "./resources/Currencies";
+import BillsV4 from "./resources/BillsV4";
 
 export * from "./interfaces/BillsStatic";
 export * from "./interfaces/BusinessActivitiesStatic";
@@ -39,6 +40,7 @@ export * from "./interfaces/ItemsStatic";
 export * from "./interfaces/InvoicesStatic";
 export * from "./interfaces/PositionStatic";
 export * from "./interfaces/CurrenciesStatic";
+export * from "./interfaces/BillsV4Static";
 
 export default class Bexio {
   private token: string;
@@ -57,6 +59,11 @@ export default class Bexio {
   // Sales Order Management
   public orders: Orders;
   public expenses: Expenses;
+  public billsV4: BillsV4;
+
+  /**
+   * @deprecated Use BillsV4 instead
+   */
   public bills: Bills;
 
   // Projects
@@ -95,6 +102,7 @@ export default class Bexio {
     this.projectStatuses = new ProjectStatuses(this.token);
     this.projectTypes = new ProjectTypes(this.token);
     this.expenses = new Expenses(this.token);
+    this.billsV4 = new BillsV4(this.token);
     this.bills = new Bills(this.token);
     this.timetrackings = new Timetrackings(this.token);
     this.timetrackingStatuses = new TimetrackingStatuses(this.token);

src/index.ts

@@ -0,0 +1,212 @@
+export namespace BillsV4Static {
+  export interface Bill {
+    id: string; // uuid, required
+    document_no: string; // required, 1..255 chars
+    title?: string; // 1..80 chars
+    status: BillStatus; // required, enum
+    firstname_suffix?: string; // 1..80 chars
+    lastname_company: string; // required, 1..80 chars
+    created_at: string; // required, date-time
+    vendor_ref?: string; // 1..255 chars
+    pending_amount?: number; // double
+    currency_code: string; // required, 1..20 chars
+    net?: number; // double, calculated from line_items and discounts
+    gross?: number; // double, calculated from line_items and discounts
+    bill_date: string; // required, date
+    due_date: string; // required, date
+    overdue: boolean; // required
+    booking_account_ids: number[]; // required, array of int32
+    attachment_ids: string[]; // required, array of uuid
+  }
+
+  export interface BillFull extends Bill {
+    supplier_id: number;
+    contact_partner_id: number;
+    amount_man: number;
+    amount_calc: number;
+    manual_amount: boolean;
+    exchange_rate: number;
+    base_currency_code: string;
+    item_net: boolean;
+    split_into_line_items: boolean;
+    purchase_order_id?: number;
+    base_currency_amount: number;
+    qr_bill_information?: string;
+    address: Address;
+    line_items: LineItem[];
+    discounts: Discount[];
+    payment?: Payment;
+    note?: string;
+  }
+
+  export interface Address {
+    title?: string;
+    salutation?: string;
+    firstname_suffix?: string;
+    lastname_company: string;
+    address_line?: string;
+    postcode?: string;
+    city?: string;
+    country_code?: string;
+    main_contact_id?: number;
+    contact_address_id?: number;
+    type: "PRIVATE" | "COMPANY";
+  }
+
+  export interface LineItem {
+    position: number;
+    title?: string;
+    tax_id?: number;
+    amount: number;
+    booking_account_id?: number;
+  }
+
+  export interface Discount {
+    position: number;
+    amount: number;
+  }
+
+  export interface Payment {
+    type: PaymentType;
+    bank_account_id?: number;
+    fee?: PaymentFee;
+    execution_date: string;
+    exchange_rate?: number;
+    amount: number;
+    account_no?: string;
+    iban?: string;
+    name?: string;
+    address?: string;
+    street?: string;
+    house_no?: string;
+    postcode?: string;
+    city?: string;
+    country_code?: string;
+    message?: string;
+    booking_text?: string;
+    salary_payment?: boolean;
+    reference_no?: string;
+  }
+
+  export interface BillCreate {
+    supplier_id: number;
+    vendor_ref?: string;
+    title?: string;
+    contact_partner_id: number;
+    bill_date: string;
+    due_date: string;
+    amount_man?: number;
+    amount_calc?: number;
+    manual_amount: boolean;
+    currency_code: string;
+    exchange_rate?: number;
+    base_currency_amount?: number;
+    item_net: boolean;
+    purchase_order_id?: number;
+    qr_bill_information?: string;
+    attachment_ids: string[];
+    address: Address;
+    line_items: LineItem[];
+    discounts: Discount[];
+    payment?: Payment;
+    salary_payment?: boolean;
+    reference_no?: string;
+    note?: string;
+  }
+
+  export interface BillOverwrite {
+    document_no?: string;
+    title?: string;
+    supplier_id: number;
+    vendor_ref?: string;
+    contact_partner_id: number;
+    bill_date: string;
+    due_date: string;
+    amount_man?: number;
+    amount_calc?: number;
+    manual_amount: boolean;
+    currency_code: string;
+    exchange_rate?: number;
+    item_net: boolean;
+    split_into_line_items: boolean;
+    base_currency_amount?: number;
+    attachment_ids: string[];
+    address: Address;
+    line_items: LineItem[];
+    discounts: Discount[];
+    payment?: Payment;
+  }
+
+  export enum SearchParameters {
+    document_no = "document_no",
+    title = "title",
+    vendor_ref = "vendor_ref",
+    currency_code = "currency_code",
+    lastname_company = "lastname_company",
+    firstname_suffix = "firstname_suffix",
+  }
+
+  export enum BillStatusUpdate {
+    DRAFT = "DRAFT",
+    BOOKED = "BOOKED",
+  }
+
+  export enum BillAction {
+    DUPLICATE = "DUPLICATE",
+  }
+
+  export interface ListOptions {
+    limit?: number;
+    page?: number;
+    order?: "asc" | "desc";
+    sort?: string;
+    search_term?: string;
+    "fields[]"?: string[];
+    status?: "DRAFTS" | "TODO" | "PAID" | "OVERDUE";
+    bill_date_start?: string;
+    bill_date_end?: string;
+    due_date_start?: string;
+    due_date_end?: string;
+    vendor_ref?: string;
+    title?: string;
+    currency_code?: string;
+    pending_amount_min?: number;
+    pending_amount_max?: number;
+    vendor?: string;
+    gross_min?: number;
+    gross_max?: number;
+    net_min?: number;
+    net_max?: number;
+    document_no?: string;
+    supplier_id?: number;
+    average_exchange_rate_enabled?: boolean;
+  }
+
+  export enum PaymentType {
+    IBAN = "IBAN",
+    MANUAL = "MANUAL",
+    QR = "QR",
+  }
+
+  export enum PaymentFee {
+    BY_SENDER = "BY_SENDER",
+    BY_RECEIVER = "BY_RECEIVER",
+    BREAKDOWN = "BREAKDOWN",
+    NO_FEE = "NO_FEE",
+  }
+
+  export enum BillStatus {
+    DRAFT = "DRAFT",
+    BOOKED = "BOOKED",
+    PARTIALLY_CREATED = "PARTIALLY_CREATED",
+    CREATED = "CREATED",
+    PARTIALLY_SENT = "PARTIALLY_SENT",
+    SENT = "SENT",
+    PARTIALLY_DOWNLOADED = "PARTIALLY_DOWNLOADED",
+    DOWNLOADED = "DOWNLOADED",
+    PARTIALLY_PAID = "PARTIALLY_PAID",
+    PAID = "PAID",
+    PARTIALLY_FAILED = "PARTIALLY_FAILED",
+    FAILED = "FAILED",
+  }
+}

src/interfaces/BillsV4Static.ts

@@ -4,6 +4,9 @@ import Payments from "./Payments";
 import { PaymentsStatic } from "../interfaces/PaymentsStatic";
 import { BaseStatic } from "../interfaces/BaseStatic";
 
+/**
+ * @deprecated Use BillsV4 instead
+ */
 export default class Bills extends BaseCrud<
   BillsStatic.Bill,
   BillsStatic.BillFull,