bexio 4.0.0 → 4.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.mts CHANGED
@@ -176,64 +176,64 @@ declare namespace ContactsStatic {
176
176
  profile_image: string;
177
177
  }
178
178
  interface ContactCreate {
179
- nr?: string;
179
+ nr?: string | null;
180
180
  name_1: string;
181
181
  user_id: number;
182
- country_id?: number;
182
+ country_id?: number | null;
183
183
  owner_id: number;
184
184
  contact_type_id: number;
185
- contact_group_ids?: Array<number>;
186
- name_2?: string;
187
- salutation_id?: number;
188
- salutation_form?: number;
189
- title_id?: number;
190
- birthday?: string;
191
- street_name?: string;
192
- house_number?: string;
193
- address_addition?: string;
194
- postcode?: string;
195
- city?: string;
196
- mail?: string;
197
- mail_second?: string;
198
- phone_fixed?: string;
199
- phone_fixed_second?: string;
200
- phone_mobile?: string;
201
- fax?: string;
202
- url?: string;
203
- skype_name?: string;
204
- remarks?: string;
205
- language_id?: number;
206
- contact_branch_ids?: string;
185
+ contact_group_ids?: Array<number> | null;
186
+ name_2?: string | null;
187
+ salutation_id?: number | null;
188
+ salutation_form?: number | null;
189
+ title_id?: number | null;
190
+ birthday?: string | null;
191
+ street_name?: string | null;
192
+ house_number?: string | null;
193
+ address_addition?: string | null;
194
+ postcode?: string | null;
195
+ city?: string | null;
196
+ mail?: string | null;
197
+ mail_second?: string | null;
198
+ phone_fixed?: string | null;
199
+ phone_fixed_second?: string | null;
200
+ phone_mobile?: string | null;
201
+ fax?: string | null;
202
+ url?: string | null;
203
+ skype_name?: string | null;
204
+ remarks?: string | null;
205
+ language_id?: number | null;
206
+ contact_branch_ids?: string | null;
207
207
  }
208
208
  interface ContactOverwrite {
209
- nr?: string;
209
+ nr?: string | null;
210
210
  name_1: string;
211
211
  user_id: number;
212
- country_id?: number;
212
+ country_id?: number | null;
213
213
  owner_id: number;
214
214
  contact_type_id: number;
215
- contact_group_ids?: Array<number>;
216
- name_2?: string;
217
- salutation_id?: number;
218
- salutation_form?: number;
219
- title_id?: number;
220
- birthday?: string;
221
- street_name?: string;
222
- house_number?: string;
223
- address_addition?: string;
224
- postcode?: string;
225
- city?: string;
226
- mail?: string;
227
- mail_second?: string;
228
- phone_fixed?: string;
229
- phone_fixed_second?: string;
230
- phone_mobile?: string;
231
- fax?: string;
232
- url?: string;
233
- skype_name?: string;
234
- remarks?: string;
235
- language_id?: number;
236
- contact_branch_ids?: string;
215
+ contact_group_ids?: Array<number> | null;
216
+ name_2?: string | null;
217
+ salutation_id?: number | null;
218
+ salutation_form?: number | null;
219
+ title_id?: number | null;
220
+ birthday?: string | null;
221
+ street_name?: string | null;
222
+ house_number?: string | null;
223
+ address_addition?: string | null;
224
+ postcode?: string | null;
225
+ city?: string | null;
226
+ mail?: string | null;
227
+ mail_second?: string | null;
228
+ phone_fixed?: string | null;
229
+ phone_fixed_second?: string | null;
230
+ phone_mobile?: string | null;
231
+ fax?: string | null;
232
+ url?: string | null;
233
+ skype_name?: string | null;
234
+ remarks?: string | null;
235
+ language_id?: number | null;
236
+ contact_branch_ids?: string | null;
237
237
  }
