@getyetty-sdk/sellsy 2026.3.20 → 2026.3.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1005 -266
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +512 -27
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -5317,6 +5317,10 @@ type Deals = {
|
|
|
5317
5317
|
* Priority level of the calendar event
|
|
5318
5318
|
*/
|
|
5319
5319
|
priority?: number;
|
|
5320
|
+
/**
|
|
5321
|
+
* Meet link for the calendar event
|
|
5322
|
+
*/
|
|
5323
|
+
meet_link?: string | null;
|
|
5320
5324
|
} | (_heyapi_480_ & {
|
|
5321
5325
|
/**
|
|
5322
5326
|
* Short description
|
|
@@ -6664,23 +6668,27 @@ type Ocr = {
|
|
|
6664
6668
|
*/
|
|
6665
6669
|
type OcrPurInvoiceMetas = {
|
|
6666
6670
|
/**
|
|
6667
|
-
*
|
|
6671
|
+
* User can validate a purchase invoice
|
|
6668
6672
|
*/
|
|
6669
6673
|
user_can_validate_pur_invoice: boolean;
|
|
6670
6674
|
/**
|
|
6671
|
-
*
|
|
6675
|
+
* User can create a payment
|
|
6672
6676
|
*/
|
|
6673
6677
|
create_payment: boolean;
|
|
6674
6678
|
/**
|
|
6675
|
-
*
|
|
6679
|
+
* User can create a purchase invoice
|
|
6676
6680
|
*/
|
|
6677
|
-
|
|
6681
|
+
create_pur_invoice: boolean;
|
|
6678
6682
|
/**
|
|
6679
|
-
*
|
|
6683
|
+
* User can create a purchase credit note
|
|
6684
|
+
*/
|
|
6685
|
+
create_pur_credit_note: boolean;
|
|
6686
|
+
/**
|
|
6687
|
+
* User can create a fast purchase invoice
|
|
6680
6688
|
*/
|
|
6681
6689
|
create_fast: boolean;
|
|
6682
6690
|
/**
|
|
6683
|
-
*
|
|
6691
|
+
* User can import a purchase invoice
|
|
6684
6692
|
*/
|
|
6685
6693
|
import: boolean;
|
|
6686
6694
|
};
|
|
@@ -12336,7 +12344,8 @@ type Invoice = {
|
|
|
12336
12344
|
*/
|
|
12337
12345
|
date?: string;
|
|
12338
12346
|
/**
|
|
12339
|
-
*
|
|
12347
|
+
* Due date of the invoice.
|
|
12348
|
+
*
|
|
12340
12349
|
*/
|
|
12341
12350
|
due_date?: string;
|
|
12342
12351
|
/**
|
|
@@ -12711,7 +12720,8 @@ type InvoiceOne = {
|
|
|
12711
12720
|
*/
|
|
12712
12721
|
date?: string;
|
|
12713
12722
|
/**
|
|
12714
|
-
*
|
|
12723
|
+
* Due date of the invoice.
|
|
12724
|
+
*
|
|
12715
12725
|
*/
|
|
12716
12726
|
due_date?: string;
|
|
12717
12727
|
/**
|
|
@@ -13866,9 +13876,13 @@ type InvoiceCreate = {
|
|
|
13866
13876
|
*/
|
|
13867
13877
|
date?: string;
|
|
13868
13878
|
/**
|
|
13869
|
-
* Due date of the invoice
|
|
13879
|
+
* Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.
|
|
13880
|
+
*
|
|
13881
|
+
*
|
|
13882
|
+
* @deprecated
|
|
13870
13883
|
*/
|
|
13871
13884
|
due_date?: string;
|
|
13885
|
+
payment_terms?: _heyapi_684_;
|
|
13872
13886
|
/**
|
|
13873
13887
|
* Created date of invoice
|
|
13874
13888
|
*/
|
|
@@ -14041,7 +14055,7 @@ type InvoiceCreate = {
|
|
|
14041
14055
|
* Parent object id
|
|
14042
14056
|
*/
|
|
14043
14057
|
id?: number;
|
|
14044
|
-
} |
|
|
14058
|
+
} | _heyapi_685_ | null;
|
|
14045
14059
|
/**
|
|
14046
14060
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
14047
14061
|
*/
|
|
@@ -14111,10 +14125,6 @@ type DepositInvoiceCreate = {
|
|
|
14111
14125
|
* Date of the invoice
|
|
14112
14126
|
*/
|
|
14113
14127
|
date?: string;
|
|
14114
|
-
/**
|
|
14115
|
-
* Due date of the invoice
|
|
14116
|
-
*/
|
|
14117
|
-
due_date?: string;
|
|
14118
14128
|
/**
|
|
14119
14129
|
* Subject of the invoice
|
|
14120
14130
|
*/
|
|
@@ -14160,6 +14170,129 @@ type DepositInvoiceCreate = {
|
|
|
14160
14170
|
* Analytic code of document
|
|
14161
14171
|
*/
|
|
14162
14172
|
analytic_code?: string | null;
|
|
14173
|
+
/**
|
|
14174
|
+
* Payment terms of the invoice
|
|
14175
|
+
*
|
|
14176
|
+
*/
|
|
14177
|
+
payment_terms?: {
|
|
14178
|
+
/**
|
|
14179
|
+
* Payment terms id
|
|
14180
|
+
*/
|
|
14181
|
+
id: number;
|
|
14182
|
+
/**
|
|
14183
|
+
* Payment terms code
|
|
14184
|
+
*/
|
|
14185
|
+
code?: 'onorder';
|
|
14186
|
+
} | {
|
|
14187
|
+
/**
|
|
14188
|
+
* Payment terms id
|
|
14189
|
+
*/
|
|
14190
|
+
id: number;
|
|
14191
|
+
/**
|
|
14192
|
+
* Payment terms code
|
|
14193
|
+
*/
|
|
14194
|
+
code?: 'endmonth';
|
|
14195
|
+
} | {
|
|
14196
|
+
/**
|
|
14197
|
+
* Payment terms id
|
|
14198
|
+
*/
|
|
14199
|
+
id: number;
|
|
14200
|
+
/**
|
|
14201
|
+
* Payment terms code
|
|
14202
|
+
*/
|
|
14203
|
+
code?: 'received';
|
|
14204
|
+
} | {
|
|
14205
|
+
/**
|
|
14206
|
+
* Payment terms id
|
|
14207
|
+
*/
|
|
14208
|
+
id: number;
|
|
14209
|
+
/**
|
|
14210
|
+
* Payment terms code
|
|
14211
|
+
*/
|
|
14212
|
+
code?: 'oninvoice';
|
|
14213
|
+
} | {
|
|
14214
|
+
/**
|
|
14215
|
+
* Payment terms id
|
|
14216
|
+
*/
|
|
14217
|
+
id: number;
|
|
14218
|
+
/**
|
|
14219
|
+
* Payment terms code
|
|
14220
|
+
*/
|
|
14221
|
+
code?: 'nextmonth';
|
|
14222
|
+
} | {
|
|
14223
|
+
/**
|
|
14224
|
+
* Payment terms id
|
|
14225
|
+
*/
|
|
14226
|
+
id: number;
|
|
14227
|
+
/**
|
|
14228
|
+
* Is pay deadlines at end of the month
|
|
14229
|
+
*/
|
|
14230
|
+
end_of_month: boolean;
|
|
14231
|
+
/**
|
|
14232
|
+
* Payment terms code
|
|
14233
|
+
*/
|
|
14234
|
+
code?: '30days';
|
|
14235
|
+
} | {
|
|
14236
|
+
/**
|
|
14237
|
+
* Payment terms id
|
|
14238
|
+
*/
|
|
14239
|
+
id: number;
|
|
14240
|
+
/**
|
|
14241
|
+
* Is pay deadlines at end of the month
|
|
14242
|
+
*/
|
|
14243
|
+
end_of_month: boolean;
|
|
14244
|
+
/**
|
|
14245
|
+
* Payment terms code
|
|
14246
|
+
*/
|
|
14247
|
+
code?: '45days';
|
|
14248
|
+
} | {
|
|
14249
|
+
/**
|
|
14250
|
+
* Payment terms id
|
|
14251
|
+
*/
|
|
14252
|
+
id: number;
|
|
14253
|
+
/**
|
|
14254
|
+
* Is pay deadlines at end of the month
|
|
14255
|
+
*/
|
|
14256
|
+
end_of_month: boolean;
|
|
14257
|
+
/**
|
|
14258
|
+
* Payment terms code
|
|
14259
|
+
*/
|
|
14260
|
+
code?: '60days';
|
|
14261
|
+
} | {
|
|
14262
|
+
/**
|
|
14263
|
+
* Payment terms id
|
|
14264
|
+
*/
|
|
14265
|
+
id: number;
|
|
14266
|
+
/**
|
|
14267
|
+
* Number of days for pay deadlines
|
|
14268
|
+
*/
|
|
14269
|
+
x_days: number;
|
|
14270
|
+
code?: 'xdays';
|
|
14271
|
+
} | {
|
|
14272
|
+
/**
|
|
14273
|
+
* Payment terms id
|
|
14274
|
+
*/
|
|
14275
|
+
id: number;
|
|
14276
|
+
/**
|
|
14277
|
+
* Number of days for pay deadlines
|
|
14278
|
+
*/
|
|
14279
|
+
x_days: number;
|
|
14280
|
+
/**
|
|
14281
|
+
* Details of payment terms
|
|
14282
|
+
*/
|
|
14283
|
+
description: string;
|
|
14284
|
+
code?: 'scaled';
|
|
14285
|
+
} | {
|
|
14286
|
+
/**
|
|
14287
|
+
* Payment terms id
|
|
14288
|
+
*/
|
|
14289
|
+
id: number;
|
|
14290
|
+
/**
|
|
14291
|
+
* Due date of the payment term
|
|
14292
|
+
*/
|
|
14293
|
+
due_date: string;
|
|
14294
|
+
code?: 'custom';
|
|
14295
|
+
};
|
|
14163
14296
|
};
|
|
14164
14297
|
/**
|
|
14165
14298
|
* Invoice
|
|
@@ -14214,7 +14347,7 @@ type DepositInvoiceUpdate = {
|
|
|
14214
14347
|
* Currency code of the invoice
|
|
14215
14348
|
*/
|
|
14216
14349
|
currency?: string;
|
|
14217
|
-
related?:
|
|
14350
|
+
related?: _heyapi_688_;
|
|
14218
14351
|
/**
|
|
14219
14352
|
* Public link of the invoice
|
|
14220
14353
|
*/
|
|
@@ -14235,6 +14368,7 @@ type DepositInvoiceUpdate = {
|
|
|
14235
14368
|
* Analytic code of document
|
|
14236
14369
|
*/
|
|
14237
14370
|
analytic_code?: string | null;
|
|
14371
|
+
payment_terms?: _heyapi_689_;
|
|
14238
14372
|
};
|
|
14239
14373
|
/**
|
|
14240
14374
|
* Prepare Deposit Invoice
|
|
@@ -14317,8 +14451,8 @@ type DepositInvoicePrepareOutput = {
|
|
|
14317
14451
|
}>;
|
|
14318
14452
|
};
|
|
14319
14453
|
type DepositInvoiceOne = _heyapi_535_ & {
|
|
14320
|
-
rows?: Array<
|
|
14321
|
-
_embed?:
|
|
14454
|
+
rows?: Array<_heyapi_693_ | _heyapi_396_ | _heyapi_397_>;
|
|
14455
|
+
_embed?: _heyapi_694_;
|
|
14322
14456
|
};
|
|
14323
14457
|
/**
|
|
14324
14458
|
* Deposit Invoices filters
|
|
@@ -14326,7 +14460,7 @@ type DepositInvoiceOne = _heyapi_535_ & {
|
|
|
14326
14460
|
* Deposit Invoices filters
|
|
14327
14461
|
*/
|
|
14328
14462
|
type DepositInvoiceFilter = {
|
|
14329
|
-
filters:
|
|
14463
|
+
filters: _heyapi_696_;
|
|
14330
14464
|
};
|
|
14331
14465
|
/**
|
|
14332
14466
|
* Progress Invoice
|
|
@@ -14395,13 +14529,13 @@ type ProgressInvoiceCreate = {
|
|
|
14395
14529
|
* Bar code ID for progress-catalog row
|
|
14396
14530
|
*/
|
|
14397
14531
|
sku_id?: number | null;
|
|
14398
|
-
}) | (
|
|
14532
|
+
}) | (_heyapi_698_ & {
|
|
14399
14533
|
type?: 'progress-single';
|
|
14400
14534
|
/**
|
|
14401
14535
|
* Purchase amount
|
|
14402
14536
|
*/
|
|
14403
14537
|
purchase_amount?: string;
|
|
14404
|
-
}) | (
|
|
14538
|
+
}) | (_heyapi_698_ & {
|
|
14405
14539
|
type?: 'progress-shipping' | 'progress-packaging';
|
|
14406
14540
|
}) | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
14407
14541
|
/**
|
|
@@ -14662,7 +14796,7 @@ type ProgressInvoiceCreate = {
|
|
|
14662
14796
|
* Show progress invoice summary
|
|
14663
14797
|
*/
|
|
14664
14798
|
show_progress_invoice_summary?: boolean;
|
|
14665
|
-
} &
|
|
14799
|
+
} & _heyapi_699_;
|
|
14666
14800
|
} & _heyapi_442_;
|
|
14667
14801
|
/**
|
|
14668
14802
|
* Date of the shipping
|
|
@@ -14714,7 +14848,7 @@ type ProgressInvoiceCompute = {
|
|
|
14714
14848
|
* Rows of the progress invoice. There must be at least one progress row.
|
|
14715
14849
|
*
|
|
14716
14850
|
*/
|
|
14717
|
-
rows: Array<_heyapi_398_ |
|
|
14851
|
+
rows: Array<_heyapi_398_ | _heyapi_701_ | _heyapi_702_ | _heyapi_703_ | _heyapi_396_ | ({
|
|
14718
14852
|
/**
|
|
14719
14853
|
* ID of the progress invoice row
|
|
14720
14854
|
*/
|
|
@@ -14748,12 +14882,12 @@ type ProgressInvoiceCompute = {
|
|
|
14748
14882
|
* Bar code ID for progress-catalog row
|
|
14749
14883
|
*/
|
|
14750
14884
|
sku_id?: number | null;
|
|
14751
|
-
}) | (
|
|
14885
|
+
}) | (_heyapi_704_ & {
|
|
14752
14886
|
/**
|
|
14753
14887
|
* Purchase amount
|
|
14754
14888
|
*/
|
|
14755
14889
|
purchase_amount?: string;
|
|
14756
|
-
}) |
|
|
14890
|
+
}) | _heyapi_704_ | {
|
|
14757
14891
|
/**
|
|
14758
14892
|
* Row Identifier
|
|
14759
14893
|
*/
|
|
@@ -14977,11 +15111,11 @@ type ComputedProgresssInvoice = {
|
|
|
14977
15111
|
/**
|
|
14978
15112
|
* Credit notes linked to the invoice
|
|
14979
15113
|
*/
|
|
14980
|
-
credit_notes?: Array<
|
|
15114
|
+
credit_notes?: Array<_heyapi_706_>;
|
|
14981
15115
|
}>;
|
|
14982
15116
|
};
|
|
14983
|
-
type InvoiceUpdate =
|
|
14984
|
-
rows?: Array<
|
|
15117
|
+
type InvoiceUpdate = _heyapi_708_ & {
|
|
15118
|
+
rows?: Array<_heyapi_709_> | null;
|
|
14985
15119
|
settings?: _heyapi_442_;
|
|
14986
15120
|
};
|
|
14987
15121
|
type ValidateInvoice = {
|
|
@@ -15230,9 +15364,9 @@ type CreditNote = {
|
|
|
15230
15364
|
/**
|
|
15231
15365
|
* Credit Note Embed
|
|
15232
15366
|
*/
|
|
15233
|
-
_embed?:
|
|
15367
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
15234
15368
|
fiscal_year?: _heyapi_448_;
|
|
15235
|
-
currency?:
|
|
15369
|
+
currency?: _heyapi_713_;
|
|
15236
15370
|
owner?: _heyapi_408_;
|
|
15237
15371
|
/**
|
|
15238
15372
|
* Credit Note ACL
|
|
@@ -15493,10 +15627,10 @@ type CreditNoteOne = {
|
|
|
15493
15627
|
* Analytic code of document
|
|
15494
15628
|
*/
|
|
15495
15629
|
analytic_code?: string | null;
|
|
15496
|
-
_embed?:
|
|
15630
|
+
_embed?: _heyapi_715_;
|
|
15497
15631
|
} & {
|
|
15498
15632
|
rows?: Array<_heyapi_452_>;
|
|
15499
|
-
_embed?:
|
|
15633
|
+
_embed?: _heyapi_715_ & _heyapi_674_ & {
|
|
15500
15634
|
file?: _heyapi_595_;
|
|
15501
15635
|
};
|
|
15502
15636
|
};
|
|
@@ -15600,14 +15734,14 @@ type CreditNoteCreate = {
|
|
|
15600
15734
|
issuer_address_id?: number;
|
|
15601
15735
|
} & {
|
|
15602
15736
|
rows?: Array<_heyapi_452_> | null;
|
|
15603
|
-
parent?:
|
|
15737
|
+
parent?: _heyapi_685_ | null;
|
|
15604
15738
|
/**
|
|
15605
15739
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
15606
15740
|
*/
|
|
15607
15741
|
rate_category_id?: number;
|
|
15608
15742
|
};
|
|
15609
|
-
type CreditNoteUpdate =
|
|
15610
|
-
rows?: Array<
|
|
15743
|
+
type CreditNoteUpdate = _heyapi_718_ & {
|
|
15744
|
+
rows?: Array<_heyapi_709_> | null;
|
|
15611
15745
|
};
|
|
15612
15746
|
type CreditNoteValidate = {
|
|
15613
15747
|
/**
|
|
@@ -15892,15 +16026,15 @@ type OrderCreate = {
|
|
|
15892
16026
|
shipping_volume?: string;
|
|
15893
16027
|
} & {
|
|
15894
16028
|
rows?: Array<_heyapi_452_> | null;
|
|
15895
|
-
parent?:
|
|
16029
|
+
parent?: _heyapi_685_ | null;
|
|
15896
16030
|
/**
|
|
15897
16031
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
15898
16032
|
*/
|
|
15899
16033
|
rate_category_id?: number;
|
|
15900
16034
|
settings?: _heyapi_442_;
|
|
15901
16035
|
};
|
|
15902
|
-
type OrderUpdate =
|
|
15903
|
-
rows?: Array<
|
|
16036
|
+
type OrderUpdate = _heyapi_724_ & {
|
|
16037
|
+
rows?: Array<_heyapi_709_> | null;
|
|
15904
16038
|
settings?: _heyapi_442_;
|
|
15905
16039
|
};
|
|
15906
16040
|
/**
|
|
@@ -16108,7 +16242,7 @@ type Order = {
|
|
|
16108
16242
|
/**
|
|
16109
16243
|
* Order Embed
|
|
16110
16244
|
*/
|
|
16111
|
-
_embed?:
|
|
16245
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
16112
16246
|
/**
|
|
16113
16247
|
* Order ACL
|
|
16114
16248
|
*/
|
|
@@ -16124,7 +16258,7 @@ type Order = {
|
|
|
16124
16258
|
};
|
|
16125
16259
|
owner?: _heyapi_408_;
|
|
16126
16260
|
fiscal_year?: _heyapi_448_;
|
|
16127
|
-
currency?:
|
|
16261
|
+
currency?: _heyapi_713_;
|
|
16128
16262
|
/**
|
|
16129
16263
|
* Smart-tags linked
|
|
16130
16264
|
*/
|
|
@@ -16386,7 +16520,7 @@ type OrderOne = {
|
|
|
16386
16520
|
* Notes of the order
|
|
16387
16521
|
*/
|
|
16388
16522
|
note?: string;
|
|
16389
|
-
_embed?:
|
|
16523
|
+
_embed?: _heyapi_727_;
|
|
16390
16524
|
/**
|
|
16391
16525
|
* Date of the shipping
|
|
16392
16526
|
*/
|
|
@@ -16434,7 +16568,7 @@ type OrderOne = {
|
|
|
16434
16568
|
/**
|
|
16435
16569
|
* Order Embed
|
|
16436
16570
|
*/
|
|
16437
|
-
_embed?:
|
|
16571
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
16438
16572
|
/**
|
|
16439
16573
|
* Document Payment Terms
|
|
16440
16574
|
*
|
|
@@ -16475,7 +16609,7 @@ type OrderOne = {
|
|
|
16475
16609
|
};
|
|
16476
16610
|
owner?: _heyapi_408_;
|
|
16477
16611
|
fiscal_year?: _heyapi_448_;
|
|
16478
|
-
currency?:
|
|
16612
|
+
currency?: _heyapi_713_;
|
|
16479
16613
|
/**
|
|
16480
16614
|
* Smart-tags linked
|
|
16481
16615
|
*/
|
|
@@ -16863,7 +16997,7 @@ type Delivery = {
|
|
|
16863
16997
|
/**
|
|
16864
16998
|
* Delivery Embed
|
|
16865
16999
|
*/
|
|
16866
|
-
_embed?:
|
|
17000
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
16867
17001
|
/**
|
|
16868
17002
|
* Delivery ACL
|
|
16869
17003
|
*/
|
|
@@ -16879,7 +17013,7 @@ type Delivery = {
|
|
|
16879
17013
|
};
|
|
16880
17014
|
owner?: _heyapi_408_;
|
|
16881
17015
|
fiscal_year?: _heyapi_448_;
|
|
16882
|
-
currency?:
|
|
17016
|
+
currency?: _heyapi_713_;
|
|
16883
17017
|
/**
|
|
16884
17018
|
* Smart-tags linked
|
|
16885
17019
|
*/
|
|
@@ -17117,10 +17251,10 @@ type DeliveryOne = {
|
|
|
17117
17251
|
* Total volume of product to ship in m3
|
|
17118
17252
|
*/
|
|
17119
17253
|
shipping_volume?: string;
|
|
17120
|
-
_embed?:
|
|
17254
|
+
_embed?: _heyapi_732_;
|
|
17121
17255
|
} & {
|
|
17122
17256
|
rows?: Array<_heyapi_452_>;
|
|
17123
|
-
_embed?:
|
|
17257
|
+
_embed?: _heyapi_732_ & {
|
|
17124
17258
|
file?: _heyapi_595_;
|
|
17125
17259
|
};
|
|
17126
17260
|
};
|
|
@@ -17570,7 +17704,7 @@ type ImportPrepareInput = {
|
|
|
17570
17704
|
* List of identifiers
|
|
17571
17705
|
*/
|
|
17572
17706
|
service: ['id' | 'reference'];
|
|
17573
|
-
} |
|
|
17707
|
+
} | _heyapi_748_ | {
|
|
17574
17708
|
/**
|
|
17575
17709
|
* List of identifiers
|
|
17576
17710
|
*/
|
|
@@ -18167,7 +18301,7 @@ type ImportPrepareInput = {
|
|
|
18167
18301
|
/**
|
|
18168
18302
|
* Rate category ids and corresponding prices
|
|
18169
18303
|
*/
|
|
18170
|
-
prices?: Array<
|
|
18304
|
+
prices?: Array<_heyapi_749_>;
|
|
18171
18305
|
} | {
|
|
18172
18306
|
/**
|
|
18173
18307
|
* Row id
|
|
@@ -18248,11 +18382,11 @@ type ImportValidateInput = {
|
|
|
18248
18382
|
* Batch id
|
|
18249
18383
|
*/
|
|
18250
18384
|
batch_id: string;
|
|
18251
|
-
metadata:
|
|
18385
|
+
metadata: _heyapi_751_;
|
|
18252
18386
|
/**
|
|
18253
18387
|
* Rows to validate
|
|
18254
18388
|
*/
|
|
18255
|
-
data: Array<
|
|
18389
|
+
data: Array<_heyapi_752_ | _heyapi_753_ | _heyapi_754_ | _heyapi_755_ | _heyapi_756_ | _heyapi_757_ | _heyapi_758_>;
|
|
18256
18390
|
};
|
|
18257
18391
|
/**
|
|
18258
18392
|
* Import
|
|
@@ -18508,8 +18642,8 @@ type UpdateCompanyPreferences = {
|
|
|
18508
18642
|
value: 'id';
|
|
18509
18643
|
id: number;
|
|
18510
18644
|
};
|
|
18511
|
-
invoice?:
|
|
18512
|
-
proforma?:
|
|
18645
|
+
invoice?: _heyapi_762_ | _heyapi_763_ | _heyapi_764_;
|
|
18646
|
+
proforma?: _heyapi_762_ | _heyapi_763_ | _heyapi_764_;
|
|
18513
18647
|
};
|
|
18514
18648
|
/**
|
|
18515
18649
|
* Id of the rate category selected.
|
|
@@ -18538,7 +18672,7 @@ type IndividualPreferences = {
|
|
|
18538
18672
|
*/
|
|
18539
18673
|
label?: string;
|
|
18540
18674
|
} | null;
|
|
18541
|
-
tax?:
|
|
18675
|
+
tax?: _heyapi_766_;
|
|
18542
18676
|
/**
|
|
18543
18677
|
* Individual preferred pay date.
|
|
18544
18678
|
*/
|
|
@@ -18725,8 +18859,8 @@ type UpdateIndividualPreferences = {
|
|
|
18725
18859
|
value: 'id';
|
|
18726
18860
|
id: number;
|
|
18727
18861
|
};
|
|
18728
|
-
invoice?:
|
|
18729
|
-
proforma?:
|
|
18862
|
+
invoice?: _heyapi_768_ | _heyapi_769_ | _heyapi_770_;
|
|
18863
|
+
proforma?: _heyapi_768_ | _heyapi_769_ | _heyapi_770_;
|
|
18730
18864
|
};
|
|
18731
18865
|
/**
|
|
18732
18866
|
* Id of the rate category selected.
|
|
@@ -18994,8 +19128,8 @@ type SubscriptionCreate = {
|
|
|
18994
19128
|
* - An optional contact can be added, it must be linked to the provided company.
|
|
18995
19129
|
*
|
|
18996
19130
|
*/
|
|
18997
|
-
related: Array<
|
|
18998
|
-
sending:
|
|
19131
|
+
related: Array<_heyapi_774_>;
|
|
19132
|
+
sending: _heyapi_775_;
|
|
18999
19133
|
/**
|
|
19000
19134
|
* Source of payment preferences
|
|
19001
19135
|
*/
|
|
@@ -19013,7 +19147,7 @@ type SubscriptionCreate = {
|
|
|
19013
19147
|
/**
|
|
19014
19148
|
* Interval for subscription deadlines
|
|
19015
19149
|
*/
|
|
19016
|
-
interval:
|
|
19150
|
+
interval: _heyapi_776_ | _heyapi_777_ | _heyapi_778_;
|
|
19017
19151
|
};
|
|
19018
19152
|
/**
|
|
19019
19153
|
* Subscription payment installments to be generated
|
|
@@ -19171,9 +19305,9 @@ type ObjectiveCollectionOutput = {
|
|
|
19171
19305
|
* Objective name
|
|
19172
19306
|
*/
|
|
19173
19307
|
name: string;
|
|
19174
|
-
category:
|
|
19175
|
-
turnover:
|
|
19176
|
-
period:
|
|
19308
|
+
category: _heyapi_782_;
|
|
19309
|
+
turnover: _heyapi_783_;
|
|
19310
|
+
period: _heyapi_784_;
|
|
19177
19311
|
item: {
|
|
19178
19312
|
/**
|
|
19179
19313
|
* linked Item id
|
|
@@ -19184,16 +19318,16 @@ type ObjectiveCollectionOutput = {
|
|
|
19184
19318
|
*/
|
|
19185
19319
|
name: string;
|
|
19186
19320
|
} | null;
|
|
19187
|
-
item_category:
|
|
19321
|
+
item_category: _heyapi_785_;
|
|
19188
19322
|
/**
|
|
19189
19323
|
* Refinements of the objective
|
|
19190
19324
|
*/
|
|
19191
19325
|
refinements: Array<{
|
|
19192
|
-
period?:
|
|
19193
|
-
turnover?:
|
|
19326
|
+
period?: _heyapi_784_;
|
|
19327
|
+
turnover?: _heyapi_783_;
|
|
19194
19328
|
}>;
|
|
19195
|
-
assignee:
|
|
19196
|
-
links:
|
|
19329
|
+
assignee: _heyapi_786_;
|
|
19330
|
+
links: _heyapi_787_;
|
|
19197
19331
|
} & {
|
|
19198
19332
|
_embed?: {
|
|
19199
19333
|
created_by?: _heyapi_408_;
|
|
@@ -19214,8 +19348,8 @@ type ObjectiveTurnoverInput = {
|
|
|
19214
19348
|
* Code of an existing objective category
|
|
19215
19349
|
*/
|
|
19216
19350
|
category: 'turnover' | 'forecast_turnover';
|
|
19217
|
-
period:
|
|
19218
|
-
assignee:
|
|
19351
|
+
period: _heyapi_784_;
|
|
19352
|
+
assignee: _heyapi_789_;
|
|
19219
19353
|
} & unknown & {
|
|
19220
19354
|
/**
|
|
19221
19355
|
* Linked item id
|
|
@@ -19261,7 +19395,7 @@ type ObjectiveTurnoverInput = {
|
|
|
19261
19395
|
*/
|
|
19262
19396
|
date_end: string;
|
|
19263
19397
|
};
|
|
19264
|
-
turnover?:
|
|
19398
|
+
turnover?: _heyapi_790_;
|
|
19265
19399
|
}>;
|
|
19266
19400
|
};
|
|
19267
19401
|
/**
|
|
@@ -19331,8 +19465,8 @@ type ObjectiveOutput = {
|
|
|
19331
19465
|
* Turnover
|
|
19332
19466
|
*/
|
|
19333
19467
|
turnover: {
|
|
19334
|
-
expected:
|
|
19335
|
-
actual:
|
|
19468
|
+
expected: _heyapi_790_;
|
|
19469
|
+
actual: _heyapi_790_;
|
|
19336
19470
|
/**
|
|
19337
19471
|
* Progression of the objective
|
|
19338
19472
|
*/
|
|
@@ -19346,7 +19480,7 @@ type ObjectiveOutput = {
|
|
|
19346
19480
|
*/
|
|
19347
19481
|
days_left: number;
|
|
19348
19482
|
};
|
|
19349
|
-
period:
|
|
19483
|
+
period: _heyapi_784_;
|
|
19350
19484
|
item: {
|
|
19351
19485
|
/**
|
|
19352
19486
|
* linked Item id
|
|
@@ -19371,8 +19505,8 @@ type ObjectiveOutput = {
|
|
|
19371
19505
|
* Refinements of the objective
|
|
19372
19506
|
*/
|
|
19373
19507
|
refinements: Array<{
|
|
19374
|
-
period?:
|
|
19375
|
-
turnover?:
|
|
19508
|
+
period?: _heyapi_784_;
|
|
19509
|
+
turnover?: _heyapi_783_;
|
|
19376
19510
|
}>;
|
|
19377
19511
|
/**
|
|
19378
19512
|
* Assignee
|
|
@@ -19393,7 +19527,7 @@ type ObjectiveOutput = {
|
|
|
19393
19527
|
*/
|
|
19394
19528
|
name?: string;
|
|
19395
19529
|
};
|
|
19396
|
-
links:
|
|
19530
|
+
links: _heyapi_787_;
|
|
19397
19531
|
};
|
|
19398
19532
|
/**
|
|
19399
19533
|
* objective metadatas
|
|
@@ -19404,7 +19538,7 @@ type ObjectiveMetadata = {
|
|
|
19404
19538
|
*/
|
|
19405
19539
|
turnover?: {
|
|
19406
19540
|
data?: {
|
|
19407
|
-
category:
|
|
19541
|
+
category: _heyapi_782_;
|
|
19408
19542
|
currency: string;
|
|
19409
19543
|
assignees_types: Array<{
|
|
19410
19544
|
value: string;
|
|
@@ -19412,14 +19546,14 @@ type ObjectiveMetadata = {
|
|
|
19412
19546
|
order: number;
|
|
19413
19547
|
}>;
|
|
19414
19548
|
assignees: Array<{
|
|
19415
|
-
groups?: Array<
|
|
19416
|
-
staffs?: Array<
|
|
19549
|
+
groups?: Array<_heyapi_794_>;
|
|
19550
|
+
staffs?: Array<_heyapi_794_>;
|
|
19417
19551
|
}>;
|
|
19418
|
-
item_categories: Array<
|
|
19552
|
+
item_categories: Array<_heyapi_794_ & {
|
|
19419
19553
|
parent?: number | null;
|
|
19420
19554
|
logo?: string | null;
|
|
19421
19555
|
}>;
|
|
19422
|
-
durations: Array<
|
|
19556
|
+
durations: Array<_heyapi_794_ & {
|
|
19423
19557
|
period?: {
|
|
19424
19558
|
/**
|
|
19425
19559
|
* The start date
|
|
@@ -19448,20 +19582,20 @@ type ObjectiveMetadata = {
|
|
|
19448
19582
|
/**
|
|
19449
19583
|
* List of Assignees
|
|
19450
19584
|
*/
|
|
19451
|
-
assignee?: Array<
|
|
19585
|
+
assignee?: Array<_heyapi_795_>;
|
|
19452
19586
|
/**
|
|
19453
19587
|
* List of Categories
|
|
19454
19588
|
*/
|
|
19455
|
-
category?: Array<
|
|
19589
|
+
category?: Array<_heyapi_796_>;
|
|
19456
19590
|
};
|
|
19457
19591
|
metadata?: {
|
|
19458
19592
|
choose_product?: boolean;
|
|
19459
19593
|
create_new_staff?: boolean;
|
|
19460
19594
|
create_new_group?: boolean;
|
|
19461
19595
|
};
|
|
19462
|
-
_links?:
|
|
19596
|
+
_links?: _heyapi_787_;
|
|
19463
19597
|
};
|
|
19464
|
-
forecast_turnover?:
|
|
19598
|
+
forecast_turnover?: _heyapi_797_;
|
|
19465
19599
|
};
|
|
19466
19600
|
/**
|
|
19467
19601
|
* objective metadatas upsell
|
|
@@ -19472,7 +19606,7 @@ type ObjectiveMetadataUpsell = {
|
|
|
19472
19606
|
*/
|
|
19473
19607
|
turnover?: {
|
|
19474
19608
|
data?: {
|
|
19475
|
-
assignees_types: Array<
|
|
19609
|
+
assignees_types: Array<_heyapi_794_ & {
|
|
19476
19610
|
/**
|
|
19477
19611
|
* upsell
|
|
19478
19612
|
*/
|
|
@@ -19484,11 +19618,11 @@ type ObjectiveMetadataUpsell = {
|
|
|
19484
19618
|
};
|
|
19485
19619
|
metadata?: {
|
|
19486
19620
|
choose_product: {
|
|
19487
|
-
upsell:
|
|
19621
|
+
upsell: _heyapi_799_;
|
|
19488
19622
|
};
|
|
19489
19623
|
};
|
|
19490
19624
|
};
|
|
19491
|
-
forecast_turnover?:
|
|
19625
|
+
forecast_turnover?: _heyapi_800_;
|
|
19492
19626
|
};
|
|
19493
19627
|
type ObjectiveComputeTurnoverInput = {
|
|
19494
19628
|
/**
|
|
@@ -19498,7 +19632,7 @@ type ObjectiveComputeTurnoverInput = {
|
|
|
19498
19632
|
/**
|
|
19499
19633
|
* Period used to compute the turnover
|
|
19500
19634
|
*/
|
|
19501
|
-
period:
|
|
19635
|
+
period: _heyapi_784_;
|
|
19502
19636
|
/**
|
|
19503
19637
|
* linked item id used to compute the turnover
|
|
19504
19638
|
*/
|
|
@@ -19527,11 +19661,11 @@ type ObjectiveComputeTurnoverOutput = Array<{
|
|
|
19527
19661
|
/**
|
|
19528
19662
|
* Period used to compute the turnover
|
|
19529
19663
|
*/
|
|
19530
|
-
period:
|
|
19664
|
+
period: _heyapi_784_;
|
|
19531
19665
|
/**
|
|
19532
19666
|
* The computed turnover
|
|
19533
19667
|
*/
|
|
19534
|
-
turnover:
|
|
19668
|
+
turnover: _heyapi_790_;
|
|
19535
19669
|
}>;
|
|
19536
19670
|
/**
|
|
19537
19671
|
* ObjectiveTurnoverUpdateInput
|
|
@@ -19541,13 +19675,13 @@ type ObjectiveTurnoverUpdateInput = {
|
|
|
19541
19675
|
* Objective name
|
|
19542
19676
|
*/
|
|
19543
19677
|
name: string;
|
|
19544
|
-
turnover:
|
|
19678
|
+
turnover: _heyapi_790_;
|
|
19545
19679
|
/**
|
|
19546
19680
|
* Refinements of the objective
|
|
19547
19681
|
*/
|
|
19548
19682
|
refinements: Array<{
|
|
19549
|
-
period?:
|
|
19550
|
-
turnover?:
|
|
19683
|
+
period?: _heyapi_784_;
|
|
19684
|
+
turnover?: _heyapi_790_;
|
|
19551
19685
|
}>;
|
|
19552
19686
|
};
|
|
19553
19687
|
/**
|
|
@@ -19781,16 +19915,16 @@ type MarketingAttributeDiffOutput = {
|
|
|
19781
19915
|
/**
|
|
19782
19916
|
* List of new Marketing Attributes to create
|
|
19783
19917
|
*/
|
|
19784
|
-
create: Array<
|
|
19918
|
+
create: Array<_heyapi_811_>;
|
|
19785
19919
|
/**
|
|
19786
19920
|
* List of previous Marketing Attributes to delete
|
|
19787
19921
|
*/
|
|
19788
|
-
delete: Array<
|
|
19922
|
+
delete: Array<_heyapi_811_>;
|
|
19789
19923
|
/**
|
|
19790
19924
|
* List of Marketing Attributes unchanged
|
|
19791
19925
|
*/
|
|
19792
|
-
void: Array<
|
|
19793
|
-
links:
|
|
19926
|
+
void: Array<_heyapi_811_>;
|
|
19927
|
+
links: _heyapi_812_;
|
|
19794
19928
|
};
|
|
19795
19929
|
/**
|
|
19796
19930
|
* Discount including taxes
|
|
@@ -19834,7 +19968,7 @@ type ConsentSettingsOuput = {
|
|
|
19834
19968
|
href: string;
|
|
19835
19969
|
}>;
|
|
19836
19970
|
};
|
|
19837
|
-
type ConsentSettingsInput =
|
|
19971
|
+
type ConsentSettingsInput = _heyapi_816_;
|
|
19838
19972
|
/**
|
|
19839
19973
|
* The marketing consent settings
|
|
19840
19974
|
*/
|
|
@@ -19862,9 +19996,9 @@ type ProgressInvoiceMetadata = {
|
|
|
19862
19996
|
* Progress invoice mode
|
|
19863
19997
|
*/
|
|
19864
19998
|
progress_invoice_mode?: 'global' | 'per-line';
|
|
19865
|
-
}) | (
|
|
19999
|
+
}) | (_heyapi_819_ & {
|
|
19866
20000
|
rows?: Array<_heyapi_452_>;
|
|
19867
|
-
_embed?:
|
|
20001
|
+
_embed?: _heyapi_820_;
|
|
19868
20002
|
} & {
|
|
19869
20003
|
/**
|
|
19870
20004
|
* Rate category with taxes included
|
|
@@ -19879,12 +20013,12 @@ type ProgressInvoiceMetadata = {
|
|
|
19879
20013
|
* Invoice related to the progress invoice, exist only if invoice type is used
|
|
19880
20014
|
*/
|
|
19881
20015
|
invoice?: (_heyapi_535_ & {
|
|
19882
|
-
rows?: Array<
|
|
20016
|
+
rows?: Array<_heyapi_821_ | _heyapi_822_ | _heyapi_823_ | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
19883
20017
|
/**
|
|
19884
20018
|
* The next available progress invoice number
|
|
19885
20019
|
*/
|
|
19886
20020
|
next_progress_invoice_number?: number | null;
|
|
19887
|
-
_embed?:
|
|
20021
|
+
_embed?: _heyapi_824_;
|
|
19888
20022
|
} & {
|
|
19889
20023
|
/**
|
|
19890
20024
|
* Rate category with taxes included
|
|
@@ -20097,11 +20231,11 @@ type ProgressInvoiceMetadata = {
|
|
|
20097
20231
|
/**
|
|
20098
20232
|
* List of document layouts
|
|
20099
20233
|
*/
|
|
20100
|
-
document_layouts?: Array<
|
|
20234
|
+
document_layouts?: Array<_heyapi_825_>;
|
|
20101
20235
|
/**
|
|
20102
20236
|
* List of languages
|
|
20103
20237
|
*/
|
|
20104
|
-
languages?: Array<
|
|
20238
|
+
languages?: Array<_heyapi_826_>;
|
|
20105
20239
|
/**
|
|
20106
20240
|
* Tax with embed
|
|
20107
20241
|
*
|
|
@@ -20314,7 +20448,7 @@ type ProgressInvoiceMetadata = {
|
|
|
20314
20448
|
/**
|
|
20315
20449
|
* Payment term translations
|
|
20316
20450
|
*/
|
|
20317
|
-
translations?: Array<
|
|
20451
|
+
translations?: Array<_heyapi_827_>;
|
|
20318
20452
|
};
|
|
20319
20453
|
}>;
|
|
20320
20454
|
/**
|
|
@@ -20337,7 +20471,7 @@ type ProgressInvoiceMetadata = {
|
|
|
20337
20471
|
/**
|
|
20338
20472
|
* Assigned staff translations
|
|
20339
20473
|
*/
|
|
20340
|
-
translations?: Array<
|
|
20474
|
+
translations?: Array<_heyapi_828_>;
|
|
20341
20475
|
};
|
|
20342
20476
|
}>;
|
|
20343
20477
|
/**
|
|
@@ -20512,11 +20646,11 @@ type ProgressInvoiceMetadata = {
|
|
|
20512
20646
|
/**
|
|
20513
20647
|
* Summary of all document history (includes current document)
|
|
20514
20648
|
*/
|
|
20515
|
-
summary?: Array<
|
|
20649
|
+
summary?: Array<_heyapi_706_ & {
|
|
20516
20650
|
/**
|
|
20517
20651
|
* Credit notes linked to the invoice
|
|
20518
20652
|
*/
|
|
20519
|
-
credit_notes?: Array<
|
|
20653
|
+
credit_notes?: Array<_heyapi_706_>;
|
|
20520
20654
|
}>;
|
|
20521
20655
|
};
|
|
20522
20656
|
/**
|
|
@@ -20562,7 +20696,7 @@ type ProgressInvoiceMetadata = {
|
|
|
20562
20696
|
* Update Progress Invoice
|
|
20563
20697
|
*/
|
|
20564
20698
|
type ProgressInvoiceUpdate = {
|
|
20565
|
-
rows?: Array<
|
|
20699
|
+
rows?: Array<_heyapi_701_ | _heyapi_702_ | _heyapi_703_ | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_ | _heyapi_830_ | _heyapi_831_ | _heyapi_704_ | _heyapi_437_ | _heyapi_438_ | _heyapi_439_ | {
|
|
20566
20700
|
/**
|
|
20567
20701
|
* Row Identifier
|
|
20568
20702
|
*/
|
|
@@ -20690,8 +20824,8 @@ type ProgressInvoiceUpdate = {
|
|
|
20690
20824
|
*/
|
|
20691
20825
|
shipping_volume?: string;
|
|
20692
20826
|
shipping_weight?: _heyapi_433_;
|
|
20693
|
-
payment_terms?:
|
|
20694
|
-
settings?:
|
|
20827
|
+
payment_terms?: _heyapi_684_;
|
|
20828
|
+
settings?: _heyapi_832_;
|
|
20695
20829
|
/**
|
|
20696
20830
|
* Analytic code of document
|
|
20697
20831
|
*/
|
|
@@ -20861,7 +20995,7 @@ type ProposalModel = {
|
|
|
20861
20995
|
/**
|
|
20862
20996
|
* Proposal document
|
|
20863
20997
|
*/
|
|
20864
|
-
type ProposalDocument =
|
|
20998
|
+
type ProposalDocument = _heyapi_839_ & {
|
|
20865
20999
|
/**
|
|
20866
21000
|
* Proposal document link
|
|
20867
21001
|
*/
|
|
@@ -24629,6 +24763,10 @@ type DealsWritable = {
|
|
|
24629
24763
|
* Priority level of the calendar event
|
|
24630
24764
|
*/
|
|
24631
24765
|
priority?: number;
|
|
24766
|
+
/**
|
|
24767
|
+
* Meet link for the calendar event
|
|
24768
|
+
*/
|
|
24769
|
+
meet_link?: string | null;
|
|
24632
24770
|
} | (_heyapi_480_ & {
|
|
24633
24771
|
/**
|
|
24634
24772
|
* Short description
|
|
@@ -26769,7 +26907,8 @@ type InvoiceWritable = {
|
|
|
26769
26907
|
*/
|
|
26770
26908
|
date?: string;
|
|
26771
26909
|
/**
|
|
26772
|
-
*
|
|
26910
|
+
* Due date of the invoice.
|
|
26911
|
+
*
|
|
26773
26912
|
*/
|
|
26774
26913
|
due_date?: string;
|
|
26775
26914
|
/**
|
|
@@ -27020,7 +27159,8 @@ type InvoiceOneWritable = {
|
|
|
27020
27159
|
*/
|
|
27021
27160
|
date?: string;
|
|
27022
27161
|
/**
|
|
27023
|
-
*
|
|
27162
|
+
* Due date of the invoice.
|
|
27163
|
+
*
|
|
27024
27164
|
*/
|
|
27025
27165
|
due_date?: string;
|
|
27026
27166
|
/**
|
|
@@ -27770,9 +27910,13 @@ type InvoiceCreateWritable = {
|
|
|
27770
27910
|
*/
|
|
27771
27911
|
date?: string;
|
|
27772
27912
|
/**
|
|
27773
|
-
* Due date of the invoice
|
|
27913
|
+
* Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.
|
|
27914
|
+
*
|
|
27915
|
+
*
|
|
27916
|
+
* @deprecated
|
|
27774
27917
|
*/
|
|
27775
27918
|
due_date?: string;
|
|
27919
|
+
payment_terms?: _heyapi_684_;
|
|
27776
27920
|
/**
|
|
27777
27921
|
* Created date of invoice
|
|
27778
27922
|
*/
|
|
@@ -27945,7 +28089,7 @@ type InvoiceCreateWritable = {
|
|
|
27945
28089
|
* Parent object id
|
|
27946
28090
|
*/
|
|
27947
28091
|
id?: number;
|
|
27948
|
-
} |
|
|
28092
|
+
} | _heyapi_685_ | null;
|
|
27949
28093
|
/**
|
|
27950
28094
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
27951
28095
|
*/
|
|
@@ -28015,10 +28159,6 @@ type DepositInvoiceCreateWritable = {
|
|
|
28015
28159
|
* Date of the invoice
|
|
28016
28160
|
*/
|
|
28017
28161
|
date?: string;
|
|
28018
|
-
/**
|
|
28019
|
-
* Due date of the invoice
|
|
28020
|
-
*/
|
|
28021
|
-
due_date?: string;
|
|
28022
28162
|
/**
|
|
28023
28163
|
* Subject of the invoice
|
|
28024
28164
|
*/
|
|
@@ -28064,6 +28204,129 @@ type DepositInvoiceCreateWritable = {
|
|
|
28064
28204
|
* Analytic code of document
|
|
28065
28205
|
*/
|
|
28066
28206
|
analytic_code?: string | null;
|
|
28207
|
+
/**
|
|
28208
|
+
* Payment terms of the invoice
|
|
28209
|
+
*
|
|
28210
|
+
*/
|
|
28211
|
+
payment_terms?: {
|
|
28212
|
+
/**
|
|
28213
|
+
* Payment terms id
|
|
28214
|
+
*/
|
|
28215
|
+
id: number;
|
|
28216
|
+
/**
|
|
28217
|
+
* Payment terms code
|
|
28218
|
+
*/
|
|
28219
|
+
code?: 'onorder';
|
|
28220
|
+
} | {
|
|
28221
|
+
/**
|
|
28222
|
+
* Payment terms id
|
|
28223
|
+
*/
|
|
28224
|
+
id: number;
|
|
28225
|
+
/**
|
|
28226
|
+
* Payment terms code
|
|
28227
|
+
*/
|
|
28228
|
+
code?: 'endmonth';
|
|
28229
|
+
} | {
|
|
28230
|
+
/**
|
|
28231
|
+
* Payment terms id
|
|
28232
|
+
*/
|
|
28233
|
+
id: number;
|
|
28234
|
+
/**
|
|
28235
|
+
* Payment terms code
|
|
28236
|
+
*/
|
|
28237
|
+
code?: 'received';
|
|
28238
|
+
} | {
|
|
28239
|
+
/**
|
|
28240
|
+
* Payment terms id
|
|
28241
|
+
*/
|
|
28242
|
+
id: number;
|
|
28243
|
+
/**
|
|
28244
|
+
* Payment terms code
|
|
28245
|
+
*/
|
|
28246
|
+
code?: 'oninvoice';
|
|
28247
|
+
} | {
|
|
28248
|
+
/**
|
|
28249
|
+
* Payment terms id
|
|
28250
|
+
*/
|
|
28251
|
+
id: number;
|
|
28252
|
+
/**
|
|
28253
|
+
* Payment terms code
|
|
28254
|
+
*/
|
|
28255
|
+
code?: 'nextmonth';
|
|
28256
|
+
} | {
|
|
28257
|
+
/**
|
|
28258
|
+
* Payment terms id
|
|
28259
|
+
*/
|
|
28260
|
+
id: number;
|
|
28261
|
+
/**
|
|
28262
|
+
* Is pay deadlines at end of the month
|
|
28263
|
+
*/
|
|
28264
|
+
end_of_month: boolean;
|
|
28265
|
+
/**
|
|
28266
|
+
* Payment terms code
|
|
28267
|
+
*/
|
|
28268
|
+
code?: '30days';
|
|
28269
|
+
} | {
|
|
28270
|
+
/**
|
|
28271
|
+
* Payment terms id
|
|
28272
|
+
*/
|
|
28273
|
+
id: number;
|
|
28274
|
+
/**
|
|
28275
|
+
* Is pay deadlines at end of the month
|
|
28276
|
+
*/
|
|
28277
|
+
end_of_month: boolean;
|
|
28278
|
+
/**
|
|
28279
|
+
* Payment terms code
|
|
28280
|
+
*/
|
|
28281
|
+
code?: '45days';
|
|
28282
|
+
} | {
|
|
28283
|
+
/**
|
|
28284
|
+
* Payment terms id
|
|
28285
|
+
*/
|
|
28286
|
+
id: number;
|
|
28287
|
+
/**
|
|
28288
|
+
* Is pay deadlines at end of the month
|
|
28289
|
+
*/
|
|
28290
|
+
end_of_month: boolean;
|
|
28291
|
+
/**
|
|
28292
|
+
* Payment terms code
|
|
28293
|
+
*/
|
|
28294
|
+
code?: '60days';
|
|
28295
|
+
} | {
|
|
28296
|
+
/**
|
|
28297
|
+
* Payment terms id
|
|
28298
|
+
*/
|
|
28299
|
+
id: number;
|
|
28300
|
+
/**
|
|
28301
|
+
* Number of days for pay deadlines
|
|
28302
|
+
*/
|
|
28303
|
+
x_days: number;
|
|
28304
|
+
code?: 'xdays';
|
|
28305
|
+
} | {
|
|
28306
|
+
/**
|
|
28307
|
+
* Payment terms id
|
|
28308
|
+
*/
|
|
28309
|
+
id: number;
|
|
28310
|
+
/**
|
|
28311
|
+
* Number of days for pay deadlines
|
|
28312
|
+
*/
|
|
28313
|
+
x_days: number;
|
|
28314
|
+
/**
|
|
28315
|
+
* Details of payment terms
|
|
28316
|
+
*/
|
|
28317
|
+
description: string;
|
|
28318
|
+
code?: 'scaled';
|
|
28319
|
+
} | {
|
|
28320
|
+
/**
|
|
28321
|
+
* Payment terms id
|
|
28322
|
+
*/
|
|
28323
|
+
id: number;
|
|
28324
|
+
/**
|
|
28325
|
+
* Due date of the payment term
|
|
28326
|
+
*/
|
|
28327
|
+
due_date: string;
|
|
28328
|
+
code?: 'custom';
|
|
28329
|
+
};
|
|
28067
28330
|
};
|
|
28068
28331
|
/**
|
|
28069
28332
|
* Invoice
|
|
@@ -28118,7 +28381,7 @@ type DepositInvoiceUpdateWritable = {
|
|
|
28118
28381
|
* Currency code of the invoice
|
|
28119
28382
|
*/
|
|
28120
28383
|
currency?: string;
|
|
28121
|
-
related?:
|
|
28384
|
+
related?: _heyapi_688_;
|
|
28122
28385
|
/**
|
|
28123
28386
|
* Public link of the invoice
|
|
28124
28387
|
*/
|
|
@@ -28139,10 +28402,11 @@ type DepositInvoiceUpdateWritable = {
|
|
|
28139
28402
|
* Analytic code of document
|
|
28140
28403
|
*/
|
|
28141
28404
|
analytic_code?: string | null;
|
|
28405
|
+
payment_terms?: _heyapi_689_;
|
|
28142
28406
|
};
|
|
28143
28407
|
type DepositInvoiceOneWritable = _heyapi_535_ & {
|
|
28144
|
-
rows?: Array<
|
|
28145
|
-
_embed?:
|
|
28408
|
+
rows?: Array<_heyapi_693_ | _heyapi_396_ | _heyapi_397_>;
|
|
28409
|
+
_embed?: _heyapi_694_;
|
|
28146
28410
|
};
|
|
28147
28411
|
/**
|
|
28148
28412
|
* Progress Invoice
|
|
@@ -28211,13 +28475,13 @@ type ProgressInvoiceCreateWritable = {
|
|
|
28211
28475
|
* Bar code ID for progress-catalog row
|
|
28212
28476
|
*/
|
|
28213
28477
|
sku_id?: number | null;
|
|
28214
|
-
}) | (
|
|
28478
|
+
}) | (_heyapi_698_ & {
|
|
28215
28479
|
type?: 'progress-single';
|
|
28216
28480
|
/**
|
|
28217
28481
|
* Purchase amount
|
|
28218
28482
|
*/
|
|
28219
28483
|
purchase_amount?: string;
|
|
28220
|
-
}) | (
|
|
28484
|
+
}) | (_heyapi_698_ & {
|
|
28221
28485
|
type?: 'progress-shipping' | 'progress-packaging';
|
|
28222
28486
|
}) | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
28223
28487
|
/**
|
|
@@ -28478,7 +28742,7 @@ type ProgressInvoiceCreateWritable = {
|
|
|
28478
28742
|
* Show progress invoice summary
|
|
28479
28743
|
*/
|
|
28480
28744
|
show_progress_invoice_summary?: boolean;
|
|
28481
|
-
} &
|
|
28745
|
+
} & _heyapi_699_;
|
|
28482
28746
|
} & _heyapi_442_;
|
|
28483
28747
|
/**
|
|
28484
28748
|
* Date of the shipping
|
|
@@ -28530,7 +28794,7 @@ type ProgressInvoiceComputeWritable = {
|
|
|
28530
28794
|
* Rows of the progress invoice. There must be at least one progress row.
|
|
28531
28795
|
*
|
|
28532
28796
|
*/
|
|
28533
|
-
rows: Array<_heyapi_398_ |
|
|
28797
|
+
rows: Array<_heyapi_398_ | _heyapi_701_ | _heyapi_702_ | _heyapi_703_ | _heyapi_396_ | ({
|
|
28534
28798
|
/**
|
|
28535
28799
|
* ID of the progress invoice row
|
|
28536
28800
|
*/
|
|
@@ -28564,20 +28828,20 @@ type ProgressInvoiceComputeWritable = {
|
|
|
28564
28828
|
* Bar code ID for progress-catalog row
|
|
28565
28829
|
*/
|
|
28566
28830
|
sku_id?: number | null;
|
|
28567
|
-
}) | (
|
|
28831
|
+
}) | (_heyapi_704_ & {
|
|
28568
28832
|
/**
|
|
28569
28833
|
* Purchase amount
|
|
28570
28834
|
*/
|
|
28571
28835
|
purchase_amount?: string;
|
|
28572
|
-
}) |
|
|
28836
|
+
}) | _heyapi_704_ | {
|
|
28573
28837
|
/**
|
|
28574
28838
|
* Row Identifier
|
|
28575
28839
|
*/
|
|
28576
28840
|
id: number;
|
|
28577
28841
|
}>;
|
|
28578
28842
|
};
|
|
28579
|
-
type InvoiceUpdateWritable =
|
|
28580
|
-
rows?: Array<
|
|
28843
|
+
type InvoiceUpdateWritable = _heyapi_708_ & {
|
|
28844
|
+
rows?: Array<_heyapi_709_> | null;
|
|
28581
28845
|
settings?: _heyapi_442_;
|
|
28582
28846
|
};
|
|
28583
28847
|
/**
|
|
@@ -28772,9 +29036,9 @@ type CreditNoteWritable = {
|
|
|
28772
29036
|
/**
|
|
28773
29037
|
* Credit Note Embed
|
|
28774
29038
|
*/
|
|
28775
|
-
_embed?:
|
|
29039
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
28776
29040
|
fiscal_year?: _heyapi_448_;
|
|
28777
|
-
currency?:
|
|
29041
|
+
currency?: _heyapi_713_;
|
|
28778
29042
|
owner?: _heyapi_408_;
|
|
28779
29043
|
/**
|
|
28780
29044
|
* Credit Note ACL
|
|
@@ -28988,10 +29252,10 @@ type CreditNoteOneWritable = {
|
|
|
28988
29252
|
* Analytic code of document
|
|
28989
29253
|
*/
|
|
28990
29254
|
analytic_code?: string | null;
|
|
28991
|
-
_embed?:
|
|
29255
|
+
_embed?: _heyapi_715_;
|
|
28992
29256
|
} & {
|
|
28993
29257
|
rows?: Array<_heyapi_452_>;
|
|
28994
|
-
_embed?:
|
|
29258
|
+
_embed?: _heyapi_715_ & _heyapi_674_ & {
|
|
28995
29259
|
file?: _heyapi_595_;
|
|
28996
29260
|
};
|
|
28997
29261
|
};
|
|
@@ -29095,14 +29359,14 @@ type CreditNoteCreateWritable = {
|
|
|
29095
29359
|
issuer_address_id?: number;
|
|
29096
29360
|
} & {
|
|
29097
29361
|
rows?: Array<_heyapi_452_> | null;
|
|
29098
|
-
parent?:
|
|
29362
|
+
parent?: _heyapi_685_ | null;
|
|
29099
29363
|
/**
|
|
29100
29364
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
29101
29365
|
*/
|
|
29102
29366
|
rate_category_id?: number;
|
|
29103
29367
|
};
|
|
29104
|
-
type CreditNoteUpdateWritable =
|
|
29105
|
-
rows?: Array<
|
|
29368
|
+
type CreditNoteUpdateWritable = _heyapi_718_ & {
|
|
29369
|
+
rows?: Array<_heyapi_709_> | null;
|
|
29106
29370
|
};
|
|
29107
29371
|
/**
|
|
29108
29372
|
* Credit Note
|
|
@@ -29347,15 +29611,15 @@ type OrderCreateWritable = {
|
|
|
29347
29611
|
shipping_volume?: string;
|
|
29348
29612
|
} & {
|
|
29349
29613
|
rows?: Array<_heyapi_452_> | null;
|
|
29350
|
-
parent?:
|
|
29614
|
+
parent?: _heyapi_685_ | null;
|
|
29351
29615
|
/**
|
|
29352
29616
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
29353
29617
|
*/
|
|
29354
29618
|
rate_category_id?: number;
|
|
29355
29619
|
settings?: _heyapi_442_;
|
|
29356
29620
|
};
|
|
29357
|
-
type OrderUpdateWritable =
|
|
29358
|
-
rows?: Array<
|
|
29621
|
+
type OrderUpdateWritable = _heyapi_724_ & {
|
|
29622
|
+
rows?: Array<_heyapi_709_> | null;
|
|
29359
29623
|
settings?: _heyapi_442_;
|
|
29360
29624
|
};
|
|
29361
29625
|
/**
|
|
@@ -29463,7 +29727,7 @@ type OrderWritable = {
|
|
|
29463
29727
|
/**
|
|
29464
29728
|
* Order Embed
|
|
29465
29729
|
*/
|
|
29466
|
-
_embed?:
|
|
29730
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
29467
29731
|
/**
|
|
29468
29732
|
* Order ACL
|
|
29469
29733
|
*/
|
|
@@ -29479,7 +29743,7 @@ type OrderWritable = {
|
|
|
29479
29743
|
};
|
|
29480
29744
|
owner?: _heyapi_408_;
|
|
29481
29745
|
fiscal_year?: _heyapi_448_;
|
|
29482
|
-
currency?:
|
|
29746
|
+
currency?: _heyapi_713_;
|
|
29483
29747
|
/**
|
|
29484
29748
|
* Smart-tags linked
|
|
29485
29749
|
*/
|
|
@@ -29633,7 +29897,7 @@ type OrderOneWritable = {
|
|
|
29633
29897
|
* Notes of the order
|
|
29634
29898
|
*/
|
|
29635
29899
|
note?: string;
|
|
29636
|
-
_embed?:
|
|
29900
|
+
_embed?: _heyapi_727_;
|
|
29637
29901
|
/**
|
|
29638
29902
|
* Date of the shipping
|
|
29639
29903
|
*/
|
|
@@ -29673,7 +29937,7 @@ type OrderOneWritable = {
|
|
|
29673
29937
|
/**
|
|
29674
29938
|
* Order Embed
|
|
29675
29939
|
*/
|
|
29676
|
-
_embed?:
|
|
29940
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
29677
29941
|
/**
|
|
29678
29942
|
* Document Payment Terms
|
|
29679
29943
|
*
|
|
@@ -29714,7 +29978,7 @@ type OrderOneWritable = {
|
|
|
29714
29978
|
};
|
|
29715
29979
|
owner?: _heyapi_408_;
|
|
29716
29980
|
fiscal_year?: _heyapi_448_;
|
|
29717
|
-
currency?:
|
|
29981
|
+
currency?: _heyapi_713_;
|
|
29718
29982
|
/**
|
|
29719
29983
|
* Smart-tags linked
|
|
29720
29984
|
*/
|
|
@@ -29921,7 +30185,7 @@ type DeliveryWritable = {
|
|
|
29921
30185
|
/**
|
|
29922
30186
|
* Delivery Embed
|
|
29923
30187
|
*/
|
|
29924
|
-
_embed?:
|
|
30188
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
29925
30189
|
/**
|
|
29926
30190
|
* Delivery ACL
|
|
29927
30191
|
*/
|
|
@@ -29937,7 +30201,7 @@ type DeliveryWritable = {
|
|
|
29937
30201
|
};
|
|
29938
30202
|
owner?: _heyapi_408_;
|
|
29939
30203
|
fiscal_year?: _heyapi_448_;
|
|
29940
|
-
currency?:
|
|
30204
|
+
currency?: _heyapi_713_;
|
|
29941
30205
|
/**
|
|
29942
30206
|
* Smart-tags linked
|
|
29943
30207
|
*/
|
|
@@ -30072,7 +30336,7 @@ type DeliveryOneWritable = {
|
|
|
30072
30336
|
* Total volume of product to ship in m3
|
|
30073
30337
|
*/
|
|
30074
30338
|
shipping_volume?: string;
|
|
30075
|
-
_embed?:
|
|
30339
|
+
_embed?: _heyapi_732_;
|
|
30076
30340
|
} & {
|
|
30077
30341
|
rows?: Array<_heyapi_452_>;
|
|
30078
30342
|
};
|
|
@@ -30347,7 +30611,7 @@ type IndividualPreferencesWritable = {
|
|
|
30347
30611
|
*/
|
|
30348
30612
|
label?: string;
|
|
30349
30613
|
} | null;
|
|
30350
|
-
tax?:
|
|
30614
|
+
tax?: _heyapi_766_;
|
|
30351
30615
|
/**
|
|
30352
30616
|
* Individual preferred pay date.
|
|
30353
30617
|
*/
|
|
@@ -30488,9 +30752,9 @@ type ObjectiveCollectionOutputWritable = {
|
|
|
30488
30752
|
* Objective name
|
|
30489
30753
|
*/
|
|
30490
30754
|
name: string;
|
|
30491
|
-
category:
|
|
30492
|
-
turnover:
|
|
30493
|
-
period:
|
|
30755
|
+
category: _heyapi_782_;
|
|
30756
|
+
turnover: _heyapi_783_;
|
|
30757
|
+
period: _heyapi_784_;
|
|
30494
30758
|
item: {
|
|
30495
30759
|
/**
|
|
30496
30760
|
* linked Item id
|
|
@@ -30501,16 +30765,16 @@ type ObjectiveCollectionOutputWritable = {
|
|
|
30501
30765
|
*/
|
|
30502
30766
|
name: string;
|
|
30503
30767
|
} | null;
|
|
30504
|
-
item_category:
|
|
30768
|
+
item_category: _heyapi_785_;
|
|
30505
30769
|
/**
|
|
30506
30770
|
* Refinements of the objective
|
|
30507
30771
|
*/
|
|
30508
30772
|
refinements: Array<{
|
|
30509
|
-
period?:
|
|
30510
|
-
turnover?:
|
|
30773
|
+
period?: _heyapi_784_;
|
|
30774
|
+
turnover?: _heyapi_783_;
|
|
30511
30775
|
}>;
|
|
30512
|
-
assignee:
|
|
30513
|
-
links:
|
|
30776
|
+
assignee: _heyapi_786_;
|
|
30777
|
+
links: _heyapi_787_;
|
|
30514
30778
|
} & {
|
|
30515
30779
|
_embed?: {
|
|
30516
30780
|
created_by?: _heyapi_408_;
|
|
@@ -30567,7 +30831,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30567
30831
|
* Progress invoice mode
|
|
30568
30832
|
*/
|
|
30569
30833
|
progress_invoice_mode?: 'global' | 'per-line';
|
|
30570
|
-
}) | (
|
|
30834
|
+
}) | (_heyapi_819_ & {
|
|
30571
30835
|
rows?: Array<_heyapi_452_>;
|
|
30572
30836
|
} & {
|
|
30573
30837
|
/**
|
|
@@ -30583,7 +30847,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30583
30847
|
* Invoice related to the progress invoice, exist only if invoice type is used
|
|
30584
30848
|
*/
|
|
30585
30849
|
invoice?: (_heyapi_535_ & {
|
|
30586
|
-
rows?: Array<
|
|
30850
|
+
rows?: Array<_heyapi_821_ | _heyapi_822_ | _heyapi_823_ | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
30587
30851
|
/**
|
|
30588
30852
|
* The next available progress invoice number
|
|
30589
30853
|
*/
|
|
@@ -30796,11 +31060,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30796
31060
|
/**
|
|
30797
31061
|
* List of document layouts
|
|
30798
31062
|
*/
|
|
30799
|
-
document_layouts?: Array<
|
|
31063
|
+
document_layouts?: Array<_heyapi_825_>;
|
|
30800
31064
|
/**
|
|
30801
31065
|
* List of languages
|
|
30802
31066
|
*/
|
|
30803
|
-
languages?: Array<
|
|
31067
|
+
languages?: Array<_heyapi_826_>;
|
|
30804
31068
|
/**
|
|
30805
31069
|
* Tax with embed
|
|
30806
31070
|
*
|
|
@@ -31013,7 +31277,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31013
31277
|
/**
|
|
31014
31278
|
* Payment term translations
|
|
31015
31279
|
*/
|
|
31016
|
-
translations?: Array<
|
|
31280
|
+
translations?: Array<_heyapi_827_>;
|
|
31017
31281
|
};
|
|
31018
31282
|
}>;
|
|
31019
31283
|
/**
|
|
@@ -31036,7 +31300,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31036
31300
|
/**
|
|
31037
31301
|
* Assigned staff translations
|
|
31038
31302
|
*/
|
|
31039
|
-
translations?: Array<
|
|
31303
|
+
translations?: Array<_heyapi_828_>;
|
|
31040
31304
|
};
|
|
31041
31305
|
}>;
|
|
31042
31306
|
/**
|
|
@@ -31211,11 +31475,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31211
31475
|
/**
|
|
31212
31476
|
* Summary of all document history (includes current document)
|
|
31213
31477
|
*/
|
|
31214
|
-
summary?: Array<
|
|
31478
|
+
summary?: Array<_heyapi_706_ & {
|
|
31215
31479
|
/**
|
|
31216
31480
|
* Credit notes linked to the invoice
|
|
31217
31481
|
*/
|
|
31218
|
-
credit_notes?: Array<
|
|
31482
|
+
credit_notes?: Array<_heyapi_706_>;
|
|
31219
31483
|
}>;
|
|
31220
31484
|
};
|
|
31221
31485
|
/**
|
|
@@ -31261,7 +31525,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31261
31525
|
* Update Progress Invoice
|
|
31262
31526
|
*/
|
|
31263
31527
|
type ProgressInvoiceUpdateWritable = {
|
|
31264
|
-
rows?: Array<
|
|
31528
|
+
rows?: Array<_heyapi_701_ | _heyapi_702_ | _heyapi_703_ | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_ | _heyapi_830_ | _heyapi_831_ | _heyapi_704_ | _heyapi_437_ | _heyapi_438_ | _heyapi_439_ | {
|
|
31265
31529
|
/**
|
|
31266
31530
|
* Row Identifier
|
|
31267
31531
|
*/
|
|
@@ -31389,8 +31653,8 @@ type ProgressInvoiceUpdateWritable = {
|
|
|
31389
31653
|
*/
|
|
31390
31654
|
shipping_volume?: string;
|
|
31391
31655
|
shipping_weight?: _heyapi_433_;
|
|
31392
|
-
payment_terms?:
|
|
31393
|
-
settings?:
|
|
31656
|
+
payment_terms?: _heyapi_684_;
|
|
31657
|
+
settings?: _heyapi_832_;
|
|
31394
31658
|
/**
|
|
31395
31659
|
* Analytic code of document
|
|
31396
31660
|
*/
|
|
@@ -31431,7 +31695,7 @@ type ProposalModelWritable = {
|
|
|
31431
31695
|
/**
|
|
31432
31696
|
* Proposal document
|
|
31433
31697
|
*/
|
|
31434
|
-
type ProposalDocumentWritable =
|
|
31698
|
+
type ProposalDocumentWritable = _heyapi_839_ & {
|
|
31435
31699
|
/**
|
|
31436
31700
|
* Proposal document link
|
|
31437
31701
|
*/
|
|
@@ -31711,12 +31975,12 @@ type CrmActivityEmbed = Array<'aggregations' | 'aggregations.by_event' | 'aggreg
|
|
|
31711
31975
|
* Example : `embed[]=assigned_staffs&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
31712
31976
|
*
|
|
31713
31977
|
*/
|
|
31714
|
-
type OpportunityEmbed = Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
31978
|
+
type OpportunityEmbed = Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_967_>;
|
|
31715
31979
|
/**
|
|
31716
31980
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
31717
31981
|
*
|
|
31718
31982
|
*/
|
|
31719
|
-
type OpportunityEmbedWithAggregations = Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'aggregations' | 'aggregations.amount_sum' | 'aggregations.amount_sum_by_status' | 'aggregations.amount_sum_by_status_due_at_seven' | 'aggregations.number_by_pipeline_and_step' | 'smart_tags' |
|
|
31983
|
+
type OpportunityEmbedWithAggregations = Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'aggregations' | 'aggregations.amount_sum' | 'aggregations.amount_sum_by_status' | 'aggregations.amount_sum_by_status_due_at_seven' | 'aggregations.number_by_pipeline_and_step' | 'smart_tags' | _heyapi_967_>;
|
|
31720
31984
|
/**
|
|
31721
31985
|
* The order field
|
|
31722
31986
|
*/
|
|
@@ -31799,12 +32063,12 @@ type FavouriteFiltersOrder = (typeof FavouriteFiltersOrder)[keyof typeof Favouri
|
|
|
31799
32063
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
31800
32064
|
*
|
|
31801
32065
|
*/
|
|
31802
|
-
type SaleEmbed2 = Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' |
|
|
32066
|
+
type SaleEmbed2 = Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' | _heyapi_967_>;
|
|
31803
32067
|
/**
|
|
31804
32068
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> - discount_incl_taxes: `discount-incl-taxes.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
31805
32069
|
*
|
|
31806
32070
|
*/
|
|
31807
|
-
type EstimateOneEmbed2 = Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'discount_incl_taxes' | 'settings' | 'file' |
|
|
32071
|
+
type EstimateOneEmbed2 = Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'discount_incl_taxes' | 'settings' | 'file' | _heyapi_967_>;
|
|
31808
32072
|
/**
|
|
31809
32073
|
* The order field
|
|
31810
32074
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -32088,11 +32352,11 @@ type CorporationStaffEmbed = Array<'predicted_licenses' | 'aggregations.count_li
|
|
|
32088
32352
|
/**
|
|
32089
32353
|
* Additional object included in the result
|
|
32090
32354
|
*/
|
|
32091
|
-
type InvoiceEmbed = Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
32355
|
+
type InvoiceEmbed = Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_967_>;
|
|
32092
32356
|
/**
|
|
32093
32357
|
* Additional object included in the result
|
|
32094
32358
|
*/
|
|
32095
|
-
type InvoiceOneEmbed = Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' |
|
|
32359
|
+
type InvoiceOneEmbed = Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
32096
32360
|
/**
|
|
32097
32361
|
* Order field
|
|
32098
32362
|
*/
|
|
@@ -32111,11 +32375,11 @@ type InvoiceOrder = (typeof InvoiceOrder)[keyof typeof InvoiceOrder];
|
|
|
32111
32375
|
/**
|
|
32112
32376
|
* Additional object included in the result
|
|
32113
32377
|
*/
|
|
32114
|
-
type CreditNoteEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' |
|
|
32378
|
+
type CreditNoteEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | _heyapi_967_>;
|
|
32115
32379
|
/**
|
|
32116
32380
|
* Additional object included in the result
|
|
32117
32381
|
*/
|
|
32118
|
-
type CreditNoteOneEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
32382
|
+
type CreditNoteOneEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_967_>;
|
|
32119
32383
|
/**
|
|
32120
32384
|
* Order field
|
|
32121
32385
|
*/
|
|
@@ -32161,11 +32425,11 @@ type ImportType = (typeof ImportType)[keyof typeof ImportType];
|
|
|
32161
32425
|
/**
|
|
32162
32426
|
* Additional object included in the result
|
|
32163
32427
|
*/
|
|
32164
|
-
type OrderEmbed = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'payment_method_ids' |
|
|
32428
|
+
type OrderEmbed = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'payment_method_ids' | _heyapi_967_>;
|
|
32165
32429
|
/**
|
|
32166
32430
|
* Additional object included in the result
|
|
32167
32431
|
*/
|
|
32168
|
-
type OrderEmbedOne = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
32432
|
+
type OrderEmbedOne = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_967_>;
|
|
32169
32433
|
/**
|
|
32170
32434
|
* Order field
|
|
32171
32435
|
*/
|
|
@@ -32185,11 +32449,11 @@ type OrderOrder = (typeof OrderOrder)[keyof typeof OrderOrder];
|
|
|
32185
32449
|
/**
|
|
32186
32450
|
* Additional object included in the result
|
|
32187
32451
|
*/
|
|
32188
|
-
type DeliveryEmbed = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' |
|
|
32452
|
+
type DeliveryEmbed = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | _heyapi_967_>;
|
|
32189
32453
|
/**
|
|
32190
32454
|
* Additional object included in the result
|
|
32191
32455
|
*/
|
|
32192
|
-
type DeliveryEmbedOne = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
32456
|
+
type DeliveryEmbedOne = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_967_>;
|
|
32193
32457
|
/**
|
|
32194
32458
|
* Order field
|
|
32195
32459
|
*/
|
|
@@ -32553,7 +32817,7 @@ type GetCompaniesResponses = {
|
|
|
32553
32817
|
/**
|
|
32554
32818
|
* Company acl
|
|
32555
32819
|
*/
|
|
32556
|
-
acl?:
|
|
32820
|
+
acl?: _heyapi_1057_ | null;
|
|
32557
32821
|
/**
|
|
32558
32822
|
* Smart-tags linked
|
|
32559
32823
|
*/
|
|
@@ -32766,7 +33030,7 @@ type CreateCompanyResponses = {
|
|
|
32766
33030
|
/**
|
|
32767
33031
|
* Company acl
|
|
32768
33032
|
*/
|
|
32769
|
-
acl?:
|
|
33033
|
+
acl?: _heyapi_1057_ | null;
|
|
32770
33034
|
/**
|
|
32771
33035
|
* Smart-tags linked
|
|
32772
33036
|
*/
|
|
@@ -32957,7 +33221,7 @@ type SearchCompaniesResponses = {
|
|
|
32957
33221
|
/**
|
|
32958
33222
|
* Company acl
|
|
32959
33223
|
*/
|
|
32960
|
-
acl?:
|
|
33224
|
+
acl?: _heyapi_1057_ | null;
|
|
32961
33225
|
/**
|
|
32962
33226
|
* Smart-tags linked
|
|
32963
33227
|
*/
|
|
@@ -33102,7 +33366,7 @@ type GetCompanyResponses = {
|
|
|
33102
33366
|
/**
|
|
33103
33367
|
* Company acl
|
|
33104
33368
|
*/
|
|
33105
|
-
acl?:
|
|
33369
|
+
acl?: _heyapi_1057_ | null;
|
|
33106
33370
|
/**
|
|
33107
33371
|
* Smart-tags linked
|
|
33108
33372
|
*/
|
|
@@ -33314,7 +33578,7 @@ type UpdateCompanyResponses = {
|
|
|
33314
33578
|
/**
|
|
33315
33579
|
* Company acl
|
|
33316
33580
|
*/
|
|
33317
|
-
acl?:
|
|
33581
|
+
acl?: _heyapi_1057_ | null;
|
|
33318
33582
|
/**
|
|
33319
33583
|
* Smart-tags linked
|
|
33320
33584
|
*/
|
|
@@ -34799,7 +35063,7 @@ type GetContactCompaniesResponses = {
|
|
|
34799
35063
|
/**
|
|
34800
35064
|
* Company acl
|
|
34801
35065
|
*/
|
|
34802
|
-
acl?:
|
|
35066
|
+
acl?: _heyapi_1057_ | null;
|
|
34803
35067
|
/**
|
|
34804
35068
|
* Smart-tags linked
|
|
34805
35069
|
*/
|
|
@@ -36586,7 +36850,7 @@ type GetEstimatesData = {
|
|
|
36586
36850
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
36587
36851
|
*
|
|
36588
36852
|
*/
|
|
36589
|
-
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' |
|
|
36853
|
+
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' | _heyapi_967_>;
|
|
36590
36854
|
/**
|
|
36591
36855
|
* The order field
|
|
36592
36856
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -36610,7 +36874,7 @@ type CreateEstimateData = {
|
|
|
36610
36874
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
36611
36875
|
*
|
|
36612
36876
|
*/
|
|
36613
|
-
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' |
|
|
36877
|
+
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' | _heyapi_967_>;
|
|
36614
36878
|
/**
|
|
36615
36879
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
36616
36880
|
*
|
|
@@ -36651,7 +36915,7 @@ type SearchEstimatesData = {
|
|
|
36651
36915
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
36652
36916
|
*
|
|
36653
36917
|
*/
|
|
36654
|
-
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' |
|
|
36918
|
+
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' | _heyapi_967_>;
|
|
36655
36919
|
/**
|
|
36656
36920
|
* The order field
|
|
36657
36921
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -37560,7 +37824,7 @@ type GetEstimateData = {
|
|
|
37560
37824
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> - discount_incl_taxes: `discount-incl-taxes.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
37561
37825
|
*
|
|
37562
37826
|
*/
|
|
37563
|
-
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'discount_incl_taxes' | 'settings' | 'file' |
|
|
37827
|
+
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'discount_incl_taxes' | 'settings' | 'file' | _heyapi_967_>;
|
|
37564
37828
|
};
|
|
37565
37829
|
url: '/estimates/{id}';
|
|
37566
37830
|
};
|
|
@@ -37595,7 +37859,7 @@ type UpdateEstimateData = {
|
|
|
37595
37859
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
37596
37860
|
*
|
|
37597
37861
|
*/
|
|
37598
|
-
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' |
|
|
37862
|
+
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' | _heyapi_967_>;
|
|
37599
37863
|
};
|
|
37600
37864
|
url: '/estimates/{id}';
|
|
37601
37865
|
};
|
|
@@ -37624,7 +37888,7 @@ type UpdateEstimateStatusData = {
|
|
|
37624
37888
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
37625
37889
|
*
|
|
37626
37890
|
*/
|
|
37627
|
-
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' |
|
|
37891
|
+
embed?: Array<'company' | 'individual' | 'contact' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'currency' | 'acl' | 'payment_method_ids' | 'aggregations' | 'aggregations.amount_sum_by_status' | 'aggregations.count_by_status' | 'fiscal_year' | 'smart_tags' | 'payment_terms' | 'settings' | _heyapi_967_>;
|
|
37628
37892
|
};
|
|
37629
37893
|
url: '/estimates/{id}/status';
|
|
37630
37894
|
};
|
|
@@ -38171,7 +38435,7 @@ type GetOrdersData = {
|
|
|
38171
38435
|
/**
|
|
38172
38436
|
* Additional object included in the result
|
|
38173
38437
|
*/
|
|
38174
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'payment_method_ids' |
|
|
38438
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'payment_method_ids' | _heyapi_967_>;
|
|
38175
38439
|
/**
|
|
38176
38440
|
* Order field
|
|
38177
38441
|
*/
|
|
@@ -38201,7 +38465,7 @@ type CreateOrderData = {
|
|
|
38201
38465
|
/**
|
|
38202
38466
|
* Additional object included in the result
|
|
38203
38467
|
*/
|
|
38204
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
38468
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_967_>;
|
|
38205
38469
|
};
|
|
38206
38470
|
url: '/orders';
|
|
38207
38471
|
};
|
|
@@ -38237,7 +38501,7 @@ type GetOrderData = {
|
|
|
38237
38501
|
/**
|
|
38238
38502
|
* Additional object included in the result
|
|
38239
38503
|
*/
|
|
38240
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
38504
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_967_>;
|
|
38241
38505
|
};
|
|
38242
38506
|
url: '/orders/{id}';
|
|
38243
38507
|
};
|
|
@@ -38260,7 +38524,7 @@ type UpdateOrderData = {
|
|
|
38260
38524
|
/**
|
|
38261
38525
|
* Additional object included in the result
|
|
38262
38526
|
*/
|
|
38263
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
38527
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_967_>;
|
|
38264
38528
|
};
|
|
38265
38529
|
url: '/orders/{id}';
|
|
38266
38530
|
};
|
|
@@ -38295,7 +38559,7 @@ type SearchOrdersData = {
|
|
|
38295
38559
|
/**
|
|
38296
38560
|
* Additional object included in the result
|
|
38297
38561
|
*/
|
|
38298
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'payment_method_ids' |
|
|
38562
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'payment_terms' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'payment_method_ids' | _heyapi_967_>;
|
|
38299
38563
|
/**
|
|
38300
38564
|
* Order field
|
|
38301
38565
|
*/
|
|
@@ -39703,7 +39967,7 @@ type GetDeliveriesData = {
|
|
|
39703
39967
|
/**
|
|
39704
39968
|
* Additional object included in the result
|
|
39705
39969
|
*/
|
|
39706
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' |
|
|
39970
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | _heyapi_967_>;
|
|
39707
39971
|
/**
|
|
39708
39972
|
* Order field
|
|
39709
39973
|
*/
|
|
@@ -39745,7 +40009,7 @@ type SearchDeliveriesData = {
|
|
|
39745
40009
|
/**
|
|
39746
40010
|
* Additional object included in the result
|
|
39747
40011
|
*/
|
|
39748
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' |
|
|
40012
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | _heyapi_967_>;
|
|
39749
40013
|
/**
|
|
39750
40014
|
* Order field
|
|
39751
40015
|
*/
|
|
@@ -39775,7 +40039,7 @@ type GetDeliveryData = {
|
|
|
39775
40039
|
/**
|
|
39776
40040
|
* Additional object included in the result
|
|
39777
40041
|
*/
|
|
39778
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
40042
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_967_>;
|
|
39779
40043
|
};
|
|
39780
40044
|
url: '/deliveries/{id}';
|
|
39781
40045
|
};
|
|
@@ -39798,7 +40062,7 @@ type GetIndividualsData = {
|
|
|
39798
40062
|
* Example : `embed[]=invoicing_address&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - opportunities: `opportunities.read`<br /> - main_contact, dunning_contact, invoicing_contact: `contacts.read`<br /> - estimates,invoices,orders,deliveries: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
39799
40063
|
*
|
|
39800
40064
|
*/
|
|
39801
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
40065
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_967_>;
|
|
39802
40066
|
/**
|
|
39803
40067
|
* The order direction
|
|
39804
40068
|
*/
|
|
@@ -39876,7 +40140,7 @@ type GetIndividualsResponses = {
|
|
|
39876
40140
|
/**
|
|
39877
40141
|
* Individual acl
|
|
39878
40142
|
*/
|
|
39879
|
-
acl?:
|
|
40143
|
+
acl?: _heyapi_1301_ | null;
|
|
39880
40144
|
/**
|
|
39881
40145
|
* Smart-tags linked
|
|
39882
40146
|
*/
|
|
@@ -40006,7 +40270,7 @@ type CreateIndividualData = {
|
|
|
40006
40270
|
* Example : `embed[]=invoicing_address&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - opportunities: `opportunities.read`<br /> - main_contact, dunning_contact, invoicing_contact: `contacts.read`<br /> - estimates,invoices,orders,deliveries: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
40007
40271
|
*
|
|
40008
40272
|
*/
|
|
40009
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
40273
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_967_>;
|
|
40010
40274
|
/**
|
|
40011
40275
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
40012
40276
|
*
|
|
@@ -40073,7 +40337,7 @@ type CreateIndividualResponses = {
|
|
|
40073
40337
|
/**
|
|
40074
40338
|
* Individual acl
|
|
40075
40339
|
*/
|
|
40076
|
-
acl?:
|
|
40340
|
+
acl?: _heyapi_1301_ | null;
|
|
40077
40341
|
/**
|
|
40078
40342
|
* Smart-tags linked
|
|
40079
40343
|
*/
|
|
@@ -40177,7 +40441,7 @@ type SearchIndividualsData = {
|
|
|
40177
40441
|
* Example : `embed[]=invoicing_address&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - opportunities: `opportunities.read`<br /> - main_contact, dunning_contact, invoicing_contact: `contacts.read`<br /> - estimates,invoices,orders,deliveries: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
40178
40442
|
*
|
|
40179
40443
|
*/
|
|
40180
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
40444
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_967_>;
|
|
40181
40445
|
/**
|
|
40182
40446
|
* The order direction
|
|
40183
40447
|
*/
|
|
@@ -40252,7 +40516,7 @@ type SearchIndividualsResponses = {
|
|
|
40252
40516
|
/**
|
|
40253
40517
|
* Individual acl
|
|
40254
40518
|
*/
|
|
40255
|
-
acl?:
|
|
40519
|
+
acl?: _heyapi_1301_ | null;
|
|
40256
40520
|
/**
|
|
40257
40521
|
* Smart-tags linked
|
|
40258
40522
|
*/
|
|
@@ -40452,7 +40716,7 @@ type GetIndividualData = {
|
|
|
40452
40716
|
* Example : `embed[]=invoicing_address&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - opportunities: `opportunities.read`<br /> - main_contact, dunning_contact, invoicing_contact: `contacts.read`<br /> - estimates,invoices,orders,deliveries: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
40453
40717
|
*
|
|
40454
40718
|
*/
|
|
40455
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
40719
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_967_>;
|
|
40456
40720
|
/**
|
|
40457
40721
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
40458
40722
|
*
|
|
@@ -40515,7 +40779,7 @@ type GetIndividualResponses = {
|
|
|
40515
40779
|
/**
|
|
40516
40780
|
* Individual acl
|
|
40517
40781
|
*/
|
|
40518
|
-
acl?:
|
|
40782
|
+
acl?: _heyapi_1301_ | null;
|
|
40519
40783
|
/**
|
|
40520
40784
|
* Smart-tags linked
|
|
40521
40785
|
*/
|
|
@@ -40644,7 +40908,7 @@ type UpdateIndividualData = {
|
|
|
40644
40908
|
* Example : `embed[]=invoicing_address&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - opportunities: `opportunities.read`<br /> - main_contact, dunning_contact, invoicing_contact: `contacts.read`<br /> - estimates,invoices,orders,deliveries: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
40645
40909
|
*
|
|
40646
40910
|
*/
|
|
40647
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
40911
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_967_>;
|
|
40648
40912
|
/**
|
|
40649
40913
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
40650
40914
|
*
|
|
@@ -40711,7 +40975,7 @@ type UpdateIndividualResponses = {
|
|
|
40711
40975
|
/**
|
|
40712
40976
|
* Individual acl
|
|
40713
40977
|
*/
|
|
40714
|
-
acl?:
|
|
40978
|
+
acl?: _heyapi_1301_ | null;
|
|
40715
40979
|
/**
|
|
40716
40980
|
* Smart-tags linked
|
|
40717
40981
|
*/
|
|
@@ -42760,7 +43024,7 @@ type GetTaxesResponses = {
|
|
|
42760
43024
|
/**
|
|
42761
43025
|
* Tax with embed
|
|
42762
43026
|
*/
|
|
42763
|
-
data: Array<
|
|
43027
|
+
data: Array<_heyapi_766_ & {
|
|
42764
43028
|
/**
|
|
42765
43029
|
* Optional objects added through the embed parameter
|
|
42766
43030
|
*/
|
|
@@ -42999,7 +43263,7 @@ type CreateTaxResponses = {
|
|
|
42999
43263
|
*
|
|
43000
43264
|
* Tax created
|
|
43001
43265
|
*/
|
|
43002
|
-
201:
|
|
43266
|
+
201: _heyapi_766_ & {
|
|
43003
43267
|
/**
|
|
43004
43268
|
* Optional objects added through the embed parameter
|
|
43005
43269
|
*/
|
|
@@ -43106,7 +43370,7 @@ type SearchTaxesResponses = {
|
|
|
43106
43370
|
*/
|
|
43107
43371
|
200: {
|
|
43108
43372
|
pagination: Pagination;
|
|
43109
|
-
data: Array<
|
|
43373
|
+
data: Array<_heyapi_766_ & {
|
|
43110
43374
|
/**
|
|
43111
43375
|
* Optional objects added through the embed parameter
|
|
43112
43376
|
*/
|
|
@@ -43227,7 +43491,7 @@ type GetTaxResponses = {
|
|
|
43227
43491
|
*
|
|
43228
43492
|
* Tax fetched
|
|
43229
43493
|
*/
|
|
43230
|
-
200:
|
|
43494
|
+
200: _heyapi_766_ & {
|
|
43231
43495
|
/**
|
|
43232
43496
|
* Optional objects added through the embed parameter
|
|
43233
43497
|
*/
|
|
@@ -43476,7 +43740,7 @@ type UpdateTaxResponses = {
|
|
|
43476
43740
|
*
|
|
43477
43741
|
* Tax updated
|
|
43478
43742
|
*/
|
|
43479
|
-
200:
|
|
43743
|
+
200: _heyapi_766_ & {
|
|
43480
43744
|
/**
|
|
43481
43745
|
* Optional objects added through the embed parameter
|
|
43482
43746
|
*/
|
|
@@ -46516,7 +46780,7 @@ type GetOpportunityData = {
|
|
|
46516
46780
|
* Example : `embed[]=assigned_staffs&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
46517
46781
|
*
|
|
46518
46782
|
*/
|
|
46519
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
46783
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_967_>;
|
|
46520
46784
|
/**
|
|
46521
46785
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
46522
46786
|
*
|
|
@@ -46551,7 +46815,7 @@ type PatchOpportunityData = {
|
|
|
46551
46815
|
* Example : `embed[]=assigned_staffs&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
46552
46816
|
*
|
|
46553
46817
|
*/
|
|
46554
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
46818
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_967_>;
|
|
46555
46819
|
/**
|
|
46556
46820
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
46557
46821
|
*
|
|
@@ -46588,7 +46852,7 @@ type UpdateOpportunityData = {
|
|
|
46588
46852
|
* Example : `embed[]=assigned_staffs&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
46589
46853
|
*
|
|
46590
46854
|
*/
|
|
46591
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
46855
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_967_>;
|
|
46592
46856
|
/**
|
|
46593
46857
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
46594
46858
|
*
|
|
@@ -46650,7 +46914,7 @@ type GetOpportunitiesData = {
|
|
|
46650
46914
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
46651
46915
|
*
|
|
46652
46916
|
*/
|
|
46653
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'aggregations' | 'aggregations.amount_sum' | 'aggregations.amount_sum_by_status' | 'aggregations.amount_sum_by_status_due_at_seven' | 'aggregations.number_by_pipeline_and_step' | 'smart_tags' |
|
|
46917
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'aggregations' | 'aggregations.amount_sum' | 'aggregations.amount_sum_by_status' | 'aggregations.amount_sum_by_status_due_at_seven' | 'aggregations.number_by_pipeline_and_step' | 'smart_tags' | _heyapi_967_>;
|
|
46654
46918
|
/**
|
|
46655
46919
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
46656
46920
|
*
|
|
@@ -46682,7 +46946,7 @@ type CreateOpportunityData = {
|
|
|
46682
46946
|
* Example : `embed[]=assigned_staffs&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
46683
46947
|
*
|
|
46684
46948
|
*/
|
|
46685
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
46949
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_967_>;
|
|
46686
46950
|
/**
|
|
46687
46951
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
46688
46952
|
*
|
|
@@ -46769,7 +47033,7 @@ type SearchOpportunitiesData = {
|
|
|
46769
47033
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - assigned_staffs: `staffs.read`<br /> - contacts: `contacts.read`<br /> - estimates, invoices, orders, deliveries, proformas, creditnotes: `invoicing.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br />
|
|
46770
47034
|
*
|
|
46771
47035
|
*/
|
|
46772
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'aggregations' | 'aggregations.amount_sum' | 'aggregations.amount_sum_by_status' | 'aggregations.amount_sum_by_status_due_at_seven' | 'aggregations.number_by_pipeline_and_step' | 'smart_tags' |
|
|
47036
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'aggregations' | 'aggregations.amount_sum' | 'aggregations.amount_sum_by_status' | 'aggregations.amount_sum_by_status_due_at_seven' | 'aggregations.number_by_pipeline_and_step' | 'smart_tags' | _heyapi_967_>;
|
|
46773
47037
|
/**
|
|
46774
47038
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
46775
47039
|
*
|
|
@@ -52422,7 +52686,7 @@ type GetInvoiceData = {
|
|
|
52422
52686
|
/**
|
|
52423
52687
|
* Additional object included in the result
|
|
52424
52688
|
*/
|
|
52425
|
-
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' |
|
|
52689
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
52426
52690
|
};
|
|
52427
52691
|
url: '/invoices/{id}';
|
|
52428
52692
|
};
|
|
@@ -52445,7 +52709,7 @@ type UpdateInvoiceData = {
|
|
|
52445
52709
|
/**
|
|
52446
52710
|
* Additional object included in the result
|
|
52447
52711
|
*/
|
|
52448
|
-
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' |
|
|
52712
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
52449
52713
|
};
|
|
52450
52714
|
url: '/invoices/{id}';
|
|
52451
52715
|
};
|
|
@@ -52480,7 +52744,7 @@ type GetInvoicesData = {
|
|
|
52480
52744
|
/**
|
|
52481
52745
|
* Additional object included in the result
|
|
52482
52746
|
*/
|
|
52483
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
52747
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_967_>;
|
|
52484
52748
|
/**
|
|
52485
52749
|
* Order field
|
|
52486
52750
|
*/
|
|
@@ -52505,7 +52769,7 @@ type CreateInvoiceData = {
|
|
|
52505
52769
|
/**
|
|
52506
52770
|
* Additional object included in the result
|
|
52507
52771
|
*/
|
|
52508
|
-
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' |
|
|
52772
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
52509
52773
|
/**
|
|
52510
52774
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
52511
52775
|
*
|
|
@@ -52545,7 +52809,7 @@ type SearchInvoicesData = {
|
|
|
52545
52809
|
/**
|
|
52546
52810
|
* Additional object included in the result
|
|
52547
52811
|
*/
|
|
52548
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
52812
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_967_>;
|
|
52549
52813
|
/**
|
|
52550
52814
|
* Order field
|
|
52551
52815
|
*/
|
|
@@ -53879,7 +54143,7 @@ type GetCreditNoteData = {
|
|
|
53879
54143
|
/**
|
|
53880
54144
|
* Additional object included in the result
|
|
53881
54145
|
*/
|
|
53882
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
54146
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_967_>;
|
|
53883
54147
|
};
|
|
53884
54148
|
url: '/credit-notes/{id}';
|
|
53885
54149
|
};
|
|
@@ -53902,7 +54166,7 @@ type UpdateCreditNoteData = {
|
|
|
53902
54166
|
/**
|
|
53903
54167
|
* Additional object included in the result
|
|
53904
54168
|
*/
|
|
53905
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
54169
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_967_>;
|
|
53906
54170
|
};
|
|
53907
54171
|
url: '/credit-notes/{id}';
|
|
53908
54172
|
};
|
|
@@ -53937,7 +54201,7 @@ type GetCreditNotesData = {
|
|
|
53937
54201
|
/**
|
|
53938
54202
|
* Additional object included in the result
|
|
53939
54203
|
*/
|
|
53940
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' |
|
|
54204
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | _heyapi_967_>;
|
|
53941
54205
|
/**
|
|
53942
54206
|
* Order field
|
|
53943
54207
|
*/
|
|
@@ -53962,7 +54226,7 @@ type CreateCreditNoteData = {
|
|
|
53962
54226
|
/**
|
|
53963
54227
|
* Additional object included in the result
|
|
53964
54228
|
*/
|
|
53965
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
54229
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_967_>;
|
|
53966
54230
|
/**
|
|
53967
54231
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
53968
54232
|
*
|
|
@@ -54002,7 +54266,7 @@ type SearchCreditNotesData = {
|
|
|
54002
54266
|
/**
|
|
54003
54267
|
* Additional object included in the result
|
|
54004
54268
|
*/
|
|
54005
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' |
|
|
54269
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | _heyapi_967_>;
|
|
54006
54270
|
/**
|
|
54007
54271
|
* Order field
|
|
54008
54272
|
*/
|
|
@@ -56845,7 +57109,7 @@ type UpdateModelData = {
|
|
|
56845
57109
|
* Invoice's owner (staff id)
|
|
56846
57110
|
*/
|
|
56847
57111
|
owner_id?: number;
|
|
56848
|
-
rows?: Array<
|
|
57112
|
+
rows?: Array<_heyapi_2136_> | null;
|
|
56849
57113
|
};
|
|
56850
57114
|
path: {
|
|
56851
57115
|
/**
|
|
@@ -57261,7 +57525,7 @@ type GetDepositInvoicesData = {
|
|
|
57261
57525
|
/**
|
|
57262
57526
|
* Additional object included in the result
|
|
57263
57527
|
*/
|
|
57264
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
57528
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_967_>;
|
|
57265
57529
|
/**
|
|
57266
57530
|
* Order field
|
|
57267
57531
|
*/
|
|
@@ -57283,7 +57547,12 @@ type GetDepositInvoicesResponse = GetDepositInvoicesResponses[keyof GetDepositIn
|
|
|
57283
57547
|
type CreateDepositInvoiceData = {
|
|
57284
57548
|
body?: DepositInvoiceCreateWritable;
|
|
57285
57549
|
path?: never;
|
|
57286
|
-
query?:
|
|
57550
|
+
query?: {
|
|
57551
|
+
/**
|
|
57552
|
+
* Additional object included in the result
|
|
57553
|
+
*/
|
|
57554
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
57555
|
+
};
|
|
57287
57556
|
url: '/deposit-invoices';
|
|
57288
57557
|
};
|
|
57289
57558
|
type CreateDepositInvoiceResponses = {
|
|
@@ -57317,7 +57586,7 @@ type SearchDepositInvoicesData = {
|
|
|
57317
57586
|
/**
|
|
57318
57587
|
* Additional object included in the result
|
|
57319
57588
|
*/
|
|
57320
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
57589
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_967_>;
|
|
57321
57590
|
/**
|
|
57322
57591
|
* Order field
|
|
57323
57592
|
*/
|
|
@@ -57369,7 +57638,12 @@ type GetDepositInvoiceData = {
|
|
|
57369
57638
|
*/
|
|
57370
57639
|
id: number;
|
|
57371
57640
|
};
|
|
57372
|
-
query?:
|
|
57641
|
+
query?: {
|
|
57642
|
+
/**
|
|
57643
|
+
* Additional object included in the result
|
|
57644
|
+
*/
|
|
57645
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
57646
|
+
};
|
|
57373
57647
|
url: '/deposit-invoices/{id}';
|
|
57374
57648
|
};
|
|
57375
57649
|
type GetDepositInvoiceResponses = {
|
|
@@ -57387,7 +57661,12 @@ type UpdateDepositInvoiceData = {
|
|
|
57387
57661
|
*/
|
|
57388
57662
|
id: number;
|
|
57389
57663
|
};
|
|
57390
|
-
query?:
|
|
57664
|
+
query?: {
|
|
57665
|
+
/**
|
|
57666
|
+
* Additional object included in the result
|
|
57667
|
+
*/
|
|
57668
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
57669
|
+
};
|
|
57391
57670
|
url: '/deposit-invoices/{id}';
|
|
57392
57671
|
};
|
|
57393
57672
|
type UpdateDepositInvoiceResponses = {
|
|
@@ -58467,7 +58746,7 @@ type CreateProgressInvoiceData = {
|
|
|
58467
58746
|
/**
|
|
58468
58747
|
* Additional object included in the result
|
|
58469
58748
|
*/
|
|
58470
|
-
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' |
|
|
58749
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
58471
58750
|
/**
|
|
58472
58751
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
58473
58752
|
*
|
|
@@ -58508,7 +58787,7 @@ type UpdateProgressInvoiceData = {
|
|
|
58508
58787
|
/**
|
|
58509
58788
|
* Additional object included in the result
|
|
58510
58789
|
*/
|
|
58511
|
-
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' |
|
|
58790
|
+
embed?: Array<'acl' | 'payment_terms' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'automatic_dunning' | 'smart_tags' | 'discount_incl_taxes' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | 'settings' | 'file' | _heyapi_967_>;
|
|
58512
58791
|
/**
|
|
58513
58792
|
* Filters the fields returned in the response <br /><br /> Example:<br /> - `field[]=id`: Return the `id` field<br /> - `field[]=address.id`: Return the `id` field of the `address` object<br /> - `field[]=addresses[].id`: Return the `id` field of the `address` objects<br /> <br> On endpoints that implement the `embed` query parameter, if you specified embeds in your call, you will need to request the `_embed` field as well.<br> Example:<br> - `field[]=_embed`: Return all fields from all requested embeds<br> - `field[]=_embed.address`: Return all fields from the `address` embed<br> - `field[]=_embed.company.name`: Return the `name` field from the `company` embed<br>
|
|
58514
58793
|
*
|
|
@@ -65968,6 +66247,11 @@ declare const DealsSchema: {
|
|
|
65968
66247
|
readonly minimum: 0;
|
|
65969
66248
|
readonly maximum: 1;
|
|
65970
66249
|
};
|
|
66250
|
+
readonly meet_link: {
|
|
66251
|
+
readonly type: "string";
|
|
66252
|
+
readonly description: "Meet link for the calendar event";
|
|
66253
|
+
readonly nullable: true;
|
|
66254
|
+
};
|
|
65971
66255
|
};
|
|
65972
66256
|
}, {
|
|
65973
66257
|
readonly title: "Email";
|
|
@@ -68438,26 +68722,30 @@ declare const OcrPurInvoiceMetasSchema: {
|
|
|
68438
68722
|
readonly properties: {
|
|
68439
68723
|
readonly user_can_validate_pur_invoice: {
|
|
68440
68724
|
readonly type: "boolean";
|
|
68441
|
-
readonly description: "
|
|
68725
|
+
readonly description: "User can validate a purchase invoice";
|
|
68442
68726
|
};
|
|
68443
68727
|
readonly create_payment: {
|
|
68444
68728
|
readonly type: "boolean";
|
|
68445
|
-
readonly description: "
|
|
68729
|
+
readonly description: "User can create a payment";
|
|
68446
68730
|
};
|
|
68447
|
-
readonly
|
|
68731
|
+
readonly create_pur_invoice: {
|
|
68732
|
+
readonly type: "boolean";
|
|
68733
|
+
readonly description: "User can create a purchase invoice";
|
|
68734
|
+
};
|
|
68735
|
+
readonly create_pur_credit_note: {
|
|
68448
68736
|
readonly type: "boolean";
|
|
68449
|
-
readonly description: "
|
|
68737
|
+
readonly description: "User can create a purchase credit note";
|
|
68450
68738
|
};
|
|
68451
68739
|
readonly create_fast: {
|
|
68452
68740
|
readonly type: "boolean";
|
|
68453
|
-
readonly description: "
|
|
68741
|
+
readonly description: "User can create a fast purchase invoice";
|
|
68454
68742
|
};
|
|
68455
68743
|
readonly import: {
|
|
68456
68744
|
readonly type: "boolean";
|
|
68457
|
-
readonly description: "
|
|
68745
|
+
readonly description: "User can import a purchase invoice";
|
|
68458
68746
|
};
|
|
68459
68747
|
};
|
|
68460
|
-
readonly required: readonly ["user_can_validate_pur_invoice", "create_payment", "
|
|
68748
|
+
readonly required: readonly ["user_can_validate_pur_invoice", "create_payment", "create_pur_invoice", "create_pur_credit_note", "create_fast", "import"];
|
|
68461
68749
|
};
|
|
68462
68750
|
declare const InvoicingConformityStateSchema: {
|
|
68463
68751
|
readonly title: "conformityState";
|
|
@@ -78039,7 +78327,7 @@ declare const InvoiceSchema: {
|
|
|
78039
78327
|
readonly due_date: {
|
|
78040
78328
|
readonly type: "string";
|
|
78041
78329
|
readonly format: "date";
|
|
78042
|
-
readonly description: "
|
|
78330
|
+
readonly description: "Due date of the invoice.\n";
|
|
78043
78331
|
readonly example: "2022-02-02";
|
|
78044
78332
|
};
|
|
78045
78333
|
readonly created: {
|
|
@@ -78604,7 +78892,7 @@ declare const InvoiceOneSchema: {
|
|
|
78604
78892
|
readonly due_date: {
|
|
78605
78893
|
readonly type: "string";
|
|
78606
78894
|
readonly format: "date";
|
|
78607
|
-
readonly description: "
|
|
78895
|
+
readonly description: "Due date of the invoice.\n";
|
|
78608
78896
|
readonly example: "2022-02-02";
|
|
78609
78897
|
};
|
|
78610
78898
|
readonly created: {
|
|
@@ -80436,9 +80724,13 @@ declare const InvoiceCreateSchema: {
|
|
|
80436
80724
|
readonly due_date: {
|
|
80437
80725
|
readonly type: "string";
|
|
80438
80726
|
readonly format: "date";
|
|
80439
|
-
readonly
|
|
80727
|
+
readonly deprecated: true;
|
|
80728
|
+
readonly description: "Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.\n";
|
|
80440
80729
|
readonly example: "2022-02-02";
|
|
80441
80730
|
};
|
|
80731
|
+
readonly payment_terms: {
|
|
80732
|
+
readonly $ref: "#/components/schemas/ProgressInvoiceCreate/properties/payment_terms";
|
|
80733
|
+
};
|
|
80442
80734
|
readonly created: {
|
|
80443
80735
|
readonly description: "Created date of invoice";
|
|
80444
80736
|
readonly type: "string";
|
|
@@ -80784,12 +81076,6 @@ declare const DepositInvoiceCreateSchema: {
|
|
|
80784
81076
|
readonly description: "Date of the invoice";
|
|
80785
81077
|
readonly example: "2022-01-02";
|
|
80786
81078
|
};
|
|
80787
|
-
readonly due_date: {
|
|
80788
|
-
readonly type: "string";
|
|
80789
|
-
readonly format: "date";
|
|
80790
|
-
readonly description: "Due date of the invoice";
|
|
80791
|
-
readonly example: "2022-02-02";
|
|
80792
|
-
};
|
|
80793
81079
|
readonly subject: {
|
|
80794
81080
|
readonly type: "string";
|
|
80795
81081
|
readonly description: "Subject of the invoice";
|
|
@@ -80849,6 +81135,228 @@ declare const DepositInvoiceCreateSchema: {
|
|
|
80849
81135
|
readonly description: "Analytic code of document";
|
|
80850
81136
|
readonly example: "divers";
|
|
80851
81137
|
};
|
|
81138
|
+
readonly payment_terms: {
|
|
81139
|
+
readonly type: "object";
|
|
81140
|
+
readonly description: "Payment terms of the invoice\n";
|
|
81141
|
+
readonly anyOf: readonly [{
|
|
81142
|
+
readonly type: "object";
|
|
81143
|
+
readonly title: "On order";
|
|
81144
|
+
readonly properties: {
|
|
81145
|
+
readonly id: {
|
|
81146
|
+
readonly type: "integer";
|
|
81147
|
+
readonly minimum: 1;
|
|
81148
|
+
readonly description: "Payment terms id";
|
|
81149
|
+
};
|
|
81150
|
+
readonly code: {
|
|
81151
|
+
readonly type: "string";
|
|
81152
|
+
readonly description: "Payment terms code";
|
|
81153
|
+
readonly enum: readonly ["onorder"];
|
|
81154
|
+
};
|
|
81155
|
+
};
|
|
81156
|
+
readonly additionalProperties: false;
|
|
81157
|
+
readonly required: readonly ["id"];
|
|
81158
|
+
}, {
|
|
81159
|
+
readonly type: "object";
|
|
81160
|
+
readonly title: "End of the month";
|
|
81161
|
+
readonly properties: {
|
|
81162
|
+
readonly id: {
|
|
81163
|
+
readonly type: "integer";
|
|
81164
|
+
readonly minimum: 1;
|
|
81165
|
+
readonly description: "Payment terms id";
|
|
81166
|
+
};
|
|
81167
|
+
readonly code: {
|
|
81168
|
+
readonly type: "string";
|
|
81169
|
+
readonly description: "Payment terms code";
|
|
81170
|
+
readonly enum: readonly ["endmonth"];
|
|
81171
|
+
};
|
|
81172
|
+
};
|
|
81173
|
+
readonly additionalProperties: false;
|
|
81174
|
+
readonly required: readonly ["id"];
|
|
81175
|
+
}, {
|
|
81176
|
+
readonly type: "object";
|
|
81177
|
+
readonly title: "Upon receipt";
|
|
81178
|
+
readonly properties: {
|
|
81179
|
+
readonly id: {
|
|
81180
|
+
readonly type: "integer";
|
|
81181
|
+
readonly minimum: 1;
|
|
81182
|
+
readonly description: "Payment terms id";
|
|
81183
|
+
};
|
|
81184
|
+
readonly code: {
|
|
81185
|
+
readonly type: "string";
|
|
81186
|
+
readonly description: "Payment terms code";
|
|
81187
|
+
readonly enum: readonly ["received"];
|
|
81188
|
+
};
|
|
81189
|
+
};
|
|
81190
|
+
readonly additionalProperties: false;
|
|
81191
|
+
readonly required: readonly ["id"];
|
|
81192
|
+
}, {
|
|
81193
|
+
readonly type: "object";
|
|
81194
|
+
readonly title: "On receipt of invoice";
|
|
81195
|
+
readonly properties: {
|
|
81196
|
+
readonly id: {
|
|
81197
|
+
readonly type: "integer";
|
|
81198
|
+
readonly minimum: 1;
|
|
81199
|
+
readonly description: "Payment terms id";
|
|
81200
|
+
};
|
|
81201
|
+
readonly code: {
|
|
81202
|
+
readonly type: "string";
|
|
81203
|
+
readonly description: "Payment terms code";
|
|
81204
|
+
readonly enum: readonly ["oninvoice"];
|
|
81205
|
+
};
|
|
81206
|
+
};
|
|
81207
|
+
readonly additionalProperties: false;
|
|
81208
|
+
readonly required: readonly ["id"];
|
|
81209
|
+
}, {
|
|
81210
|
+
readonly type: "object";
|
|
81211
|
+
readonly title: "Next month";
|
|
81212
|
+
readonly properties: {
|
|
81213
|
+
readonly id: {
|
|
81214
|
+
readonly type: "integer";
|
|
81215
|
+
readonly minimum: 1;
|
|
81216
|
+
readonly description: "Payment terms id";
|
|
81217
|
+
};
|
|
81218
|
+
readonly code: {
|
|
81219
|
+
readonly type: "string";
|
|
81220
|
+
readonly description: "Payment terms code";
|
|
81221
|
+
readonly enum: readonly ["nextmonth"];
|
|
81222
|
+
};
|
|
81223
|
+
};
|
|
81224
|
+
readonly additionalProperties: false;
|
|
81225
|
+
readonly required: readonly ["id"];
|
|
81226
|
+
}, {
|
|
81227
|
+
readonly type: "object";
|
|
81228
|
+
readonly title: "30 days";
|
|
81229
|
+
readonly properties: {
|
|
81230
|
+
readonly id: {
|
|
81231
|
+
readonly type: "integer";
|
|
81232
|
+
readonly minimum: 1;
|
|
81233
|
+
readonly description: "Payment terms id";
|
|
81234
|
+
};
|
|
81235
|
+
readonly end_of_month: {
|
|
81236
|
+
readonly type: "boolean";
|
|
81237
|
+
readonly description: "Is pay deadlines at end of the month";
|
|
81238
|
+
};
|
|
81239
|
+
readonly code: {
|
|
81240
|
+
readonly type: "string";
|
|
81241
|
+
readonly description: "Payment terms code";
|
|
81242
|
+
readonly enum: readonly ["30days"];
|
|
81243
|
+
};
|
|
81244
|
+
};
|
|
81245
|
+
readonly additionalProperties: false;
|
|
81246
|
+
readonly required: readonly ["id", "end_of_month"];
|
|
81247
|
+
}, {
|
|
81248
|
+
readonly type: "object";
|
|
81249
|
+
readonly title: "45 days";
|
|
81250
|
+
readonly properties: {
|
|
81251
|
+
readonly id: {
|
|
81252
|
+
readonly type: "integer";
|
|
81253
|
+
readonly minimum: 1;
|
|
81254
|
+
readonly description: "Payment terms id";
|
|
81255
|
+
};
|
|
81256
|
+
readonly end_of_month: {
|
|
81257
|
+
readonly type: "boolean";
|
|
81258
|
+
readonly description: "Is pay deadlines at end of the month";
|
|
81259
|
+
};
|
|
81260
|
+
readonly code: {
|
|
81261
|
+
readonly type: "string";
|
|
81262
|
+
readonly description: "Payment terms code";
|
|
81263
|
+
readonly enum: readonly ["45days"];
|
|
81264
|
+
};
|
|
81265
|
+
};
|
|
81266
|
+
readonly additionalProperties: false;
|
|
81267
|
+
readonly required: readonly ["id", "end_of_month"];
|
|
81268
|
+
}, {
|
|
81269
|
+
readonly type: "object";
|
|
81270
|
+
readonly title: "60 days";
|
|
81271
|
+
readonly properties: {
|
|
81272
|
+
readonly id: {
|
|
81273
|
+
readonly type: "integer";
|
|
81274
|
+
readonly minimum: 1;
|
|
81275
|
+
readonly description: "Payment terms id";
|
|
81276
|
+
};
|
|
81277
|
+
readonly end_of_month: {
|
|
81278
|
+
readonly type: "boolean";
|
|
81279
|
+
readonly description: "Is pay deadlines at end of the month";
|
|
81280
|
+
};
|
|
81281
|
+
readonly code: {
|
|
81282
|
+
readonly type: "string";
|
|
81283
|
+
readonly description: "Payment terms code";
|
|
81284
|
+
readonly enum: readonly ["60days"];
|
|
81285
|
+
};
|
|
81286
|
+
};
|
|
81287
|
+
readonly additionalProperties: false;
|
|
81288
|
+
readonly required: readonly ["id", "end_of_month"];
|
|
81289
|
+
}, {
|
|
81290
|
+
readonly type: "object";
|
|
81291
|
+
readonly title: "X days";
|
|
81292
|
+
readonly properties: {
|
|
81293
|
+
readonly id: {
|
|
81294
|
+
readonly type: "integer";
|
|
81295
|
+
readonly minimum: 1;
|
|
81296
|
+
readonly description: "Payment terms id";
|
|
81297
|
+
};
|
|
81298
|
+
readonly x_days: {
|
|
81299
|
+
readonly type: "integer";
|
|
81300
|
+
readonly description: "Number of days for pay deadlines";
|
|
81301
|
+
readonly minimum: 0;
|
|
81302
|
+
readonly maximum: 1000;
|
|
81303
|
+
};
|
|
81304
|
+
readonly code: {
|
|
81305
|
+
readonly type: "string";
|
|
81306
|
+
readonly enum: readonly ["xdays"];
|
|
81307
|
+
};
|
|
81308
|
+
};
|
|
81309
|
+
readonly additionalProperties: false;
|
|
81310
|
+
readonly required: readonly ["id", "x_days"];
|
|
81311
|
+
}, {
|
|
81312
|
+
readonly type: "object";
|
|
81313
|
+
readonly title: "Scaled";
|
|
81314
|
+
readonly properties: {
|
|
81315
|
+
readonly id: {
|
|
81316
|
+
readonly type: "integer";
|
|
81317
|
+
readonly minimum: 1;
|
|
81318
|
+
readonly description: "Payment terms id";
|
|
81319
|
+
};
|
|
81320
|
+
readonly x_days: {
|
|
81321
|
+
readonly type: "integer";
|
|
81322
|
+
readonly description: "Number of days for pay deadlines";
|
|
81323
|
+
};
|
|
81324
|
+
readonly description: {
|
|
81325
|
+
readonly type: "string";
|
|
81326
|
+
readonly description: "Details of payment terms";
|
|
81327
|
+
readonly maxLength: 262144;
|
|
81328
|
+
};
|
|
81329
|
+
readonly code: {
|
|
81330
|
+
readonly type: "string";
|
|
81331
|
+
readonly enum: readonly ["scaled"];
|
|
81332
|
+
};
|
|
81333
|
+
};
|
|
81334
|
+
readonly additionalProperties: false;
|
|
81335
|
+
readonly required: readonly ["id", "x_days", "description"];
|
|
81336
|
+
}, {
|
|
81337
|
+
readonly type: "object";
|
|
81338
|
+
readonly title: "User defined";
|
|
81339
|
+
readonly properties: {
|
|
81340
|
+
readonly id: {
|
|
81341
|
+
readonly type: "integer";
|
|
81342
|
+
readonly minimum: 1;
|
|
81343
|
+
readonly description: "Payment terms id";
|
|
81344
|
+
};
|
|
81345
|
+
readonly due_date: {
|
|
81346
|
+
readonly type: "string";
|
|
81347
|
+
readonly format: "date";
|
|
81348
|
+
readonly description: "Due date of the payment term";
|
|
81349
|
+
readonly example: "2022-01-02";
|
|
81350
|
+
};
|
|
81351
|
+
readonly code: {
|
|
81352
|
+
readonly type: "string";
|
|
81353
|
+
readonly enum: readonly ["custom"];
|
|
81354
|
+
};
|
|
81355
|
+
};
|
|
81356
|
+
readonly additionalProperties: false;
|
|
81357
|
+
readonly required: readonly ["id", "due_date"];
|
|
81358
|
+
}];
|
|
81359
|
+
};
|
|
80852
81360
|
};
|
|
80853
81361
|
readonly required: readonly ["parent", "rows"];
|
|
80854
81362
|
};
|
|
@@ -80971,6 +81479,9 @@ declare const DepositInvoiceUpdateSchema: {
|
|
|
80971
81479
|
readonly description: "Analytic code of document";
|
|
80972
81480
|
readonly example: "divers";
|
|
80973
81481
|
};
|
|
81482
|
+
readonly payment_terms: {
|
|
81483
|
+
readonly $ref: "#/components/schemas/DepositInvoiceCreate/properties/payment_terms";
|
|
81484
|
+
};
|
|
80974
81485
|
};
|
|
80975
81486
|
};
|
|
80976
81487
|
declare const DepositInvoicePrepareInputSchema: {
|
|
@@ -96130,6 +96641,11 @@ declare const DealsWritableSchema: {
|
|
|
96130
96641
|
readonly minimum: 0;
|
|
96131
96642
|
readonly maximum: 1;
|
|
96132
96643
|
};
|
|
96644
|
+
readonly meet_link: {
|
|
96645
|
+
readonly type: "string";
|
|
96646
|
+
readonly description: "Meet link for the calendar event";
|
|
96647
|
+
readonly nullable: true;
|
|
96648
|
+
};
|
|
96133
96649
|
};
|
|
96134
96650
|
}, {
|
|
96135
96651
|
readonly title: "Email";
|
|
@@ -99831,7 +100347,7 @@ declare const InvoiceWritableSchema: {
|
|
|
99831
100347
|
readonly due_date: {
|
|
99832
100348
|
readonly type: "string";
|
|
99833
100349
|
readonly format: "date";
|
|
99834
|
-
readonly description: "
|
|
100350
|
+
readonly description: "Due date of the invoice.\n";
|
|
99835
100351
|
readonly example: "2022-02-02";
|
|
99836
100352
|
};
|
|
99837
100353
|
readonly created: {
|
|
@@ -100213,7 +100729,7 @@ declare const InvoiceOneWritableSchema: {
|
|
|
100213
100729
|
readonly due_date: {
|
|
100214
100730
|
readonly type: "string";
|
|
100215
100731
|
readonly format: "date";
|
|
100216
|
-
readonly description: "
|
|
100732
|
+
readonly description: "Due date of the invoice.\n";
|
|
100217
100733
|
readonly example: "2022-02-02";
|
|
100218
100734
|
};
|
|
100219
100735
|
readonly created: {
|
|
@@ -101442,9 +101958,13 @@ declare const InvoiceCreateWritableSchema: {
|
|
|
101442
101958
|
readonly due_date: {
|
|
101443
101959
|
readonly type: "string";
|
|
101444
101960
|
readonly format: "date";
|
|
101445
|
-
readonly
|
|
101961
|
+
readonly deprecated: true;
|
|
101962
|
+
readonly description: "Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.\n";
|
|
101446
101963
|
readonly example: "2022-02-02";
|
|
101447
101964
|
};
|
|
101965
|
+
readonly payment_terms: {
|
|
101966
|
+
readonly $ref: "#/components/schemas/ProgressInvoiceCreate/properties/payment_terms";
|
|
101967
|
+
};
|
|
101448
101968
|
readonly created: {
|
|
101449
101969
|
readonly description: "Created date of invoice";
|
|
101450
101970
|
readonly type: "string";
|
|
@@ -101790,12 +102310,6 @@ declare const DepositInvoiceCreateWritableSchema: {
|
|
|
101790
102310
|
readonly description: "Date of the invoice";
|
|
101791
102311
|
readonly example: "2022-01-02";
|
|
101792
102312
|
};
|
|
101793
|
-
readonly due_date: {
|
|
101794
|
-
readonly type: "string";
|
|
101795
|
-
readonly format: "date";
|
|
101796
|
-
readonly description: "Due date of the invoice";
|
|
101797
|
-
readonly example: "2022-02-02";
|
|
101798
|
-
};
|
|
101799
102313
|
readonly subject: {
|
|
101800
102314
|
readonly type: "string";
|
|
101801
102315
|
readonly description: "Subject of the invoice";
|
|
@@ -101855,6 +102369,228 @@ declare const DepositInvoiceCreateWritableSchema: {
|
|
|
101855
102369
|
readonly description: "Analytic code of document";
|
|
101856
102370
|
readonly example: "divers";
|
|
101857
102371
|
};
|
|
102372
|
+
readonly payment_terms: {
|
|
102373
|
+
readonly type: "object";
|
|
102374
|
+
readonly description: "Payment terms of the invoice\n";
|
|
102375
|
+
readonly anyOf: readonly [{
|
|
102376
|
+
readonly type: "object";
|
|
102377
|
+
readonly title: "On order";
|
|
102378
|
+
readonly properties: {
|
|
102379
|
+
readonly id: {
|
|
102380
|
+
readonly type: "integer";
|
|
102381
|
+
readonly minimum: 1;
|
|
102382
|
+
readonly description: "Payment terms id";
|
|
102383
|
+
};
|
|
102384
|
+
readonly code: {
|
|
102385
|
+
readonly type: "string";
|
|
102386
|
+
readonly description: "Payment terms code";
|
|
102387
|
+
readonly enum: readonly ["onorder"];
|
|
102388
|
+
};
|
|
102389
|
+
};
|
|
102390
|
+
readonly additionalProperties: false;
|
|
102391
|
+
readonly required: readonly ["id"];
|
|
102392
|
+
}, {
|
|
102393
|
+
readonly type: "object";
|
|
102394
|
+
readonly title: "End of the month";
|
|
102395
|
+
readonly properties: {
|
|
102396
|
+
readonly id: {
|
|
102397
|
+
readonly type: "integer";
|
|
102398
|
+
readonly minimum: 1;
|
|
102399
|
+
readonly description: "Payment terms id";
|
|
102400
|
+
};
|
|
102401
|
+
readonly code: {
|
|
102402
|
+
readonly type: "string";
|
|
102403
|
+
readonly description: "Payment terms code";
|
|
102404
|
+
readonly enum: readonly ["endmonth"];
|
|
102405
|
+
};
|
|
102406
|
+
};
|
|
102407
|
+
readonly additionalProperties: false;
|
|
102408
|
+
readonly required: readonly ["id"];
|
|
102409
|
+
}, {
|
|
102410
|
+
readonly type: "object";
|
|
102411
|
+
readonly title: "Upon receipt";
|
|
102412
|
+
readonly properties: {
|
|
102413
|
+
readonly id: {
|
|
102414
|
+
readonly type: "integer";
|
|
102415
|
+
readonly minimum: 1;
|
|
102416
|
+
readonly description: "Payment terms id";
|
|
102417
|
+
};
|
|
102418
|
+
readonly code: {
|
|
102419
|
+
readonly type: "string";
|
|
102420
|
+
readonly description: "Payment terms code";
|
|
102421
|
+
readonly enum: readonly ["received"];
|
|
102422
|
+
};
|
|
102423
|
+
};
|
|
102424
|
+
readonly additionalProperties: false;
|
|
102425
|
+
readonly required: readonly ["id"];
|
|
102426
|
+
}, {
|
|
102427
|
+
readonly type: "object";
|
|
102428
|
+
readonly title: "On receipt of invoice";
|
|
102429
|
+
readonly properties: {
|
|
102430
|
+
readonly id: {
|
|
102431
|
+
readonly type: "integer";
|
|
102432
|
+
readonly minimum: 1;
|
|
102433
|
+
readonly description: "Payment terms id";
|
|
102434
|
+
};
|
|
102435
|
+
readonly code: {
|
|
102436
|
+
readonly type: "string";
|
|
102437
|
+
readonly description: "Payment terms code";
|
|
102438
|
+
readonly enum: readonly ["oninvoice"];
|
|
102439
|
+
};
|
|
102440
|
+
};
|
|
102441
|
+
readonly additionalProperties: false;
|
|
102442
|
+
readonly required: readonly ["id"];
|
|
102443
|
+
}, {
|
|
102444
|
+
readonly type: "object";
|
|
102445
|
+
readonly title: "Next month";
|
|
102446
|
+
readonly properties: {
|
|
102447
|
+
readonly id: {
|
|
102448
|
+
readonly type: "integer";
|
|
102449
|
+
readonly minimum: 1;
|
|
102450
|
+
readonly description: "Payment terms id";
|
|
102451
|
+
};
|
|
102452
|
+
readonly code: {
|
|
102453
|
+
readonly type: "string";
|
|
102454
|
+
readonly description: "Payment terms code";
|
|
102455
|
+
readonly enum: readonly ["nextmonth"];
|
|
102456
|
+
};
|
|
102457
|
+
};
|
|
102458
|
+
readonly additionalProperties: false;
|
|
102459
|
+
readonly required: readonly ["id"];
|
|
102460
|
+
}, {
|
|
102461
|
+
readonly type: "object";
|
|
102462
|
+
readonly title: "30 days";
|
|
102463
|
+
readonly properties: {
|
|
102464
|
+
readonly id: {
|
|
102465
|
+
readonly type: "integer";
|
|
102466
|
+
readonly minimum: 1;
|
|
102467
|
+
readonly description: "Payment terms id";
|
|
102468
|
+
};
|
|
102469
|
+
readonly end_of_month: {
|
|
102470
|
+
readonly type: "boolean";
|
|
102471
|
+
readonly description: "Is pay deadlines at end of the month";
|
|
102472
|
+
};
|
|
102473
|
+
readonly code: {
|
|
102474
|
+
readonly type: "string";
|
|
102475
|
+
readonly description: "Payment terms code";
|
|
102476
|
+
readonly enum: readonly ["30days"];
|
|
102477
|
+
};
|
|
102478
|
+
};
|
|
102479
|
+
readonly additionalProperties: false;
|
|
102480
|
+
readonly required: readonly ["id", "end_of_month"];
|
|
102481
|
+
}, {
|
|
102482
|
+
readonly type: "object";
|
|
102483
|
+
readonly title: "45 days";
|
|
102484
|
+
readonly properties: {
|
|
102485
|
+
readonly id: {
|
|
102486
|
+
readonly type: "integer";
|
|
102487
|
+
readonly minimum: 1;
|
|
102488
|
+
readonly description: "Payment terms id";
|
|
102489
|
+
};
|
|
102490
|
+
readonly end_of_month: {
|
|
102491
|
+
readonly type: "boolean";
|
|
102492
|
+
readonly description: "Is pay deadlines at end of the month";
|
|
102493
|
+
};
|
|
102494
|
+
readonly code: {
|
|
102495
|
+
readonly type: "string";
|
|
102496
|
+
readonly description: "Payment terms code";
|
|
102497
|
+
readonly enum: readonly ["45days"];
|
|
102498
|
+
};
|
|
102499
|
+
};
|
|
102500
|
+
readonly additionalProperties: false;
|
|
102501
|
+
readonly required: readonly ["id", "end_of_month"];
|
|
102502
|
+
}, {
|
|
102503
|
+
readonly type: "object";
|
|
102504
|
+
readonly title: "60 days";
|
|
102505
|
+
readonly properties: {
|
|
102506
|
+
readonly id: {
|
|
102507
|
+
readonly type: "integer";
|
|
102508
|
+
readonly minimum: 1;
|
|
102509
|
+
readonly description: "Payment terms id";
|
|
102510
|
+
};
|
|
102511
|
+
readonly end_of_month: {
|
|
102512
|
+
readonly type: "boolean";
|
|
102513
|
+
readonly description: "Is pay deadlines at end of the month";
|
|
102514
|
+
};
|
|
102515
|
+
readonly code: {
|
|
102516
|
+
readonly type: "string";
|
|
102517
|
+
readonly description: "Payment terms code";
|
|
102518
|
+
readonly enum: readonly ["60days"];
|
|
102519
|
+
};
|
|
102520
|
+
};
|
|
102521
|
+
readonly additionalProperties: false;
|
|
102522
|
+
readonly required: readonly ["id", "end_of_month"];
|
|
102523
|
+
}, {
|
|
102524
|
+
readonly type: "object";
|
|
102525
|
+
readonly title: "X days";
|
|
102526
|
+
readonly properties: {
|
|
102527
|
+
readonly id: {
|
|
102528
|
+
readonly type: "integer";
|
|
102529
|
+
readonly minimum: 1;
|
|
102530
|
+
readonly description: "Payment terms id";
|
|
102531
|
+
};
|
|
102532
|
+
readonly x_days: {
|
|
102533
|
+
readonly type: "integer";
|
|
102534
|
+
readonly description: "Number of days for pay deadlines";
|
|
102535
|
+
readonly minimum: 0;
|
|
102536
|
+
readonly maximum: 1000;
|
|
102537
|
+
};
|
|
102538
|
+
readonly code: {
|
|
102539
|
+
readonly type: "string";
|
|
102540
|
+
readonly enum: readonly ["xdays"];
|
|
102541
|
+
};
|
|
102542
|
+
};
|
|
102543
|
+
readonly additionalProperties: false;
|
|
102544
|
+
readonly required: readonly ["id", "x_days"];
|
|
102545
|
+
}, {
|
|
102546
|
+
readonly type: "object";
|
|
102547
|
+
readonly title: "Scaled";
|
|
102548
|
+
readonly properties: {
|
|
102549
|
+
readonly id: {
|
|
102550
|
+
readonly type: "integer";
|
|
102551
|
+
readonly minimum: 1;
|
|
102552
|
+
readonly description: "Payment terms id";
|
|
102553
|
+
};
|
|
102554
|
+
readonly x_days: {
|
|
102555
|
+
readonly type: "integer";
|
|
102556
|
+
readonly description: "Number of days for pay deadlines";
|
|
102557
|
+
};
|
|
102558
|
+
readonly description: {
|
|
102559
|
+
readonly type: "string";
|
|
102560
|
+
readonly description: "Details of payment terms";
|
|
102561
|
+
readonly maxLength: 262144;
|
|
102562
|
+
};
|
|
102563
|
+
readonly code: {
|
|
102564
|
+
readonly type: "string";
|
|
102565
|
+
readonly enum: readonly ["scaled"];
|
|
102566
|
+
};
|
|
102567
|
+
};
|
|
102568
|
+
readonly additionalProperties: false;
|
|
102569
|
+
readonly required: readonly ["id", "x_days", "description"];
|
|
102570
|
+
}, {
|
|
102571
|
+
readonly type: "object";
|
|
102572
|
+
readonly title: "User defined";
|
|
102573
|
+
readonly properties: {
|
|
102574
|
+
readonly id: {
|
|
102575
|
+
readonly type: "integer";
|
|
102576
|
+
readonly minimum: 1;
|
|
102577
|
+
readonly description: "Payment terms id";
|
|
102578
|
+
};
|
|
102579
|
+
readonly due_date: {
|
|
102580
|
+
readonly type: "string";
|
|
102581
|
+
readonly format: "date";
|
|
102582
|
+
readonly description: "Due date of the payment term";
|
|
102583
|
+
readonly example: "2022-01-02";
|
|
102584
|
+
};
|
|
102585
|
+
readonly code: {
|
|
102586
|
+
readonly type: "string";
|
|
102587
|
+
readonly enum: readonly ["custom"];
|
|
102588
|
+
};
|
|
102589
|
+
};
|
|
102590
|
+
readonly additionalProperties: false;
|
|
102591
|
+
readonly required: readonly ["id", "due_date"];
|
|
102592
|
+
}];
|
|
102593
|
+
};
|
|
101858
102594
|
};
|
|
101859
102595
|
readonly required: readonly ["parent", "rows"];
|
|
101860
102596
|
};
|
|
@@ -101977,6 +102713,9 @@ declare const DepositInvoiceUpdateWritableSchema: {
|
|
|
101977
102713
|
readonly description: "Analytic code of document";
|
|
101978
102714
|
readonly example: "divers";
|
|
101979
102715
|
};
|
|
102716
|
+
readonly payment_terms: {
|
|
102717
|
+
readonly $ref: "#/components/schemas/DepositInvoiceCreate/properties/payment_terms";
|
|
102718
|
+
};
|
|
101980
102719
|
};
|
|
101981
102720
|
};
|
|
101982
102721
|
declare const DepositInvoiceOneWritableSchema: {
|