@getyetty-sdk/sellsy 2026.3.15 → 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 +1072 -268
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +554 -28
- 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
|
|
@@ -6646,29 +6650,45 @@ type Ocr = {
|
|
|
6646
6650
|
* Source of the incoming document
|
|
6647
6651
|
*/
|
|
6648
6652
|
source?: 'ocr' | 'facturx';
|
|
6653
|
+
/**
|
|
6654
|
+
* Supplier name
|
|
6655
|
+
*/
|
|
6656
|
+
supplier?: string | null;
|
|
6657
|
+
/**
|
|
6658
|
+
* Total amount excluding tax
|
|
6659
|
+
*/
|
|
6660
|
+
total_excl_tax?: string | null;
|
|
6661
|
+
/**
|
|
6662
|
+
* Currency code
|
|
6663
|
+
*/
|
|
6664
|
+
currency?: string | null;
|
|
6649
6665
|
};
|
|
6650
6666
|
/**
|
|
6651
6667
|
* Metadata
|
|
6652
6668
|
*/
|
|
6653
6669
|
type OcrPurInvoiceMetas = {
|
|
6654
6670
|
/**
|
|
6655
|
-
*
|
|
6671
|
+
* User can validate a purchase invoice
|
|
6656
6672
|
*/
|
|
6657
6673
|
user_can_validate_pur_invoice: boolean;
|
|
6658
6674
|
/**
|
|
6659
|
-
*
|
|
6675
|
+
* User can create a payment
|
|
6660
6676
|
*/
|
|
6661
6677
|
create_payment: boolean;
|
|
6662
6678
|
/**
|
|
6663
|
-
*
|
|
6679
|
+
* User can create a purchase invoice
|
|
6680
|
+
*/
|
|
6681
|
+
create_pur_invoice: boolean;
|
|
6682
|
+
/**
|
|
6683
|
+
* User can create a purchase credit note
|
|
6664
6684
|
*/
|
|
6665
|
-
|
|
6685
|
+
create_pur_credit_note: boolean;
|
|
6666
6686
|
/**
|
|
6667
|
-
*
|
|
6687
|
+
* User can create a fast purchase invoice
|
|
6668
6688
|
*/
|
|
6669
6689
|
create_fast: boolean;
|
|
6670
6690
|
/**
|
|
6671
|
-
*
|
|
6691
|
+
* User can import a purchase invoice
|
|
6672
6692
|
*/
|
|
6673
6693
|
import: boolean;
|
|
6674
6694
|
};
|
|
@@ -12324,7 +12344,8 @@ type Invoice = {
|
|
|
12324
12344
|
*/
|
|
12325
12345
|
date?: string;
|
|
12326
12346
|
/**
|
|
12327
|
-
*
|
|
12347
|
+
* Due date of the invoice.
|
|
12348
|
+
*
|
|
12328
12349
|
*/
|
|
12329
12350
|
due_date?: string;
|
|
12330
12351
|
/**
|
|
@@ -12699,7 +12720,8 @@ type InvoiceOne = {
|
|
|
12699
12720
|
*/
|
|
12700
12721
|
date?: string;
|
|
12701
12722
|
/**
|
|
12702
|
-
*
|
|
12723
|
+
* Due date of the invoice.
|
|
12724
|
+
*
|
|
12703
12725
|
*/
|
|
12704
12726
|
due_date?: string;
|
|
12705
12727
|
/**
|
|
@@ -13854,9 +13876,13 @@ type InvoiceCreate = {
|
|
|
13854
13876
|
*/
|
|
13855
13877
|
date?: string;
|
|
13856
13878
|
/**
|
|
13857
|
-
* Due date of the invoice
|
|
13879
|
+
* Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.
|
|
13880
|
+
*
|
|
13881
|
+
*
|
|
13882
|
+
* @deprecated
|
|
13858
13883
|
*/
|
|
13859
13884
|
due_date?: string;
|
|
13885
|
+
payment_terms?: _heyapi_684_;
|
|
13860
13886
|
/**
|
|
13861
13887
|
* Created date of invoice
|
|
13862
13888
|
*/
|
|
@@ -14029,7 +14055,7 @@ type InvoiceCreate = {
|
|
|
14029
14055
|
* Parent object id
|
|
14030
14056
|
*/
|
|
14031
14057
|
id?: number;
|
|
14032
|
-
} |
|
|
14058
|
+
} | _heyapi_685_ | null;
|
|
14033
14059
|
/**
|
|
14034
14060
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
14035
14061
|
*/
|
|
@@ -14099,10 +14125,6 @@ type DepositInvoiceCreate = {
|
|
|
14099
14125
|
* Date of the invoice
|
|
14100
14126
|
*/
|
|
14101
14127
|
date?: string;
|
|
14102
|
-
/**
|
|
14103
|
-
* Due date of the invoice
|
|
14104
|
-
*/
|
|
14105
|
-
due_date?: string;
|
|
14106
14128
|
/**
|
|
14107
14129
|
* Subject of the invoice
|
|
14108
14130
|
*/
|
|
@@ -14148,6 +14170,129 @@ type DepositInvoiceCreate = {
|
|
|
14148
14170
|
* Analytic code of document
|
|
14149
14171
|
*/
|
|
14150
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
|
+
};
|
|
14151
14296
|
};
|
|
14152
14297
|
/**
|
|
14153
14298
|
* Invoice
|
|
@@ -14202,7 +14347,7 @@ type DepositInvoiceUpdate = {
|
|
|
14202
14347
|
* Currency code of the invoice
|
|
14203
14348
|
*/
|
|
14204
14349
|
currency?: string;
|
|
14205
|
-
related?:
|
|
14350
|
+
related?: _heyapi_688_;
|
|
14206
14351
|
/**
|
|
14207
14352
|
* Public link of the invoice
|
|
14208
14353
|
*/
|
|
@@ -14223,6 +14368,7 @@ type DepositInvoiceUpdate = {
|
|
|
14223
14368
|
* Analytic code of document
|
|
14224
14369
|
*/
|
|
14225
14370
|
analytic_code?: string | null;
|
|
14371
|
+
payment_terms?: _heyapi_689_;
|
|
14226
14372
|
};
|
|
14227
14373
|
/**
|
|
14228
14374
|
* Prepare Deposit Invoice
|
|
@@ -14305,8 +14451,8 @@ type DepositInvoicePrepareOutput = {
|
|
|
14305
14451
|
}>;
|
|
14306
14452
|
};
|
|
14307
14453
|
type DepositInvoiceOne = _heyapi_535_ & {
|
|
14308
|
-
rows?: Array<
|
|
14309
|
-
_embed?:
|
|
14454
|
+
rows?: Array<_heyapi_693_ | _heyapi_396_ | _heyapi_397_>;
|
|
14455
|
+
_embed?: _heyapi_694_;
|
|
14310
14456
|
};
|
|
14311
14457
|
/**
|
|
14312
14458
|
* Deposit Invoices filters
|
|
@@ -14314,7 +14460,7 @@ type DepositInvoiceOne = _heyapi_535_ & {
|
|
|
14314
14460
|
* Deposit Invoices filters
|
|
14315
14461
|
*/
|
|
14316
14462
|
type DepositInvoiceFilter = {
|
|
14317
|
-
filters:
|
|
14463
|
+
filters: _heyapi_696_;
|
|
14318
14464
|
};
|
|
14319
14465
|
/**
|
|
14320
14466
|
* Progress Invoice
|
|
@@ -14383,13 +14529,13 @@ type ProgressInvoiceCreate = {
|
|
|
14383
14529
|
* Bar code ID for progress-catalog row
|
|
14384
14530
|
*/
|
|
14385
14531
|
sku_id?: number | null;
|
|
14386
|
-
}) | (
|
|
14532
|
+
}) | (_heyapi_698_ & {
|
|
14387
14533
|
type?: 'progress-single';
|
|
14388
14534
|
/**
|
|
14389
14535
|
* Purchase amount
|
|
14390
14536
|
*/
|
|
14391
14537
|
purchase_amount?: string;
|
|
14392
|
-
}) | (
|
|
14538
|
+
}) | (_heyapi_698_ & {
|
|
14393
14539
|
type?: 'progress-shipping' | 'progress-packaging';
|
|
14394
14540
|
}) | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
14395
14541
|
/**
|
|
@@ -14650,7 +14796,7 @@ type ProgressInvoiceCreate = {
|
|
|
14650
14796
|
* Show progress invoice summary
|
|
14651
14797
|
*/
|
|
14652
14798
|
show_progress_invoice_summary?: boolean;
|
|
14653
|
-
} &
|
|
14799
|
+
} & _heyapi_699_;
|
|
14654
14800
|
} & _heyapi_442_;
|
|
14655
14801
|
/**
|
|
14656
14802
|
* Date of the shipping
|
|
@@ -14702,7 +14848,7 @@ type ProgressInvoiceCompute = {
|
|
|
14702
14848
|
* Rows of the progress invoice. There must be at least one progress row.
|
|
14703
14849
|
*
|
|
14704
14850
|
*/
|
|
14705
|
-
rows: Array<_heyapi_398_ |
|
|
14851
|
+
rows: Array<_heyapi_398_ | _heyapi_701_ | _heyapi_702_ | _heyapi_703_ | _heyapi_396_ | ({
|
|
14706
14852
|
/**
|
|
14707
14853
|
* ID of the progress invoice row
|
|
14708
14854
|
*/
|
|
@@ -14736,12 +14882,12 @@ type ProgressInvoiceCompute = {
|
|
|
14736
14882
|
* Bar code ID for progress-catalog row
|
|
14737
14883
|
*/
|
|
14738
14884
|
sku_id?: number | null;
|
|
14739
|
-
}) | (
|
|
14885
|
+
}) | (_heyapi_704_ & {
|
|
14740
14886
|
/**
|
|
14741
14887
|
* Purchase amount
|
|
14742
14888
|
*/
|
|
14743
14889
|
purchase_amount?: string;
|
|
14744
|
-
}) |
|
|
14890
|
+
}) | _heyapi_704_ | {
|
|
14745
14891
|
/**
|
|
14746
14892
|
* Row Identifier
|
|
14747
14893
|
*/
|
|
@@ -14965,11 +15111,11 @@ type ComputedProgresssInvoice = {
|
|
|
14965
15111
|
/**
|
|
14966
15112
|
* Credit notes linked to the invoice
|
|
14967
15113
|
*/
|
|
14968
|
-
credit_notes?: Array<
|
|
15114
|
+
credit_notes?: Array<_heyapi_706_>;
|
|
14969
15115
|
}>;
|
|
14970
15116
|
};
|
|
14971
|
-
type InvoiceUpdate =
|
|
14972
|
-
rows?: Array<
|
|
15117
|
+
type InvoiceUpdate = _heyapi_708_ & {
|
|
15118
|
+
rows?: Array<_heyapi_709_> | null;
|
|
14973
15119
|
settings?: _heyapi_442_;
|
|
14974
15120
|
};
|
|
14975
15121
|
type ValidateInvoice = {
|
|
@@ -15218,9 +15364,9 @@ type CreditNote = {
|
|
|
15218
15364
|
/**
|
|
15219
15365
|
* Credit Note Embed
|
|
15220
15366
|
*/
|
|
15221
|
-
_embed?:
|
|
15367
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
15222
15368
|
fiscal_year?: _heyapi_448_;
|
|
15223
|
-
currency?:
|
|
15369
|
+
currency?: _heyapi_713_;
|
|
15224
15370
|
owner?: _heyapi_408_;
|
|
15225
15371
|
/**
|
|
15226
15372
|
* Credit Note ACL
|
|
@@ -15481,10 +15627,10 @@ type CreditNoteOne = {
|
|
|
15481
15627
|
* Analytic code of document
|
|
15482
15628
|
*/
|
|
15483
15629
|
analytic_code?: string | null;
|
|
15484
|
-
_embed?:
|
|
15630
|
+
_embed?: _heyapi_715_;
|
|
15485
15631
|
} & {
|
|
15486
15632
|
rows?: Array<_heyapi_452_>;
|
|
15487
|
-
_embed?:
|
|
15633
|
+
_embed?: _heyapi_715_ & _heyapi_674_ & {
|
|
15488
15634
|
file?: _heyapi_595_;
|
|
15489
15635
|
};
|
|
15490
15636
|
};
|
|
@@ -15588,14 +15734,14 @@ type CreditNoteCreate = {
|
|
|
15588
15734
|
issuer_address_id?: number;
|
|
15589
15735
|
} & {
|
|
15590
15736
|
rows?: Array<_heyapi_452_> | null;
|
|
15591
|
-
parent?:
|
|
15737
|
+
parent?: _heyapi_685_ | null;
|
|
15592
15738
|
/**
|
|
15593
15739
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
15594
15740
|
*/
|
|
15595
15741
|
rate_category_id?: number;
|
|
15596
15742
|
};
|
|
15597
|
-
type CreditNoteUpdate =
|
|
15598
|
-
rows?: Array<
|
|
15743
|
+
type CreditNoteUpdate = _heyapi_718_ & {
|
|
15744
|
+
rows?: Array<_heyapi_709_> | null;
|
|
15599
15745
|
};
|
|
15600
15746
|
type CreditNoteValidate = {
|
|
15601
15747
|
/**
|
|
@@ -15880,15 +16026,15 @@ type OrderCreate = {
|
|
|
15880
16026
|
shipping_volume?: string;
|
|
15881
16027
|
} & {
|
|
15882
16028
|
rows?: Array<_heyapi_452_> | null;
|
|
15883
|
-
parent?:
|
|
16029
|
+
parent?: _heyapi_685_ | null;
|
|
15884
16030
|
/**
|
|
15885
16031
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
15886
16032
|
*/
|
|
15887
16033
|
rate_category_id?: number;
|
|
15888
16034
|
settings?: _heyapi_442_;
|
|
15889
16035
|
};
|
|
15890
|
-
type OrderUpdate =
|
|
15891
|
-
rows?: Array<
|
|
16036
|
+
type OrderUpdate = _heyapi_724_ & {
|
|
16037
|
+
rows?: Array<_heyapi_709_> | null;
|
|
15892
16038
|
settings?: _heyapi_442_;
|
|
15893
16039
|
};
|
|
15894
16040
|
/**
|
|
@@ -16096,7 +16242,7 @@ type Order = {
|
|
|
16096
16242
|
/**
|
|
16097
16243
|
* Order Embed
|
|
16098
16244
|
*/
|
|
16099
|
-
_embed?:
|
|
16245
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
16100
16246
|
/**
|
|
16101
16247
|
* Order ACL
|
|
16102
16248
|
*/
|
|
@@ -16112,7 +16258,7 @@ type Order = {
|
|
|
16112
16258
|
};
|
|
16113
16259
|
owner?: _heyapi_408_;
|
|
16114
16260
|
fiscal_year?: _heyapi_448_;
|
|
16115
|
-
currency?:
|
|
16261
|
+
currency?: _heyapi_713_;
|
|
16116
16262
|
/**
|
|
16117
16263
|
* Smart-tags linked
|
|
16118
16264
|
*/
|
|
@@ -16374,7 +16520,7 @@ type OrderOne = {
|
|
|
16374
16520
|
* Notes of the order
|
|
16375
16521
|
*/
|
|
16376
16522
|
note?: string;
|
|
16377
|
-
_embed?:
|
|
16523
|
+
_embed?: _heyapi_727_;
|
|
16378
16524
|
/**
|
|
16379
16525
|
* Date of the shipping
|
|
16380
16526
|
*/
|
|
@@ -16422,7 +16568,7 @@ type OrderOne = {
|
|
|
16422
16568
|
/**
|
|
16423
16569
|
* Order Embed
|
|
16424
16570
|
*/
|
|
16425
|
-
_embed?:
|
|
16571
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
16426
16572
|
/**
|
|
16427
16573
|
* Document Payment Terms
|
|
16428
16574
|
*
|
|
@@ -16463,7 +16609,7 @@ type OrderOne = {
|
|
|
16463
16609
|
};
|
|
16464
16610
|
owner?: _heyapi_408_;
|
|
16465
16611
|
fiscal_year?: _heyapi_448_;
|
|
16466
|
-
currency?:
|
|
16612
|
+
currency?: _heyapi_713_;
|
|
16467
16613
|
/**
|
|
16468
16614
|
* Smart-tags linked
|
|
16469
16615
|
*/
|
|
@@ -16851,7 +16997,7 @@ type Delivery = {
|
|
|
16851
16997
|
/**
|
|
16852
16998
|
* Delivery Embed
|
|
16853
16999
|
*/
|
|
16854
|
-
_embed?:
|
|
17000
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
16855
17001
|
/**
|
|
16856
17002
|
* Delivery ACL
|
|
16857
17003
|
*/
|
|
@@ -16867,7 +17013,7 @@ type Delivery = {
|
|
|
16867
17013
|
};
|
|
16868
17014
|
owner?: _heyapi_408_;
|
|
16869
17015
|
fiscal_year?: _heyapi_448_;
|
|
16870
|
-
currency?:
|
|
17016
|
+
currency?: _heyapi_713_;
|
|
16871
17017
|
/**
|
|
16872
17018
|
* Smart-tags linked
|
|
16873
17019
|
*/
|
|
@@ -17105,10 +17251,10 @@ type DeliveryOne = {
|
|
|
17105
17251
|
* Total volume of product to ship in m3
|
|
17106
17252
|
*/
|
|
17107
17253
|
shipping_volume?: string;
|
|
17108
|
-
_embed?:
|
|
17254
|
+
_embed?: _heyapi_732_;
|
|
17109
17255
|
} & {
|
|
17110
17256
|
rows?: Array<_heyapi_452_>;
|
|
17111
|
-
_embed?:
|
|
17257
|
+
_embed?: _heyapi_732_ & {
|
|
17112
17258
|
file?: _heyapi_595_;
|
|
17113
17259
|
};
|
|
17114
17260
|
};
|
|
@@ -17558,7 +17704,7 @@ type ImportPrepareInput = {
|
|
|
17558
17704
|
* List of identifiers
|
|
17559
17705
|
*/
|
|
17560
17706
|
service: ['id' | 'reference'];
|
|
17561
|
-
} |
|
|
17707
|
+
} | _heyapi_748_ | {
|
|
17562
17708
|
/**
|
|
17563
17709
|
* List of identifiers
|
|
17564
17710
|
*/
|
|
@@ -18155,7 +18301,7 @@ type ImportPrepareInput = {
|
|
|
18155
18301
|
/**
|
|
18156
18302
|
* Rate category ids and corresponding prices
|
|
18157
18303
|
*/
|
|
18158
|
-
prices?: Array<
|
|
18304
|
+
prices?: Array<_heyapi_749_>;
|
|
18159
18305
|
} | {
|
|
18160
18306
|
/**
|
|
18161
18307
|
* Row id
|
|
@@ -18236,11 +18382,11 @@ type ImportValidateInput = {
|
|
|
18236
18382
|
* Batch id
|
|
18237
18383
|
*/
|
|
18238
18384
|
batch_id: string;
|
|
18239
|
-
metadata:
|
|
18385
|
+
metadata: _heyapi_751_;
|
|
18240
18386
|
/**
|
|
18241
18387
|
* Rows to validate
|
|
18242
18388
|
*/
|
|
18243
|
-
data: Array<
|
|
18389
|
+
data: Array<_heyapi_752_ | _heyapi_753_ | _heyapi_754_ | _heyapi_755_ | _heyapi_756_ | _heyapi_757_ | _heyapi_758_>;
|
|
18244
18390
|
};
|
|
18245
18391
|
/**
|
|
18246
18392
|
* Import
|
|
@@ -18496,8 +18642,8 @@ type UpdateCompanyPreferences = {
|
|
|
18496
18642
|
value: 'id';
|
|
18497
18643
|
id: number;
|
|
18498
18644
|
};
|
|
18499
|
-
invoice?:
|
|
18500
|
-
proforma?:
|
|
18645
|
+
invoice?: _heyapi_762_ | _heyapi_763_ | _heyapi_764_;
|
|
18646
|
+
proforma?: _heyapi_762_ | _heyapi_763_ | _heyapi_764_;
|
|
18501
18647
|
};
|
|
18502
18648
|
/**
|
|
18503
18649
|
* Id of the rate category selected.
|
|
@@ -18526,7 +18672,7 @@ type IndividualPreferences = {
|
|
|
18526
18672
|
*/
|
|
18527
18673
|
label?: string;
|
|
18528
18674
|
} | null;
|
|
18529
|
-
tax?:
|
|
18675
|
+
tax?: _heyapi_766_;
|
|
18530
18676
|
/**
|
|
18531
18677
|
* Individual preferred pay date.
|
|
18532
18678
|
*/
|
|
@@ -18713,8 +18859,8 @@ type UpdateIndividualPreferences = {
|
|
|
18713
18859
|
value: 'id';
|
|
18714
18860
|
id: number;
|
|
18715
18861
|
};
|
|
18716
|
-
invoice?:
|
|
18717
|
-
proforma?:
|
|
18862
|
+
invoice?: _heyapi_768_ | _heyapi_769_ | _heyapi_770_;
|
|
18863
|
+
proforma?: _heyapi_768_ | _heyapi_769_ | _heyapi_770_;
|
|
18718
18864
|
};
|
|
18719
18865
|
/**
|
|
18720
18866
|
* Id of the rate category selected.
|
|
@@ -18982,8 +19128,8 @@ type SubscriptionCreate = {
|
|
|
18982
19128
|
* - An optional contact can be added, it must be linked to the provided company.
|
|
18983
19129
|
*
|
|
18984
19130
|
*/
|
|
18985
|
-
related: Array<
|
|
18986
|
-
sending:
|
|
19131
|
+
related: Array<_heyapi_774_>;
|
|
19132
|
+
sending: _heyapi_775_;
|
|
18987
19133
|
/**
|
|
18988
19134
|
* Source of payment preferences
|
|
18989
19135
|
*/
|
|
@@ -19001,7 +19147,7 @@ type SubscriptionCreate = {
|
|
|
19001
19147
|
/**
|
|
19002
19148
|
* Interval for subscription deadlines
|
|
19003
19149
|
*/
|
|
19004
|
-
interval:
|
|
19150
|
+
interval: _heyapi_776_ | _heyapi_777_ | _heyapi_778_;
|
|
19005
19151
|
};
|
|
19006
19152
|
/**
|
|
19007
19153
|
* Subscription payment installments to be generated
|
|
@@ -19159,9 +19305,9 @@ type ObjectiveCollectionOutput = {
|
|
|
19159
19305
|
* Objective name
|
|
19160
19306
|
*/
|
|
19161
19307
|
name: string;
|
|
19162
|
-
category:
|
|
19163
|
-
turnover:
|
|
19164
|
-
period:
|
|
19308
|
+
category: _heyapi_782_;
|
|
19309
|
+
turnover: _heyapi_783_;
|
|
19310
|
+
period: _heyapi_784_;
|
|
19165
19311
|
item: {
|
|
19166
19312
|
/**
|
|
19167
19313
|
* linked Item id
|
|
@@ -19172,16 +19318,16 @@ type ObjectiveCollectionOutput = {
|
|
|
19172
19318
|
*/
|
|
19173
19319
|
name: string;
|
|
19174
19320
|
} | null;
|
|
19175
|
-
item_category:
|
|
19321
|
+
item_category: _heyapi_785_;
|
|
19176
19322
|
/**
|
|
19177
19323
|
* Refinements of the objective
|
|
19178
19324
|
*/
|
|
19179
19325
|
refinements: Array<{
|
|
19180
|
-
period?:
|
|
19181
|
-
turnover?:
|
|
19326
|
+
period?: _heyapi_784_;
|
|
19327
|
+
turnover?: _heyapi_783_;
|
|
19182
19328
|
}>;
|
|
19183
|
-
assignee:
|
|
19184
|
-
links:
|
|
19329
|
+
assignee: _heyapi_786_;
|
|
19330
|
+
links: _heyapi_787_;
|
|
19185
19331
|
} & {
|
|
19186
19332
|
_embed?: {
|
|
19187
19333
|
created_by?: _heyapi_408_;
|
|
@@ -19202,8 +19348,8 @@ type ObjectiveTurnoverInput = {
|
|
|
19202
19348
|
* Code of an existing objective category
|
|
19203
19349
|
*/
|
|
19204
19350
|
category: 'turnover' | 'forecast_turnover';
|
|
19205
|
-
period:
|
|
19206
|
-
assignee:
|
|
19351
|
+
period: _heyapi_784_;
|
|
19352
|
+
assignee: _heyapi_789_;
|
|
19207
19353
|
} & unknown & {
|
|
19208
19354
|
/**
|
|
19209
19355
|
* Linked item id
|
|
@@ -19249,7 +19395,7 @@ type ObjectiveTurnoverInput = {
|
|
|
19249
19395
|
*/
|
|
19250
19396
|
date_end: string;
|
|
19251
19397
|
};
|
|
19252
|
-
turnover?:
|
|
19398
|
+
turnover?: _heyapi_790_;
|
|
19253
19399
|
}>;
|
|
19254
19400
|
};
|
|
19255
19401
|
/**
|
|
@@ -19319,8 +19465,8 @@ type ObjectiveOutput = {
|
|
|
19319
19465
|
* Turnover
|
|
19320
19466
|
*/
|
|
19321
19467
|
turnover: {
|
|
19322
|
-
expected:
|
|
19323
|
-
actual:
|
|
19468
|
+
expected: _heyapi_790_;
|
|
19469
|
+
actual: _heyapi_790_;
|
|
19324
19470
|
/**
|
|
19325
19471
|
* Progression of the objective
|
|
19326
19472
|
*/
|
|
@@ -19334,7 +19480,7 @@ type ObjectiveOutput = {
|
|
|
19334
19480
|
*/
|
|
19335
19481
|
days_left: number;
|
|
19336
19482
|
};
|
|
19337
|
-
period:
|
|
19483
|
+
period: _heyapi_784_;
|
|
19338
19484
|
item: {
|
|
19339
19485
|
/**
|
|
19340
19486
|
* linked Item id
|
|
@@ -19359,8 +19505,8 @@ type ObjectiveOutput = {
|
|
|
19359
19505
|
* Refinements of the objective
|
|
19360
19506
|
*/
|
|
19361
19507
|
refinements: Array<{
|
|
19362
|
-
period?:
|
|
19363
|
-
turnover?:
|
|
19508
|
+
period?: _heyapi_784_;
|
|
19509
|
+
turnover?: _heyapi_783_;
|
|
19364
19510
|
}>;
|
|
19365
19511
|
/**
|
|
19366
19512
|
* Assignee
|
|
@@ -19381,7 +19527,7 @@ type ObjectiveOutput = {
|
|
|
19381
19527
|
*/
|
|
19382
19528
|
name?: string;
|
|
19383
19529
|
};
|
|
19384
|
-
links:
|
|
19530
|
+
links: _heyapi_787_;
|
|
19385
19531
|
};
|
|
19386
19532
|
/**
|
|
19387
19533
|
* objective metadatas
|
|
@@ -19392,7 +19538,7 @@ type ObjectiveMetadata = {
|
|
|
19392
19538
|
*/
|
|
19393
19539
|
turnover?: {
|
|
19394
19540
|
data?: {
|
|
19395
|
-
category:
|
|
19541
|
+
category: _heyapi_782_;
|
|
19396
19542
|
currency: string;
|
|
19397
19543
|
assignees_types: Array<{
|
|
19398
19544
|
value: string;
|
|
@@ -19400,14 +19546,14 @@ type ObjectiveMetadata = {
|
|
|
19400
19546
|
order: number;
|
|
19401
19547
|
}>;
|
|
19402
19548
|
assignees: Array<{
|
|
19403
|
-
groups?: Array<
|
|
19404
|
-
staffs?: Array<
|
|
19549
|
+
groups?: Array<_heyapi_794_>;
|
|
19550
|
+
staffs?: Array<_heyapi_794_>;
|
|
19405
19551
|
}>;
|
|
19406
|
-
item_categories: Array<
|
|
19552
|
+
item_categories: Array<_heyapi_794_ & {
|
|
19407
19553
|
parent?: number | null;
|
|
19408
19554
|
logo?: string | null;
|
|
19409
19555
|
}>;
|
|
19410
|
-
durations: Array<
|
|
19556
|
+
durations: Array<_heyapi_794_ & {
|
|
19411
19557
|
period?: {
|
|
19412
19558
|
/**
|
|
19413
19559
|
* The start date
|
|
@@ -19436,20 +19582,20 @@ type ObjectiveMetadata = {
|
|
|
19436
19582
|
/**
|
|
19437
19583
|
* List of Assignees
|
|
19438
19584
|
*/
|
|
19439
|
-
assignee?: Array<
|
|
19585
|
+
assignee?: Array<_heyapi_795_>;
|
|
19440
19586
|
/**
|
|
19441
19587
|
* List of Categories
|
|
19442
19588
|
*/
|
|
19443
|
-
category?: Array<
|
|
19589
|
+
category?: Array<_heyapi_796_>;
|
|
19444
19590
|
};
|
|
19445
19591
|
metadata?: {
|
|
19446
19592
|
choose_product?: boolean;
|
|
19447
19593
|
create_new_staff?: boolean;
|
|
19448
19594
|
create_new_group?: boolean;
|
|
19449
19595
|
};
|
|
19450
|
-
_links?:
|
|
19596
|
+
_links?: _heyapi_787_;
|
|
19451
19597
|
};
|
|
19452
|
-
forecast_turnover?:
|
|
19598
|
+
forecast_turnover?: _heyapi_797_;
|
|
19453
19599
|
};
|
|
19454
19600
|
/**
|
|
19455
19601
|
* objective metadatas upsell
|
|
@@ -19460,7 +19606,7 @@ type ObjectiveMetadataUpsell = {
|
|
|
19460
19606
|
*/
|
|
19461
19607
|
turnover?: {
|
|
19462
19608
|
data?: {
|
|
19463
|
-
assignees_types: Array<
|
|
19609
|
+
assignees_types: Array<_heyapi_794_ & {
|
|
19464
19610
|
/**
|
|
19465
19611
|
* upsell
|
|
19466
19612
|
*/
|
|
@@ -19472,11 +19618,11 @@ type ObjectiveMetadataUpsell = {
|
|
|
19472
19618
|
};
|
|
19473
19619
|
metadata?: {
|
|
19474
19620
|
choose_product: {
|
|
19475
|
-
upsell:
|
|
19621
|
+
upsell: _heyapi_799_;
|
|
19476
19622
|
};
|
|
19477
19623
|
};
|
|
19478
19624
|
};
|
|
19479
|
-
forecast_turnover?:
|
|
19625
|
+
forecast_turnover?: _heyapi_800_;
|
|
19480
19626
|
};
|
|
19481
19627
|
type ObjectiveComputeTurnoverInput = {
|
|
19482
19628
|
/**
|
|
@@ -19486,7 +19632,7 @@ type ObjectiveComputeTurnoverInput = {
|
|
|
19486
19632
|
/**
|
|
19487
19633
|
* Period used to compute the turnover
|
|
19488
19634
|
*/
|
|
19489
|
-
period:
|
|
19635
|
+
period: _heyapi_784_;
|
|
19490
19636
|
/**
|
|
19491
19637
|
* linked item id used to compute the turnover
|
|
19492
19638
|
*/
|
|
@@ -19515,11 +19661,11 @@ type ObjectiveComputeTurnoverOutput = Array<{
|
|
|
19515
19661
|
/**
|
|
19516
19662
|
* Period used to compute the turnover
|
|
19517
19663
|
*/
|
|
19518
|
-
period:
|
|
19664
|
+
period: _heyapi_784_;
|
|
19519
19665
|
/**
|
|
19520
19666
|
* The computed turnover
|
|
19521
19667
|
*/
|
|
19522
|
-
turnover:
|
|
19668
|
+
turnover: _heyapi_790_;
|
|
19523
19669
|
}>;
|
|
19524
19670
|
/**
|
|
19525
19671
|
* ObjectiveTurnoverUpdateInput
|
|
@@ -19529,13 +19675,13 @@ type ObjectiveTurnoverUpdateInput = {
|
|
|
19529
19675
|
* Objective name
|
|
19530
19676
|
*/
|
|
19531
19677
|
name: string;
|
|
19532
|
-
turnover:
|
|
19678
|
+
turnover: _heyapi_790_;
|
|
19533
19679
|
/**
|
|
19534
19680
|
* Refinements of the objective
|
|
19535
19681
|
*/
|
|
19536
19682
|
refinements: Array<{
|
|
19537
|
-
period?:
|
|
19538
|
-
turnover?:
|
|
19683
|
+
period?: _heyapi_784_;
|
|
19684
|
+
turnover?: _heyapi_790_;
|
|
19539
19685
|
}>;
|
|
19540
19686
|
};
|
|
19541
19687
|
/**
|
|
@@ -19769,16 +19915,16 @@ type MarketingAttributeDiffOutput = {
|
|
|
19769
19915
|
/**
|
|
19770
19916
|
* List of new Marketing Attributes to create
|
|
19771
19917
|
*/
|
|
19772
|
-
create: Array<
|
|
19918
|
+
create: Array<_heyapi_811_>;
|
|
19773
19919
|
/**
|
|
19774
19920
|
* List of previous Marketing Attributes to delete
|
|
19775
19921
|
*/
|
|
19776
|
-
delete: Array<
|
|
19922
|
+
delete: Array<_heyapi_811_>;
|
|
19777
19923
|
/**
|
|
19778
19924
|
* List of Marketing Attributes unchanged
|
|
19779
19925
|
*/
|
|
19780
|
-
void: Array<
|
|
19781
|
-
links:
|
|
19926
|
+
void: Array<_heyapi_811_>;
|
|
19927
|
+
links: _heyapi_812_;
|
|
19782
19928
|
};
|
|
19783
19929
|
/**
|
|
19784
19930
|
* Discount including taxes
|
|
@@ -19822,7 +19968,7 @@ type ConsentSettingsOuput = {
|
|
|
19822
19968
|
href: string;
|
|
19823
19969
|
}>;
|
|
19824
19970
|
};
|
|
19825
|
-
type ConsentSettingsInput =
|
|
19971
|
+
type ConsentSettingsInput = _heyapi_816_;
|
|
19826
19972
|
/**
|
|
19827
19973
|
* The marketing consent settings
|
|
19828
19974
|
*/
|
|
@@ -19850,9 +19996,9 @@ type ProgressInvoiceMetadata = {
|
|
|
19850
19996
|
* Progress invoice mode
|
|
19851
19997
|
*/
|
|
19852
19998
|
progress_invoice_mode?: 'global' | 'per-line';
|
|
19853
|
-
}) | (
|
|
19999
|
+
}) | (_heyapi_819_ & {
|
|
19854
20000
|
rows?: Array<_heyapi_452_>;
|
|
19855
|
-
_embed?:
|
|
20001
|
+
_embed?: _heyapi_820_;
|
|
19856
20002
|
} & {
|
|
19857
20003
|
/**
|
|
19858
20004
|
* Rate category with taxes included
|
|
@@ -19867,12 +20013,12 @@ type ProgressInvoiceMetadata = {
|
|
|
19867
20013
|
* Invoice related to the progress invoice, exist only if invoice type is used
|
|
19868
20014
|
*/
|
|
19869
20015
|
invoice?: (_heyapi_535_ & {
|
|
19870
|
-
rows?: Array<
|
|
20016
|
+
rows?: Array<_heyapi_821_ | _heyapi_822_ | _heyapi_823_ | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
19871
20017
|
/**
|
|
19872
20018
|
* The next available progress invoice number
|
|
19873
20019
|
*/
|
|
19874
20020
|
next_progress_invoice_number?: number | null;
|
|
19875
|
-
_embed?:
|
|
20021
|
+
_embed?: _heyapi_824_;
|
|
19876
20022
|
} & {
|
|
19877
20023
|
/**
|
|
19878
20024
|
* Rate category with taxes included
|
|
@@ -20085,11 +20231,11 @@ type ProgressInvoiceMetadata = {
|
|
|
20085
20231
|
/**
|
|
20086
20232
|
* List of document layouts
|
|
20087
20233
|
*/
|
|
20088
|
-
document_layouts?: Array<
|
|
20234
|
+
document_layouts?: Array<_heyapi_825_>;
|
|
20089
20235
|
/**
|
|
20090
20236
|
* List of languages
|
|
20091
20237
|
*/
|
|
20092
|
-
languages?: Array<
|
|
20238
|
+
languages?: Array<_heyapi_826_>;
|
|
20093
20239
|
/**
|
|
20094
20240
|
* Tax with embed
|
|
20095
20241
|
*
|
|
@@ -20302,7 +20448,7 @@ type ProgressInvoiceMetadata = {
|
|
|
20302
20448
|
/**
|
|
20303
20449
|
* Payment term translations
|
|
20304
20450
|
*/
|
|
20305
|
-
translations?: Array<
|
|
20451
|
+
translations?: Array<_heyapi_827_>;
|
|
20306
20452
|
};
|
|
20307
20453
|
}>;
|
|
20308
20454
|
/**
|
|
@@ -20325,7 +20471,7 @@ type ProgressInvoiceMetadata = {
|
|
|
20325
20471
|
/**
|
|
20326
20472
|
* Assigned staff translations
|
|
20327
20473
|
*/
|
|
20328
|
-
translations?: Array<
|
|
20474
|
+
translations?: Array<_heyapi_828_>;
|
|
20329
20475
|
};
|
|
20330
20476
|
}>;
|
|
20331
20477
|
/**
|
|
@@ -20500,11 +20646,11 @@ type ProgressInvoiceMetadata = {
|
|
|
20500
20646
|
/**
|
|
20501
20647
|
* Summary of all document history (includes current document)
|
|
20502
20648
|
*/
|
|
20503
|
-
summary?: Array<
|
|
20649
|
+
summary?: Array<_heyapi_706_ & {
|
|
20504
20650
|
/**
|
|
20505
20651
|
* Credit notes linked to the invoice
|
|
20506
20652
|
*/
|
|
20507
|
-
credit_notes?: Array<
|
|
20653
|
+
credit_notes?: Array<_heyapi_706_>;
|
|
20508
20654
|
}>;
|
|
20509
20655
|
};
|
|
20510
20656
|
/**
|
|
@@ -20550,7 +20696,7 @@ type ProgressInvoiceMetadata = {
|
|
|
20550
20696
|
* Update Progress Invoice
|
|
20551
20697
|
*/
|
|
20552
20698
|
type ProgressInvoiceUpdate = {
|
|
20553
|
-
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_ | {
|
|
20554
20700
|
/**
|
|
20555
20701
|
* Row Identifier
|
|
20556
20702
|
*/
|
|
@@ -20678,8 +20824,8 @@ type ProgressInvoiceUpdate = {
|
|
|
20678
20824
|
*/
|
|
20679
20825
|
shipping_volume?: string;
|
|
20680
20826
|
shipping_weight?: _heyapi_433_;
|
|
20681
|
-
payment_terms?:
|
|
20682
|
-
settings?:
|
|
20827
|
+
payment_terms?: _heyapi_684_;
|
|
20828
|
+
settings?: _heyapi_832_;
|
|
20683
20829
|
/**
|
|
20684
20830
|
* Analytic code of document
|
|
20685
20831
|
*/
|
|
@@ -20849,7 +20995,7 @@ type ProposalModel = {
|
|
|
20849
20995
|
/**
|
|
20850
20996
|
* Proposal document
|
|
20851
20997
|
*/
|
|
20852
|
-
type ProposalDocument =
|
|
20998
|
+
type ProposalDocument = _heyapi_839_ & {
|
|
20853
20999
|
/**
|
|
20854
21000
|
* Proposal document link
|
|
20855
21001
|
*/
|
|
@@ -24617,6 +24763,10 @@ type DealsWritable = {
|
|
|
24617
24763
|
* Priority level of the calendar event
|
|
24618
24764
|
*/
|
|
24619
24765
|
priority?: number;
|
|
24766
|
+
/**
|
|
24767
|
+
* Meet link for the calendar event
|
|
24768
|
+
*/
|
|
24769
|
+
meet_link?: string | null;
|
|
24620
24770
|
} | (_heyapi_480_ & {
|
|
24621
24771
|
/**
|
|
24622
24772
|
* Short description
|
|
@@ -25213,6 +25363,18 @@ type OcrWritable = {
|
|
|
25213
25363
|
* Source of the incoming document
|
|
25214
25364
|
*/
|
|
25215
25365
|
source?: 'ocr' | 'facturx';
|
|
25366
|
+
/**
|
|
25367
|
+
* Supplier name
|
|
25368
|
+
*/
|
|
25369
|
+
supplier?: string | null;
|
|
25370
|
+
/**
|
|
25371
|
+
* Total amount excluding tax
|
|
25372
|
+
*/
|
|
25373
|
+
total_excl_tax?: string | null;
|
|
25374
|
+
/**
|
|
25375
|
+
* Currency code
|
|
25376
|
+
*/
|
|
25377
|
+
currency?: string | null;
|
|
25216
25378
|
};
|
|
25217
25379
|
/**
|
|
25218
25380
|
* conformityState
|
|
@@ -26745,7 +26907,8 @@ type InvoiceWritable = {
|
|
|
26745
26907
|
*/
|
|
26746
26908
|
date?: string;
|
|
26747
26909
|
/**
|
|
26748
|
-
*
|
|
26910
|
+
* Due date of the invoice.
|
|
26911
|
+
*
|
|
26749
26912
|
*/
|
|
26750
26913
|
due_date?: string;
|
|
26751
26914
|
/**
|
|
@@ -26996,7 +27159,8 @@ type InvoiceOneWritable = {
|
|
|
26996
27159
|
*/
|
|
26997
27160
|
date?: string;
|
|
26998
27161
|
/**
|
|
26999
|
-
*
|
|
27162
|
+
* Due date of the invoice.
|
|
27163
|
+
*
|
|
27000
27164
|
*/
|
|
27001
27165
|
due_date?: string;
|
|
27002
27166
|
/**
|
|
@@ -27746,9 +27910,13 @@ type InvoiceCreateWritable = {
|
|
|
27746
27910
|
*/
|
|
27747
27911
|
date?: string;
|
|
27748
27912
|
/**
|
|
27749
|
-
* Due date of the invoice
|
|
27913
|
+
* Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.
|
|
27914
|
+
*
|
|
27915
|
+
*
|
|
27916
|
+
* @deprecated
|
|
27750
27917
|
*/
|
|
27751
27918
|
due_date?: string;
|
|
27919
|
+
payment_terms?: _heyapi_684_;
|
|
27752
27920
|
/**
|
|
27753
27921
|
* Created date of invoice
|
|
27754
27922
|
*/
|
|
@@ -27921,7 +28089,7 @@ type InvoiceCreateWritable = {
|
|
|
27921
28089
|
* Parent object id
|
|
27922
28090
|
*/
|
|
27923
28091
|
id?: number;
|
|
27924
|
-
} |
|
|
28092
|
+
} | _heyapi_685_ | null;
|
|
27925
28093
|
/**
|
|
27926
28094
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
27927
28095
|
*/
|
|
@@ -27991,10 +28159,6 @@ type DepositInvoiceCreateWritable = {
|
|
|
27991
28159
|
* Date of the invoice
|
|
27992
28160
|
*/
|
|
27993
28161
|
date?: string;
|
|
27994
|
-
/**
|
|
27995
|
-
* Due date of the invoice
|
|
27996
|
-
*/
|
|
27997
|
-
due_date?: string;
|
|
27998
28162
|
/**
|
|
27999
28163
|
* Subject of the invoice
|
|
28000
28164
|
*/
|
|
@@ -28040,6 +28204,129 @@ type DepositInvoiceCreateWritable = {
|
|
|
28040
28204
|
* Analytic code of document
|
|
28041
28205
|
*/
|
|
28042
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
|
+
};
|
|
28043
28330
|
};
|
|
28044
28331
|
/**
|
|
28045
28332
|
* Invoice
|
|
@@ -28094,7 +28381,7 @@ type DepositInvoiceUpdateWritable = {
|
|
|
28094
28381
|
* Currency code of the invoice
|
|
28095
28382
|
*/
|
|
28096
28383
|
currency?: string;
|
|
28097
|
-
related?:
|
|
28384
|
+
related?: _heyapi_688_;
|
|
28098
28385
|
/**
|
|
28099
28386
|
* Public link of the invoice
|
|
28100
28387
|
*/
|
|
@@ -28115,10 +28402,11 @@ type DepositInvoiceUpdateWritable = {
|
|
|
28115
28402
|
* Analytic code of document
|
|
28116
28403
|
*/
|
|
28117
28404
|
analytic_code?: string | null;
|
|
28405
|
+
payment_terms?: _heyapi_689_;
|
|
28118
28406
|
};
|
|
28119
28407
|
type DepositInvoiceOneWritable = _heyapi_535_ & {
|
|
28120
|
-
rows?: Array<
|
|
28121
|
-
_embed?:
|
|
28408
|
+
rows?: Array<_heyapi_693_ | _heyapi_396_ | _heyapi_397_>;
|
|
28409
|
+
_embed?: _heyapi_694_;
|
|
28122
28410
|
};
|
|
28123
28411
|
/**
|
|
28124
28412
|
* Progress Invoice
|
|
@@ -28187,13 +28475,13 @@ type ProgressInvoiceCreateWritable = {
|
|
|
28187
28475
|
* Bar code ID for progress-catalog row
|
|
28188
28476
|
*/
|
|
28189
28477
|
sku_id?: number | null;
|
|
28190
|
-
}) | (
|
|
28478
|
+
}) | (_heyapi_698_ & {
|
|
28191
28479
|
type?: 'progress-single';
|
|
28192
28480
|
/**
|
|
28193
28481
|
* Purchase amount
|
|
28194
28482
|
*/
|
|
28195
28483
|
purchase_amount?: string;
|
|
28196
|
-
}) | (
|
|
28484
|
+
}) | (_heyapi_698_ & {
|
|
28197
28485
|
type?: 'progress-shipping' | 'progress-packaging';
|
|
28198
28486
|
}) | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
28199
28487
|
/**
|
|
@@ -28454,7 +28742,7 @@ type ProgressInvoiceCreateWritable = {
|
|
|
28454
28742
|
* Show progress invoice summary
|
|
28455
28743
|
*/
|
|
28456
28744
|
show_progress_invoice_summary?: boolean;
|
|
28457
|
-
} &
|
|
28745
|
+
} & _heyapi_699_;
|
|
28458
28746
|
} & _heyapi_442_;
|
|
28459
28747
|
/**
|
|
28460
28748
|
* Date of the shipping
|
|
@@ -28506,7 +28794,7 @@ type ProgressInvoiceComputeWritable = {
|
|
|
28506
28794
|
* Rows of the progress invoice. There must be at least one progress row.
|
|
28507
28795
|
*
|
|
28508
28796
|
*/
|
|
28509
|
-
rows: Array<_heyapi_398_ |
|
|
28797
|
+
rows: Array<_heyapi_398_ | _heyapi_701_ | _heyapi_702_ | _heyapi_703_ | _heyapi_396_ | ({
|
|
28510
28798
|
/**
|
|
28511
28799
|
* ID of the progress invoice row
|
|
28512
28800
|
*/
|
|
@@ -28540,20 +28828,20 @@ type ProgressInvoiceComputeWritable = {
|
|
|
28540
28828
|
* Bar code ID for progress-catalog row
|
|
28541
28829
|
*/
|
|
28542
28830
|
sku_id?: number | null;
|
|
28543
|
-
}) | (
|
|
28831
|
+
}) | (_heyapi_704_ & {
|
|
28544
28832
|
/**
|
|
28545
28833
|
* Purchase amount
|
|
28546
28834
|
*/
|
|
28547
28835
|
purchase_amount?: string;
|
|
28548
|
-
}) |
|
|
28836
|
+
}) | _heyapi_704_ | {
|
|
28549
28837
|
/**
|
|
28550
28838
|
* Row Identifier
|
|
28551
28839
|
*/
|
|
28552
28840
|
id: number;
|
|
28553
28841
|
}>;
|
|
28554
28842
|
};
|
|
28555
|
-
type InvoiceUpdateWritable =
|
|
28556
|
-
rows?: Array<
|
|
28843
|
+
type InvoiceUpdateWritable = _heyapi_708_ & {
|
|
28844
|
+
rows?: Array<_heyapi_709_> | null;
|
|
28557
28845
|
settings?: _heyapi_442_;
|
|
28558
28846
|
};
|
|
28559
28847
|
/**
|
|
@@ -28748,9 +29036,9 @@ type CreditNoteWritable = {
|
|
|
28748
29036
|
/**
|
|
28749
29037
|
* Credit Note Embed
|
|
28750
29038
|
*/
|
|
28751
|
-
_embed?:
|
|
29039
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
28752
29040
|
fiscal_year?: _heyapi_448_;
|
|
28753
|
-
currency?:
|
|
29041
|
+
currency?: _heyapi_713_;
|
|
28754
29042
|
owner?: _heyapi_408_;
|
|
28755
29043
|
/**
|
|
28756
29044
|
* Credit Note ACL
|
|
@@ -28964,10 +29252,10 @@ type CreditNoteOneWritable = {
|
|
|
28964
29252
|
* Analytic code of document
|
|
28965
29253
|
*/
|
|
28966
29254
|
analytic_code?: string | null;
|
|
28967
|
-
_embed?:
|
|
29255
|
+
_embed?: _heyapi_715_;
|
|
28968
29256
|
} & {
|
|
28969
29257
|
rows?: Array<_heyapi_452_>;
|
|
28970
|
-
_embed?:
|
|
29258
|
+
_embed?: _heyapi_715_ & _heyapi_674_ & {
|
|
28971
29259
|
file?: _heyapi_595_;
|
|
28972
29260
|
};
|
|
28973
29261
|
};
|
|
@@ -29071,14 +29359,14 @@ type CreditNoteCreateWritable = {
|
|
|
29071
29359
|
issuer_address_id?: number;
|
|
29072
29360
|
} & {
|
|
29073
29361
|
rows?: Array<_heyapi_452_> | null;
|
|
29074
|
-
parent?:
|
|
29362
|
+
parent?: _heyapi_685_ | null;
|
|
29075
29363
|
/**
|
|
29076
29364
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
29077
29365
|
*/
|
|
29078
29366
|
rate_category_id?: number;
|
|
29079
29367
|
};
|
|
29080
|
-
type CreditNoteUpdateWritable =
|
|
29081
|
-
rows?: Array<
|
|
29368
|
+
type CreditNoteUpdateWritable = _heyapi_718_ & {
|
|
29369
|
+
rows?: Array<_heyapi_709_> | null;
|
|
29082
29370
|
};
|
|
29083
29371
|
/**
|
|
29084
29372
|
* Credit Note
|
|
@@ -29323,15 +29611,15 @@ type OrderCreateWritable = {
|
|
|
29323
29611
|
shipping_volume?: string;
|
|
29324
29612
|
} & {
|
|
29325
29613
|
rows?: Array<_heyapi_452_> | null;
|
|
29326
|
-
parent?:
|
|
29614
|
+
parent?: _heyapi_685_ | null;
|
|
29327
29615
|
/**
|
|
29328
29616
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
29329
29617
|
*/
|
|
29330
29618
|
rate_category_id?: number;
|
|
29331
29619
|
settings?: _heyapi_442_;
|
|
29332
29620
|
};
|
|
29333
|
-
type OrderUpdateWritable =
|
|
29334
|
-
rows?: Array<
|
|
29621
|
+
type OrderUpdateWritable = _heyapi_724_ & {
|
|
29622
|
+
rows?: Array<_heyapi_709_> | null;
|
|
29335
29623
|
settings?: _heyapi_442_;
|
|
29336
29624
|
};
|
|
29337
29625
|
/**
|
|
@@ -29439,7 +29727,7 @@ type OrderWritable = {
|
|
|
29439
29727
|
/**
|
|
29440
29728
|
* Order Embed
|
|
29441
29729
|
*/
|
|
29442
|
-
_embed?:
|
|
29730
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
29443
29731
|
/**
|
|
29444
29732
|
* Order ACL
|
|
29445
29733
|
*/
|
|
@@ -29455,7 +29743,7 @@ type OrderWritable = {
|
|
|
29455
29743
|
};
|
|
29456
29744
|
owner?: _heyapi_408_;
|
|
29457
29745
|
fiscal_year?: _heyapi_448_;
|
|
29458
|
-
currency?:
|
|
29746
|
+
currency?: _heyapi_713_;
|
|
29459
29747
|
/**
|
|
29460
29748
|
* Smart-tags linked
|
|
29461
29749
|
*/
|
|
@@ -29609,7 +29897,7 @@ type OrderOneWritable = {
|
|
|
29609
29897
|
* Notes of the order
|
|
29610
29898
|
*/
|
|
29611
29899
|
note?: string;
|
|
29612
|
-
_embed?:
|
|
29900
|
+
_embed?: _heyapi_727_;
|
|
29613
29901
|
/**
|
|
29614
29902
|
* Date of the shipping
|
|
29615
29903
|
*/
|
|
@@ -29649,7 +29937,7 @@ type OrderOneWritable = {
|
|
|
29649
29937
|
/**
|
|
29650
29938
|
* Order Embed
|
|
29651
29939
|
*/
|
|
29652
|
-
_embed?:
|
|
29940
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
29653
29941
|
/**
|
|
29654
29942
|
* Document Payment Terms
|
|
29655
29943
|
*
|
|
@@ -29690,7 +29978,7 @@ type OrderOneWritable = {
|
|
|
29690
29978
|
};
|
|
29691
29979
|
owner?: _heyapi_408_;
|
|
29692
29980
|
fiscal_year?: _heyapi_448_;
|
|
29693
|
-
currency?:
|
|
29981
|
+
currency?: _heyapi_713_;
|
|
29694
29982
|
/**
|
|
29695
29983
|
* Smart-tags linked
|
|
29696
29984
|
*/
|
|
@@ -29897,7 +30185,7 @@ type DeliveryWritable = {
|
|
|
29897
30185
|
/**
|
|
29898
30186
|
* Delivery Embed
|
|
29899
30187
|
*/
|
|
29900
|
-
_embed?:
|
|
30188
|
+
_embed?: _heyapi_712_ & _heyapi_423_ & {
|
|
29901
30189
|
/**
|
|
29902
30190
|
* Delivery ACL
|
|
29903
30191
|
*/
|
|
@@ -29913,7 +30201,7 @@ type DeliveryWritable = {
|
|
|
29913
30201
|
};
|
|
29914
30202
|
owner?: _heyapi_408_;
|
|
29915
30203
|
fiscal_year?: _heyapi_448_;
|
|
29916
|
-
currency?:
|
|
30204
|
+
currency?: _heyapi_713_;
|
|
29917
30205
|
/**
|
|
29918
30206
|
* Smart-tags linked
|
|
29919
30207
|
*/
|
|
@@ -30048,7 +30336,7 @@ type DeliveryOneWritable = {
|
|
|
30048
30336
|
* Total volume of product to ship in m3
|
|
30049
30337
|
*/
|
|
30050
30338
|
shipping_volume?: string;
|
|
30051
|
-
_embed?:
|
|
30339
|
+
_embed?: _heyapi_732_;
|
|
30052
30340
|
} & {
|
|
30053
30341
|
rows?: Array<_heyapi_452_>;
|
|
30054
30342
|
};
|
|
@@ -30323,7 +30611,7 @@ type IndividualPreferencesWritable = {
|
|
|
30323
30611
|
*/
|
|
30324
30612
|
label?: string;
|
|
30325
30613
|
} | null;
|
|
30326
|
-
tax?:
|
|
30614
|
+
tax?: _heyapi_766_;
|
|
30327
30615
|
/**
|
|
30328
30616
|
* Individual preferred pay date.
|
|
30329
30617
|
*/
|
|
@@ -30464,9 +30752,9 @@ type ObjectiveCollectionOutputWritable = {
|
|
|
30464
30752
|
* Objective name
|
|
30465
30753
|
*/
|
|
30466
30754
|
name: string;
|
|
30467
|
-
category:
|
|
30468
|
-
turnover:
|
|
30469
|
-
period:
|
|
30755
|
+
category: _heyapi_782_;
|
|
30756
|
+
turnover: _heyapi_783_;
|
|
30757
|
+
period: _heyapi_784_;
|
|
30470
30758
|
item: {
|
|
30471
30759
|
/**
|
|
30472
30760
|
* linked Item id
|
|
@@ -30477,16 +30765,16 @@ type ObjectiveCollectionOutputWritable = {
|
|
|
30477
30765
|
*/
|
|
30478
30766
|
name: string;
|
|
30479
30767
|
} | null;
|
|
30480
|
-
item_category:
|
|
30768
|
+
item_category: _heyapi_785_;
|
|
30481
30769
|
/**
|
|
30482
30770
|
* Refinements of the objective
|
|
30483
30771
|
*/
|
|
30484
30772
|
refinements: Array<{
|
|
30485
|
-
period?:
|
|
30486
|
-
turnover?:
|
|
30773
|
+
period?: _heyapi_784_;
|
|
30774
|
+
turnover?: _heyapi_783_;
|
|
30487
30775
|
}>;
|
|
30488
|
-
assignee:
|
|
30489
|
-
links:
|
|
30776
|
+
assignee: _heyapi_786_;
|
|
30777
|
+
links: _heyapi_787_;
|
|
30490
30778
|
} & {
|
|
30491
30779
|
_embed?: {
|
|
30492
30780
|
created_by?: _heyapi_408_;
|
|
@@ -30543,7 +30831,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30543
30831
|
* Progress invoice mode
|
|
30544
30832
|
*/
|
|
30545
30833
|
progress_invoice_mode?: 'global' | 'per-line';
|
|
30546
|
-
}) | (
|
|
30834
|
+
}) | (_heyapi_819_ & {
|
|
30547
30835
|
rows?: Array<_heyapi_452_>;
|
|
30548
30836
|
} & {
|
|
30549
30837
|
/**
|
|
@@ -30559,7 +30847,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30559
30847
|
* Invoice related to the progress invoice, exist only if invoice type is used
|
|
30560
30848
|
*/
|
|
30561
30849
|
invoice?: (_heyapi_535_ & {
|
|
30562
|
-
rows?: Array<
|
|
30850
|
+
rows?: Array<_heyapi_821_ | _heyapi_822_ | _heyapi_823_ | _heyapi_396_ | _heyapi_397_ | _heyapi_398_ | _heyapi_399_ | _heyapi_400_>;
|
|
30563
30851
|
/**
|
|
30564
30852
|
* The next available progress invoice number
|
|
30565
30853
|
*/
|
|
@@ -30772,11 +31060,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30772
31060
|
/**
|
|
30773
31061
|
* List of document layouts
|
|
30774
31062
|
*/
|
|
30775
|
-
document_layouts?: Array<
|
|
31063
|
+
document_layouts?: Array<_heyapi_825_>;
|
|
30776
31064
|
/**
|
|
30777
31065
|
* List of languages
|
|
30778
31066
|
*/
|
|
30779
|
-
languages?: Array<
|
|
31067
|
+
languages?: Array<_heyapi_826_>;
|
|
30780
31068
|
/**
|
|
30781
31069
|
* Tax with embed
|
|
30782
31070
|
*
|
|
@@ -30989,7 +31277,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
30989
31277
|
/**
|
|
30990
31278
|
* Payment term translations
|
|
30991
31279
|
*/
|
|
30992
|
-
translations?: Array<
|
|
31280
|
+
translations?: Array<_heyapi_827_>;
|
|
30993
31281
|
};
|
|
30994
31282
|
}>;
|
|
30995
31283
|
/**
|
|
@@ -31012,7 +31300,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31012
31300
|
/**
|
|
31013
31301
|
* Assigned staff translations
|
|
31014
31302
|
*/
|
|
31015
|
-
translations?: Array<
|
|
31303
|
+
translations?: Array<_heyapi_828_>;
|
|
31016
31304
|
};
|
|
31017
31305
|
}>;
|
|
31018
31306
|
/**
|
|
@@ -31187,11 +31475,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31187
31475
|
/**
|
|
31188
31476
|
* Summary of all document history (includes current document)
|
|
31189
31477
|
*/
|
|
31190
|
-
summary?: Array<
|
|
31478
|
+
summary?: Array<_heyapi_706_ & {
|
|
31191
31479
|
/**
|
|
31192
31480
|
* Credit notes linked to the invoice
|
|
31193
31481
|
*/
|
|
31194
|
-
credit_notes?: Array<
|
|
31482
|
+
credit_notes?: Array<_heyapi_706_>;
|
|
31195
31483
|
}>;
|
|
31196
31484
|
};
|
|
31197
31485
|
/**
|
|
@@ -31237,7 +31525,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
31237
31525
|
* Update Progress Invoice
|
|
31238
31526
|
*/
|
|
31239
31527
|
type ProgressInvoiceUpdateWritable = {
|
|
31240
|
-
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_ | {
|
|
31241
31529
|
/**
|
|
31242
31530
|
* Row Identifier
|
|
31243
31531
|
*/
|
|
@@ -31365,8 +31653,8 @@ type ProgressInvoiceUpdateWritable = {
|
|
|
31365
31653
|
*/
|
|
31366
31654
|
shipping_volume?: string;
|
|
31367
31655
|
shipping_weight?: _heyapi_433_;
|
|
31368
|
-
payment_terms?:
|
|
31369
|
-
settings?:
|
|
31656
|
+
payment_terms?: _heyapi_684_;
|
|
31657
|
+
settings?: _heyapi_832_;
|
|
31370
31658
|
/**
|
|
31371
31659
|
* Analytic code of document
|
|
31372
31660
|
*/
|
|
@@ -31407,7 +31695,7 @@ type ProposalModelWritable = {
|
|
|
31407
31695
|
/**
|
|
31408
31696
|
* Proposal document
|
|
31409
31697
|
*/
|
|
31410
|
-
type ProposalDocumentWritable =
|
|
31698
|
+
type ProposalDocumentWritable = _heyapi_839_ & {
|
|
31411
31699
|
/**
|
|
31412
31700
|
* Proposal document link
|
|
31413
31701
|
*/
|
|
@@ -31687,12 +31975,12 @@ type CrmActivityEmbed = Array<'aggregations' | 'aggregations.by_event' | 'aggreg
|
|
|
31687
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 />
|
|
31688
31976
|
*
|
|
31689
31977
|
*/
|
|
31690
|
-
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_>;
|
|
31691
31979
|
/**
|
|
31692
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 />
|
|
31693
31981
|
*
|
|
31694
31982
|
*/
|
|
31695
|
-
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_>;
|
|
31696
31984
|
/**
|
|
31697
31985
|
* The order field
|
|
31698
31986
|
*/
|
|
@@ -31775,12 +32063,12 @@ type FavouriteFiltersOrder = (typeof FavouriteFiltersOrder)[keyof typeof Favouri
|
|
|
31775
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>
|
|
31776
32064
|
*
|
|
31777
32065
|
*/
|
|
31778
|
-
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_>;
|
|
31779
32067
|
/**
|
|
31780
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>
|
|
31781
32069
|
*
|
|
31782
32070
|
*/
|
|
31783
|
-
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_>;
|
|
31784
32072
|
/**
|
|
31785
32073
|
* The order field
|
|
31786
32074
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -31972,6 +32260,11 @@ type CustomActivityOrder = (typeof CustomActivityOrder)[keyof typeof CustomActiv
|
|
|
31972
32260
|
declare const OcrOrder: {
|
|
31973
32261
|
readonly CREATED_AT: "created_at";
|
|
31974
32262
|
readonly COMPLETED_AT: "completed_at";
|
|
32263
|
+
readonly LINKED_TYPE: "linked_type";
|
|
32264
|
+
readonly SOURCE: "source";
|
|
32265
|
+
readonly SUPPLIER: "supplier";
|
|
32266
|
+
readonly TOTAL_EXCL_TAX: "total_excl_tax";
|
|
32267
|
+
readonly STATE: "state";
|
|
31975
32268
|
};
|
|
31976
32269
|
/**
|
|
31977
32270
|
* The order field
|
|
@@ -32059,11 +32352,11 @@ type CorporationStaffEmbed = Array<'predicted_licenses' | 'aggregations.count_li
|
|
|
32059
32352
|
/**
|
|
32060
32353
|
* Additional object included in the result
|
|
32061
32354
|
*/
|
|
32062
|
-
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_>;
|
|
32063
32356
|
/**
|
|
32064
32357
|
* Additional object included in the result
|
|
32065
32358
|
*/
|
|
32066
|
-
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_>;
|
|
32067
32360
|
/**
|
|
32068
32361
|
* Order field
|
|
32069
32362
|
*/
|
|
@@ -32082,11 +32375,11 @@ type InvoiceOrder = (typeof InvoiceOrder)[keyof typeof InvoiceOrder];
|
|
|
32082
32375
|
/**
|
|
32083
32376
|
* Additional object included in the result
|
|
32084
32377
|
*/
|
|
32085
|
-
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_>;
|
|
32086
32379
|
/**
|
|
32087
32380
|
* Additional object included in the result
|
|
32088
32381
|
*/
|
|
32089
|
-
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_>;
|
|
32090
32383
|
/**
|
|
32091
32384
|
* Order field
|
|
32092
32385
|
*/
|
|
@@ -32132,11 +32425,11 @@ type ImportType = (typeof ImportType)[keyof typeof ImportType];
|
|
|
32132
32425
|
/**
|
|
32133
32426
|
* Additional object included in the result
|
|
32134
32427
|
*/
|
|
32135
|
-
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_>;
|
|
32136
32429
|
/**
|
|
32137
32430
|
* Additional object included in the result
|
|
32138
32431
|
*/
|
|
32139
|
-
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_>;
|
|
32140
32433
|
/**
|
|
32141
32434
|
* Order field
|
|
32142
32435
|
*/
|
|
@@ -32156,11 +32449,11 @@ type OrderOrder = (typeof OrderOrder)[keyof typeof OrderOrder];
|
|
|
32156
32449
|
/**
|
|
32157
32450
|
* Additional object included in the result
|
|
32158
32451
|
*/
|
|
32159
|
-
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_>;
|
|
32160
32453
|
/**
|
|
32161
32454
|
* Additional object included in the result
|
|
32162
32455
|
*/
|
|
32163
|
-
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_>;
|
|
32164
32457
|
/**
|
|
32165
32458
|
* Order field
|
|
32166
32459
|
*/
|
|
@@ -32524,7 +32817,7 @@ type GetCompaniesResponses = {
|
|
|
32524
32817
|
/**
|
|
32525
32818
|
* Company acl
|
|
32526
32819
|
*/
|
|
32527
|
-
acl?:
|
|
32820
|
+
acl?: _heyapi_1057_ | null;
|
|
32528
32821
|
/**
|
|
32529
32822
|
* Smart-tags linked
|
|
32530
32823
|
*/
|
|
@@ -32737,7 +33030,7 @@ type CreateCompanyResponses = {
|
|
|
32737
33030
|
/**
|
|
32738
33031
|
* Company acl
|
|
32739
33032
|
*/
|
|
32740
|
-
acl?:
|
|
33033
|
+
acl?: _heyapi_1057_ | null;
|
|
32741
33034
|
/**
|
|
32742
33035
|
* Smart-tags linked
|
|
32743
33036
|
*/
|
|
@@ -32928,7 +33221,7 @@ type SearchCompaniesResponses = {
|
|
|
32928
33221
|
/**
|
|
32929
33222
|
* Company acl
|
|
32930
33223
|
*/
|
|
32931
|
-
acl?:
|
|
33224
|
+
acl?: _heyapi_1057_ | null;
|
|
32932
33225
|
/**
|
|
32933
33226
|
* Smart-tags linked
|
|
32934
33227
|
*/
|
|
@@ -33073,7 +33366,7 @@ type GetCompanyResponses = {
|
|
|
33073
33366
|
/**
|
|
33074
33367
|
* Company acl
|
|
33075
33368
|
*/
|
|
33076
|
-
acl?:
|
|
33369
|
+
acl?: _heyapi_1057_ | null;
|
|
33077
33370
|
/**
|
|
33078
33371
|
* Smart-tags linked
|
|
33079
33372
|
*/
|
|
@@ -33285,7 +33578,7 @@ type UpdateCompanyResponses = {
|
|
|
33285
33578
|
/**
|
|
33286
33579
|
* Company acl
|
|
33287
33580
|
*/
|
|
33288
|
-
acl?:
|
|
33581
|
+
acl?: _heyapi_1057_ | null;
|
|
33289
33582
|
/**
|
|
33290
33583
|
* Smart-tags linked
|
|
33291
33584
|
*/
|
|
@@ -34770,7 +35063,7 @@ type GetContactCompaniesResponses = {
|
|
|
34770
35063
|
/**
|
|
34771
35064
|
* Company acl
|
|
34772
35065
|
*/
|
|
34773
|
-
acl?:
|
|
35066
|
+
acl?: _heyapi_1057_ | null;
|
|
34774
35067
|
/**
|
|
34775
35068
|
* Smart-tags linked
|
|
34776
35069
|
*/
|
|
@@ -36557,7 +36850,7 @@ type GetEstimatesData = {
|
|
|
36557
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>
|
|
36558
36851
|
*
|
|
36559
36852
|
*/
|
|
36560
|
-
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_>;
|
|
36561
36854
|
/**
|
|
36562
36855
|
* The order field
|
|
36563
36856
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -36581,7 +36874,7 @@ type CreateEstimateData = {
|
|
|
36581
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>
|
|
36582
36875
|
*
|
|
36583
36876
|
*/
|
|
36584
|
-
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_>;
|
|
36585
36878
|
/**
|
|
36586
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>
|
|
36587
36880
|
*
|
|
@@ -36622,7 +36915,7 @@ type SearchEstimatesData = {
|
|
|
36622
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>
|
|
36623
36916
|
*
|
|
36624
36917
|
*/
|
|
36625
|
-
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_>;
|
|
36626
36919
|
/**
|
|
36627
36920
|
* The order field
|
|
36628
36921
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -37531,7 +37824,7 @@ type GetEstimateData = {
|
|
|
37531
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>
|
|
37532
37825
|
*
|
|
37533
37826
|
*/
|
|
37534
|
-
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_>;
|
|
37535
37828
|
};
|
|
37536
37829
|
url: '/estimates/{id}';
|
|
37537
37830
|
};
|
|
@@ -37566,7 +37859,7 @@ type UpdateEstimateData = {
|
|
|
37566
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>
|
|
37567
37860
|
*
|
|
37568
37861
|
*/
|
|
37569
|
-
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_>;
|
|
37570
37863
|
};
|
|
37571
37864
|
url: '/estimates/{id}';
|
|
37572
37865
|
};
|
|
@@ -37595,7 +37888,7 @@ type UpdateEstimateStatusData = {
|
|
|
37595
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>
|
|
37596
37889
|
*
|
|
37597
37890
|
*/
|
|
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' |
|
|
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_>;
|
|
37599
37892
|
};
|
|
37600
37893
|
url: '/estimates/{id}/status';
|
|
37601
37894
|
};
|
|
@@ -38142,7 +38435,7 @@ type GetOrdersData = {
|
|
|
38142
38435
|
/**
|
|
38143
38436
|
* Additional object included in the result
|
|
38144
38437
|
*/
|
|
38145
|
-
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_>;
|
|
38146
38439
|
/**
|
|
38147
38440
|
* Order field
|
|
38148
38441
|
*/
|
|
@@ -38172,7 +38465,7 @@ type CreateOrderData = {
|
|
|
38172
38465
|
/**
|
|
38173
38466
|
* Additional object included in the result
|
|
38174
38467
|
*/
|
|
38175
|
-
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_>;
|
|
38176
38469
|
};
|
|
38177
38470
|
url: '/orders';
|
|
38178
38471
|
};
|
|
@@ -38208,7 +38501,7 @@ type GetOrderData = {
|
|
|
38208
38501
|
/**
|
|
38209
38502
|
* Additional object included in the result
|
|
38210
38503
|
*/
|
|
38211
|
-
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_>;
|
|
38212
38505
|
};
|
|
38213
38506
|
url: '/orders/{id}';
|
|
38214
38507
|
};
|
|
@@ -38231,7 +38524,7 @@ type UpdateOrderData = {
|
|
|
38231
38524
|
/**
|
|
38232
38525
|
* Additional object included in the result
|
|
38233
38526
|
*/
|
|
38234
|
-
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_>;
|
|
38235
38528
|
};
|
|
38236
38529
|
url: '/orders/{id}';
|
|
38237
38530
|
};
|
|
@@ -38266,7 +38559,7 @@ type SearchOrdersData = {
|
|
|
38266
38559
|
/**
|
|
38267
38560
|
* Additional object included in the result
|
|
38268
38561
|
*/
|
|
38269
|
-
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_>;
|
|
38270
38563
|
/**
|
|
38271
38564
|
* Order field
|
|
38272
38565
|
*/
|
|
@@ -39674,7 +39967,7 @@ type GetDeliveriesData = {
|
|
|
39674
39967
|
/**
|
|
39675
39968
|
* Additional object included in the result
|
|
39676
39969
|
*/
|
|
39677
|
-
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_>;
|
|
39678
39971
|
/**
|
|
39679
39972
|
* Order field
|
|
39680
39973
|
*/
|
|
@@ -39716,7 +40009,7 @@ type SearchDeliveriesData = {
|
|
|
39716
40009
|
/**
|
|
39717
40010
|
* Additional object included in the result
|
|
39718
40011
|
*/
|
|
39719
|
-
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_>;
|
|
39720
40013
|
/**
|
|
39721
40014
|
* Order field
|
|
39722
40015
|
*/
|
|
@@ -39746,7 +40039,7 @@ type GetDeliveryData = {
|
|
|
39746
40039
|
/**
|
|
39747
40040
|
* Additional object included in the result
|
|
39748
40041
|
*/
|
|
39749
|
-
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_>;
|
|
39750
40043
|
};
|
|
39751
40044
|
url: '/deliveries/{id}';
|
|
39752
40045
|
};
|
|
@@ -39769,7 +40062,7 @@ type GetIndividualsData = {
|
|
|
39769
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 />
|
|
39770
40063
|
*
|
|
39771
40064
|
*/
|
|
39772
|
-
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_>;
|
|
39773
40066
|
/**
|
|
39774
40067
|
* The order direction
|
|
39775
40068
|
*/
|
|
@@ -39847,7 +40140,7 @@ type GetIndividualsResponses = {
|
|
|
39847
40140
|
/**
|
|
39848
40141
|
* Individual acl
|
|
39849
40142
|
*/
|
|
39850
|
-
acl?:
|
|
40143
|
+
acl?: _heyapi_1301_ | null;
|
|
39851
40144
|
/**
|
|
39852
40145
|
* Smart-tags linked
|
|
39853
40146
|
*/
|
|
@@ -39977,7 +40270,7 @@ type CreateIndividualData = {
|
|
|
39977
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 />
|
|
39978
40271
|
*
|
|
39979
40272
|
*/
|
|
39980
|
-
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_>;
|
|
39981
40274
|
/**
|
|
39982
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>
|
|
39983
40276
|
*
|
|
@@ -40044,7 +40337,7 @@ type CreateIndividualResponses = {
|
|
|
40044
40337
|
/**
|
|
40045
40338
|
* Individual acl
|
|
40046
40339
|
*/
|
|
40047
|
-
acl?:
|
|
40340
|
+
acl?: _heyapi_1301_ | null;
|
|
40048
40341
|
/**
|
|
40049
40342
|
* Smart-tags linked
|
|
40050
40343
|
*/
|
|
@@ -40148,7 +40441,7 @@ type SearchIndividualsData = {
|
|
|
40148
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 />
|
|
40149
40442
|
*
|
|
40150
40443
|
*/
|
|
40151
|
-
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_>;
|
|
40152
40445
|
/**
|
|
40153
40446
|
* The order direction
|
|
40154
40447
|
*/
|
|
@@ -40223,7 +40516,7 @@ type SearchIndividualsResponses = {
|
|
|
40223
40516
|
/**
|
|
40224
40517
|
* Individual acl
|
|
40225
40518
|
*/
|
|
40226
|
-
acl?:
|
|
40519
|
+
acl?: _heyapi_1301_ | null;
|
|
40227
40520
|
/**
|
|
40228
40521
|
* Smart-tags linked
|
|
40229
40522
|
*/
|
|
@@ -40423,7 +40716,7 @@ type GetIndividualData = {
|
|
|
40423
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 />
|
|
40424
40717
|
*
|
|
40425
40718
|
*/
|
|
40426
|
-
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_>;
|
|
40427
40720
|
/**
|
|
40428
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>
|
|
40429
40722
|
*
|
|
@@ -40486,7 +40779,7 @@ type GetIndividualResponses = {
|
|
|
40486
40779
|
/**
|
|
40487
40780
|
* Individual acl
|
|
40488
40781
|
*/
|
|
40489
|
-
acl?:
|
|
40782
|
+
acl?: _heyapi_1301_ | null;
|
|
40490
40783
|
/**
|
|
40491
40784
|
* Smart-tags linked
|
|
40492
40785
|
*/
|
|
@@ -40615,7 +40908,7 @@ type UpdateIndividualData = {
|
|
|
40615
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 />
|
|
40616
40909
|
*
|
|
40617
40910
|
*/
|
|
40618
|
-
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_>;
|
|
40619
40912
|
/**
|
|
40620
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>
|
|
40621
40914
|
*
|
|
@@ -40682,7 +40975,7 @@ type UpdateIndividualResponses = {
|
|
|
40682
40975
|
/**
|
|
40683
40976
|
* Individual acl
|
|
40684
40977
|
*/
|
|
40685
|
-
acl?:
|
|
40978
|
+
acl?: _heyapi_1301_ | null;
|
|
40686
40979
|
/**
|
|
40687
40980
|
* Smart-tags linked
|
|
40688
40981
|
*/
|
|
@@ -42731,7 +43024,7 @@ type GetTaxesResponses = {
|
|
|
42731
43024
|
/**
|
|
42732
43025
|
* Tax with embed
|
|
42733
43026
|
*/
|
|
42734
|
-
data: Array<
|
|
43027
|
+
data: Array<_heyapi_766_ & {
|
|
42735
43028
|
/**
|
|
42736
43029
|
* Optional objects added through the embed parameter
|
|
42737
43030
|
*/
|
|
@@ -42970,7 +43263,7 @@ type CreateTaxResponses = {
|
|
|
42970
43263
|
*
|
|
42971
43264
|
* Tax created
|
|
42972
43265
|
*/
|
|
42973
|
-
201:
|
|
43266
|
+
201: _heyapi_766_ & {
|
|
42974
43267
|
/**
|
|
42975
43268
|
* Optional objects added through the embed parameter
|
|
42976
43269
|
*/
|
|
@@ -43077,7 +43370,7 @@ type SearchTaxesResponses = {
|
|
|
43077
43370
|
*/
|
|
43078
43371
|
200: {
|
|
43079
43372
|
pagination: Pagination;
|
|
43080
|
-
data: Array<
|
|
43373
|
+
data: Array<_heyapi_766_ & {
|
|
43081
43374
|
/**
|
|
43082
43375
|
* Optional objects added through the embed parameter
|
|
43083
43376
|
*/
|
|
@@ -43198,7 +43491,7 @@ type GetTaxResponses = {
|
|
|
43198
43491
|
*
|
|
43199
43492
|
* Tax fetched
|
|
43200
43493
|
*/
|
|
43201
|
-
200:
|
|
43494
|
+
200: _heyapi_766_ & {
|
|
43202
43495
|
/**
|
|
43203
43496
|
* Optional objects added through the embed parameter
|
|
43204
43497
|
*/
|
|
@@ -43447,7 +43740,7 @@ type UpdateTaxResponses = {
|
|
|
43447
43740
|
*
|
|
43448
43741
|
* Tax updated
|
|
43449
43742
|
*/
|
|
43450
|
-
200:
|
|
43743
|
+
200: _heyapi_766_ & {
|
|
43451
43744
|
/**
|
|
43452
43745
|
* Optional objects added through the embed parameter
|
|
43453
43746
|
*/
|
|
@@ -45022,7 +45315,7 @@ type GetOcrPurInvoiceData = {
|
|
|
45022
45315
|
/**
|
|
45023
45316
|
* The order field
|
|
45024
45317
|
*/
|
|
45025
|
-
order?: 'created_at' | 'completed_at';
|
|
45318
|
+
order?: 'created_at' | 'completed_at' | 'linked_type' | 'source' | 'supplier' | 'total_excl_tax' | 'state';
|
|
45026
45319
|
/**
|
|
45027
45320
|
* Pagination limit
|
|
45028
45321
|
*/
|
|
@@ -45066,7 +45359,7 @@ type SearchOcrPurInvoiceData = {
|
|
|
45066
45359
|
/**
|
|
45067
45360
|
* The order field
|
|
45068
45361
|
*/
|
|
45069
|
-
order?: 'created_at' | 'completed_at';
|
|
45362
|
+
order?: 'created_at' | 'completed_at' | 'linked_type' | 'source' | 'supplier' | 'total_excl_tax' | 'state';
|
|
45070
45363
|
/**
|
|
45071
45364
|
* Pagination limit
|
|
45072
45365
|
*/
|
|
@@ -46487,7 +46780,7 @@ type GetOpportunityData = {
|
|
|
46487
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 />
|
|
46488
46781
|
*
|
|
46489
46782
|
*/
|
|
46490
|
-
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_>;
|
|
46491
46784
|
/**
|
|
46492
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>
|
|
46493
46786
|
*
|
|
@@ -46522,7 +46815,7 @@ type PatchOpportunityData = {
|
|
|
46522
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 />
|
|
46523
46816
|
*
|
|
46524
46817
|
*/
|
|
46525
|
-
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_>;
|
|
46526
46819
|
/**
|
|
46527
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>
|
|
46528
46821
|
*
|
|
@@ -46559,7 +46852,7 @@ type UpdateOpportunityData = {
|
|
|
46559
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 />
|
|
46560
46853
|
*
|
|
46561
46854
|
*/
|
|
46562
|
-
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_>;
|
|
46563
46856
|
/**
|
|
46564
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>
|
|
46565
46858
|
*
|
|
@@ -46621,7 +46914,7 @@ type GetOpportunitiesData = {
|
|
|
46621
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 />
|
|
46622
46915
|
*
|
|
46623
46916
|
*/
|
|
46624
|
-
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_>;
|
|
46625
46918
|
/**
|
|
46626
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>
|
|
46627
46920
|
*
|
|
@@ -46653,7 +46946,7 @@ type CreateOpportunityData = {
|
|
|
46653
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 />
|
|
46654
46947
|
*
|
|
46655
46948
|
*/
|
|
46656
|
-
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_>;
|
|
46657
46950
|
/**
|
|
46658
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>
|
|
46659
46952
|
*
|
|
@@ -46740,7 +47033,7 @@ type SearchOpportunitiesData = {
|
|
|
46740
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 />
|
|
46741
47034
|
*
|
|
46742
47035
|
*/
|
|
46743
|
-
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_>;
|
|
46744
47037
|
/**
|
|
46745
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>
|
|
46746
47039
|
*
|
|
@@ -52393,7 +52686,7 @@ type GetInvoiceData = {
|
|
|
52393
52686
|
/**
|
|
52394
52687
|
* Additional object included in the result
|
|
52395
52688
|
*/
|
|
52396
|
-
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_>;
|
|
52397
52690
|
};
|
|
52398
52691
|
url: '/invoices/{id}';
|
|
52399
52692
|
};
|
|
@@ -52416,7 +52709,7 @@ type UpdateInvoiceData = {
|
|
|
52416
52709
|
/**
|
|
52417
52710
|
* Additional object included in the result
|
|
52418
52711
|
*/
|
|
52419
|
-
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_>;
|
|
52420
52713
|
};
|
|
52421
52714
|
url: '/invoices/{id}';
|
|
52422
52715
|
};
|
|
@@ -52451,7 +52744,7 @@ type GetInvoicesData = {
|
|
|
52451
52744
|
/**
|
|
52452
52745
|
* Additional object included in the result
|
|
52453
52746
|
*/
|
|
52454
|
-
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_>;
|
|
52455
52748
|
/**
|
|
52456
52749
|
* Order field
|
|
52457
52750
|
*/
|
|
@@ -52476,7 +52769,7 @@ type CreateInvoiceData = {
|
|
|
52476
52769
|
/**
|
|
52477
52770
|
* Additional object included in the result
|
|
52478
52771
|
*/
|
|
52479
|
-
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_>;
|
|
52480
52773
|
/**
|
|
52481
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>
|
|
52482
52775
|
*
|
|
@@ -52516,7 +52809,7 @@ type SearchInvoicesData = {
|
|
|
52516
52809
|
/**
|
|
52517
52810
|
* Additional object included in the result
|
|
52518
52811
|
*/
|
|
52519
|
-
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_>;
|
|
52520
52813
|
/**
|
|
52521
52814
|
* Order field
|
|
52522
52815
|
*/
|
|
@@ -53850,7 +54143,7 @@ type GetCreditNoteData = {
|
|
|
53850
54143
|
/**
|
|
53851
54144
|
* Additional object included in the result
|
|
53852
54145
|
*/
|
|
53853
|
-
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_>;
|
|
53854
54147
|
};
|
|
53855
54148
|
url: '/credit-notes/{id}';
|
|
53856
54149
|
};
|
|
@@ -53873,7 +54166,7 @@ type UpdateCreditNoteData = {
|
|
|
53873
54166
|
/**
|
|
53874
54167
|
* Additional object included in the result
|
|
53875
54168
|
*/
|
|
53876
|
-
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_>;
|
|
53877
54170
|
};
|
|
53878
54171
|
url: '/credit-notes/{id}';
|
|
53879
54172
|
};
|
|
@@ -53908,7 +54201,7 @@ type GetCreditNotesData = {
|
|
|
53908
54201
|
/**
|
|
53909
54202
|
* Additional object included in the result
|
|
53910
54203
|
*/
|
|
53911
|
-
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_>;
|
|
53912
54205
|
/**
|
|
53913
54206
|
* Order field
|
|
53914
54207
|
*/
|
|
@@ -53933,7 +54226,7 @@ type CreateCreditNoteData = {
|
|
|
53933
54226
|
/**
|
|
53934
54227
|
* Additional object included in the result
|
|
53935
54228
|
*/
|
|
53936
|
-
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_>;
|
|
53937
54230
|
/**
|
|
53938
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>
|
|
53939
54232
|
*
|
|
@@ -53973,7 +54266,7 @@ type SearchCreditNotesData = {
|
|
|
53973
54266
|
/**
|
|
53974
54267
|
* Additional object included in the result
|
|
53975
54268
|
*/
|
|
53976
|
-
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_>;
|
|
53977
54270
|
/**
|
|
53978
54271
|
* Order field
|
|
53979
54272
|
*/
|
|
@@ -56816,7 +57109,7 @@ type UpdateModelData = {
|
|
|
56816
57109
|
* Invoice's owner (staff id)
|
|
56817
57110
|
*/
|
|
56818
57111
|
owner_id?: number;
|
|
56819
|
-
rows?: Array<
|
|
57112
|
+
rows?: Array<_heyapi_2136_> | null;
|
|
56820
57113
|
};
|
|
56821
57114
|
path: {
|
|
56822
57115
|
/**
|
|
@@ -57232,7 +57525,7 @@ type GetDepositInvoicesData = {
|
|
|
57232
57525
|
/**
|
|
57233
57526
|
* Additional object included in the result
|
|
57234
57527
|
*/
|
|
57235
|
-
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_>;
|
|
57236
57529
|
/**
|
|
57237
57530
|
* Order field
|
|
57238
57531
|
*/
|
|
@@ -57254,7 +57547,12 @@ type GetDepositInvoicesResponse = GetDepositInvoicesResponses[keyof GetDepositIn
|
|
|
57254
57547
|
type CreateDepositInvoiceData = {
|
|
57255
57548
|
body?: DepositInvoiceCreateWritable;
|
|
57256
57549
|
path?: never;
|
|
57257
|
-
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
|
+
};
|
|
57258
57556
|
url: '/deposit-invoices';
|
|
57259
57557
|
};
|
|
57260
57558
|
type CreateDepositInvoiceResponses = {
|
|
@@ -57288,7 +57586,7 @@ type SearchDepositInvoicesData = {
|
|
|
57288
57586
|
/**
|
|
57289
57587
|
* Additional object included in the result
|
|
57290
57588
|
*/
|
|
57291
|
-
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_>;
|
|
57292
57590
|
/**
|
|
57293
57591
|
* Order field
|
|
57294
57592
|
*/
|
|
@@ -57340,7 +57638,12 @@ type GetDepositInvoiceData = {
|
|
|
57340
57638
|
*/
|
|
57341
57639
|
id: number;
|
|
57342
57640
|
};
|
|
57343
|
-
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
|
+
};
|
|
57344
57647
|
url: '/deposit-invoices/{id}';
|
|
57345
57648
|
};
|
|
57346
57649
|
type GetDepositInvoiceResponses = {
|
|
@@ -57358,7 +57661,12 @@ type UpdateDepositInvoiceData = {
|
|
|
57358
57661
|
*/
|
|
57359
57662
|
id: number;
|
|
57360
57663
|
};
|
|
57361
|
-
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
|
+
};
|
|
57362
57670
|
url: '/deposit-invoices/{id}';
|
|
57363
57671
|
};
|
|
57364
57672
|
type UpdateDepositInvoiceResponses = {
|
|
@@ -58438,7 +58746,7 @@ type CreateProgressInvoiceData = {
|
|
|
58438
58746
|
/**
|
|
58439
58747
|
* Additional object included in the result
|
|
58440
58748
|
*/
|
|
58441
|
-
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_>;
|
|
58442
58750
|
/**
|
|
58443
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>
|
|
58444
58752
|
*
|
|
@@ -58479,7 +58787,7 @@ type UpdateProgressInvoiceData = {
|
|
|
58479
58787
|
/**
|
|
58480
58788
|
* Additional object included in the result
|
|
58481
58789
|
*/
|
|
58482
|
-
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_>;
|
|
58483
58791
|
/**
|
|
58484
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>
|
|
58485
58793
|
*
|
|
@@ -65939,6 +66247,11 @@ declare const DealsSchema: {
|
|
|
65939
66247
|
readonly minimum: 0;
|
|
65940
66248
|
readonly maximum: 1;
|
|
65941
66249
|
};
|
|
66250
|
+
readonly meet_link: {
|
|
66251
|
+
readonly type: "string";
|
|
66252
|
+
readonly description: "Meet link for the calendar event";
|
|
66253
|
+
readonly nullable: true;
|
|
66254
|
+
};
|
|
65942
66255
|
};
|
|
65943
66256
|
}, {
|
|
65944
66257
|
readonly title: "Email";
|
|
@@ -68383,6 +68696,24 @@ declare const OcrSchema: {
|
|
|
68383
68696
|
readonly enum: readonly ["ocr", "facturx"];
|
|
68384
68697
|
readonly example: "ocr";
|
|
68385
68698
|
};
|
|
68699
|
+
readonly supplier: {
|
|
68700
|
+
readonly type: "string";
|
|
68701
|
+
readonly description: "Supplier name";
|
|
68702
|
+
readonly nullable: true;
|
|
68703
|
+
readonly example: "SELLSY";
|
|
68704
|
+
};
|
|
68705
|
+
readonly total_excl_tax: {
|
|
68706
|
+
readonly type: "string";
|
|
68707
|
+
readonly description: "Total amount excluding tax";
|
|
68708
|
+
readonly nullable: true;
|
|
68709
|
+
readonly example: "35.00";
|
|
68710
|
+
};
|
|
68711
|
+
readonly currency: {
|
|
68712
|
+
readonly type: "string";
|
|
68713
|
+
readonly description: "Currency code";
|
|
68714
|
+
readonly nullable: true;
|
|
68715
|
+
readonly example: "EUR";
|
|
68716
|
+
};
|
|
68386
68717
|
};
|
|
68387
68718
|
};
|
|
68388
68719
|
declare const OcrPurInvoiceMetasSchema: {
|
|
@@ -68391,26 +68722,30 @@ declare const OcrPurInvoiceMetasSchema: {
|
|
|
68391
68722
|
readonly properties: {
|
|
68392
68723
|
readonly user_can_validate_pur_invoice: {
|
|
68393
68724
|
readonly type: "boolean";
|
|
68394
|
-
readonly description: "
|
|
68725
|
+
readonly description: "User can validate a purchase invoice";
|
|
68395
68726
|
};
|
|
68396
68727
|
readonly create_payment: {
|
|
68397
68728
|
readonly type: "boolean";
|
|
68398
|
-
readonly description: "
|
|
68729
|
+
readonly description: "User can create a payment";
|
|
68399
68730
|
};
|
|
68400
|
-
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: {
|
|
68401
68736
|
readonly type: "boolean";
|
|
68402
|
-
readonly description: "
|
|
68737
|
+
readonly description: "User can create a purchase credit note";
|
|
68403
68738
|
};
|
|
68404
68739
|
readonly create_fast: {
|
|
68405
68740
|
readonly type: "boolean";
|
|
68406
|
-
readonly description: "
|
|
68741
|
+
readonly description: "User can create a fast purchase invoice";
|
|
68407
68742
|
};
|
|
68408
68743
|
readonly import: {
|
|
68409
68744
|
readonly type: "boolean";
|
|
68410
|
-
readonly description: "
|
|
68745
|
+
readonly description: "User can import a purchase invoice";
|
|
68411
68746
|
};
|
|
68412
68747
|
};
|
|
68413
|
-
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"];
|
|
68414
68749
|
};
|
|
68415
68750
|
declare const InvoicingConformityStateSchema: {
|
|
68416
68751
|
readonly title: "conformityState";
|
|
@@ -77992,7 +78327,7 @@ declare const InvoiceSchema: {
|
|
|
77992
78327
|
readonly due_date: {
|
|
77993
78328
|
readonly type: "string";
|
|
77994
78329
|
readonly format: "date";
|
|
77995
|
-
readonly description: "
|
|
78330
|
+
readonly description: "Due date of the invoice.\n";
|
|
77996
78331
|
readonly example: "2022-02-02";
|
|
77997
78332
|
};
|
|
77998
78333
|
readonly created: {
|
|
@@ -78557,7 +78892,7 @@ declare const InvoiceOneSchema: {
|
|
|
78557
78892
|
readonly due_date: {
|
|
78558
78893
|
readonly type: "string";
|
|
78559
78894
|
readonly format: "date";
|
|
78560
|
-
readonly description: "
|
|
78895
|
+
readonly description: "Due date of the invoice.\n";
|
|
78561
78896
|
readonly example: "2022-02-02";
|
|
78562
78897
|
};
|
|
78563
78898
|
readonly created: {
|
|
@@ -80389,9 +80724,13 @@ declare const InvoiceCreateSchema: {
|
|
|
80389
80724
|
readonly due_date: {
|
|
80390
80725
|
readonly type: "string";
|
|
80391
80726
|
readonly format: "date";
|
|
80392
|
-
readonly
|
|
80727
|
+
readonly deprecated: true;
|
|
80728
|
+
readonly description: "Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.\n";
|
|
80393
80729
|
readonly example: "2022-02-02";
|
|
80394
80730
|
};
|
|
80731
|
+
readonly payment_terms: {
|
|
80732
|
+
readonly $ref: "#/components/schemas/ProgressInvoiceCreate/properties/payment_terms";
|
|
80733
|
+
};
|
|
80395
80734
|
readonly created: {
|
|
80396
80735
|
readonly description: "Created date of invoice";
|
|
80397
80736
|
readonly type: "string";
|
|
@@ -80737,12 +81076,6 @@ declare const DepositInvoiceCreateSchema: {
|
|
|
80737
81076
|
readonly description: "Date of the invoice";
|
|
80738
81077
|
readonly example: "2022-01-02";
|
|
80739
81078
|
};
|
|
80740
|
-
readonly due_date: {
|
|
80741
|
-
readonly type: "string";
|
|
80742
|
-
readonly format: "date";
|
|
80743
|
-
readonly description: "Due date of the invoice";
|
|
80744
|
-
readonly example: "2022-02-02";
|
|
80745
|
-
};
|
|
80746
81079
|
readonly subject: {
|
|
80747
81080
|
readonly type: "string";
|
|
80748
81081
|
readonly description: "Subject of the invoice";
|
|
@@ -80802,6 +81135,228 @@ declare const DepositInvoiceCreateSchema: {
|
|
|
80802
81135
|
readonly description: "Analytic code of document";
|
|
80803
81136
|
readonly example: "divers";
|
|
80804
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
|
+
};
|
|
80805
81360
|
};
|
|
80806
81361
|
readonly required: readonly ["parent", "rows"];
|
|
80807
81362
|
};
|
|
@@ -80924,6 +81479,9 @@ declare const DepositInvoiceUpdateSchema: {
|
|
|
80924
81479
|
readonly description: "Analytic code of document";
|
|
80925
81480
|
readonly example: "divers";
|
|
80926
81481
|
};
|
|
81482
|
+
readonly payment_terms: {
|
|
81483
|
+
readonly $ref: "#/components/schemas/DepositInvoiceCreate/properties/payment_terms";
|
|
81484
|
+
};
|
|
80927
81485
|
};
|
|
80928
81486
|
};
|
|
80929
81487
|
declare const DepositInvoicePrepareInputSchema: {
|
|
@@ -96083,6 +96641,11 @@ declare const DealsWritableSchema: {
|
|
|
96083
96641
|
readonly minimum: 0;
|
|
96084
96642
|
readonly maximum: 1;
|
|
96085
96643
|
};
|
|
96644
|
+
readonly meet_link: {
|
|
96645
|
+
readonly type: "string";
|
|
96646
|
+
readonly description: "Meet link for the calendar event";
|
|
96647
|
+
readonly nullable: true;
|
|
96648
|
+
};
|
|
96086
96649
|
};
|
|
96087
96650
|
}, {
|
|
96088
96651
|
readonly title: "Email";
|
|
@@ -97154,6 +97717,24 @@ declare const OcrWritableSchema: {
|
|
|
97154
97717
|
readonly enum: readonly ["ocr", "facturx"];
|
|
97155
97718
|
readonly example: "ocr";
|
|
97156
97719
|
};
|
|
97720
|
+
readonly supplier: {
|
|
97721
|
+
readonly type: "string";
|
|
97722
|
+
readonly description: "Supplier name";
|
|
97723
|
+
readonly nullable: true;
|
|
97724
|
+
readonly example: "SELLSY";
|
|
97725
|
+
};
|
|
97726
|
+
readonly total_excl_tax: {
|
|
97727
|
+
readonly type: "string";
|
|
97728
|
+
readonly description: "Total amount excluding tax";
|
|
97729
|
+
readonly nullable: true;
|
|
97730
|
+
readonly example: "35.00";
|
|
97731
|
+
};
|
|
97732
|
+
readonly currency: {
|
|
97733
|
+
readonly type: "string";
|
|
97734
|
+
readonly description: "Currency code";
|
|
97735
|
+
readonly nullable: true;
|
|
97736
|
+
readonly example: "EUR";
|
|
97737
|
+
};
|
|
97157
97738
|
};
|
|
97158
97739
|
};
|
|
97159
97740
|
declare const InvoicingConformityStateWritableSchema: {
|
|
@@ -99766,7 +100347,7 @@ declare const InvoiceWritableSchema: {
|
|
|
99766
100347
|
readonly due_date: {
|
|
99767
100348
|
readonly type: "string";
|
|
99768
100349
|
readonly format: "date";
|
|
99769
|
-
readonly description: "
|
|
100350
|
+
readonly description: "Due date of the invoice.\n";
|
|
99770
100351
|
readonly example: "2022-02-02";
|
|
99771
100352
|
};
|
|
99772
100353
|
readonly created: {
|
|
@@ -100148,7 +100729,7 @@ declare const InvoiceOneWritableSchema: {
|
|
|
100148
100729
|
readonly due_date: {
|
|
100149
100730
|
readonly type: "string";
|
|
100150
100731
|
readonly format: "date";
|
|
100151
|
-
readonly description: "
|
|
100732
|
+
readonly description: "Due date of the invoice.\n";
|
|
100152
100733
|
readonly example: "2022-02-02";
|
|
100153
100734
|
};
|
|
100154
100735
|
readonly created: {
|
|
@@ -101377,9 +101958,13 @@ declare const InvoiceCreateWritableSchema: {
|
|
|
101377
101958
|
readonly due_date: {
|
|
101378
101959
|
readonly type: "string";
|
|
101379
101960
|
readonly format: "date";
|
|
101380
|
-
readonly
|
|
101961
|
+
readonly deprecated: true;
|
|
101962
|
+
readonly description: "Deprecated: Use `payment_terms` instead. <br/> Due date of the invoice.\n";
|
|
101381
101963
|
readonly example: "2022-02-02";
|
|
101382
101964
|
};
|
|
101965
|
+
readonly payment_terms: {
|
|
101966
|
+
readonly $ref: "#/components/schemas/ProgressInvoiceCreate/properties/payment_terms";
|
|
101967
|
+
};
|
|
101383
101968
|
readonly created: {
|
|
101384
101969
|
readonly description: "Created date of invoice";
|
|
101385
101970
|
readonly type: "string";
|
|
@@ -101725,12 +102310,6 @@ declare const DepositInvoiceCreateWritableSchema: {
|
|
|
101725
102310
|
readonly description: "Date of the invoice";
|
|
101726
102311
|
readonly example: "2022-01-02";
|
|
101727
102312
|
};
|
|
101728
|
-
readonly due_date: {
|
|
101729
|
-
readonly type: "string";
|
|
101730
|
-
readonly format: "date";
|
|
101731
|
-
readonly description: "Due date of the invoice";
|
|
101732
|
-
readonly example: "2022-02-02";
|
|
101733
|
-
};
|
|
101734
102313
|
readonly subject: {
|
|
101735
102314
|
readonly type: "string";
|
|
101736
102315
|
readonly description: "Subject of the invoice";
|
|
@@ -101790,6 +102369,228 @@ declare const DepositInvoiceCreateWritableSchema: {
|
|
|
101790
102369
|
readonly description: "Analytic code of document";
|
|
101791
102370
|
readonly example: "divers";
|
|
101792
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
|
+
};
|
|
101793
102594
|
};
|
|
101794
102595
|
readonly required: readonly ["parent", "rows"];
|
|
101795
102596
|
};
|
|
@@ -101912,6 +102713,9 @@ declare const DepositInvoiceUpdateWritableSchema: {
|
|
|
101912
102713
|
readonly description: "Analytic code of document";
|
|
101913
102714
|
readonly example: "divers";
|
|
101914
102715
|
};
|
|
102716
|
+
readonly payment_terms: {
|
|
102717
|
+
readonly $ref: "#/components/schemas/DepositInvoiceCreate/properties/payment_terms";
|
|
102718
|
+
};
|
|
101915
102719
|
};
|
|
101916
102720
|
};
|
|
101917
102721
|
declare const DepositInvoiceOneWritableSchema: {
|