238
238
  enum ContactSearchParameters {
239
239
  id = "id",
@@ -873,6 +873,7 @@ declare namespace OrdersStatic {
873
873
 
874
874
  declare namespace PositionsStatic {
875
875
  type KbDocumentType = "kb_invoice" | "kb_offer" | "kb_order";
876
+ type PositionType = "KbPositionCustom" | "KbPositionArticle" | "KbPositionText" | "KbPositionSubtotal" | "KbPositionPagebreak" | "KbPositionDiscount" | "KbPositionSubposition";
876
877
  interface DefaultPositionCreate {
877
878
  amount: string;
878
879
  amount_reserved: string;
@@ -918,6 +919,42 @@ declare namespace PositionsStatic {
918
919
  }
919
920
  }
920
921
 
922
+ declare namespace PositionStatic {
923
+ interface PositionCreate {
924
+ amount?: string;
925
+ unit_id?: number;
926
+ account_id?: number;
927
+ tax_id?: number;
928
+ text: string;
929
+ unit_price?: string;
930
+ discount_in_percent?: string;
931
+ type: string;
932
+ parent_id?: number | null;
933
+ article_id?: number;
934
+ show_pos_nr?: boolean;
935
+ is_percentual?: boolean;
936
+ value?: string;
937
+ }
938
+ interface Position {
939
+ id: number;
940
+ type: PositionsStatic.PositionType;
941
+ amount: string;
942
+ unit_id: number;
943
+ account_id: number;
944
+ unit_name: string;
945
+ tax_id: number;
946
+ tax_value: string;
947
+ text: string;
948
+ unit_price: string;
949
+ discount_in_percent: string | null;
950
+ position_total: string;
951
+ pos: string;
952
+ internal_pos: number;
953
+ parent_id: number | null;
954
+ is_optional: boolean;
955
+ }
956
+ }
957
+
921
958
  declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.OrderFull, OrdersStatic.OrderSmall, OrdersStatic.OrderSearchParameters, OrdersStatic.OrderCreate, OrdersStatic.OrderCreate> {
922
959
  constructor(apiToken: string);
923
960
  /**
@@ -947,6 +984,42 @@ declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.Orde
947
984
  * @memberof Orders
948
985
  */
949
986
  createTextPosition(orderId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
987
+ /**
988
+ * Delete a default position for an order
989
+ *
990
+ * @param {number} orderId
991
+ * @param {number} positionId
992
+ * @returns {Promise<boolean>}
993
+ * @memberof Orders
994
+ */
995
+ deleteDefaultPosition(orderId: number, positionId: number): Promise<boolean>;
996
+ /**
997
+ * Delete an item position for an order
998
+ *
999
+ * @param {number} orderId
1000
+ * @param {number} positionId
1001
+ * @returns {Promise<boolean>}
1002
+ * @memberof Orders
1003
+ */
1004
+ deleteItemPosition(orderId: number, positionId: number): Promise<boolean>;
1005
+ /**
1006
+ * Delete a text position for an order
1007
+ *
1008
+ * @param {number} orderId
1009
+ * @param {number} positionId
1010
+ * @returns {Promise<boolean>}
1011
+ * @memberof Orders
1012
+ */
1013
+ deleteTextPosition(orderId: number, positionId: number): Promise<boolean>;
1014
+ /**
1015
+ * Delete a position for an order, whatever its type
1016
+ *
1017
+ * @param {number} orderId
1018
+ * @param {Pick<PositionStatic.Position, "id" | "type">} position
1019
+ * @returns {Promise<boolean>}
1020
+ * @memberof Orders
1021
+ */
1022
+ deletePosition(orderId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
950
1023
  }
951
1024
 
952
1025
  declare namespace ProjectsStatic {
@@ -1423,42 +1496,6 @@ declare class Items extends BaseCrud<ItemsStatic.Item, ItemsStatic.Item, ItemsSt
1423
1496
  constructor(apiToken: string);
1424
1497
  }
1425
1498
 
1426
- declare namespace PositionStatic {
1427
- interface PositionCreate {
1428
- amount?: string;
1429
- unit_id?: number;
1430
- account_id?: number;
1431
- tax_id?: number;
1432
- text: string;
1433
- unit_price?: string;
1434
- discount_in_percent?: string;
1435
- type: string;
1436
- parent_id?: number | null;
1437
- article_id?: number;
1438
- show_pos_nr?: boolean;
1439
- is_percentual?: boolean;
1440
- value?: string;
1441
- }
1442
- interface Position {
1443
- id: number;
1444
- type: string;
1445
- amount: string;
1446
- unit_id: number;
1447
- account_id: number;
1448
- unit_name: string;
1449
- tax_id: number;
1450
- tax_value: string;
1451
- text: string;
1452
- unit_price: string;
1453
- discount_in_percent: null;
1454
- position_total: string;
1455
- pos: string;
1456
- internal_pos: number;
1457
- parent_id: null;
1458
- is_optional: false;
1459
- }
1460
- }
1461
-
1462
1499
  declare namespace InvoicesStatic {
1463
1500
  interface Invoice {
1464
1501
  id: number;
@@ -1508,6 +1545,7 @@ declare namespace InvoicesStatic {
1508
1545
  title?: string | null;
1509
1546
  contact_id: number;
1510
1547
  contact_sub_id?: number | null;
1548
+ contact_address_manual?: string | null;
1511
1549
  user_id: number;
1512
1550
  pr_project_id?: number | null;
1513
1551
  logopaper_id?: number;
@@ -1531,6 +1569,7 @@ declare namespace InvoicesStatic {
1531
1569
  title?: string | null;
1532
1570
  contact_id?: number;
1533
1571
  contact_sub_id?: number | null;
1572
+ contact_address_manual?: string | null;
1534
1573
  user_id?: number;
1535
1574
  pr_project_id?: number | null;
1536
1575
  logopaper_id?: number;
@@ -1729,6 +1768,42 @@ declare class Invoices extends BaseCrud<InvoicesStatic.Invoice, InvoicesStatic.I
1729
1768
  * @memberof Invoices
1730
1769
  */
1731
1770
  createTextPosition(invoiceId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
1771
+ /**
1772
+ * Delete a default position for an invoice
1773
+ *
1774
+ * @param {number} invoiceId
1775
+ * @param {number} positionId
1776
+ * @returns {Promise<boolean>}
1777
+ * @memberof Invoices
1778
+ */
1779
+ deleteDefaultPosition(invoiceId: number, positionId: number): Promise<boolean>;
1780
+ /**
1781
+ * Delete an item position for an invoice
1782
+ *
1783
+ * @param {number} invoiceId
1784
+ * @param {number} positionId
1785
+ * @returns {Promise<boolean>}
1786
+ * @memberof Invoices
1787
+ */
1788
+ deleteItemPosition(invoiceId: number, positionId: number): Promise<boolean>;
1789
+ /**
1790
+ * Delete a text position for an invoice
1791
+ *
1792
+ * @param {number} invoiceId
1793
+ * @param {number} positionId
1794
+ * @returns {Promise<boolean>}
1795
+ * @memberof Invoices
1796
+ */
1797
+ deleteTextPosition(invoiceId: number, positionId: number): Promise<boolean>;
1798
+ /**
1799
+ * Delete a position for an invoice, whatever its type
1800
+ *
1801
+ * @param {number} invoiceId
1802
+ * @param {Pick<PositionStatic.Position, "id" | "type">} position
1803
+ * @returns {Promise<boolean>}
1804
+ * @memberof Invoices
1805
+ */
1806
+ deletePosition(invoiceId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
1732
1807
  }
1733
1808
 
1734
1809
  declare namespace CurrenciesStatic {
package/lib/index.d.ts CHANGED
@@ -176,64 +176,64 @@ declare namespace ContactsStatic {
176
176
  profile_image: string;
177
177
  }
178
178
  interface ContactCreate {
179
- nr?: string;
179
+ nr?: string | null;
180
180
  name_1: string;
181
181
  user_id: number;
182
- country_id?: number;
182
+ country_id?: number | null;
183
183
  owner_id: number;
184
184
  contact_type_id: number;
185
- contact_group_ids?: Array<number>;
186
- name_2?: string;
187
- salutation_id?: number;
188
- salutation_form?: number;
189
- title_id?: number;
190
- birthday?: string;
191
- street_name?: string;
192
- house_number?: string;
193
- address_addition?: string;
194
- postcode?: string;
195
- city?: string;
196
- mail?: string;
197
- mail_second?: string;
198
- phone_fixed?: string;
199
- phone_fixed_second?: string;
200
- phone_mobile?: string;
201
- fax?: string;
202
- url?: string;
203
- skype_name?: string;
204
- remarks?: string;
205
- language_id?: number;
206
- contact_branch_ids?: string;
185
+ contact_group_ids?: Array<number> | null;
186
+ name_2?: string | null;
187
+ salutation_id?: number | null;
188
+ salutation_form?: number | null;
189
+ title_id?: number | null;
190
+ birthday?: string | null;
191
+ street_name?: string | null;
192
+ house_number?: string | null;
193
+ address_addition?: string | null;
194
+ postcode?: string | null;
195
+ city?: string | null;
196
+ mail?: string | null;
197
+ mail_second?: string | null;
198
+ phone_fixed?: string | null;
199
+ phone_fixed_second?: string | null;
200
+ phone_mobile?: string | null;
201
+ fax?: string | null;
202
+ url?: string | null;
203
+ skype_name?: string | null;
204
+ remarks?: string | null;
205
+ language_id?: number | null;
206
+ contact_branch_ids?: string | null;
207
207
  }
208
208
  interface ContactOverwrite {
209
- nr?: string;
209
+ nr?: string | null;
210
210
  name_1: string;
211
211
  user_id: number;
212
- country_id?: number;
212
+ country_id?: number | null;
213
213
  owner_id: number;
214
214
  contact_type_id: number;
215
- contact_group_ids?: Array<number>;
216
- name_2?: string;
217
- salutation_id?: number;
218
- salutation_form?: number;
219
- title_id?: number;
220
- birthday?: string;
221
- street_name?: string;
222
- house_number?: string;
223
- address_addition?: string;
224
- postcode?: string;
225
- city?: string;
226
- mail?: string;
227
- mail_second?: string;
228
- phone_fixed?: string;
229
- phone_fixed_second?: string;
230
- phone_mobile?: string;
231
- fax?: string;
232
- url?: string;
233
- skype_name?: string;
234
- remarks?: string;
235
- language_id?: number;
236
- contact_branch_ids?: string;
215
+ contact_group_ids?: Array<number> | null;
216
+ name_2?: string | null;
217
+ salutation_id?: number | null;
218
+ salutation_form?: number | null;
219
+ title_id?: number | null;
220
+ birthday?: string | null;
221
+ street_name?: string | null;
222
+ house_number?: string | null;
223
+ address_addition?: string | null;
224
+ postcode?: string | null;
225
+ city?: string | null;
226
+ mail?: string | null;
227
+ mail_second?: string | null;
228
+ phone_fixed?: string | null;
229
+ phone_fixed_second?: string | null;
230
+ phone_mobile?: string | null;
231
+ fax?: string | null;
232
+ url?: string | null;
233
+ skype_name?: string | null;
234
+ remarks?: string | null;
235
+ language_id?: number | null;
236
+ contact_branch_ids?: string | null;
237
237
  }
238
238
  enum ContactSearchParameters {
239
239
  id = "id",
@@ -873,6 +873,7 @@ declare namespace OrdersStatic {
873
873
 
874
874
  declare namespace PositionsStatic {
875
875
  type KbDocumentType = "kb_invoice" | "kb_offer" | "kb_order";
876
+ type PositionType = "KbPositionCustom" | "KbPositionArticle" | "KbPositionText" | "KbPositionSubtotal" | "KbPositionPagebreak" | "KbPositionDiscount" | "KbPositionSubposition";
876
877
  interface DefaultPositionCreate {
877
878
  amount: string;
878
879
  amount_reserved: string;
@@ -918,6 +919,42 @@ declare namespace PositionsStatic {
918
919
  }
919
920
  }
920
921
 
922
+ declare namespace PositionStatic {
923
+ interface PositionCreate {
924
+ amount?: string;
925
+ unit_id?: number;
926
+ account_id?: number;
927
+ tax_id?: number;
928
+ text: string;
929
+ unit_price?: string;
930
+ discount_in_percent?: string;
931
+ type: string;
932
+ parent_id?: number | null;
933
+ article_id?: number;
934
+ show_pos_nr?: boolean;
935
+ is_percentual?: boolean;
936
+ value?: string;
937
+ }
938
+ interface Position {
939
+ id: number;
940
+ type: PositionsStatic.PositionType;
941
+ amount: string;
942
+ unit_id: number;
943
+ account_id: number;
944
+ unit_name: string;
945
+ tax_id: number;
946
+ tax_value: string;
947
+ text: string;
948
+ unit_price: string;
949
+ discount_in_percent: string | null;
950
+ position_total: string;
951
+ pos: string;
952
+ internal_pos: number;
953
+ parent_id: number | null;
954
+ is_optional: boolean;
955
+ }
956
+ }
957
+
921
958
  declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.OrderFull, OrdersStatic.OrderSmall, OrdersStatic.OrderSearchParameters, OrdersStatic.OrderCreate, OrdersStatic.OrderCreate> {
922
959
  constructor(apiToken: string);
923
960
  /**
@@ -947,6 +984,42 @@ declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.Orde
947
984
  * @memberof Orders
948
985
  */
949
986
  createTextPosition(orderId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
987
+ /**
988
+ * Delete a default position for an order
989
+ *
990
+ * @param {number} orderId
991
+ * @param {number} positionId
992
+ * @returns {Promise<boolean>}
993
+ * @memberof Orders
994
+ */
995
+ deleteDefaultPosition(orderId: number, positionId: number): Promise<boolean>;
996
+ /**
997
+ * Delete an item position for an order
998
+ *
999
+ * @param {number} orderId
1000
+ * @param {number} positionId
1001
+ * @returns {Promise<boolean>}
1002
+ * @memberof Orders
1003
+ */
1004
+ deleteItemPosition(orderId: number, positionId: number): Promise<boolean>;
1005
+ /**
1006
+ * Delete a text position for an order
1007
+ *
1008
+ * @param {number} orderId
1009
+ * @param {number} positionId
1010
+ * @returns {Promise<boolean>}
1011
+ * @memberof Orders
1012
+ */
1013
+ deleteTextPosition(orderId: number, positionId: number): Promise<boolean>;
1014
+ /**
1015
+ * Delete a position for an order, whatever its type
1016
+ *
1017
+ * @param {number} orderId
1018
+ * @param {Pick<PositionStatic.Position, "id" | "type">} position
1019
+ * @returns {Promise<boolean>}
1020
+ * @memberof Orders
1021
+ */
1022
+ deletePosition(orderId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
950
1023
  }
951
1024
 
952
1025
  declare namespace ProjectsStatic {
@@ -1423,42 +1496,6 @@ declare class Items extends BaseCrud<ItemsStatic.Item, ItemsStatic.Item, ItemsSt
1423
1496
  constructor(apiToken: string);
1424
1497
  }
1425
1498
 
1426
- declare namespace PositionStatic {
1427
- interface PositionCreate {
1428
- amount?: string;
1429
- unit_id?: number;
1430
- account_id?: number;
1431
- tax_id?: number;
1432
- text: string;
1433
- unit_price?: string;
1434
- discount_in_percent?: string;
1435
- type: string;
1436
- parent_id?: number | null;
1437
- article_id?: number;
1438
- show_pos_nr?: boolean;
1439
- is_percentual?: boolean;
1440
- value?: string;
1441
- }
1442
- interface Position {
1443
- id: number;
1444
- type: string;
1445
- amount: string;
1446
- unit_id: number;
1447
- account_id: number;
1448
- unit_name: string;
1449
- tax_id: number;
1450
- tax_value: string;
1451
- text: string;
1452
- unit_price: string;
1453
- discount_in_percent: null;
1454
- position_total: string;
1455
- pos: string;
1456
- internal_pos: number;
1457
- parent_id: null;
1458
- is_optional: false;
1459
- }
1460
- }
1461
-
1462
1499
  declare namespace InvoicesStatic {
1463
1500
  interface Invoice {
1464
1501
  id: number;
@@ -1508,6 +1545,7 @@ declare namespace InvoicesStatic {
1508
1545
  title?: string | null;
1509
1546
  contact_id: number;
1510
1547
  contact_sub_id?: number | null;
1548
+ contact_address_manual?: string | null;
1511
1549
  user_id: number;
1512
1550
  pr_project_id?: number | null;
1513
1551
  logopaper_id?: number;
@@ -1531,6 +1569,7 @@ declare namespace InvoicesStatic {
1531
1569
  title?: string | null;
1532
1570
  contact_id?: number;
1533
1571
  contact_sub_id?: number | null;
1572
+ contact_address_manual?: string | null;
1534
1573
  user_id?: number;
1535
1574
  pr_project_id?: number | null;
1536
1575
  logopaper_id?: number;
@@ -1729,6 +1768,42 @@ declare class Invoices extends BaseCrud<InvoicesStatic.Invoice, InvoicesStatic.I
1729
1768
  * @memberof Invoices
1730
1769
  */
1731
1770
  createTextPosition(invoiceId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
1771
+ /**
1772
+ * Delete a default position for an invoice
1773
+ *
1774
+ * @param {number} invoiceId
1775
+ * @param {number} positionId
1776
+ * @returns {Promise<boolean>}
1777
+ * @memberof Invoices
1778
+ */
1779
+ deleteDefaultPosition(invoiceId: number, positionId: number): Promise<boolean>;
1780
+ /**
1781
+ * Delete an item position for an invoice
1782
+ *
1783
+ * @param {number} invoiceId
1784
+ * @param {number} positionId
1785
+ * @returns {Promise<boolean>}
1786
+ * @memberof Invoices
1787
+ */
1788
+ deleteItemPosition(invoiceId: number, positionId: number): Promise<boolean>;
1789
+ /**
1790
+ * Delete a text position for an invoice
1791
+ *
1792
+ * @param {number} invoiceId
1793
+ * @param {number} positionId
1794
+ * @returns {Promise<boolean>}
1795
+ * @memberof Invoices
1796
+ */
1797
+ deleteTextPosition(invoiceId: number, positionId: number): Promise<boolean>;
1798
+ /**
1799
+ * Delete a position for an invoice, whatever its type
1800
+ *
1801
+ * @param {number} invoiceId
1802
+ * @param {Pick<PositionStatic.Position, "id" | "type">} position
1803
+ * @returns {Promise<boolean>}
1804
+ * @memberof Invoices
1805
+ */
1806
+ deletePosition(invoiceId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
1732
1807
  }
1733
1808
 
1734
1809
  declare namespace CurrenciesStatic {