conductor-node 12.0.0-beta.20 → 12.0.0-beta.22

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.
@@ -0,0 +1,2336 @@
1
+ import { APIResource } from "../../resource.js";
2
+ import * as Core from "../../core.js";
3
+ import { CursorPage, type CursorPageParams } from "../../pagination.js";
4
+ export declare class ItemReceipts extends APIResource {
5
+ /**
6
+ * Creates a new item receipt.
7
+ */
8
+ create(params: ItemReceiptCreateParams, options?: Core.RequestOptions): Core.APIPromise<ItemReceipt>;
9
+ /**
10
+ * Retrieves an item receipt by ID.
11
+ */
12
+ retrieve(id: string, params: ItemReceiptRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<ItemReceipt>;
13
+ /**
14
+ * Updates an existing item receipt.
15
+ */
16
+ update(id: string, params: ItemReceiptUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ItemReceipt>;
17
+ /**
18
+ * Returns a list of item receipts. Use the `cursor` parameter to paginate through
19
+ * the results.
20
+ */
21
+ list(params: ItemReceiptListParams, options?: Core.RequestOptions): Core.PagePromise<ItemReceiptsCursorPage, ItemReceipt>;
22
+ /**
23
+ * Permanently deletes a an item receipt. The deletion will fail if the item
24
+ * receipt is currently in use or has any linked transactions that are in use.
25
+ */
26
+ delete(id: string, params: ItemReceiptDeleteParams, options?: Core.RequestOptions): Core.APIPromise<ItemReceiptDeleteResponse>;
27
+ }
28
+ export declare class ItemReceiptsCursorPage extends CursorPage<ItemReceipt> {
29
+ }
30
+ export interface ItemReceipt {
31
+ /**
32
+ * The unique identifier assigned by QuickBooks to this item receipt. This ID is
33
+ * unique across all transaction types.
34
+ */
35
+ id: string;
36
+ /**
37
+ * The date and time when this item receipt was created, in ISO 8601 format
38
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
39
+ * in QuickBooks.
40
+ */
41
+ createdAt: string;
42
+ /**
43
+ * The item receipt's currency. For built-in currencies, the name and code are
44
+ * standard international values. For user-defined currencies, all values are
45
+ * editable.
46
+ */
47
+ currency: ItemReceipt.Currency | null;
48
+ /**
49
+ * The custom fields for the item receipt object, added as user-defined data
50
+ * extensions, not included in the standard QuickBooks object.
51
+ */
52
+ customFields: Array<ItemReceipt.CustomField>;
53
+ /**
54
+ * The market exchange rate between this item receipt's currency and the home
55
+ * currency in QuickBooks at the time of this transaction. Represented as a decimal
56
+ * value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
57
+ */
58
+ exchangeRate: number | null;
59
+ /**
60
+ * The item receipt's expense lines, each representing one line in this expense.
61
+ */
62
+ expenseLines: Array<ItemReceipt.ExpenseLine>;
63
+ /**
64
+ * A globally unique identifier (GUID) you, the developer, can provide for tracking
65
+ * this object in your external system. This field is immutable and can only be set
66
+ * during object creation.
67
+ */
68
+ externalId: string | null;
69
+ /**
70
+ * The item receipt's item group lines, each representing a predefined set of items
71
+ * bundled together because they are commonly purchased together or grouped for
72
+ * faster entry.
73
+ */
74
+ itemLineGroups: Array<ItemReceipt.ItemLineGroup>;
75
+ /**
76
+ * The item receipt's item lines, each representing the purchase of a specific item
77
+ * or service.
78
+ */
79
+ itemLines: Array<ItemReceipt.ItemLine>;
80
+ /**
81
+ * The liability account used to track the amount owed for this item receipt.
82
+ */
83
+ liabilityAccount: ItemReceipt.LiabilityAccount | null;
84
+ /**
85
+ * The item receipt's linked transactions, such as payments applied, credits used,
86
+ * or associated purchase orders.
87
+ *
88
+ * **IMPORTANT**: You must specify the parameter `includeLinkedTransactions` when
89
+ * fetching a list of item receipts to receive this field because it is not
90
+ * returned by default.
91
+ */
92
+ linkedTransactions: Array<ItemReceipt.LinkedTransaction>;
93
+ /**
94
+ * A memo or note for this item receipt.
95
+ */
96
+ memo: string | null;
97
+ /**
98
+ * The type of object. This value is always `"qbd_item_receipt"`.
99
+ */
100
+ objectType: 'qbd_item_receipt';
101
+ /**
102
+ * The Accounts-Payable (A/P) account to which this item receipt is assigned, used
103
+ * to track the amount owed. If not specified, QuickBooks Desktop will use its
104
+ * default A/P account.
105
+ *
106
+ * **IMPORTANT**: If this item receipt is linked to other transactions, this A/P
107
+ * account must match the `payablesAccount` used in those other transactions.
108
+ */
109
+ payablesAccount: ItemReceipt.PayablesAccount | null;
110
+ /**
111
+ * The case-sensitive user-defined reference number for this item receipt, which
112
+ * can be used to identify the transaction in QuickBooks. This value is not
113
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
114
+ */
115
+ refNumber: string | null;
116
+ /**
117
+ * The current QuickBooks-assigned revision number of this item receipt object,
118
+ * which changes each time the object is modified. When updating this object, you
119
+ * must provide the most recent `revisionNumber` to ensure you're working with the
120
+ * latest data; otherwise, the update will return an error.
121
+ */
122
+ revisionNumber: string;
123
+ /**
124
+ * The sales-tax code for this item receipt, determining whether it is taxable or
125
+ * non-taxable. If set, this overrides any sales-tax codes defined on the vendor.
126
+ * This can be overridden on the item receipt's individual lines.
127
+ *
128
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
129
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
130
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
131
+ * non-taxable code to all sales.
132
+ */
133
+ salesTaxCode: ItemReceipt.SalesTaxCode | null;
134
+ /**
135
+ * The total monetary amount of this item receipt, equivalent to the sum of the
136
+ * amounts in `expenseLines`, `itemLines`, and `itemGroupLines`, represented as a
137
+ * decimal string.
138
+ */
139
+ totalAmount: string;
140
+ /**
141
+ * The total monetary amount of this item receipt converted to the home currency of
142
+ * the QuickBooks company file. Represented as a decimal string.
143
+ */
144
+ totalAmountInHomeCurrency: string | null;
145
+ /**
146
+ * The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).
147
+ */
148
+ transactionDate: string;
149
+ /**
150
+ * The date and time when this item receipt was last updated, in ISO 8601 format
151
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
152
+ * in QuickBooks.
153
+ */
154
+ updatedAt: string;
155
+ /**
156
+ * The vendor who sent this item receipt for goods or services purchased.
157
+ */
158
+ vendor: ItemReceipt.Vendor;
159
+ }
160
+ export declare namespace ItemReceipt {
161
+ /**
162
+ * The item receipt's currency. For built-in currencies, the name and code are
163
+ * standard international values. For user-defined currencies, all values are
164
+ * editable.
165
+ */
166
+ interface Currency {
167
+ /**
168
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
169
+ * across all objects of the same type, but not across different QuickBooks object
170
+ * types.
171
+ */
172
+ id: string | null;
173
+ /**
174
+ * The fully-qualified unique name for this object, formed by combining the names
175
+ * of its parent objects with its own `name`, separated by colons. Not
176
+ * case-sensitive.
177
+ */
178
+ fullName: string | null;
179
+ }
180
+ interface CustomField {
181
+ /**
182
+ * The name of the custom field, unique for the specified `ownerId`. For public
183
+ * custom fields, this name is visible as a label in the QuickBooks UI.
184
+ */
185
+ name: string;
186
+ /**
187
+ * The identifier of the owner of the custom field, which QuickBooks internally
188
+ * calls a "data extension". For public custom fields visible in the UI, such as
189
+ * those added by the QuickBooks user, this is always "0". For private custom
190
+ * fields that are only visible to the application that created them, this is a
191
+ * valid GUID identifying the owning application. Internally, Conductor always
192
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
193
+ * objects.
194
+ */
195
+ ownerId: string;
196
+ /**
197
+ * The data type of this custom field.
198
+ */
199
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
200
+ /**
201
+ * The value of this custom field. The maximum length depends on the field's data
202
+ * type.
203
+ */
204
+ value: string;
205
+ }
206
+ interface ExpenseLine {
207
+ /**
208
+ * The unique identifier assigned by QuickBooks to this expense line. This ID is
209
+ * unique across all transaction line types.
210
+ */
211
+ id: string;
212
+ /**
213
+ * The expense account being debited (increased) for this expense line. The
214
+ * corresponding account being credited is usually a liability account (e.g.,
215
+ * Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
216
+ * type.
217
+ */
218
+ account: ExpenseLine.Account | null;
219
+ /**
220
+ * The monetary amount of this expense line, represented as a decimal string.
221
+ */
222
+ amount: string | null;
223
+ /**
224
+ * The billing status of this expense line.
225
+ */
226
+ billingStatus: 'billable' | 'has_been_billed' | 'not_billable' | null;
227
+ /**
228
+ * The expense line's class. Classes can be used to categorize objects into
229
+ * meaningful segments, such as department, location, or type of work. In
230
+ * QuickBooks, class tracking is off by default. If a class is specified for the
231
+ * entire parent transaction, it is automatically applied to all expense lines
232
+ * unless overridden here, at the transaction line level.
233
+ */
234
+ class: ExpenseLine.Class | null;
235
+ /**
236
+ * The custom fields for the expense line object, added as user-defined data
237
+ * extensions, not included in the standard QuickBooks object.
238
+ */
239
+ customFields: Array<ExpenseLine.CustomField>;
240
+ /**
241
+ * A memo or note for this expense line.
242
+ */
243
+ memo: string | null;
244
+ /**
245
+ * The type of object. This value is always `"qbd_expense_line"`.
246
+ */
247
+ objectType: 'qbd_expense_line';
248
+ /**
249
+ * If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
250
+ * expense's vendor (not the customer). If `account` refers to any other type of
251
+ * account, `payee` refers to the expense's customer (not the vendor).
252
+ */
253
+ payee: ExpenseLine.Payee | null;
254
+ /**
255
+ * The expense line's sales representative. Sales representatives can be employees,
256
+ * vendors, or other names in QuickBooks.
257
+ */
258
+ salesRepresentative: ExpenseLine.SalesRepresentative | null;
259
+ /**
260
+ * The sales-tax code for this expense line, determining whether it is taxable or
261
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
262
+ * transaction or the associated item.
263
+ *
264
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
265
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
266
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
267
+ * non-taxable code to all sales.
268
+ */
269
+ salesTaxCode: ExpenseLine.SalesTaxCode | null;
270
+ }
271
+ namespace ExpenseLine {
272
+ /**
273
+ * The expense account being debited (increased) for this expense line. The
274
+ * corresponding account being credited is usually a liability account (e.g.,
275
+ * Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
276
+ * type.
277
+ */
278
+ interface Account {
279
+ /**
280
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
281
+ * across all objects of the same type, but not across different QuickBooks object
282
+ * types.
283
+ */
284
+ id: string | null;
285
+ /**
286
+ * The fully-qualified unique name for this object, formed by combining the names
287
+ * of its parent objects with its own `name`, separated by colons. Not
288
+ * case-sensitive.
289
+ */
290
+ fullName: string | null;
291
+ }
292
+ /**
293
+ * The expense line's class. Classes can be used to categorize objects into
294
+ * meaningful segments, such as department, location, or type of work. In
295
+ * QuickBooks, class tracking is off by default. If a class is specified for the
296
+ * entire parent transaction, it is automatically applied to all expense lines
297
+ * unless overridden here, at the transaction line level.
298
+ */
299
+ interface Class {
300
+ /**
301
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
302
+ * across all objects of the same type, but not across different QuickBooks object
303
+ * types.
304
+ */
305
+ id: string | null;
306
+ /**
307
+ * The fully-qualified unique name for this object, formed by combining the names
308
+ * of its parent objects with its own `name`, separated by colons. Not
309
+ * case-sensitive.
310
+ */
311
+ fullName: string | null;
312
+ }
313
+ interface CustomField {
314
+ /**
315
+ * The name of the custom field, unique for the specified `ownerId`. For public
316
+ * custom fields, this name is visible as a label in the QuickBooks UI.
317
+ */
318
+ name: string;
319
+ /**
320
+ * The identifier of the owner of the custom field, which QuickBooks internally
321
+ * calls a "data extension". For public custom fields visible in the UI, such as
322
+ * those added by the QuickBooks user, this is always "0". For private custom
323
+ * fields that are only visible to the application that created them, this is a
324
+ * valid GUID identifying the owning application. Internally, Conductor always
325
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
326
+ * objects.
327
+ */
328
+ ownerId: string;
329
+ /**
330
+ * The data type of this custom field.
331
+ */
332
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
333
+ /**
334
+ * The value of this custom field. The maximum length depends on the field's data
335
+ * type.
336
+ */
337
+ value: string;
338
+ }
339
+ /**
340
+ * If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
341
+ * expense's vendor (not the customer). If `account` refers to any other type of
342
+ * account, `payee` refers to the expense's customer (not the vendor).
343
+ */
344
+ interface Payee {
345
+ /**
346
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
347
+ * across all objects of the same type, but not across different QuickBooks object
348
+ * types.
349
+ */
350
+ id: string | null;
351
+ /**
352
+ * The fully-qualified unique name for this object, formed by combining the names
353
+ * of its parent objects with its own `name`, separated by colons. Not
354
+ * case-sensitive.
355
+ */
356
+ fullName: string | null;
357
+ }
358
+ /**
359
+ * The expense line's sales representative. Sales representatives can be employees,
360
+ * vendors, or other names in QuickBooks.
361
+ */
362
+ interface SalesRepresentative {
363
+ /**
364
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
365
+ * across all objects of the same type, but not across different QuickBooks object
366
+ * types.
367
+ */
368
+ id: string | null;
369
+ /**
370
+ * The fully-qualified unique name for this object, formed by combining the names
371
+ * of its parent objects with its own `name`, separated by colons. Not
372
+ * case-sensitive.
373
+ */
374
+ fullName: string | null;
375
+ }
376
+ /**
377
+ * The sales-tax code for this expense line, determining whether it is taxable or
378
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
379
+ * transaction or the associated item.
380
+ *
381
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
382
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
383
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
384
+ * non-taxable code to all sales.
385
+ */
386
+ interface SalesTaxCode {
387
+ /**
388
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
389
+ * across all objects of the same type, but not across different QuickBooks object
390
+ * types.
391
+ */
392
+ id: string | null;
393
+ /**
394
+ * The fully-qualified unique name for this object, formed by combining the names
395
+ * of its parent objects with its own `name`, separated by colons. Not
396
+ * case-sensitive.
397
+ */
398
+ fullName: string | null;
399
+ }
400
+ }
401
+ interface ItemLineGroup {
402
+ /**
403
+ * The unique identifier assigned by QuickBooks to this item line group. This ID is
404
+ * unique across all transaction line types.
405
+ */
406
+ id: string;
407
+ /**
408
+ * The custom fields for the item line group object, added as user-defined data
409
+ * extensions, not included in the standard QuickBooks object.
410
+ */
411
+ customFields: Array<ItemLineGroup.CustomField>;
412
+ /**
413
+ * A description of this item line group.
414
+ */
415
+ description: string | null;
416
+ /**
417
+ * The item line group's item group, representing a predefined set of items bundled
418
+ * because they are commonly purchased together or grouped for faster entry.
419
+ */
420
+ itemGroup: ItemLineGroup.ItemGroup;
421
+ /**
422
+ * The item line group's item lines, each representing the purchase of a specific
423
+ * item or service.
424
+ */
425
+ itemLines: Array<ItemLineGroup.ItemLine>;
426
+ /**
427
+ * The type of object. This value is always `"qbd_item_line_group"`.
428
+ */
429
+ objectType: 'qbd_item_line_group';
430
+ /**
431
+ * Specifies an alternative unit-of-measure set when updating this item line
432
+ * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
433
+ * select units from a different set than the item's default unit-of-measure set,
434
+ * which remains unchanged on the item itself. The override applies only to this
435
+ * specific line. For example, you can sell an item typically measured in volume
436
+ * units using weight units in a specific transaction by specifying a different
437
+ * unit-of-measure set with this field.
438
+ */
439
+ overrideUnitOfMeasureSet: ItemLineGroup.OverrideUnitOfMeasureSet | null;
440
+ /**
441
+ * The quantity of the item group associated with this item line group. This field
442
+ * cannot be cleared.
443
+ *
444
+ * **NOTE**: Do not use this field if the associated item group is a discount item
445
+ * group.
446
+ */
447
+ quantity: number | null;
448
+ /**
449
+ * The total monetary amount of this item line group, equivalent to the sum of the
450
+ * amounts in `lines`, represented as a decimal string.
451
+ */
452
+ totalAmount: string;
453
+ /**
454
+ * The unit-of-measure used for the `quantity` in this item line group. Must be a
455
+ * valid unit within the item's available units of measure.
456
+ */
457
+ unitOfMeasure: string | null;
458
+ }
459
+ namespace ItemLineGroup {
460
+ interface CustomField {
461
+ /**
462
+ * The name of the custom field, unique for the specified `ownerId`. For public
463
+ * custom fields, this name is visible as a label in the QuickBooks UI.
464
+ */
465
+ name: string;
466
+ /**
467
+ * The identifier of the owner of the custom field, which QuickBooks internally
468
+ * calls a "data extension". For public custom fields visible in the UI, such as
469
+ * those added by the QuickBooks user, this is always "0". For private custom
470
+ * fields that are only visible to the application that created them, this is a
471
+ * valid GUID identifying the owning application. Internally, Conductor always
472
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
473
+ * objects.
474
+ */
475
+ ownerId: string;
476
+ /**
477
+ * The data type of this custom field.
478
+ */
479
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
480
+ /**
481
+ * The value of this custom field. The maximum length depends on the field's data
482
+ * type.
483
+ */
484
+ value: string;
485
+ }
486
+ /**
487
+ * The item line group's item group, representing a predefined set of items bundled
488
+ * because they are commonly purchased together or grouped for faster entry.
489
+ */
490
+ interface ItemGroup {
491
+ /**
492
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
493
+ * across all objects of the same type, but not across different QuickBooks object
494
+ * types.
495
+ */
496
+ id: string | null;
497
+ /**
498
+ * The fully-qualified unique name for this object, formed by combining the names
499
+ * of its parent objects with its own `name`, separated by colons. Not
500
+ * case-sensitive.
501
+ */
502
+ fullName: string | null;
503
+ }
504
+ interface ItemLine {
505
+ /**
506
+ * The unique identifier assigned by QuickBooks to this item line. This ID is
507
+ * unique across all transaction line types.
508
+ */
509
+ id: string;
510
+ /**
511
+ * The monetary amount of this item line, represented as a decimal string. If both
512
+ * `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
513
+ * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
514
+ * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
515
+ * suggested `cost`. This field cannot be cleared.
516
+ */
517
+ amount: string | null;
518
+ /**
519
+ * The billing status of this item line.
520
+ */
521
+ billingStatus: 'billable' | 'has_been_billed' | 'not_billable' | null;
522
+ /**
523
+ * The item line's class. Classes can be used to categorize objects into meaningful
524
+ * segments, such as department, location, or type of work. In QuickBooks, class
525
+ * tracking is off by default. If a class is specified for the entire parent
526
+ * transaction, it is automatically applied to all item lines unless overridden
527
+ * here, at the transaction line level.
528
+ */
529
+ class: ItemLine.Class | null;
530
+ /**
531
+ * The cost of this item line, represented as a decimal string. If both `quantity`
532
+ * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
533
+ * `cost`.
534
+ */
535
+ cost: string | null;
536
+ /**
537
+ * The customer or customer-job associated with this item line.
538
+ */
539
+ customer: ItemLine.Customer | null;
540
+ /**
541
+ * The custom fields for the item line object, added as user-defined data
542
+ * extensions, not included in the standard QuickBooks object.
543
+ */
544
+ customFields: Array<ItemLine.CustomField>;
545
+ /**
546
+ * A description of this item line.
547
+ */
548
+ description: string | null;
549
+ /**
550
+ * The expiration date for the serial number or lot number of the item associated
551
+ * with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
552
+ * relevant for perishable or time-sensitive inventory items. Note that this field
553
+ * is only supported on QuickBooks Desktop 2023 or later.
554
+ */
555
+ expirationDate: string | null;
556
+ /**
557
+ * The site location where inventory for the item associated with this item line is
558
+ * stored.
559
+ */
560
+ inventorySite: ItemLine.InventorySite | null;
561
+ /**
562
+ * The specific location (e.g., bin or shelf) within the inventory site where the
563
+ * item associated with this item line is stored.
564
+ */
565
+ inventorySiteLocation: ItemLine.InventorySiteLocation | null;
566
+ /**
567
+ * The item associated with this item line. This can refer to any good or service
568
+ * that the business buys or sells, including item types such as a service item,
569
+ * inventory item, or special calculation item like a discount item or sales-tax
570
+ * item.
571
+ */
572
+ item: ItemLine.Item | null;
573
+ /**
574
+ * The lot number of the item associated with this item line. Used for tracking
575
+ * groups of inventory items that are purchased or manufactured together.
576
+ */
577
+ lotNumber: string | null;
578
+ /**
579
+ * The type of object. This value is always `"qbd_item_line"`.
580
+ */
581
+ objectType: 'qbd_item_line';
582
+ /**
583
+ * Specifies an alternative unit-of-measure set when updating this item line's
584
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
585
+ * units from a different set than the item's default unit-of-measure set, which
586
+ * remains unchanged on the item itself. The override applies only to this specific
587
+ * line. For example, you can sell an item typically measured in volume units using
588
+ * weight units in a specific transaction by specifying a different unit-of-measure
589
+ * set with this field.
590
+ */
591
+ overrideUnitOfMeasureSet: ItemLine.OverrideUnitOfMeasureSet | null;
592
+ /**
593
+ * The quantity of the item associated with this item line. This field cannot be
594
+ * cleared.
595
+ *
596
+ * **NOTE**: Do not use this field if the associated item is a discount item.
597
+ */
598
+ quantity: number | null;
599
+ /**
600
+ * The item line's sales representative. Sales representatives can be employees,
601
+ * vendors, or other names in QuickBooks.
602
+ */
603
+ salesRepresentative: ItemLine.SalesRepresentative | null;
604
+ /**
605
+ * The sales-tax code for this item line, determining whether it is taxable or
606
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
607
+ * transaction or the associated item.
608
+ *
609
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
610
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
611
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
612
+ * non-taxable code to all sales.
613
+ */
614
+ salesTaxCode: ItemLine.SalesTaxCode | null;
615
+ /**
616
+ * The serial number of the item associated with this item line. This is used for
617
+ * tracking individual units of serialized inventory items.
618
+ */
619
+ serialNumber: string | null;
620
+ /**
621
+ * The unit-of-measure used for the `quantity` in this item line. Must be a valid
622
+ * unit within the item's available units of measure.
623
+ */
624
+ unitOfMeasure: string | null;
625
+ }
626
+ namespace ItemLine {
627
+ /**
628
+ * The item line's class. Classes can be used to categorize objects into meaningful
629
+ * segments, such as department, location, or type of work. In QuickBooks, class
630
+ * tracking is off by default. If a class is specified for the entire parent
631
+ * transaction, it is automatically applied to all item lines unless overridden
632
+ * here, at the transaction line level.
633
+ */
634
+ interface Class {
635
+ /**
636
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
637
+ * across all objects of the same type, but not across different QuickBooks object
638
+ * types.
639
+ */
640
+ id: string | null;
641
+ /**
642
+ * The fully-qualified unique name for this object, formed by combining the names
643
+ * of its parent objects with its own `name`, separated by colons. Not
644
+ * case-sensitive.
645
+ */
646
+ fullName: string | null;
647
+ }
648
+ /**
649
+ * The customer or customer-job associated with this item line.
650
+ */
651
+ interface Customer {
652
+ /**
653
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
654
+ * across all objects of the same type, but not across different QuickBooks object
655
+ * types.
656
+ */
657
+ id: string | null;
658
+ /**
659
+ * The fully-qualified unique name for this object, formed by combining the names
660
+ * of its parent objects with its own `name`, separated by colons. Not
661
+ * case-sensitive.
662
+ */
663
+ fullName: string | null;
664
+ }
665
+ interface CustomField {
666
+ /**
667
+ * The name of the custom field, unique for the specified `ownerId`. For public
668
+ * custom fields, this name is visible as a label in the QuickBooks UI.
669
+ */
670
+ name: string;
671
+ /**
672
+ * The identifier of the owner of the custom field, which QuickBooks internally
673
+ * calls a "data extension". For public custom fields visible in the UI, such as
674
+ * those added by the QuickBooks user, this is always "0". For private custom
675
+ * fields that are only visible to the application that created them, this is a
676
+ * valid GUID identifying the owning application. Internally, Conductor always
677
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
678
+ * objects.
679
+ */
680
+ ownerId: string;
681
+ /**
682
+ * The data type of this custom field.
683
+ */
684
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
685
+ /**
686
+ * The value of this custom field. The maximum length depends on the field's data
687
+ * type.
688
+ */
689
+ value: string;
690
+ }
691
+ /**
692
+ * The site location where inventory for the item associated with this item line is
693
+ * stored.
694
+ */
695
+ interface InventorySite {
696
+ /**
697
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
698
+ * across all objects of the same type, but not across different QuickBooks object
699
+ * types.
700
+ */
701
+ id: string | null;
702
+ /**
703
+ * The fully-qualified unique name for this object, formed by combining the names
704
+ * of its parent objects with its own `name`, separated by colons. Not
705
+ * case-sensitive.
706
+ */
707
+ fullName: string | null;
708
+ }
709
+ /**
710
+ * The specific location (e.g., bin or shelf) within the inventory site where the
711
+ * item associated with this item line is stored.
712
+ */
713
+ interface InventorySiteLocation {
714
+ /**
715
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
716
+ * across all objects of the same type, but not across different QuickBooks object
717
+ * types.
718
+ */
719
+ id: string | null;
720
+ /**
721
+ * The fully-qualified unique name for this object, formed by combining the names
722
+ * of its parent objects with its own `name`, separated by colons. Not
723
+ * case-sensitive.
724
+ */
725
+ fullName: string | null;
726
+ }
727
+ /**
728
+ * The item associated with this item line. This can refer to any good or service
729
+ * that the business buys or sells, including item types such as a service item,
730
+ * inventory item, or special calculation item like a discount item or sales-tax
731
+ * item.
732
+ */
733
+ interface Item {
734
+ /**
735
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
736
+ * across all objects of the same type, but not across different QuickBooks object
737
+ * types.
738
+ */
739
+ id: string | null;
740
+ /**
741
+ * The fully-qualified unique name for this object, formed by combining the names
742
+ * of its parent objects with its own `name`, separated by colons. Not
743
+ * case-sensitive.
744
+ */
745
+ fullName: string | null;
746
+ }
747
+ /**
748
+ * Specifies an alternative unit-of-measure set when updating this item line's
749
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
750
+ * units from a different set than the item's default unit-of-measure set, which
751
+ * remains unchanged on the item itself. The override applies only to this specific
752
+ * line. For example, you can sell an item typically measured in volume units using
753
+ * weight units in a specific transaction by specifying a different unit-of-measure
754
+ * set with this field.
755
+ */
756
+ interface OverrideUnitOfMeasureSet {
757
+ /**
758
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
759
+ * across all objects of the same type, but not across different QuickBooks object
760
+ * types.
761
+ */
762
+ id: string | null;
763
+ /**
764
+ * The fully-qualified unique name for this object, formed by combining the names
765
+ * of its parent objects with its own `name`, separated by colons. Not
766
+ * case-sensitive.
767
+ */
768
+ fullName: string | null;
769
+ }
770
+ /**
771
+ * The item line's sales representative. Sales representatives can be employees,
772
+ * vendors, or other names in QuickBooks.
773
+ */
774
+ interface SalesRepresentative {
775
+ /**
776
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
777
+ * across all objects of the same type, but not across different QuickBooks object
778
+ * types.
779
+ */
780
+ id: string | null;
781
+ /**
782
+ * The fully-qualified unique name for this object, formed by combining the names
783
+ * of its parent objects with its own `name`, separated by colons. Not
784
+ * case-sensitive.
785
+ */
786
+ fullName: string | null;
787
+ }
788
+ /**
789
+ * The sales-tax code for this item line, determining whether it is taxable or
790
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
791
+ * transaction or the associated item.
792
+ *
793
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
794
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
795
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
796
+ * non-taxable code to all sales.
797
+ */
798
+ interface SalesTaxCode {
799
+ /**
800
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
801
+ * across all objects of the same type, but not across different QuickBooks object
802
+ * types.
803
+ */
804
+ id: string | null;
805
+ /**
806
+ * The fully-qualified unique name for this object, formed by combining the names
807
+ * of its parent objects with its own `name`, separated by colons. Not
808
+ * case-sensitive.
809
+ */
810
+ fullName: string | null;
811
+ }
812
+ }
813
+ /**
814
+ * Specifies an alternative unit-of-measure set when updating this item line
815
+ * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
816
+ * select units from a different set than the item's default unit-of-measure set,
817
+ * which remains unchanged on the item itself. The override applies only to this
818
+ * specific line. For example, you can sell an item typically measured in volume
819
+ * units using weight units in a specific transaction by specifying a different
820
+ * unit-of-measure set with this field.
821
+ */
822
+ interface OverrideUnitOfMeasureSet {
823
+ /**
824
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
825
+ * across all objects of the same type, but not across different QuickBooks object
826
+ * types.
827
+ */
828
+ id: string | null;
829
+ /**
830
+ * The fully-qualified unique name for this object, formed by combining the names
831
+ * of its parent objects with its own `name`, separated by colons. Not
832
+ * case-sensitive.
833
+ */
834
+ fullName: string | null;
835
+ }
836
+ }
837
+ interface ItemLine {
838
+ /**
839
+ * The unique identifier assigned by QuickBooks to this item line. This ID is
840
+ * unique across all transaction line types.
841
+ */
842
+ id: string;
843
+ /**
844
+ * The monetary amount of this item line, represented as a decimal string. If both
845
+ * `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
846
+ * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
847
+ * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
848
+ * suggested `cost`. This field cannot be cleared.
849
+ */
850
+ amount: string | null;
851
+ /**
852
+ * The billing status of this item line.
853
+ */
854
+ billingStatus: 'billable' | 'has_been_billed' | 'not_billable' | null;
855
+ /**
856
+ * The item line's class. Classes can be used to categorize objects into meaningful
857
+ * segments, such as department, location, or type of work. In QuickBooks, class
858
+ * tracking is off by default. If a class is specified for the entire parent
859
+ * transaction, it is automatically applied to all item lines unless overridden
860
+ * here, at the transaction line level.
861
+ */
862
+ class: ItemLine.Class | null;
863
+ /**
864
+ * The cost of this item line, represented as a decimal string. If both `quantity`
865
+ * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
866
+ * `cost`.
867
+ */
868
+ cost: string | null;
869
+ /**
870
+ * The customer or customer-job associated with this item line.
871
+ */
872
+ customer: ItemLine.Customer | null;
873
+ /**
874
+ * The custom fields for the item line object, added as user-defined data
875
+ * extensions, not included in the standard QuickBooks object.
876
+ */
877
+ customFields: Array<ItemLine.CustomField>;
878
+ /**
879
+ * A description of this item line.
880
+ */
881
+ description: string | null;
882
+ /**
883
+ * The expiration date for the serial number or lot number of the item associated
884
+ * with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
885
+ * relevant for perishable or time-sensitive inventory items. Note that this field
886
+ * is only supported on QuickBooks Desktop 2023 or later.
887
+ */
888
+ expirationDate: string | null;
889
+ /**
890
+ * The site location where inventory for the item associated with this item line is
891
+ * stored.
892
+ */
893
+ inventorySite: ItemLine.InventorySite | null;
894
+ /**
895
+ * The specific location (e.g., bin or shelf) within the inventory site where the
896
+ * item associated with this item line is stored.
897
+ */
898
+ inventorySiteLocation: ItemLine.InventorySiteLocation | null;
899
+ /**
900
+ * The item associated with this item line. This can refer to any good or service
901
+ * that the business buys or sells, including item types such as a service item,
902
+ * inventory item, or special calculation item like a discount item or sales-tax
903
+ * item.
904
+ */
905
+ item: ItemLine.Item | null;
906
+ /**
907
+ * The lot number of the item associated with this item line. Used for tracking
908
+ * groups of inventory items that are purchased or manufactured together.
909
+ */
910
+ lotNumber: string | null;
911
+ /**
912
+ * The type of object. This value is always `"qbd_item_line"`.
913
+ */
914
+ objectType: 'qbd_item_line';
915
+ /**
916
+ * Specifies an alternative unit-of-measure set when updating this item line's
917
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
918
+ * units from a different set than the item's default unit-of-measure set, which
919
+ * remains unchanged on the item itself. The override applies only to this specific
920
+ * line. For example, you can sell an item typically measured in volume units using
921
+ * weight units in a specific transaction by specifying a different unit-of-measure
922
+ * set with this field.
923
+ */
924
+ overrideUnitOfMeasureSet: ItemLine.OverrideUnitOfMeasureSet | null;
925
+ /**
926
+ * The quantity of the item associated with this item line. This field cannot be
927
+ * cleared.
928
+ *
929
+ * **NOTE**: Do not use this field if the associated item is a discount item.
930
+ */
931
+ quantity: number | null;
932
+ /**
933
+ * The item line's sales representative. Sales representatives can be employees,
934
+ * vendors, or other names in QuickBooks.
935
+ */
936
+ salesRepresentative: ItemLine.SalesRepresentative | null;
937
+ /**
938
+ * The sales-tax code for this item line, determining whether it is taxable or
939
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
940
+ * transaction or the associated item.
941
+ *
942
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
943
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
944
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
945
+ * non-taxable code to all sales.
946
+ */
947
+ salesTaxCode: ItemLine.SalesTaxCode | null;
948
+ /**
949
+ * The serial number of the item associated with this item line. This is used for
950
+ * tracking individual units of serialized inventory items.
951
+ */
952
+ serialNumber: string | null;
953
+ /**
954
+ * The unit-of-measure used for the `quantity` in this item line. Must be a valid
955
+ * unit within the item's available units of measure.
956
+ */
957
+ unitOfMeasure: string | null;
958
+ }
959
+ namespace ItemLine {
960
+ /**
961
+ * The item line's class. Classes can be used to categorize objects into meaningful
962
+ * segments, such as department, location, or type of work. In QuickBooks, class
963
+ * tracking is off by default. If a class is specified for the entire parent
964
+ * transaction, it is automatically applied to all item lines unless overridden
965
+ * here, at the transaction line level.
966
+ */
967
+ interface Class {
968
+ /**
969
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
970
+ * across all objects of the same type, but not across different QuickBooks object
971
+ * types.
972
+ */
973
+ id: string | null;
974
+ /**
975
+ * The fully-qualified unique name for this object, formed by combining the names
976
+ * of its parent objects with its own `name`, separated by colons. Not
977
+ * case-sensitive.
978
+ */
979
+ fullName: string | null;
980
+ }
981
+ /**
982
+ * The customer or customer-job associated with this item line.
983
+ */
984
+ interface Customer {
985
+ /**
986
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
987
+ * across all objects of the same type, but not across different QuickBooks object
988
+ * types.
989
+ */
990
+ id: string | null;
991
+ /**
992
+ * The fully-qualified unique name for this object, formed by combining the names
993
+ * of its parent objects with its own `name`, separated by colons. Not
994
+ * case-sensitive.
995
+ */
996
+ fullName: string | null;
997
+ }
998
+ interface CustomField {
999
+ /**
1000
+ * The name of the custom field, unique for the specified `ownerId`. For public
1001
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1002
+ */
1003
+ name: string;
1004
+ /**
1005
+ * The identifier of the owner of the custom field, which QuickBooks internally
1006
+ * calls a "data extension". For public custom fields visible in the UI, such as
1007
+ * those added by the QuickBooks user, this is always "0". For private custom
1008
+ * fields that are only visible to the application that created them, this is a
1009
+ * valid GUID identifying the owning application. Internally, Conductor always
1010
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1011
+ * objects.
1012
+ */
1013
+ ownerId: string;
1014
+ /**
1015
+ * The data type of this custom field.
1016
+ */
1017
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
1018
+ /**
1019
+ * The value of this custom field. The maximum length depends on the field's data
1020
+ * type.
1021
+ */
1022
+ value: string;
1023
+ }
1024
+ /**
1025
+ * The site location where inventory for the item associated with this item line is
1026
+ * stored.
1027
+ */
1028
+ interface InventorySite {
1029
+ /**
1030
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1031
+ * across all objects of the same type, but not across different QuickBooks object
1032
+ * types.
1033
+ */
1034
+ id: string | null;
1035
+ /**
1036
+ * The fully-qualified unique name for this object, formed by combining the names
1037
+ * of its parent objects with its own `name`, separated by colons. Not
1038
+ * case-sensitive.
1039
+ */
1040
+ fullName: string | null;
1041
+ }
1042
+ /**
1043
+ * The specific location (e.g., bin or shelf) within the inventory site where the
1044
+ * item associated with this item line is stored.
1045
+ */
1046
+ interface InventorySiteLocation {
1047
+ /**
1048
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1049
+ * across all objects of the same type, but not across different QuickBooks object
1050
+ * types.
1051
+ */
1052
+ id: string | null;
1053
+ /**
1054
+ * The fully-qualified unique name for this object, formed by combining the names
1055
+ * of its parent objects with its own `name`, separated by colons. Not
1056
+ * case-sensitive.
1057
+ */
1058
+ fullName: string | null;
1059
+ }
1060
+ /**
1061
+ * The item associated with this item line. This can refer to any good or service
1062
+ * that the business buys or sells, including item types such as a service item,
1063
+ * inventory item, or special calculation item like a discount item or sales-tax
1064
+ * item.
1065
+ */
1066
+ interface Item {
1067
+ /**
1068
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1069
+ * across all objects of the same type, but not across different QuickBooks object
1070
+ * types.
1071
+ */
1072
+ id: string | null;
1073
+ /**
1074
+ * The fully-qualified unique name for this object, formed by combining the names
1075
+ * of its parent objects with its own `name`, separated by colons. Not
1076
+ * case-sensitive.
1077
+ */
1078
+ fullName: string | null;
1079
+ }
1080
+ /**
1081
+ * Specifies an alternative unit-of-measure set when updating this item line's
1082
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
1083
+ * units from a different set than the item's default unit-of-measure set, which
1084
+ * remains unchanged on the item itself. The override applies only to this specific
1085
+ * line. For example, you can sell an item typically measured in volume units using
1086
+ * weight units in a specific transaction by specifying a different unit-of-measure
1087
+ * set with this field.
1088
+ */
1089
+ interface OverrideUnitOfMeasureSet {
1090
+ /**
1091
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1092
+ * across all objects of the same type, but not across different QuickBooks object
1093
+ * types.
1094
+ */
1095
+ id: string | null;
1096
+ /**
1097
+ * The fully-qualified unique name for this object, formed by combining the names
1098
+ * of its parent objects with its own `name`, separated by colons. Not
1099
+ * case-sensitive.
1100
+ */
1101
+ fullName: string | null;
1102
+ }
1103
+ /**
1104
+ * The item line's sales representative. Sales representatives can be employees,
1105
+ * vendors, or other names in QuickBooks.
1106
+ */
1107
+ interface SalesRepresentative {
1108
+ /**
1109
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1110
+ * across all objects of the same type, but not across different QuickBooks object
1111
+ * types.
1112
+ */
1113
+ id: string | null;
1114
+ /**
1115
+ * The fully-qualified unique name for this object, formed by combining the names
1116
+ * of its parent objects with its own `name`, separated by colons. Not
1117
+ * case-sensitive.
1118
+ */
1119
+ fullName: string | null;
1120
+ }
1121
+ /**
1122
+ * The sales-tax code for this item line, determining whether it is taxable or
1123
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
1124
+ * transaction or the associated item.
1125
+ *
1126
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1127
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1128
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1129
+ * non-taxable code to all sales.
1130
+ */
1131
+ interface SalesTaxCode {
1132
+ /**
1133
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1134
+ * across all objects of the same type, but not across different QuickBooks object
1135
+ * types.
1136
+ */
1137
+ id: string | null;
1138
+ /**
1139
+ * The fully-qualified unique name for this object, formed by combining the names
1140
+ * of its parent objects with its own `name`, separated by colons. Not
1141
+ * case-sensitive.
1142
+ */
1143
+ fullName: string | null;
1144
+ }
1145
+ }
1146
+ /**
1147
+ * The liability account used to track the amount owed for this item receipt.
1148
+ */
1149
+ interface LiabilityAccount {
1150
+ /**
1151
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1152
+ * across all objects of the same type, but not across different QuickBooks object
1153
+ * types.
1154
+ */
1155
+ id: string | null;
1156
+ /**
1157
+ * The fully-qualified unique name for this object, formed by combining the names
1158
+ * of its parent objects with its own `name`, separated by colons. Not
1159
+ * case-sensitive.
1160
+ */
1161
+ fullName: string | null;
1162
+ }
1163
+ interface LinkedTransaction {
1164
+ /**
1165
+ * The unique identifier assigned by QuickBooks to this linked transaction. This ID
1166
+ * is unique across all transaction types.
1167
+ */
1168
+ id: string;
1169
+ /**
1170
+ * The monetary amount of this linked transaction, represented as a decimal string.
1171
+ */
1172
+ amount: string | null;
1173
+ /**
1174
+ * Indicates the nature of the link between the transactions: `amount` denotes an
1175
+ * amount-based link (e.g., an invoice linked to a payment), and `quantity` denotes
1176
+ * a quantity-based link (e.g., an invoice created from a sales order based on the
1177
+ * quantity of items received).
1178
+ */
1179
+ linkType: 'amount' | 'quantity' | null;
1180
+ /**
1181
+ * The type of object. This value is always `"qbd_linked_transaction"`.
1182
+ */
1183
+ objectType: 'qbd_linked_transaction';
1184
+ /**
1185
+ * The case-sensitive user-defined reference number for this linked transaction,
1186
+ * which can be used to identify the transaction in QuickBooks. This value is not
1187
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
1188
+ */
1189
+ refNumber: string | null;
1190
+ /**
1191
+ * The date of this linked transaction, in ISO 8601 format (YYYY-MM-DD).
1192
+ */
1193
+ transactionDate: string;
1194
+ /**
1195
+ * The type of transaction for this linked transaction.
1196
+ */
1197
+ transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment';
1198
+ }
1199
+ /**
1200
+ * The Accounts-Payable (A/P) account to which this item receipt is assigned, used
1201
+ * to track the amount owed. If not specified, QuickBooks Desktop will use its
1202
+ * default A/P account.
1203
+ *
1204
+ * **IMPORTANT**: If this item receipt is linked to other transactions, this A/P
1205
+ * account must match the `payablesAccount` used in those other transactions.
1206
+ */
1207
+ interface PayablesAccount {
1208
+ /**
1209
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1210
+ * across all objects of the same type, but not across different QuickBooks object
1211
+ * types.
1212
+ */
1213
+ id: string | null;
1214
+ /**
1215
+ * The fully-qualified unique name for this object, formed by combining the names
1216
+ * of its parent objects with its own `name`, separated by colons. Not
1217
+ * case-sensitive.
1218
+ */
1219
+ fullName: string | null;
1220
+ }
1221
+ /**
1222
+ * The sales-tax code for this item receipt, determining whether it is taxable or
1223
+ * non-taxable. If set, this overrides any sales-tax codes defined on the vendor.
1224
+ * This can be overridden on the item receipt's individual lines.
1225
+ *
1226
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1227
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1228
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1229
+ * non-taxable code to all sales.
1230
+ */
1231
+ interface SalesTaxCode {
1232
+ /**
1233
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1234
+ * across all objects of the same type, but not across different QuickBooks object
1235
+ * types.
1236
+ */
1237
+ id: string | null;
1238
+ /**
1239
+ * The fully-qualified unique name for this object, formed by combining the names
1240
+ * of its parent objects with its own `name`, separated by colons. Not
1241
+ * case-sensitive.
1242
+ */
1243
+ fullName: string | null;
1244
+ }
1245
+ /**
1246
+ * The vendor who sent this item receipt for goods or services purchased.
1247
+ */
1248
+ interface Vendor {
1249
+ /**
1250
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1251
+ * across all objects of the same type, but not across different QuickBooks object
1252
+ * types.
1253
+ */
1254
+ id: string | null;
1255
+ /**
1256
+ * The fully-qualified unique name for this object, formed by combining the names
1257
+ * of its parent objects with its own `name`, separated by colons. Not
1258
+ * case-sensitive.
1259
+ */
1260
+ fullName: string | null;
1261
+ }
1262
+ }
1263
+ export interface ItemReceiptDeleteResponse {
1264
+ /**
1265
+ * The QuickBooks-assigned unique identifier of the deleted item receipt.
1266
+ */
1267
+ id: string;
1268
+ /**
1269
+ * Indicates whether the item receipt was deleted.
1270
+ */
1271
+ deleted: boolean;
1272
+ /**
1273
+ * The type of object. This value is always `"qbd_item_receipt"`.
1274
+ */
1275
+ objectType: 'qbd_item_receipt';
1276
+ /**
1277
+ * The case-sensitive user-defined reference number of the deleted item receipt.
1278
+ */
1279
+ refNumber: string | null;
1280
+ }
1281
+ export interface ItemReceiptCreateParams {
1282
+ /**
1283
+ * Body param: The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).
1284
+ */
1285
+ transactionDate: string;
1286
+ /**
1287
+ * Body param: The vendor who sent this item receipt for goods or services
1288
+ * purchased.
1289
+ */
1290
+ vendorId: string;
1291
+ /**
1292
+ * Header param: The ID of the EndUser to receive this request (e.g.,
1293
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
1294
+ */
1295
+ conductorEndUserId: string;
1296
+ /**
1297
+ * Body param: The market exchange rate between this item receipt's currency and
1298
+ * the home currency in QuickBooks at the time of this transaction. Represented as
1299
+ * a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home
1300
+ * currency).
1301
+ */
1302
+ exchangeRate?: number;
1303
+ /**
1304
+ * Body param: The item receipt's expense lines, each representing one line in this
1305
+ * expense.
1306
+ */
1307
+ expenseLines?: Array<ItemReceiptCreateParams.ExpenseLine>;
1308
+ /**
1309
+ * Body param: A globally unique identifier (GUID) you, the developer, can provide
1310
+ * for tracking this object in your external system. This field is immutable and
1311
+ * can only be set during object creation.
1312
+ *
1313
+ * **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
1314
+ * QuickBooks will return an error.
1315
+ */
1316
+ externalId?: string;
1317
+ /**
1318
+ * Body param: The item receipt's item group lines, each representing a predefined
1319
+ * set of items bundled together because they are commonly purchased together or
1320
+ * grouped for faster entry.
1321
+ */
1322
+ itemLineGroups?: Array<ItemReceiptCreateParams.ItemLineGroup>;
1323
+ /**
1324
+ * Body param: The item receipt's item lines, each representing the purchase of a
1325
+ * specific item or service.
1326
+ */
1327
+ itemLines?: Array<ItemReceiptCreateParams.ItemLine>;
1328
+ /**
1329
+ * Body param: IDs of existing purchase orders that you wish to link to this item
1330
+ * receipt. Note that this links entire transactions, not individual transaction
1331
+ * lines. If you want to link individual lines in a transaction, instead use the
1332
+ * field `linkToTransactionLine` on this item receipt's lines, if available.
1333
+ *
1334
+ * Transactions can only be linked when creating this item receipt and cannot be
1335
+ * unlinked later.
1336
+ *
1337
+ * You can use both `linkToTransactionIds` (on this item receipt) and
1338
+ * `linkToTransactionLine` (on its transaction lines) as long as they do NOT link
1339
+ * to the same transaction (otherwise, QuickBooks will return an error). QuickBooks
1340
+ * will also return an error if you attempt to link a transaction that is empty or
1341
+ * already closed.
1342
+ *
1343
+ * **IMPORTANT**: By default, QuickBooks will not return any information about the
1344
+ * linked transactions in this endpoint's response even when this request is
1345
+ * successful. To see the transactions linked via this field, refetch the item
1346
+ * receipt and check the `linkedTransactions` response field. If fetching a list of
1347
+ * item receipts, you must also specify the parameter
1348
+ * `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
1349
+ */
1350
+ linkToTransactionIds?: Array<string>;
1351
+ /**
1352
+ * Body param: A memo or note for this item receipt.
1353
+ */
1354
+ memo?: string;
1355
+ /**
1356
+ * Body param: The Accounts-Payable (A/P) account to which this item receipt is
1357
+ * assigned, used to track the amount owed. If not specified, QuickBooks Desktop
1358
+ * will use its default A/P account.
1359
+ *
1360
+ * **IMPORTANT**: If this item receipt is linked to other transactions, this A/P
1361
+ * account must match the `payablesAccount` used in those other transactions.
1362
+ */
1363
+ payablesAccountId?: string;
1364
+ /**
1365
+ * Body param: The case-sensitive user-defined reference number for this item
1366
+ * receipt, which can be used to identify the transaction in QuickBooks. This value
1367
+ * is not required to be unique and can be arbitrarily changed by the QuickBooks
1368
+ * user. When left blank in this create request, this field will be left blank in
1369
+ * QuickBooks (i.e., it does _not_ auto-increment).
1370
+ */
1371
+ refNumber?: string;
1372
+ /**
1373
+ * Body param: The sales-tax code for this item receipt, determining whether it is
1374
+ * taxable or non-taxable. If set, this overrides any sales-tax codes defined on
1375
+ * the vendor. This can be overridden on the item receipt's individual lines.
1376
+ *
1377
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1378
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1379
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1380
+ * non-taxable code to all sales.
1381
+ */
1382
+ salesTaxCodeId?: string;
1383
+ }
1384
+ export declare namespace ItemReceiptCreateParams {
1385
+ interface ExpenseLine {
1386
+ /**
1387
+ * The expense account being debited (increased) for this expense line. The
1388
+ * corresponding account being credited is usually a liability account (e.g.,
1389
+ * Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
1390
+ * type.
1391
+ */
1392
+ accountId?: string;
1393
+ /**
1394
+ * The monetary amount of this expense line, represented as a decimal string.
1395
+ */
1396
+ amount?: string;
1397
+ /**
1398
+ * The billing status of this expense line.
1399
+ */
1400
+ billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
1401
+ /**
1402
+ * The expense line's class. Classes can be used to categorize objects into
1403
+ * meaningful segments, such as department, location, or type of work. In
1404
+ * QuickBooks, class tracking is off by default. If a class is specified for the
1405
+ * entire parent transaction, it is automatically applied to all expense lines
1406
+ * unless overridden here, at the transaction line level.
1407
+ */
1408
+ classId?: string;
1409
+ /**
1410
+ * The custom fields for the expense line object, added as user-defined data
1411
+ * extensions, not included in the standard QuickBooks object.
1412
+ */
1413
+ customFields?: Array<ExpenseLine.CustomField>;
1414
+ /**
1415
+ * A memo or note for this expense line.
1416
+ */
1417
+ memo?: string;
1418
+ /**
1419
+ * If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
1420
+ * expense's vendor (not the customer). If `account` refers to any other type of
1421
+ * account, `payee` refers to the expense's customer (not the vendor).
1422
+ */
1423
+ payeeId?: string;
1424
+ /**
1425
+ * The expense line's sales representative. Sales representatives can be employees,
1426
+ * vendors, or other names in QuickBooks.
1427
+ */
1428
+ salesRepresentativeId?: string;
1429
+ /**
1430
+ * The sales-tax code for this expense line, determining whether it is taxable or
1431
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
1432
+ * transaction or the associated item.
1433
+ *
1434
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1435
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1436
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1437
+ * non-taxable code to all sales.
1438
+ */
1439
+ salesTaxCodeId?: string;
1440
+ }
1441
+ namespace ExpenseLine {
1442
+ interface CustomField {
1443
+ /**
1444
+ * The name of the custom field, unique for the specified `ownerId`. For public
1445
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1446
+ */
1447
+ name: string;
1448
+ /**
1449
+ * The identifier of the owner of the custom field, which QuickBooks internally
1450
+ * calls a "data extension". For public custom fields visible in the UI, such as
1451
+ * those added by the QuickBooks user, this is always "0". For private custom
1452
+ * fields that are only visible to the application that created them, this is a
1453
+ * valid GUID identifying the owning application. Internally, Conductor always
1454
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1455
+ * objects.
1456
+ */
1457
+ ownerId: string;
1458
+ /**
1459
+ * The value of this custom field. The maximum length depends on the field's data
1460
+ * type.
1461
+ */
1462
+ value: string;
1463
+ }
1464
+ }
1465
+ interface ItemLineGroup {
1466
+ /**
1467
+ * The item line group's item group, representing a predefined set of items bundled
1468
+ * because they are commonly purchased together or grouped for faster entry.
1469
+ */
1470
+ itemGroupId: string;
1471
+ /**
1472
+ * The custom fields for the item line group object, added as user-defined data
1473
+ * extensions, not included in the standard QuickBooks object.
1474
+ */
1475
+ customFields?: Array<ItemLineGroup.CustomField>;
1476
+ /**
1477
+ * The site location where inventory for the item group associated with this item
1478
+ * line group is stored.
1479
+ */
1480
+ inventorySiteId?: string;
1481
+ /**
1482
+ * The specific location (e.g., bin or shelf) within the inventory site where the
1483
+ * item group associated with this item line group is stored.
1484
+ */
1485
+ inventorySiteLocationId?: string;
1486
+ /**
1487
+ * The quantity of the item group associated with this item line group. This field
1488
+ * cannot be cleared.
1489
+ *
1490
+ * **NOTE**: Do not use this field if the associated item group is a discount item
1491
+ * group.
1492
+ */
1493
+ quantity?: number;
1494
+ /**
1495
+ * The unit-of-measure used for the `quantity` in this item line group. Must be a
1496
+ * valid unit within the item's available units of measure.
1497
+ */
1498
+ unitOfMeasure?: string;
1499
+ }
1500
+ namespace ItemLineGroup {
1501
+ interface CustomField {
1502
+ /**
1503
+ * The name of the custom field, unique for the specified `ownerId`. For public
1504
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1505
+ */
1506
+ name: string;
1507
+ /**
1508
+ * The identifier of the owner of the custom field, which QuickBooks internally
1509
+ * calls a "data extension". For public custom fields visible in the UI, such as
1510
+ * those added by the QuickBooks user, this is always "0". For private custom
1511
+ * fields that are only visible to the application that created them, this is a
1512
+ * valid GUID identifying the owning application. Internally, Conductor always
1513
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1514
+ * objects.
1515
+ */
1516
+ ownerId: string;
1517
+ /**
1518
+ * The value of this custom field. The maximum length depends on the field's data
1519
+ * type.
1520
+ */
1521
+ value: string;
1522
+ }
1523
+ }
1524
+ interface ItemLine {
1525
+ /**
1526
+ * The monetary amount of this item line, represented as a decimal string. If both
1527
+ * `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
1528
+ * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
1529
+ * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
1530
+ * suggested `cost`. This field cannot be cleared.
1531
+ */
1532
+ amount?: string;
1533
+ /**
1534
+ * The billing status of this item line.
1535
+ */
1536
+ billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
1537
+ /**
1538
+ * The item line's class. Classes can be used to categorize objects into meaningful
1539
+ * segments, such as department, location, or type of work. In QuickBooks, class
1540
+ * tracking is off by default. If a class is specified for the entire parent
1541
+ * transaction, it is automatically applied to all item lines unless overridden
1542
+ * here, at the transaction line level.
1543
+ */
1544
+ classId?: string;
1545
+ /**
1546
+ * The cost of this item line, represented as a decimal string. If both `quantity`
1547
+ * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
1548
+ * `cost`.
1549
+ */
1550
+ cost?: string;
1551
+ /**
1552
+ * The customer or customer-job associated with this item line.
1553
+ */
1554
+ customerId?: string;
1555
+ /**
1556
+ * The custom fields for the item line object, added as user-defined data
1557
+ * extensions, not included in the standard QuickBooks object.
1558
+ */
1559
+ customFields?: Array<ItemLine.CustomField>;
1560
+ /**
1561
+ * A description of this item line.
1562
+ */
1563
+ description?: string;
1564
+ /**
1565
+ * The expiration date for the serial number or lot number of the item associated
1566
+ * with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
1567
+ * relevant for perishable or time-sensitive inventory items. Note that this field
1568
+ * is only supported on QuickBooks Desktop 2023 or later.
1569
+ */
1570
+ expirationDate?: string;
1571
+ /**
1572
+ * The site location where inventory for the item associated with this item line is
1573
+ * stored.
1574
+ */
1575
+ inventorySiteId?: string;
1576
+ /**
1577
+ * The specific location (e.g., bin or shelf) within the inventory site where the
1578
+ * item associated with this item line is stored.
1579
+ */
1580
+ inventorySiteLocationId?: string;
1581
+ /**
1582
+ * The item associated with this item line. This can refer to any good or service
1583
+ * that the business buys or sells, including item types such as a service item,
1584
+ * inventory item, or special calculation item like a discount item or sales-tax
1585
+ * item.
1586
+ */
1587
+ itemId?: string;
1588
+ /**
1589
+ * An existing transaction line that you wish to link to this item line. Note that
1590
+ * this only links to a single transaction line item, not an entire transaction. If
1591
+ * you want to link an entire transaction and bring in all its lines, instead use
1592
+ * the field `linkToTransactionIds` on the parent transaction, if available. If the
1593
+ * parent transaction is a bill or an item receipt, you can only link to purchase
1594
+ * orders; QuickBooks does not support linking these transactions to other
1595
+ * transaction types.
1596
+ *
1597
+ * Transaction lines can only be linked when creating this item line and cannot be
1598
+ * unlinked later.
1599
+ *
1600
+ * **IMPORTANT**: If you use `linkToTransactionLine` on this item line, you cannot
1601
+ * use the field `item` on this line (QuickBooks will return an error) because this
1602
+ * field brings in all of the item information you need. You can, however, specify
1603
+ * whatever `quantity` or `rate` that you want, or any other transaction line
1604
+ * element other than `item`.
1605
+ *
1606
+ * If the parent transaction supports the `linkToTransactionIds` field, you can use
1607
+ * both `linkToTransactionLine` (on this item line) and `linkToTransactionIds` (on
1608
+ * its parent transaction) in the same request as long as they do NOT link to the
1609
+ * same transaction (otherwise, QuickBooks will return an error). QuickBooks will
1610
+ * also return an error if you attempt to link a transaction that is empty or
1611
+ * already closed.
1612
+ *
1613
+ * **IMPORTANT**: By default, QuickBooks will not return any information about the
1614
+ * linked transaction line in this endpoint's response even when this request is
1615
+ * successful. To see the transaction line linked via this field, refetch the
1616
+ * parent transaction and check the `linkedTransactions` response field. If
1617
+ * fetching a list of transactions, you must also specify the parameter
1618
+ * `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
1619
+ */
1620
+ linkToTransactionLine?: ItemLine.LinkToTransactionLine;
1621
+ /**
1622
+ * The lot number of the item associated with this item line. Used for tracking
1623
+ * groups of inventory items that are purchased or manufactured together.
1624
+ */
1625
+ lotNumber?: string;
1626
+ /**
1627
+ * The account to use for this item line, overriding the default account associated
1628
+ * with the item.
1629
+ */
1630
+ overrideItemAccountId?: string;
1631
+ /**
1632
+ * The quantity of the item associated with this item line. This field cannot be
1633
+ * cleared.
1634
+ *
1635
+ * **NOTE**: Do not use this field if the associated item is a discount item.
1636
+ */
1637
+ quantity?: number;
1638
+ /**
1639
+ * The item line's sales representative. Sales representatives can be employees,
1640
+ * vendors, or other names in QuickBooks.
1641
+ */
1642
+ salesRepresentativeId?: string;
1643
+ /**
1644
+ * The sales-tax code for this item line, determining whether it is taxable or
1645
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
1646
+ * transaction or the associated item.
1647
+ *
1648
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1649
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1650
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1651
+ * non-taxable code to all sales.
1652
+ */
1653
+ salesTaxCodeId?: string;
1654
+ /**
1655
+ * The serial number of the item associated with this item line. This is used for
1656
+ * tracking individual units of serialized inventory items.
1657
+ */
1658
+ serialNumber?: string;
1659
+ /**
1660
+ * The unit-of-measure used for the `quantity` in this item line. Must be a valid
1661
+ * unit within the item's available units of measure.
1662
+ */
1663
+ unitOfMeasure?: string;
1664
+ }
1665
+ namespace ItemLine {
1666
+ interface CustomField {
1667
+ /**
1668
+ * The name of the custom field, unique for the specified `ownerId`. For public
1669
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1670
+ */
1671
+ name: string;
1672
+ /**
1673
+ * The identifier of the owner of the custom field, which QuickBooks internally
1674
+ * calls a "data extension". For public custom fields visible in the UI, such as
1675
+ * those added by the QuickBooks user, this is always "0". For private custom
1676
+ * fields that are only visible to the application that created them, this is a
1677
+ * valid GUID identifying the owning application. Internally, Conductor always
1678
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1679
+ * objects.
1680
+ */
1681
+ ownerId: string;
1682
+ /**
1683
+ * The value of this custom field. The maximum length depends on the field's data
1684
+ * type.
1685
+ */
1686
+ value: string;
1687
+ }
1688
+ /**
1689
+ * An existing transaction line that you wish to link to this item line. Note that
1690
+ * this only links to a single transaction line item, not an entire transaction. If
1691
+ * you want to link an entire transaction and bring in all its lines, instead use
1692
+ * the field `linkToTransactionIds` on the parent transaction, if available. If the
1693
+ * parent transaction is a bill or an item receipt, you can only link to purchase
1694
+ * orders; QuickBooks does not support linking these transactions to other
1695
+ * transaction types.
1696
+ *
1697
+ * Transaction lines can only be linked when creating this item line and cannot be
1698
+ * unlinked later.
1699
+ *
1700
+ * **IMPORTANT**: If you use `linkToTransactionLine` on this item line, you cannot
1701
+ * use the field `item` on this line (QuickBooks will return an error) because this
1702
+ * field brings in all of the item information you need. You can, however, specify
1703
+ * whatever `quantity` or `rate` that you want, or any other transaction line
1704
+ * element other than `item`.
1705
+ *
1706
+ * If the parent transaction supports the `linkToTransactionIds` field, you can use
1707
+ * both `linkToTransactionLine` (on this item line) and `linkToTransactionIds` (on
1708
+ * its parent transaction) in the same request as long as they do NOT link to the
1709
+ * same transaction (otherwise, QuickBooks will return an error). QuickBooks will
1710
+ * also return an error if you attempt to link a transaction that is empty or
1711
+ * already closed.
1712
+ *
1713
+ * **IMPORTANT**: By default, QuickBooks will not return any information about the
1714
+ * linked transaction line in this endpoint's response even when this request is
1715
+ * successful. To see the transaction line linked via this field, refetch the
1716
+ * parent transaction and check the `linkedTransactions` response field. If
1717
+ * fetching a list of transactions, you must also specify the parameter
1718
+ * `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
1719
+ */
1720
+ interface LinkToTransactionLine {
1721
+ /**
1722
+ * The ID of the transaction to which to link this transaction.
1723
+ */
1724
+ transactionId: string;
1725
+ /**
1726
+ * The ID of the transaction line to which to link this transaction.
1727
+ */
1728
+ transactionLineId: string;
1729
+ }
1730
+ }
1731
+ }
1732
+ export interface ItemReceiptRetrieveParams {
1733
+ /**
1734
+ * The ID of the EndUser to receive this request (e.g.,
1735
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
1736
+ */
1737
+ conductorEndUserId: string;
1738
+ }
1739
+ export interface ItemReceiptUpdateParams {
1740
+ /**
1741
+ * Body param: The current QuickBooks-assigned revision number of the item receipt
1742
+ * object you are updating, which you can get by fetching the object first. Provide
1743
+ * the most recent `revisionNumber` to ensure you're working with the latest data;
1744
+ * otherwise, the update will return an error.
1745
+ */
1746
+ revisionNumber: string;
1747
+ /**
1748
+ * Header param: The ID of the EndUser to receive this request (e.g.,
1749
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
1750
+ */
1751
+ conductorEndUserId: string;
1752
+ /**
1753
+ * Body param: When `true`, removes all existing expense lines associated with this
1754
+ * item receipt. To modify or add individual expense lines, use the field
1755
+ * `expenseLines` instead.
1756
+ */
1757
+ clearExpenseLines?: boolean;
1758
+ /**
1759
+ * Body param: When `true`, removes all existing item lines associated with this
1760
+ * item receipt. To modify or add individual item lines, use the field `itemLines`
1761
+ * instead.
1762
+ */
1763
+ clearItemLines?: boolean;
1764
+ /**
1765
+ * Body param: The market exchange rate between this item receipt's currency and
1766
+ * the home currency in QuickBooks at the time of this transaction. Represented as
1767
+ * a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home
1768
+ * currency).
1769
+ */
1770
+ exchangeRate?: number;
1771
+ /**
1772
+ * Body param: The item receipt's expense lines, each representing one line in this
1773
+ * expense.
1774
+ *
1775
+ * **IMPORTANT**:
1776
+ *
1777
+ * 1. Including this array in your update request will **REPLACE** all existing
1778
+ * expense lines for the item receipt with this array. To keep any existing
1779
+ * expense lines, you must include them in this array even if they have not
1780
+ * changed. **Any expense lines not included will be removed.**
1781
+ *
1782
+ * 2. To add a new expense line, include it here with the `id` field set to `-1`.
1783
+ *
1784
+ * 3. If you do not wish to modify any expense lines, omit this field entirely to
1785
+ * keep them unchanged.
1786
+ */
1787
+ expenseLines?: Array<ItemReceiptUpdateParams.ExpenseLine>;
1788
+ /**
1789
+ * Body param: The item receipt's item group lines, each representing a predefined
1790
+ * set of items bundled together because they are commonly purchased together or
1791
+ * grouped for faster entry.
1792
+ *
1793
+ * **IMPORTANT**:
1794
+ *
1795
+ * 1. Including this array in your update request will **REPLACE** all existing
1796
+ * item group lines for the item receipt with this array. To keep any existing
1797
+ * item group lines, you must include them in this array even if they have not
1798
+ * changed. **Any item group lines not included will be removed.**
1799
+ *
1800
+ * 2. To add a new item group line, include it here with the `id` field set to
1801
+ * `-1`.
1802
+ *
1803
+ * 3. If you do not wish to modify any item group lines, omit this field entirely
1804
+ * to keep them unchanged.
1805
+ */
1806
+ itemLineGroups?: Array<ItemReceiptUpdateParams.ItemLineGroup>;
1807
+ /**
1808
+ * Body param: The item receipt's item lines, each representing the purchase of a
1809
+ * specific item or service.
1810
+ *
1811
+ * **IMPORTANT**:
1812
+ *
1813
+ * 1. Including this array in your update request will **REPLACE** all existing
1814
+ * item lines for the item receipt with this array. To keep any existing item
1815
+ * lines, you must include them in this array even if they have not changed.
1816
+ * **Any item lines not included will be removed.**
1817
+ *
1818
+ * 2. To add a new item line, include it here with the `id` field set to `-1`.
1819
+ *
1820
+ * 3. If you do not wish to modify any item lines, omit this field entirely to keep
1821
+ * them unchanged.
1822
+ */
1823
+ itemLines?: Array<ItemReceiptUpdateParams.ItemLine>;
1824
+ /**
1825
+ * Body param: A memo or note for this item receipt.
1826
+ */
1827
+ memo?: string;
1828
+ /**
1829
+ * Body param: The Accounts-Payable (A/P) account to which this item receipt is
1830
+ * assigned, used to track the amount owed. If not specified, QuickBooks Desktop
1831
+ * will use its default A/P account.
1832
+ *
1833
+ * **IMPORTANT**: If this item receipt is linked to other transactions, this A/P
1834
+ * account must match the `payablesAccount` used in those other transactions.
1835
+ */
1836
+ payablesAccountId?: string;
1837
+ /**
1838
+ * Body param: The case-sensitive user-defined reference number for this item
1839
+ * receipt, which can be used to identify the transaction in QuickBooks. This value
1840
+ * is not required to be unique and can be arbitrarily changed by the QuickBooks
1841
+ * user.
1842
+ */
1843
+ refNumber?: string;
1844
+ /**
1845
+ * Body param: The sales-tax code for this item receipt, determining whether it is
1846
+ * taxable or non-taxable. If set, this overrides any sales-tax codes defined on
1847
+ * the vendor. This can be overridden on the item receipt's individual lines.
1848
+ *
1849
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1850
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1851
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1852
+ * non-taxable code to all sales.
1853
+ */
1854
+ salesTaxCodeId?: string;
1855
+ /**
1856
+ * Body param: The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).
1857
+ */
1858
+ transactionDate?: string;
1859
+ /**
1860
+ * Body param: The vendor who sent this item receipt for goods or services
1861
+ * purchased.
1862
+ */
1863
+ vendorId?: string;
1864
+ }
1865
+ export declare namespace ItemReceiptUpdateParams {
1866
+ interface ExpenseLine {
1867
+ /**
1868
+ * The QuickBooks-assigned unique identifier of an existing expense line you wish
1869
+ * to retain or update.
1870
+ *
1871
+ * **IMPORTANT**: Set this field to `-1` for new expense lines you wish to add.
1872
+ */
1873
+ id: string;
1874
+ /**
1875
+ * The expense account being debited (increased) for this expense line. The
1876
+ * corresponding account being credited is usually a liability account (e.g.,
1877
+ * Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
1878
+ * type.
1879
+ */
1880
+ accountId?: string;
1881
+ /**
1882
+ * The monetary amount of this expense line, represented as a decimal string.
1883
+ */
1884
+ amount?: string;
1885
+ /**
1886
+ * The billing status of this expense line.
1887
+ */
1888
+ billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
1889
+ /**
1890
+ * The expense line's class. Classes can be used to categorize objects into
1891
+ * meaningful segments, such as department, location, or type of work. In
1892
+ * QuickBooks, class tracking is off by default. If a class is specified for the
1893
+ * entire parent transaction, it is automatically applied to all expense lines
1894
+ * unless overridden here, at the transaction line level.
1895
+ */
1896
+ classId?: string;
1897
+ /**
1898
+ * A memo or note for this expense line.
1899
+ */
1900
+ memo?: string;
1901
+ /**
1902
+ * If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
1903
+ * expense's vendor (not the customer). If `account` refers to any other type of
1904
+ * account, `payee` refers to the expense's customer (not the vendor).
1905
+ */
1906
+ payeeId?: string;
1907
+ /**
1908
+ * The expense line's sales representative. Sales representatives can be employees,
1909
+ * vendors, or other names in QuickBooks.
1910
+ */
1911
+ salesRepresentativeId?: string;
1912
+ /**
1913
+ * The sales-tax code for this expense line, determining whether it is taxable or
1914
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
1915
+ * transaction or the associated item.
1916
+ *
1917
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1918
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1919
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1920
+ * non-taxable code to all sales.
1921
+ */
1922
+ salesTaxCodeId?: string;
1923
+ }
1924
+ interface ItemLineGroup {
1925
+ /**
1926
+ * The QuickBooks-assigned unique identifier of an existing item line group you
1927
+ * wish to retain or update.
1928
+ *
1929
+ * **IMPORTANT**: Set this field to `-1` for new item line groups you wish to add.
1930
+ */
1931
+ id: string;
1932
+ /**
1933
+ * The item line group's item group, representing a predefined set of items bundled
1934
+ * because they are commonly purchased together or grouped for faster entry.
1935
+ */
1936
+ itemGroupId?: string;
1937
+ /**
1938
+ * The item line group's item lines, each representing the purchase of a specific
1939
+ * item or service.
1940
+ *
1941
+ * **IMPORTANT**:
1942
+ *
1943
+ * 1. Including this array in your update request will **REPLACE** all existing
1944
+ * item lines for the item line group with this array. To keep any existing item
1945
+ * lines, you must include them in this array even if they have not changed.
1946
+ * **Any item lines not included will be removed.**
1947
+ *
1948
+ * 2. To add a new item line, include it here with the `id` field set to `-1`.
1949
+ *
1950
+ * 3. If you do not wish to modify any item lines, omit this field entirely to keep
1951
+ * them unchanged.
1952
+ */
1953
+ itemLines?: Array<ItemLineGroup.ItemLine>;
1954
+ /**
1955
+ * Specifies an alternative unit-of-measure set when updating this item line
1956
+ * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
1957
+ * select units from a different set than the item's default unit-of-measure set,
1958
+ * which remains unchanged on the item itself. The override applies only to this
1959
+ * specific line. For example, you can sell an item typically measured in volume
1960
+ * units using weight units in a specific transaction by specifying a different
1961
+ * unit-of-measure set with this field.
1962
+ */
1963
+ overrideUnitOfMeasureSetId?: string;
1964
+ /**
1965
+ * The quantity of the item group associated with this item line group. This field
1966
+ * cannot be cleared.
1967
+ *
1968
+ * **NOTE**: Do not use this field if the associated item group is a discount item
1969
+ * group.
1970
+ */
1971
+ quantity?: number;
1972
+ /**
1973
+ * The unit-of-measure used for the `quantity` in this item line group. Must be a
1974
+ * valid unit within the item's available units of measure.
1975
+ */
1976
+ unitOfMeasure?: string;
1977
+ }
1978
+ namespace ItemLineGroup {
1979
+ interface ItemLine {
1980
+ /**
1981
+ * The QuickBooks-assigned unique identifier of an existing item line you wish to
1982
+ * retain or update.
1983
+ *
1984
+ * **IMPORTANT**: Set this field to `-1` for new item lines you wish to add.
1985
+ */
1986
+ id: string;
1987
+ /**
1988
+ * The monetary amount of this item line, represented as a decimal string. If both
1989
+ * `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
1990
+ * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
1991
+ * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
1992
+ * suggested `cost`. This field cannot be cleared.
1993
+ */
1994
+ amount?: string;
1995
+ /**
1996
+ * The billing status of this item line.
1997
+ */
1998
+ billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
1999
+ /**
2000
+ * The item line's class. Classes can be used to categorize objects into meaningful
2001
+ * segments, such as department, location, or type of work. In QuickBooks, class
2002
+ * tracking is off by default. If a class is specified for the entire parent
2003
+ * transaction, it is automatically applied to all item lines unless overridden
2004
+ * here, at the transaction line level.
2005
+ */
2006
+ classId?: string;
2007
+ /**
2008
+ * The cost of this item line, represented as a decimal string. If both `quantity`
2009
+ * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2010
+ * `cost`.
2011
+ */
2012
+ cost?: string;
2013
+ /**
2014
+ * The customer or customer-job associated with this item line.
2015
+ */
2016
+ customerId?: string;
2017
+ /**
2018
+ * A description of this item line.
2019
+ */
2020
+ description?: string;
2021
+ /**
2022
+ * The expiration date for the serial number or lot number of the item associated
2023
+ * with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
2024
+ * relevant for perishable or time-sensitive inventory items. Note that this field
2025
+ * is only supported on QuickBooks Desktop 2023 or later.
2026
+ */
2027
+ expirationDate?: string;
2028
+ /**
2029
+ * The site location where inventory for the item associated with this item line is
2030
+ * stored.
2031
+ */
2032
+ inventorySiteId?: string;
2033
+ /**
2034
+ * The specific location (e.g., bin or shelf) within the inventory site where the
2035
+ * item associated with this item line is stored.
2036
+ */
2037
+ inventorySiteLocationId?: string;
2038
+ /**
2039
+ * The item associated with this item line. This can refer to any good or service
2040
+ * that the business buys or sells, including item types such as a service item,
2041
+ * inventory item, or special calculation item like a discount item or sales-tax
2042
+ * item.
2043
+ */
2044
+ itemId?: string;
2045
+ /**
2046
+ * The lot number of the item associated with this item line. Used for tracking
2047
+ * groups of inventory items that are purchased or manufactured together.
2048
+ */
2049
+ lotNumber?: string;
2050
+ /**
2051
+ * The account to use for this item line, overriding the default account associated
2052
+ * with the item.
2053
+ */
2054
+ overrideItemAccountId?: string;
2055
+ /**
2056
+ * Specifies an alternative unit-of-measure set when updating this item line's
2057
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
2058
+ * units from a different set than the item's default unit-of-measure set, which
2059
+ * remains unchanged on the item itself. The override applies only to this specific
2060
+ * line. For example, you can sell an item typically measured in volume units using
2061
+ * weight units in a specific transaction by specifying a different unit-of-measure
2062
+ * set with this field.
2063
+ */
2064
+ overrideUnitOfMeasureSetId?: string;
2065
+ /**
2066
+ * The quantity of the item associated with this item line. This field cannot be
2067
+ * cleared.
2068
+ *
2069
+ * **NOTE**: Do not use this field if the associated item is a discount item.
2070
+ */
2071
+ quantity?: number;
2072
+ /**
2073
+ * The item line's sales representative. Sales representatives can be employees,
2074
+ * vendors, or other names in QuickBooks.
2075
+ */
2076
+ salesRepresentativeId?: string;
2077
+ /**
2078
+ * The sales-tax code for this item line, determining whether it is taxable or
2079
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
2080
+ * transaction or the associated item.
2081
+ *
2082
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2083
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2084
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2085
+ * non-taxable code to all sales.
2086
+ */
2087
+ salesTaxCodeId?: string;
2088
+ /**
2089
+ * The serial number of the item associated with this item line. This is used for
2090
+ * tracking individual units of serialized inventory items.
2091
+ */
2092
+ serialNumber?: string;
2093
+ /**
2094
+ * The unit-of-measure used for the `quantity` in this item line. Must be a valid
2095
+ * unit within the item's available units of measure.
2096
+ */
2097
+ unitOfMeasure?: string;
2098
+ }
2099
+ }
2100
+ interface ItemLine {
2101
+ /**
2102
+ * The QuickBooks-assigned unique identifier of an existing item line you wish to
2103
+ * retain or update.
2104
+ *
2105
+ * **IMPORTANT**: Set this field to `-1` for new item lines you wish to add.
2106
+ */
2107
+ id: string;
2108
+ /**
2109
+ * The monetary amount of this item line, represented as a decimal string. If both
2110
+ * `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
2111
+ * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2112
+ * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2113
+ * suggested `cost`. This field cannot be cleared.
2114
+ */
2115
+ amount?: string;
2116
+ /**
2117
+ * The billing status of this item line.
2118
+ */
2119
+ billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
2120
+ /**
2121
+ * The item line's class. Classes can be used to categorize objects into meaningful
2122
+ * segments, such as department, location, or type of work. In QuickBooks, class
2123
+ * tracking is off by default. If a class is specified for the entire parent
2124
+ * transaction, it is automatically applied to all item lines unless overridden
2125
+ * here, at the transaction line level.
2126
+ */
2127
+ classId?: string;
2128
+ /**
2129
+ * The cost of this item line, represented as a decimal string. If both `quantity`
2130
+ * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2131
+ * `cost`.
2132
+ */
2133
+ cost?: string;
2134
+ /**
2135
+ * The customer or customer-job associated with this item line.
2136
+ */
2137
+ customerId?: string;
2138
+ /**
2139
+ * A description of this item line.
2140
+ */
2141
+ description?: string;
2142
+ /**
2143
+ * The expiration date for the serial number or lot number of the item associated
2144
+ * with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
2145
+ * relevant for perishable or time-sensitive inventory items. Note that this field
2146
+ * is only supported on QuickBooks Desktop 2023 or later.
2147
+ */
2148
+ expirationDate?: string;
2149
+ /**
2150
+ * The site location where inventory for the item associated with this item line is
2151
+ * stored.
2152
+ */
2153
+ inventorySiteId?: string;
2154
+ /**
2155
+ * The specific location (e.g., bin or shelf) within the inventory site where the
2156
+ * item associated with this item line is stored.
2157
+ */
2158
+ inventorySiteLocationId?: string;
2159
+ /**
2160
+ * The item associated with this item line. This can refer to any good or service
2161
+ * that the business buys or sells, including item types such as a service item,
2162
+ * inventory item, or special calculation item like a discount item or sales-tax
2163
+ * item.
2164
+ */
2165
+ itemId?: string;
2166
+ /**
2167
+ * The lot number of the item associated with this item line. Used for tracking
2168
+ * groups of inventory items that are purchased or manufactured together.
2169
+ */
2170
+ lotNumber?: string;
2171
+ /**
2172
+ * The account to use for this item line, overriding the default account associated
2173
+ * with the item.
2174
+ */
2175
+ overrideItemAccountId?: string;
2176
+ /**
2177
+ * Specifies an alternative unit-of-measure set when updating this item line's
2178
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
2179
+ * units from a different set than the item's default unit-of-measure set, which
2180
+ * remains unchanged on the item itself. The override applies only to this specific
2181
+ * line. For example, you can sell an item typically measured in volume units using
2182
+ * weight units in a specific transaction by specifying a different unit-of-measure
2183
+ * set with this field.
2184
+ */
2185
+ overrideUnitOfMeasureSetId?: string;
2186
+ /**
2187
+ * The quantity of the item associated with this item line. This field cannot be
2188
+ * cleared.
2189
+ *
2190
+ * **NOTE**: Do not use this field if the associated item is a discount item.
2191
+ */
2192
+ quantity?: number;
2193
+ /**
2194
+ * The item line's sales representative. Sales representatives can be employees,
2195
+ * vendors, or other names in QuickBooks.
2196
+ */
2197
+ salesRepresentativeId?: string;
2198
+ /**
2199
+ * The sales-tax code for this item line, determining whether it is taxable or
2200
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
2201
+ * transaction or the associated item.
2202
+ *
2203
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2204
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2205
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2206
+ * non-taxable code to all sales.
2207
+ */
2208
+ salesTaxCodeId?: string;
2209
+ /**
2210
+ * The serial number of the item associated with this item line. This is used for
2211
+ * tracking individual units of serialized inventory items.
2212
+ */
2213
+ serialNumber?: string;
2214
+ /**
2215
+ * The unit-of-measure used for the `quantity` in this item line. Must be a valid
2216
+ * unit within the item's available units of measure.
2217
+ */
2218
+ unitOfMeasure?: string;
2219
+ }
2220
+ }
2221
+ export interface ItemReceiptListParams extends CursorPageParams {
2222
+ /**
2223
+ * Header param: The ID of the EndUser to receive this request (e.g.,
2224
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
2225
+ */
2226
+ conductorEndUserId: string;
2227
+ /**
2228
+ * Query param: Filter for item receipts associated with these accounts.
2229
+ */
2230
+ accountIds?: Array<string>;
2231
+ /**
2232
+ * Query param: Filter for item receipts in these currencies.
2233
+ */
2234
+ currencyIds?: Array<string>;
2235
+ /**
2236
+ * Query param: Filter for specific item receipts by their QuickBooks-assigned
2237
+ * unique identifier(s).
2238
+ *
2239
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
2240
+ * query parameters for this request.
2241
+ *
2242
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
2243
+ * request will return an error.
2244
+ */
2245
+ ids?: Array<string>;
2246
+ /**
2247
+ * Query param: Whether to include line items in the response. Defaults to `true`.
2248
+ */
2249
+ includeLineItems?: boolean;
2250
+ /**
2251
+ * Query param: Whether to include linked transactions in the response. Defaults to
2252
+ * `false`. For example, a payment linked to the corresponding item receipt.
2253
+ */
2254
+ includeLinkedTransactions?: boolean;
2255
+ /**
2256
+ * Query param: Filter for item receipts whose `refNumber` contains this substring.
2257
+ * NOTE: If you use this parameter, you cannot also use `refNumberStartsWith` or
2258
+ * `refNumberEndsWith`.
2259
+ */
2260
+ refNumberContains?: string;
2261
+ /**
2262
+ * Query param: Filter for item receipts whose `refNumber` ends with this
2263
+ * substring. NOTE: If you use this parameter, you cannot also use
2264
+ * `refNumberContains` or `refNumberStartsWith`.
2265
+ */
2266
+ refNumberEndsWith?: string;
2267
+ /**
2268
+ * Query param: Filter for item receipts whose `refNumber` is greater than or equal
2269
+ * to this value. If omitted, the range will begin with the first number of the
2270
+ * list. Uses a numerical comparison for values that contain only digits;
2271
+ * otherwise, uses a lexicographical comparison.
2272
+ */
2273
+ refNumberFrom?: string;
2274
+ /**
2275
+ * Query param: Filter for specific item receipts by their ref-number(s),
2276
+ * case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can
2277
+ * be arbitrarily changed by the QuickBooks user.
2278
+ *
2279
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
2280
+ * query parameters for this request.
2281
+ *
2282
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
2283
+ * request will return an error.
2284
+ */
2285
+ refNumbers?: Array<string>;
2286
+ /**
2287
+ * Query param: Filter for item receipts whose `refNumber` starts with this
2288
+ * substring. NOTE: If you use this parameter, you cannot also use
2289
+ * `refNumberContains` or `refNumberEndsWith`.
2290
+ */
2291
+ refNumberStartsWith?: string;
2292
+ /**
2293
+ * Query param: Filter for item receipts whose `refNumber` is less than or equal to
2294
+ * this value. If omitted, the range will end with the last number of the list.
2295
+ * Uses a numerical comparison for values that contain only digits; otherwise, uses
2296
+ * a lexicographical comparison.
2297
+ */
2298
+ refNumberTo?: string;
2299
+ /**
2300
+ * Query param: Filter for item receipts whose `date` field is on or after this
2301
+ * date, in ISO 8601 format (YYYY-MM-DD).
2302
+ */
2303
+ transactionDateFrom?: string;
2304
+ /**
2305
+ * Query param: Filter for item receipts whose `date` field is on or before this
2306
+ * date, in ISO 8601 format (YYYY-MM-DD).
2307
+ */
2308
+ transactionDateTo?: string;
2309
+ /**
2310
+ * Query param: Filter for item receipts updated on or after this date and time, in
2311
+ * ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD),
2312
+ * the time is assumed to be 00:00:00 of that day.
2313
+ */
2314
+ updatedAfter?: string;
2315
+ /**
2316
+ * Query param: Filter for item receipts updated on or before this date and time,
2317
+ * in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date
2318
+ * (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.
2319
+ */
2320
+ updatedBefore?: string;
2321
+ /**
2322
+ * Query param: Filter for item receipts received from these vendors.
2323
+ */
2324
+ vendorIds?: Array<string>;
2325
+ }
2326
+ export interface ItemReceiptDeleteParams {
2327
+ /**
2328
+ * The ID of the EndUser to receive this request (e.g.,
2329
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
2330
+ */
2331
+ conductorEndUserId: string;
2332
+ }
2333
+ export declare namespace ItemReceipts {
2334
+ export { type ItemReceipt as ItemReceipt, type ItemReceiptDeleteResponse as ItemReceiptDeleteResponse, ItemReceiptsCursorPage as ItemReceiptsCursorPage, type ItemReceiptCreateParams as ItemReceiptCreateParams, type ItemReceiptRetrieveParams as ItemReceiptRetrieveParams, type ItemReceiptUpdateParams as ItemReceiptUpdateParams, type ItemReceiptListParams as ItemReceiptListParams, type ItemReceiptDeleteParams as ItemReceiptDeleteParams, };
2335
+ }
2336
+ //# sourceMappingURL=item-receipts.d.ts.map