@getyetty-sdk/sellsy 2026.7.2 → 2026.7.8
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 +684 -480
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +218 -14
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -5195,7 +5195,7 @@ type Deals = {
|
|
|
5195
5195
|
*/
|
|
5196
5196
|
related?: Array<{
|
|
5197
5197
|
id?: number;
|
|
5198
|
-
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery';
|
|
5198
|
+
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
5199
5199
|
}>;
|
|
5200
5200
|
/**
|
|
5201
5201
|
* Owner of the task
|
|
@@ -7671,7 +7671,7 @@ type TaskItem = _heyapi_439_ & {
|
|
|
7671
7671
|
/**
|
|
7672
7672
|
* Objects linked to the task
|
|
7673
7673
|
*/
|
|
7674
|
-
related?: Array<_heyapi_435_ | _heyapi_436_ | _heyapi_437_ | _heyapi_438_ | _heyapi_568_ | _heyapi_569_ | _heyapi_472_>;
|
|
7674
|
+
related?: Array<_heyapi_435_ | _heyapi_436_ | _heyapi_437_ | _heyapi_438_ | _heyapi_568_ | _heyapi_569_ | _heyapi_472_ | _heyapi_570_ | _heyapi_571_ | _heyapi_572_ | _heyapi_573_ | _heyapi_574_>;
|
|
7675
7675
|
company?: _heyapi_435_;
|
|
7676
7676
|
individual?: _heyapi_436_;
|
|
7677
7677
|
contact?: _heyapi_437_;
|
|
@@ -7679,7 +7679,7 @@ type TaskItem = _heyapi_439_ & {
|
|
|
7679
7679
|
/**
|
|
7680
7680
|
* Task ACL
|
|
7681
7681
|
*/
|
|
7682
|
-
acl?:
|
|
7682
|
+
acl?: _heyapi_575_ | null;
|
|
7683
7683
|
};
|
|
7684
7684
|
};
|
|
7685
7685
|
/**
|
|
@@ -7691,7 +7691,7 @@ type TaskCollectionItem = _heyapi_439_ & {
|
|
|
7691
7691
|
*
|
|
7692
7692
|
* Objects add to response. Use embed parameter
|
|
7693
7693
|
*/
|
|
7694
|
-
_embed?:
|
|
7694
|
+
_embed?: _heyapi_577_;
|
|
7695
7695
|
};
|
|
7696
7696
|
/**
|
|
7697
7697
|
* TaskCreateItem
|
|
@@ -7740,7 +7740,7 @@ type TaskCreateItem = {
|
|
|
7740
7740
|
*/
|
|
7741
7741
|
related: Array<{
|
|
7742
7742
|
id: number;
|
|
7743
|
-
type: 'opportunity' | 'company' | 'individual' | 'contact' | 'estimate' | 'invoice' | 'creditnote' | 'order' | 'delivery';
|
|
7743
|
+
type: 'opportunity' | 'company' | 'individual' | 'contact' | 'estimate' | 'invoice' | 'creditnote' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
7744
7744
|
}>;
|
|
7745
7745
|
/**
|
|
7746
7746
|
* Owner of the task (Staff id expected)
|
|
@@ -7756,7 +7756,7 @@ type TaskCreateItem = {
|
|
|
7756
7756
|
*/
|
|
7757
7757
|
related: Array<{
|
|
7758
7758
|
id: number;
|
|
7759
|
-
type: 'opportunity' | 'company' | 'individual' | 'contact' | 'estimate' | 'invoice' | 'creditnote' | 'order' | 'delivery';
|
|
7759
|
+
type: 'opportunity' | 'company' | 'individual' | 'contact' | 'estimate' | 'invoice' | 'creditnote' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
7760
7760
|
}>;
|
|
7761
7761
|
/**
|
|
7762
7762
|
* Date of creation of the calendar event
|
|
@@ -7814,7 +7814,7 @@ type TaskUpdateItem = {
|
|
|
7814
7814
|
*/
|
|
7815
7815
|
related?: Array<{
|
|
7816
7816
|
id: number;
|
|
7817
|
-
type: 'opportunity' | 'company' | 'individual' | 'contact' | 'estimate' | 'invoice' | 'creditnote' | 'order' | 'delivery';
|
|
7817
|
+
type: 'opportunity' | 'company' | 'individual' | 'contact' | 'estimate' | 'invoice' | 'creditnote' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
7818
7818
|
}>;
|
|
7819
7819
|
/**
|
|
7820
7820
|
* Owner of the task (Staff id expected)
|
|
@@ -8030,7 +8030,7 @@ type LabelBaseItem = {
|
|
|
8030
8030
|
*/
|
|
8031
8031
|
related?: Array<{
|
|
8032
8032
|
id?: number;
|
|
8033
|
-
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery';
|
|
8033
|
+
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
8034
8034
|
}>;
|
|
8035
8035
|
/**
|
|
8036
8036
|
* Owner of the task
|
|
@@ -8096,7 +8096,7 @@ type SearchResult = Array<({
|
|
|
8096
8096
|
object?: {
|
|
8097
8097
|
type?: 'contact' | 'company' | 'individual' | 'opportunity' | 'purchase' | 'item' | 'declination' | 'document' | 'staff' | 'redactor';
|
|
8098
8098
|
id?: number;
|
|
8099
|
-
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
8099
|
+
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'model' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
8100
8100
|
};
|
|
8101
8101
|
owner?: _heyapi_429_;
|
|
8102
8102
|
/**
|
|
@@ -8166,7 +8166,7 @@ type SearchResult = Array<({
|
|
|
8166
8166
|
*/
|
|
8167
8167
|
country_code?: string;
|
|
8168
8168
|
} | null;
|
|
8169
|
-
delivery_address?:
|
|
8169
|
+
delivery_address?: _heyapi_585_;
|
|
8170
8170
|
/**
|
|
8171
8171
|
* Company's main contact
|
|
8172
8172
|
*/
|
|
@@ -8192,7 +8192,7 @@ type SearchResult = Array<({
|
|
|
8192
8192
|
* Company reference
|
|
8193
8193
|
*/
|
|
8194
8194
|
reference?: string;
|
|
8195
|
-
}) | (
|
|
8195
|
+
}) | (_heyapi_586_ & {
|
|
8196
8196
|
/**
|
|
8197
8197
|
* Individual first name
|
|
8198
8198
|
*/
|
|
@@ -8218,13 +8218,13 @@ type SearchResult = Array<({
|
|
|
8218
8218
|
*/
|
|
8219
8219
|
phone_number?: string | null;
|
|
8220
8220
|
email?: string | null;
|
|
8221
|
-
invoicing_address?:
|
|
8222
|
-
delivery_address?:
|
|
8221
|
+
invoicing_address?: _heyapi_585_;
|
|
8222
|
+
delivery_address?: _heyapi_585_;
|
|
8223
8223
|
/**
|
|
8224
8224
|
* Individual reference
|
|
8225
8225
|
*/
|
|
8226
8226
|
reference?: string;
|
|
8227
|
-
}) | (
|
|
8227
|
+
}) | (_heyapi_586_ & {
|
|
8228
8228
|
/**
|
|
8229
8229
|
* Opportunity ident
|
|
8230
8230
|
*/
|
|
@@ -8264,7 +8264,7 @@ type SearchResult = Array<({
|
|
|
8264
8264
|
*/
|
|
8265
8265
|
civility?: 'mr' | 'mrs' | 'ms';
|
|
8266
8266
|
});
|
|
8267
|
-
}) | (
|
|
8267
|
+
}) | (_heyapi_586_ & {
|
|
8268
8268
|
/**
|
|
8269
8269
|
* Contact first name
|
|
8270
8270
|
*/
|
|
@@ -8307,13 +8307,13 @@ type SearchResult = Array<({
|
|
|
8307
8307
|
*/
|
|
8308
8308
|
id?: number;
|
|
8309
8309
|
}>;
|
|
8310
|
-
invoicing_address?:
|
|
8311
|
-
delivery_address?:
|
|
8312
|
-
}) | (
|
|
8310
|
+
invoicing_address?: _heyapi_585_;
|
|
8311
|
+
delivery_address?: _heyapi_585_;
|
|
8312
|
+
}) | (_heyapi_586_ & {
|
|
8313
8313
|
/**
|
|
8314
8314
|
* Purchase status
|
|
8315
8315
|
*/
|
|
8316
|
-
status?: 'draft' | 'due' | 'payinprogress' | 'paid' | 'late' | 'cancelled' | 'sent' | 'read' | 'accepted' | 'expired' | '
|
|
8316
|
+
status?: 'draft' | 'due' | 'payinprogress' | 'paid' | 'late' | 'cancelled' | 'sent' | 'read' | 'accepted' | 'expired' | 'partialinvoiced' | 'invoiced' | 'stored' | 'spent' | 'partialspend';
|
|
8317
8317
|
/**
|
|
8318
8318
|
* Purchase number
|
|
8319
8319
|
*/
|
|
@@ -8357,7 +8357,7 @@ type SearchResult = Array<({
|
|
|
8357
8357
|
*/
|
|
8358
8358
|
civility?: 'mr' | 'mrs' | 'ms';
|
|
8359
8359
|
});
|
|
8360
|
-
}) | (
|
|
8360
|
+
}) | (_heyapi_586_ & {
|
|
8361
8361
|
/**
|
|
8362
8362
|
* Item number
|
|
8363
8363
|
*/
|
|
@@ -8370,7 +8370,7 @@ type SearchResult = Array<({
|
|
|
8370
8370
|
* Item description
|
|
8371
8371
|
*/
|
|
8372
8372
|
description?: string | null;
|
|
8373
|
-
}) | (
|
|
8373
|
+
}) | (_heyapi_586_ & {
|
|
8374
8374
|
/**
|
|
8375
8375
|
* Item declination number
|
|
8376
8376
|
*/
|
|
@@ -8391,7 +8391,7 @@ type SearchResult = Array<({
|
|
|
8391
8391
|
number?: string;
|
|
8392
8392
|
name?: string;
|
|
8393
8393
|
};
|
|
8394
|
-
}) | (
|
|
8394
|
+
}) | (_heyapi_586_ & {
|
|
8395
8395
|
/**
|
|
8396
8396
|
* Document status
|
|
8397
8397
|
*/
|
|
@@ -8435,7 +8435,7 @@ type SearchResult = Array<({
|
|
|
8435
8435
|
*/
|
|
8436
8436
|
civility?: 'mr' | 'mrs' | 'ms';
|
|
8437
8437
|
});
|
|
8438
|
-
}) | (
|
|
8438
|
+
}) | (_heyapi_586_ & {
|
|
8439
8439
|
/**
|
|
8440
8440
|
* Staff's first name
|
|
8441
8441
|
*/
|
|
@@ -8464,7 +8464,7 @@ type SearchResult = Array<({
|
|
|
8464
8464
|
* Staff's job
|
|
8465
8465
|
*/
|
|
8466
8466
|
position?: string | null;
|
|
8467
|
-
}) | (
|
|
8467
|
+
}) | (_heyapi_586_ & {
|
|
8468
8468
|
/**
|
|
8469
8469
|
* Ticket status
|
|
8470
8470
|
*/
|
|
@@ -8478,7 +8478,7 @@ type SearchResult = Array<({
|
|
|
8478
8478
|
*/
|
|
8479
8479
|
index?: string;
|
|
8480
8480
|
related?: Array<string>;
|
|
8481
|
-
}) | (
|
|
8481
|
+
}) | (_heyapi_586_ & {
|
|
8482
8482
|
/**
|
|
8483
8483
|
* Redactor status
|
|
8484
8484
|
*/
|
|
@@ -8492,7 +8492,7 @@ type SearchResult = Array<({
|
|
|
8492
8492
|
*/
|
|
8493
8493
|
ident?: string;
|
|
8494
8494
|
related?: Array<string>;
|
|
8495
|
-
}) | (
|
|
8495
|
+
}) | (_heyapi_586_ & {
|
|
8496
8496
|
/**
|
|
8497
8497
|
* Redactor template name
|
|
8498
8498
|
*/
|
|
@@ -8517,7 +8517,7 @@ type SearchResultBaseItem = {
|
|
|
8517
8517
|
object?: {
|
|
8518
8518
|
type?: 'contact' | 'company' | 'individual' | 'opportunity' | 'purchase' | 'item' | 'declination' | 'document' | 'staff' | 'redactor';
|
|
8519
8519
|
id?: number;
|
|
8520
|
-
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
8520
|
+
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'model' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
8521
8521
|
};
|
|
8522
8522
|
owner?: _heyapi_429_;
|
|
8523
8523
|
/**
|
|
@@ -8545,16 +8545,16 @@ type SearchResultAggregations = {
|
|
|
8545
8545
|
* The 1st value corresponds to active objects, the 2nd to achived objects
|
|
8546
8546
|
*/
|
|
8547
8547
|
company?: Array<number>;
|
|
8548
|
-
individual?:
|
|
8549
|
-
contact?:
|
|
8550
|
-
opportunity?:
|
|
8551
|
-
purchase?:
|
|
8552
|
-
item?:
|
|
8553
|
-
declination?:
|
|
8554
|
-
document?:
|
|
8555
|
-
staff?:
|
|
8556
|
-
ticket?:
|
|
8557
|
-
redactor?:
|
|
8548
|
+
individual?: _heyapi_589_;
|
|
8549
|
+
contact?: _heyapi_589_;
|
|
8550
|
+
opportunity?: _heyapi_589_;
|
|
8551
|
+
purchase?: _heyapi_589_;
|
|
8552
|
+
item?: _heyapi_589_;
|
|
8553
|
+
declination?: _heyapi_589_;
|
|
8554
|
+
document?: _heyapi_589_;
|
|
8555
|
+
staff?: _heyapi_589_;
|
|
8556
|
+
ticket?: _heyapi_589_;
|
|
8557
|
+
redactor?: _heyapi_589_;
|
|
8558
8558
|
};
|
|
8559
8559
|
};
|
|
8560
8560
|
/**
|
|
@@ -8698,8 +8698,8 @@ type PhoneCallItem = {
|
|
|
8698
8698
|
/**
|
|
8699
8699
|
* PhoneCall
|
|
8700
8700
|
*/
|
|
8701
|
-
type PhoneCallCollectionItem =
|
|
8702
|
-
_embed?:
|
|
8701
|
+
type PhoneCallCollectionItem = _heyapi_592_ & {
|
|
8702
|
+
_embed?: _heyapi_593_;
|
|
8703
8703
|
};
|
|
8704
8704
|
/**
|
|
8705
8705
|
* PhoneCall
|
|
@@ -8919,7 +8919,7 @@ type PhoneCallFilter = {
|
|
|
8919
8919
|
/**
|
|
8920
8920
|
* Calendar Event
|
|
8921
8921
|
*/
|
|
8922
|
-
type CalendarEventItem =
|
|
8922
|
+
type CalendarEventItem = _heyapi_598_ & {
|
|
8923
8923
|
/**
|
|
8924
8924
|
* Objects add to response. Use embed parameter
|
|
8925
8925
|
*/
|
|
@@ -8933,7 +8933,7 @@ type CalendarEventItem = _heyapi_593_ & {
|
|
|
8933
8933
|
*/
|
|
8934
8934
|
related?: Array<_heyapi_435_ | _heyapi_436_ | _heyapi_437_ | _heyapi_438_ | _heyapi_472_ | _heyapi_568_ | _heyapi_569_>;
|
|
8935
8935
|
participants?: Array<_heyapi_437_ | _heyapi_434_>;
|
|
8936
|
-
acl?:
|
|
8936
|
+
acl?: _heyapi_599_;
|
|
8937
8937
|
};
|
|
8938
8938
|
};
|
|
8939
8939
|
/**
|
|
@@ -9212,13 +9212,13 @@ type Activity = {
|
|
|
9212
9212
|
object?: {
|
|
9213
9213
|
type: string;
|
|
9214
9214
|
id: string | number;
|
|
9215
|
-
model?: _heyapi_435_ | _heyapi_438_ | _heyapi_439_ | _heyapi_437_ | _heyapi_436_ |
|
|
9215
|
+
model?: _heyapi_435_ | _heyapi_438_ | _heyapi_439_ | _heyapi_437_ | _heyapi_436_ | _heyapi_606_ | _heyapi_598_ | _heyapi_607_ | null;
|
|
9216
9216
|
};
|
|
9217
9217
|
/**
|
|
9218
9218
|
* List all direct and indirect relations of the activity’s main object
|
|
9219
9219
|
*/
|
|
9220
9220
|
related?: Array<{
|
|
9221
|
-
id?:
|
|
9221
|
+
id?: _heyapi_608_;
|
|
9222
9222
|
type?: string;
|
|
9223
9223
|
}>;
|
|
9224
9224
|
/**
|
|
@@ -9236,7 +9236,7 @@ type Activity = {
|
|
|
9236
9236
|
*
|
|
9237
9237
|
* Staff schemas according of current user level of visibility on staffs
|
|
9238
9238
|
*/
|
|
9239
|
-
author?:
|
|
9239
|
+
author?: _heyapi_609_ & {
|
|
9240
9240
|
/**
|
|
9241
9241
|
* Staff phone number
|
|
9242
9242
|
*/
|
|
@@ -9433,7 +9433,7 @@ type ActivityFilters = {
|
|
|
9433
9433
|
*/
|
|
9434
9434
|
id?: number;
|
|
9435
9435
|
};
|
|
9436
|
-
entities?: Array<
|
|
9436
|
+
entities?: Array<_heyapi_611_>;
|
|
9437
9437
|
due_date?: _heyapi_513_;
|
|
9438
9438
|
/**
|
|
9439
9439
|
* Filter activity by level. Get main activities/secondary activities or both by default.
|
|
@@ -9559,15 +9559,15 @@ type EmailEngineItem = {
|
|
|
9559
9559
|
/**
|
|
9560
9560
|
* An array of name+email pairs the message was sent to.
|
|
9561
9561
|
*/
|
|
9562
|
-
to?: Array<
|
|
9562
|
+
to?: Array<_heyapi_614_>;
|
|
9563
9563
|
/**
|
|
9564
9564
|
* An array of name+email pairs the message was cc'd to.
|
|
9565
9565
|
*/
|
|
9566
|
-
cc?: Array<
|
|
9566
|
+
cc?: Array<_heyapi_614_>;
|
|
9567
9567
|
/**
|
|
9568
9568
|
* An array of name+email pairs the message was bcc'd to. For received mail this is nearly always empty.
|
|
9569
9569
|
*/
|
|
9570
|
-
bcc?: Array<
|
|
9570
|
+
bcc?: Array<_heyapi_614_>;
|
|
9571
9571
|
/**
|
|
9572
9572
|
* Private email or not
|
|
9573
9573
|
*/
|
|
@@ -9676,17 +9676,17 @@ type EmailSendBody = {
|
|
|
9676
9676
|
* Object id
|
|
9677
9677
|
*/
|
|
9678
9678
|
id: number;
|
|
9679
|
-
type:
|
|
9679
|
+
type: _heyapi_616_;
|
|
9680
9680
|
}>;
|
|
9681
9681
|
}>;
|
|
9682
9682
|
/**
|
|
9683
9683
|
* Recipients in copy
|
|
9684
9684
|
*/
|
|
9685
|
-
cc?: Array<
|
|
9685
|
+
cc?: Array<_heyapi_617_>;
|
|
9686
9686
|
/**
|
|
9687
9687
|
* Recipients in blind copy
|
|
9688
9688
|
*/
|
|
9689
|
-
bcc?: Array<
|
|
9689
|
+
bcc?: Array<_heyapi_617_>;
|
|
9690
9690
|
/**
|
|
9691
9691
|
* Related objects
|
|
9692
9692
|
*/
|
|
@@ -9743,7 +9743,7 @@ type EmailSendBody = {
|
|
|
9743
9743
|
* Id of file uploaded. Returned by the upload endpoint POST /email/attachment
|
|
9744
9744
|
*/
|
|
9745
9745
|
content_id: string;
|
|
9746
|
-
}) | (
|
|
9746
|
+
}) | (_heyapi_618_ & {
|
|
9747
9747
|
/**
|
|
9748
9748
|
* Public link to the attachment
|
|
9749
9749
|
*/
|
|
@@ -9900,7 +9900,7 @@ type EmailAuthenticationItem = {
|
|
|
9900
9900
|
*/
|
|
9901
9901
|
data?: string;
|
|
9902
9902
|
};
|
|
9903
|
-
dkim2?:
|
|
9903
|
+
dkim2?: _heyapi_623_;
|
|
9904
9904
|
};
|
|
9905
9905
|
};
|
|
9906
9906
|
/**
|
|
@@ -9929,9 +9929,9 @@ type EmailValidationItem = {
|
|
|
9929
9929
|
*/
|
|
9930
9930
|
reason?: string | null;
|
|
9931
9931
|
} | null;
|
|
9932
|
-
dkim1?:
|
|
9933
|
-
dkim2?:
|
|
9934
|
-
spf?:
|
|
9932
|
+
dkim1?: _heyapi_625_;
|
|
9933
|
+
dkim2?: _heyapi_625_;
|
|
9934
|
+
spf?: _heyapi_625_;
|
|
9935
9935
|
};
|
|
9936
9936
|
};
|
|
9937
9937
|
/**
|
|
@@ -9977,7 +9977,7 @@ type EmailRecipientSuggestionOutput = Array<{
|
|
|
9977
9977
|
* Suggested recipient's name
|
|
9978
9978
|
*/
|
|
9979
9979
|
name?: string;
|
|
9980
|
-
relatedObject?:
|
|
9980
|
+
relatedObject?: _heyapi_630_;
|
|
9981
9981
|
}>;
|
|
9982
9982
|
/**
|
|
9983
9983
|
* Recipient
|
|
@@ -10125,7 +10125,7 @@ type EmailTemplateOutput = {
|
|
|
10125
10125
|
* Content of template
|
|
10126
10126
|
*/
|
|
10127
10127
|
content?: string;
|
|
10128
|
-
attachments?:
|
|
10128
|
+
attachments?: _heyapi_636_;
|
|
10129
10129
|
/**
|
|
10130
10130
|
* Content to call AI
|
|
10131
10131
|
*/
|
|
@@ -10212,7 +10212,7 @@ type EmailTemplateItemOutput = {
|
|
|
10212
10212
|
/**
|
|
10213
10213
|
* Attachment objects
|
|
10214
10214
|
*/
|
|
10215
|
-
attachments?: Array<
|
|
10215
|
+
attachments?: Array<_heyapi_636_>;
|
|
10216
10216
|
/**
|
|
10217
10217
|
* Template used in automation
|
|
10218
10218
|
*/
|
|
@@ -10286,7 +10286,7 @@ type EmailProviderThread = {
|
|
|
10286
10286
|
/**
|
|
10287
10287
|
* An array containing the names and email addresses of all participants in the thread
|
|
10288
10288
|
*/
|
|
10289
|
-
participants?: Array<
|
|
10289
|
+
participants?: Array<_heyapi_614_>;
|
|
10290
10290
|
/**
|
|
10291
10291
|
* An array of unique identifiers for all messages in the thread
|
|
10292
10292
|
*/
|
|
@@ -10299,7 +10299,7 @@ type EmailProviderThread = {
|
|
|
10299
10299
|
* Indicates whether the last sent email has been opened by the recipient. (Only applicable to emails sent through the web app)
|
|
10300
10300
|
*/
|
|
10301
10301
|
is_open?: boolean;
|
|
10302
|
-
related?: Array<
|
|
10302
|
+
related?: Array<_heyapi_642_ | _heyapi_643_ | _heyapi_644_ | _heyapi_645_>;
|
|
10303
10303
|
_links?: Array<{
|
|
10304
10304
|
rel?: string;
|
|
10305
10305
|
href?: string;
|
|
@@ -10332,19 +10332,19 @@ type EmailProviderMessage = {
|
|
|
10332
10332
|
* The body of the message
|
|
10333
10333
|
*/
|
|
10334
10334
|
content?: string;
|
|
10335
|
-
from?:
|
|
10335
|
+
from?: _heyapi_614_;
|
|
10336
10336
|
/**
|
|
10337
10337
|
* An array of name/email address pairs that the email message was sent to
|
|
10338
10338
|
*/
|
|
10339
|
-
to?: Array<
|
|
10339
|
+
to?: Array<_heyapi_614_>;
|
|
10340
10340
|
/**
|
|
10341
10341
|
* An array of name/email address pairs that the email message was CC'd to
|
|
10342
10342
|
*/
|
|
10343
|
-
cc?: Array<
|
|
10343
|
+
cc?: Array<_heyapi_614_>;
|
|
10344
10344
|
/**
|
|
10345
10345
|
* An array of name/email address pairs that the email message was BCC'd to
|
|
10346
10346
|
*/
|
|
10347
|
-
bcc?: Array<
|
|
10347
|
+
bcc?: Array<_heyapi_614_>;
|
|
10348
10348
|
/**
|
|
10349
10349
|
* Indicates whether the email message has been read by the user
|
|
10350
10350
|
*/
|
|
@@ -10352,7 +10352,7 @@ type EmailProviderMessage = {
|
|
|
10352
10352
|
/**
|
|
10353
10353
|
* Attachment objects
|
|
10354
10354
|
*/
|
|
10355
|
-
attachments?: Array<
|
|
10355
|
+
attachments?: Array<_heyapi_648_>;
|
|
10356
10356
|
/**
|
|
10357
10357
|
* The date and time of the most recent message in the thread
|
|
10358
10358
|
*/
|
|
@@ -10364,7 +10364,7 @@ type EmailProviderMessage = {
|
|
|
10364
10364
|
id?: number;
|
|
10365
10365
|
type?: string;
|
|
10366
10366
|
}>;
|
|
10367
|
-
_links?:
|
|
10367
|
+
_links?: _heyapi_649_;
|
|
10368
10368
|
};
|
|
10369
10369
|
/**
|
|
10370
10370
|
* WebhookFilters
|
|
@@ -10442,7 +10442,7 @@ type WebhookReadItem = ({
|
|
|
10442
10442
|
*/
|
|
10443
10443
|
channel?: string | null;
|
|
10444
10444
|
}>;
|
|
10445
|
-
}) | (
|
|
10445
|
+
}) | (_heyapi_652_ & {
|
|
10446
10446
|
/**
|
|
10447
10447
|
* Returns the complete object in the webhook payload
|
|
10448
10448
|
*/
|
|
@@ -10488,7 +10488,7 @@ type WebhookEditItem = {
|
|
|
10488
10488
|
* required for slack type webhook
|
|
10489
10489
|
*/
|
|
10490
10490
|
default_channel?: string | null;
|
|
10491
|
-
configuration?:
|
|
10491
|
+
configuration?: _heyapi_654_;
|
|
10492
10492
|
} | {
|
|
10493
10493
|
/**
|
|
10494
10494
|
* Webhook status
|
|
@@ -10514,7 +10514,7 @@ type WebhookEditItem = {
|
|
|
10514
10514
|
* Key used for signing webhooks
|
|
10515
10515
|
*/
|
|
10516
10516
|
sign_key?: string;
|
|
10517
|
-
configuration?:
|
|
10517
|
+
configuration?: _heyapi_655_;
|
|
10518
10518
|
};
|
|
10519
10519
|
type WebhookCreateItem = {
|
|
10520
10520
|
/**
|
|
@@ -10537,7 +10537,7 @@ type WebhookCreateItem = {
|
|
|
10537
10537
|
* Webhook type
|
|
10538
10538
|
*/
|
|
10539
10539
|
type?: 'slack' | 'http';
|
|
10540
|
-
configuration?:
|
|
10540
|
+
configuration?: _heyapi_654_;
|
|
10541
10541
|
} | {
|
|
10542
10542
|
/**
|
|
10543
10543
|
* Webhook status
|
|
@@ -10567,7 +10567,7 @@ type WebhookCreateItem = {
|
|
|
10567
10567
|
* Key used for signing webhooks
|
|
10568
10568
|
*/
|
|
10569
10569
|
sign_key?: string;
|
|
10570
|
-
configuration?:
|
|
10570
|
+
configuration?: _heyapi_655_;
|
|
10571
10571
|
};
|
|
10572
10572
|
/**
|
|
10573
10573
|
* webhookEvents
|
|
@@ -10589,7 +10589,7 @@ type WebhookEventsList = Array<{
|
|
|
10589
10589
|
events?: {
|
|
10590
10590
|
[key: string]: string;
|
|
10591
10591
|
};
|
|
10592
|
-
} | (
|
|
10592
|
+
} | (_heyapi_658_ & {
|
|
10593
10593
|
/**
|
|
10594
10594
|
* Entity
|
|
10595
10595
|
*/
|
|
@@ -10841,7 +10841,7 @@ type RecordPayment = {
|
|
|
10841
10841
|
tax_id?: number;
|
|
10842
10842
|
rate?: string;
|
|
10843
10843
|
vat_amount?: string;
|
|
10844
|
-
|
|
10844
|
+
amount_excl_vat?: string;
|
|
10845
10845
|
}>;
|
|
10846
10846
|
/**
|
|
10847
10847
|
* Bank deposit to attach to the payment
|
|
@@ -10860,7 +10860,6 @@ type PaymentContext = {
|
|
|
10860
10860
|
document?: {
|
|
10861
10861
|
id?: number;
|
|
10862
10862
|
type?: string;
|
|
10863
|
-
third_id?: number;
|
|
10864
10863
|
total_amount?: string;
|
|
10865
10864
|
due_amount?: string;
|
|
10866
10865
|
currency_id?: number;
|
|
@@ -10873,7 +10872,7 @@ type PaymentContext = {
|
|
|
10873
10872
|
label?: string;
|
|
10874
10873
|
system_label?: string;
|
|
10875
10874
|
vat_amount?: string;
|
|
10876
|
-
|
|
10875
|
+
amount_excl_vat?: string;
|
|
10877
10876
|
}>;
|
|
10878
10877
|
deadlines?: Array<{
|
|
10879
10878
|
id?: number;
|
|
@@ -11510,88 +11509,88 @@ type Quotas = {
|
|
|
11510
11509
|
};
|
|
11511
11510
|
firm_search?: {
|
|
11512
11511
|
[key: string]: unknown;
|
|
11513
|
-
} &
|
|
11512
|
+
} & _heyapi_680_;
|
|
11514
11513
|
yousign?: {
|
|
11515
11514
|
[key: string]: unknown;
|
|
11516
|
-
} &
|
|
11515
|
+
} & _heyapi_680_;
|
|
11517
11516
|
esker?: {
|
|
11518
11517
|
[key: string]: unknown;
|
|
11519
|
-
} &
|
|
11518
|
+
} & _heyapi_680_;
|
|
11520
11519
|
sms_marketing?: {
|
|
11521
11520
|
[key: string]: unknown;
|
|
11522
|
-
} &
|
|
11521
|
+
} & _heyapi_680_;
|
|
11523
11522
|
custom_fields?: {
|
|
11524
11523
|
[key: string]: unknown;
|
|
11525
|
-
} &
|
|
11524
|
+
} & _heyapi_680_;
|
|
11526
11525
|
custom_field_groups?: {
|
|
11527
11526
|
[key: string]: unknown;
|
|
11528
|
-
} &
|
|
11527
|
+
} & _heyapi_680_;
|
|
11529
11528
|
pipelines?: {
|
|
11530
11529
|
[key: string]: unknown;
|
|
11531
|
-
} &
|
|
11530
|
+
} & _heyapi_680_;
|
|
11532
11531
|
privilege_profiles?: {
|
|
11533
11532
|
[key: string]: unknown;
|
|
11534
|
-
} &
|
|
11533
|
+
} & _heyapi_680_;
|
|
11535
11534
|
api_rate_seconds?: {
|
|
11536
11535
|
[key: string]: unknown;
|
|
11537
|
-
} &
|
|
11536
|
+
} & _heyapi_680_;
|
|
11538
11537
|
api_rate_minutes?: {
|
|
11539
11538
|
[key: string]: unknown;
|
|
11540
|
-
} &
|
|
11539
|
+
} & _heyapi_680_;
|
|
11541
11540
|
api_rate_days?: {
|
|
11542
11541
|
[key: string]: unknown;
|
|
11543
|
-
} &
|
|
11542
|
+
} & _heyapi_680_;
|
|
11544
11543
|
api_rate_months?: {
|
|
11545
11544
|
[key: string]: unknown;
|
|
11546
|
-
} &
|
|
11545
|
+
} & _heyapi_680_;
|
|
11547
11546
|
estimate_dunning_plan?: {
|
|
11548
11547
|
[key: string]: unknown;
|
|
11549
|
-
} &
|
|
11548
|
+
} & _heyapi_680_;
|
|
11550
11549
|
invoice_dunning_plan?: {
|
|
11551
11550
|
[key: string]: unknown;
|
|
11552
|
-
} &
|
|
11551
|
+
} & _heyapi_680_;
|
|
11553
11552
|
proforma_dunning_plan?: {
|
|
11554
11553
|
[key: string]: unknown;
|
|
11555
|
-
} &
|
|
11554
|
+
} & _heyapi_680_;
|
|
11556
11555
|
activity_report?: {
|
|
11557
11556
|
[key: string]: unknown;
|
|
11558
|
-
} &
|
|
11557
|
+
} & _heyapi_680_;
|
|
11559
11558
|
bank_account_reconciliations?: {
|
|
11560
11559
|
[key: string]: unknown;
|
|
11561
|
-
} &
|
|
11560
|
+
} & _heyapi_680_;
|
|
11562
11561
|
documents?: {
|
|
11563
11562
|
[key: string]: unknown;
|
|
11564
|
-
} &
|
|
11563
|
+
} & _heyapi_680_;
|
|
11565
11564
|
document_invoices?: {
|
|
11566
11565
|
[key: string]: unknown;
|
|
11567
|
-
} &
|
|
11566
|
+
} & _heyapi_680_;
|
|
11568
11567
|
file_storage?: {
|
|
11569
11568
|
[key: string]: unknown;
|
|
11570
|
-
} &
|
|
11569
|
+
} & _heyapi_680_;
|
|
11571
11570
|
rate_categories?: {
|
|
11572
11571
|
[key: string]: unknown;
|
|
11573
|
-
} &
|
|
11572
|
+
} & _heyapi_680_;
|
|
11574
11573
|
recurring?: {
|
|
11575
11574
|
[key: string]: unknown;
|
|
11576
|
-
} &
|
|
11575
|
+
} & _heyapi_680_;
|
|
11577
11576
|
report_cards?: {
|
|
11578
11577
|
[key: string]: unknown;
|
|
11579
|
-
} &
|
|
11578
|
+
} & _heyapi_680_;
|
|
11580
11579
|
catalog_items?: {
|
|
11581
11580
|
[key: string]: unknown;
|
|
11582
|
-
} &
|
|
11581
|
+
} & _heyapi_680_;
|
|
11583
11582
|
marketing_emailing?: {
|
|
11584
11583
|
[key: string]: unknown;
|
|
11585
|
-
} &
|
|
11584
|
+
} & _heyapi_680_;
|
|
11586
11585
|
marketing_transactional?: {
|
|
11587
11586
|
[key: string]: unknown;
|
|
11588
|
-
} &
|
|
11587
|
+
} & _heyapi_680_;
|
|
11589
11588
|
marketing_sms?: {
|
|
11590
11589
|
[key: string]: unknown;
|
|
11591
|
-
} &
|
|
11590
|
+
} & _heyapi_680_;
|
|
11592
11591
|
sellsy_ai?: {
|
|
11593
11592
|
[key: string]: unknown;
|
|
11594
|
-
} &
|
|
11593
|
+
} & _heyapi_680_;
|
|
11595
11594
|
};
|
|
11596
11595
|
/**
|
|
11597
11596
|
* Staff filters
|
|
@@ -11956,7 +11955,7 @@ type UserTwoFactorAuthenticationSettings = {
|
|
|
11956
11955
|
* List of registered provider for the user
|
|
11957
11956
|
*/
|
|
11958
11957
|
providers: Array<{
|
|
11959
|
-
provider:
|
|
11958
|
+
provider: _heyapi_695_;
|
|
11960
11959
|
/**
|
|
11961
11960
|
* is the primary provider
|
|
11962
11961
|
*/
|
|
@@ -12020,7 +12019,7 @@ type UserUpdateTwoFactorAuthenticationSettings = {
|
|
|
12020
12019
|
* List of registered provider for the user
|
|
12021
12020
|
*/
|
|
12022
12021
|
providers: Array<{
|
|
12023
|
-
provider:
|
|
12022
|
+
provider: _heyapi_695_;
|
|
12024
12023
|
}>;
|
|
12025
12024
|
};
|
|
12026
12025
|
/**
|
|
@@ -12035,7 +12034,7 @@ type UserUpdateTwoFactorAuthenticationSettingsResponse = {
|
|
|
12035
12034
|
* List of registered provider for the user
|
|
12036
12035
|
*/
|
|
12037
12036
|
providers: Array<{
|
|
12038
|
-
provider:
|
|
12037
|
+
provider: _heyapi_695_;
|
|
12039
12038
|
/**
|
|
12040
12039
|
* is the primary provider
|
|
12041
12040
|
*/
|
|
@@ -13355,7 +13354,7 @@ type InvoiceOne = {
|
|
|
13355
13354
|
* If the invoice is sent to accounting
|
|
13356
13355
|
*/
|
|
13357
13356
|
is_sent_to_accounting?: boolean;
|
|
13358
|
-
_embed?:
|
|
13357
|
+
_embed?: _heyapi_715_;
|
|
13359
13358
|
/**
|
|
13360
13359
|
* Date of the shipping
|
|
13361
13360
|
*/
|
|
@@ -13855,13 +13854,13 @@ type InvoiceOne = {
|
|
|
13855
13854
|
*/
|
|
13856
13855
|
is_optional?: boolean;
|
|
13857
13856
|
}>;
|
|
13858
|
-
_embed?:
|
|
13857
|
+
_embed?: _heyapi_715_ & {
|
|
13859
13858
|
/**
|
|
13860
13859
|
* Document Payment Terms
|
|
13861
13860
|
*
|
|
13862
13861
|
* Terms of payment of document
|
|
13863
13862
|
*/
|
|
13864
|
-
payment_terms?:
|
|
13863
|
+
payment_terms?: _heyapi_716_ & {
|
|
13865
13864
|
/**
|
|
13866
13865
|
* List of deadlines computed with the payment terms settings
|
|
13867
13866
|
*/
|
|
@@ -13892,7 +13891,7 @@ type InvoiceOne = {
|
|
|
13892
13891
|
description?: string | null;
|
|
13893
13892
|
}>;
|
|
13894
13893
|
};
|
|
13895
|
-
} &
|
|
13894
|
+
} & _heyapi_717_ & {
|
|
13896
13895
|
/**
|
|
13897
13896
|
* Automatic Dunning
|
|
13898
13897
|
*/
|
|
@@ -13991,7 +13990,7 @@ type InvoiceOne = {
|
|
|
13991
13990
|
}>;
|
|
13992
13991
|
};
|
|
13993
13992
|
settings?: _heyapi_476_;
|
|
13994
|
-
file?:
|
|
13993
|
+
file?: _heyapi_636_;
|
|
13995
13994
|
};
|
|
13996
13995
|
};
|
|
13997
13996
|
type InvoiceOrProgressInvoiceOne = InvoiceOne | (_heyapi_568_ & {
|
|
@@ -14030,8 +14029,8 @@ type InvoiceOrProgressInvoiceOne = InvoiceOne | (_heyapi_568_ & {
|
|
|
14030
14029
|
* The next available progress invoice number
|
|
14031
14030
|
*/
|
|
14032
14031
|
next_progress_invoice_number?: number | null;
|
|
14033
|
-
_embed?:
|
|
14034
|
-
automatic_dunning?:
|
|
14032
|
+
_embed?: _heyapi_715_ & _heyapi_719_ & _heyapi_717_ & {
|
|
14033
|
+
automatic_dunning?: _heyapi_720_;
|
|
14035
14034
|
settings?: {
|
|
14036
14035
|
pdf_display?: {
|
|
14037
14036
|
/**
|
|
@@ -14119,10 +14118,10 @@ type InvoiceOrProgressInvoiceOne = InvoiceOne | (_heyapi_568_ & {
|
|
|
14119
14118
|
show_terms_and_conditions_text?: boolean;
|
|
14120
14119
|
};
|
|
14121
14120
|
} & _heyapi_476_;
|
|
14122
|
-
file?:
|
|
14121
|
+
file?: _heyapi_636_;
|
|
14123
14122
|
};
|
|
14124
14123
|
});
|
|
14125
|
-
type ProgressInvoiceOne =
|
|
14124
|
+
type ProgressInvoiceOne = _heyapi_722_;
|
|
14126
14125
|
type InvoiceCompute = {
|
|
14127
14126
|
/**
|
|
14128
14127
|
* Status of the invoice
|
|
@@ -14222,7 +14221,7 @@ type InvoiceCompute = {
|
|
|
14222
14221
|
* payments methods allowed on the estimate
|
|
14223
14222
|
*/
|
|
14224
14223
|
payment_method_ids?: Array<number> | null;
|
|
14225
|
-
rows?: Array<
|
|
14224
|
+
rows?: Array<_heyapi_724_>;
|
|
14226
14225
|
shipping_weight?: _heyapi_460_;
|
|
14227
14226
|
};
|
|
14228
14227
|
/**
|
|
@@ -14331,7 +14330,7 @@ type InvoiceCreate = {
|
|
|
14331
14330
|
* @deprecated
|
|
14332
14331
|
*/
|
|
14333
14332
|
due_date?: string;
|
|
14334
|
-
payment_terms?:
|
|
14333
|
+
payment_terms?: _heyapi_727_;
|
|
14335
14334
|
/**
|
|
14336
14335
|
* Created date of invoice
|
|
14337
14336
|
*/
|
|
@@ -14512,7 +14511,7 @@ type InvoiceCreate = {
|
|
|
14512
14511
|
* Parent object id
|
|
14513
14512
|
*/
|
|
14514
14513
|
id?: number;
|
|
14515
|
-
} |
|
|
14514
|
+
} | _heyapi_728_ | null;
|
|
14516
14515
|
/**
|
|
14517
14516
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
14518
14517
|
*/
|
|
@@ -14952,7 +14951,7 @@ type DepositInvoiceUpdate = {
|
|
|
14952
14951
|
* Currency code of the invoice
|
|
14953
14952
|
*/
|
|
14954
14953
|
currency?: string;
|
|
14955
|
-
related?:
|
|
14954
|
+
related?: _heyapi_731_;
|
|
14956
14955
|
/**
|
|
14957
14956
|
* Company or individual name displayed on the invoice. If not provided, use company_name of the parent document.
|
|
14958
14957
|
*/
|
|
@@ -14985,7 +14984,7 @@ type DepositInvoiceUpdate = {
|
|
|
14985
14984
|
* Analytic code of document
|
|
14986
14985
|
*/
|
|
14987
14986
|
analytic_code?: string | null;
|
|
14988
|
-
payment_terms?:
|
|
14987
|
+
payment_terms?: _heyapi_732_;
|
|
14989
14988
|
/**
|
|
14990
14989
|
* Bank account id
|
|
14991
14990
|
*/
|
|
@@ -15002,7 +15001,7 @@ type DepositInvoiceUpdate = {
|
|
|
15002
15001
|
* Document Layout
|
|
15003
15002
|
*/
|
|
15004
15003
|
layout_id?: number;
|
|
15005
|
-
settings?:
|
|
15004
|
+
settings?: _heyapi_733_;
|
|
15006
15005
|
/**
|
|
15007
15006
|
* Sale type of the document: product (goods), service, or mixed. If not provided, it is automatically detected from the document rows.
|
|
15008
15007
|
*/
|
|
@@ -15016,7 +15015,7 @@ type DepositInvoiceUpdate = {
|
|
|
15016
15015
|
* Prepare Deposit Invoice
|
|
15017
15016
|
*/
|
|
15018
15017
|
type DepositInvoicePrepareInput = {
|
|
15019
|
-
parent:
|
|
15018
|
+
parent: _heyapi_735_;
|
|
15020
15019
|
/**
|
|
15021
15020
|
* Percentage is based on the remaining amount of parent document. <br/> <ul>
|
|
15022
15021
|
* <li>If the parent document has 100€ at 20% VAT and there is already a deposit invoice of 60€, the remaining amount is 40€. </li>
|
|
@@ -15073,12 +15072,12 @@ type DepositInvoicePrepareOutput = {
|
|
|
15073
15072
|
* Deposit Invoice Compute
|
|
15074
15073
|
*/
|
|
15075
15074
|
type DepositInvoiceComputeInput = {
|
|
15076
|
-
parent:
|
|
15075
|
+
parent: _heyapi_735_;
|
|
15077
15076
|
/**
|
|
15078
15077
|
* Rows of the deposit invoice. There must be as many deposit lines as there are VAT rates in the parent document. For example, if the parent document has products with VAT rates of 20% and 5.5%, there must be two 'deposit' rows."
|
|
15079
15078
|
*
|
|
15080
15079
|
*/
|
|
15081
|
-
rows: Array<
|
|
15080
|
+
rows: Array<_heyapi_738_ | _heyapi_739_ | _heyapi_423_ | _heyapi_422_>;
|
|
15082
15081
|
/**
|
|
15083
15082
|
* Deposit invoice id, if already created
|
|
15084
15083
|
*/
|
|
@@ -15194,8 +15193,8 @@ type DepositInvoiceComputeOutput = {
|
|
|
15194
15193
|
};
|
|
15195
15194
|
};
|
|
15196
15195
|
type DepositInvoiceOne = _heyapi_568_ & {
|
|
15197
|
-
rows?: Array<
|
|
15198
|
-
_embed?:
|
|
15196
|
+
rows?: Array<_heyapi_742_ | _heyapi_422_ | _heyapi_423_>;
|
|
15197
|
+
_embed?: _heyapi_743_;
|
|
15199
15198
|
};
|
|
15200
15199
|
/**
|
|
15201
15200
|
* Deposit Invoices filters
|
|
@@ -15203,7 +15202,7 @@ type DepositInvoiceOne = _heyapi_568_ & {
|
|
|
15203
15202
|
* Deposit Invoices filters
|
|
15204
15203
|
*/
|
|
15205
15204
|
type DepositInvoiceFilter = {
|
|
15206
|
-
filters:
|
|
15205
|
+
filters: _heyapi_745_;
|
|
15207
15206
|
};
|
|
15208
15207
|
/**
|
|
15209
15208
|
* Deposit Invoice Metadata
|
|
@@ -15211,19 +15210,19 @@ type DepositInvoiceFilter = {
|
|
|
15211
15210
|
type DepositInvoiceMetadata = {
|
|
15212
15211
|
parent?: (_heyapi_472_ & {
|
|
15213
15212
|
rows: Array<_heyapi_480_>;
|
|
15214
|
-
}) | (
|
|
15213
|
+
}) | (_heyapi_747_ & {
|
|
15215
15214
|
rows?: Array<_heyapi_480_>;
|
|
15216
|
-
_embed?:
|
|
15217
|
-
}) | (
|
|
15215
|
+
_embed?: _heyapi_748_;
|
|
15216
|
+
}) | (_heyapi_749_ & {
|
|
15218
15217
|
rows?: Array<_heyapi_480_>;
|
|
15219
|
-
_embed?:
|
|
15218
|
+
_embed?: _heyapi_750_;
|
|
15220
15219
|
});
|
|
15221
15220
|
/**
|
|
15222
15221
|
* Current invoice, exist only if invoice type is used
|
|
15223
15222
|
*/
|
|
15224
15223
|
document?: (_heyapi_568_ & {
|
|
15225
|
-
rows?: Array<
|
|
15226
|
-
_embed?:
|
|
15224
|
+
rows?: Array<_heyapi_742_ | _heyapi_422_ | _heyapi_423_>;
|
|
15225
|
+
_embed?: _heyapi_743_;
|
|
15227
15226
|
}) | null;
|
|
15228
15227
|
law_texts?: {
|
|
15229
15228
|
/**
|
|
@@ -15371,11 +15370,11 @@ type DepositInvoiceMetadata = {
|
|
|
15371
15370
|
/**
|
|
15372
15371
|
* List of document layouts
|
|
15373
15372
|
*/
|
|
15374
|
-
document_layouts?: Array<
|
|
15373
|
+
document_layouts?: Array<_heyapi_751_>;
|
|
15375
15374
|
/**
|
|
15376
15375
|
* List of languages
|
|
15377
15376
|
*/
|
|
15378
|
-
languages?: Array<
|
|
15377
|
+
languages?: Array<_heyapi_752_>;
|
|
15379
15378
|
/**
|
|
15380
15379
|
* List of payment terms
|
|
15381
15380
|
*/
|
|
@@ -15412,7 +15411,7 @@ type DepositInvoiceMetadata = {
|
|
|
15412
15411
|
/**
|
|
15413
15412
|
* Payment term translations
|
|
15414
15413
|
*/
|
|
15415
|
-
translations?: Array<
|
|
15414
|
+
translations?: Array<_heyapi_753_>;
|
|
15416
15415
|
};
|
|
15417
15416
|
}>;
|
|
15418
15417
|
/**
|
|
@@ -15439,7 +15438,7 @@ type DepositInvoiceMetadata = {
|
|
|
15439
15438
|
/**
|
|
15440
15439
|
* Assigned staff translations
|
|
15441
15440
|
*/
|
|
15442
|
-
translations?: Array<
|
|
15441
|
+
translations?: Array<_heyapi_754_>;
|
|
15443
15442
|
};
|
|
15444
15443
|
}>;
|
|
15445
15444
|
permissions?: {
|
|
@@ -15680,13 +15679,13 @@ type ProgressInvoiceCreate = {
|
|
|
15680
15679
|
* Bar code ID for progress-catalog row
|
|
15681
15680
|
*/
|
|
15682
15681
|
sku_id?: number | null;
|
|
15683
|
-
}) | (
|
|
15682
|
+
}) | (_heyapi_756_ & {
|
|
15684
15683
|
type?: 'progress-single';
|
|
15685
15684
|
/**
|
|
15686
15685
|
* Purchase amount
|
|
15687
15686
|
*/
|
|
15688
15687
|
purchase_amount?: string;
|
|
15689
|
-
}) | (
|
|
15688
|
+
}) | (_heyapi_756_ & {
|
|
15690
15689
|
type?: 'progress-shipping' | 'progress-packaging';
|
|
15691
15690
|
}) | _heyapi_422_ | _heyapi_423_ | _heyapi_424_ | _heyapi_425_ | _heyapi_426_>;
|
|
15692
15691
|
/**
|
|
@@ -16165,7 +16164,7 @@ type ProgressInvoiceCompute = {
|
|
|
16165
16164
|
* Rows of the progress invoice. There must be at least one progress row.
|
|
16166
16165
|
*
|
|
16167
16166
|
*/
|
|
16168
|
-
rows: Array<_heyapi_424_ |
|
|
16167
|
+
rows: Array<_heyapi_424_ | _heyapi_758_ | _heyapi_759_ | _heyapi_760_ | _heyapi_422_ | ({
|
|
16169
16168
|
/**
|
|
16170
16169
|
* ID of the progress invoice row
|
|
16171
16170
|
*/
|
|
@@ -16199,12 +16198,12 @@ type ProgressInvoiceCompute = {
|
|
|
16199
16198
|
* Bar code ID for progress-catalog row
|
|
16200
16199
|
*/
|
|
16201
16200
|
sku_id?: number | null;
|
|
16202
|
-
}) | (
|
|
16201
|
+
}) | (_heyapi_761_ & {
|
|
16203
16202
|
/**
|
|
16204
16203
|
* Purchase amount
|
|
16205
16204
|
*/
|
|
16206
16205
|
purchase_amount?: string;
|
|
16207
|
-
}) |
|
|
16206
|
+
}) | _heyapi_761_ | {
|
|
16208
16207
|
/**
|
|
16209
16208
|
* Row Identifier
|
|
16210
16209
|
*/
|
|
@@ -16379,6 +16378,10 @@ type ComputedProgresssInvoice = {
|
|
|
16379
16378
|
* Tax amount
|
|
16380
16379
|
*/
|
|
16381
16380
|
amount?: string;
|
|
16381
|
+
/**
|
|
16382
|
+
* Tax category code (EN 16931), e.g. K for intra-community VAT. Null when the tax has no category.
|
|
16383
|
+
*/
|
|
16384
|
+
category?: string | null;
|
|
16382
16385
|
}>;
|
|
16383
16386
|
deposits?: Array<{
|
|
16384
16387
|
/**
|
|
@@ -16450,11 +16453,11 @@ type ComputedProgresssInvoice = {
|
|
|
16450
16453
|
/**
|
|
16451
16454
|
* Credit notes linked to the invoice
|
|
16452
16455
|
*/
|
|
16453
|
-
credit_notes?: Array<
|
|
16456
|
+
credit_notes?: Array<_heyapi_763_>;
|
|
16454
16457
|
}>;
|
|
16455
16458
|
};
|
|
16456
|
-
type InvoiceUpdate =
|
|
16457
|
-
rows?: Array<
|
|
16459
|
+
type InvoiceUpdate = _heyapi_765_ & {
|
|
16460
|
+
rows?: Array<_heyapi_766_> | null;
|
|
16458
16461
|
settings?: _heyapi_469_;
|
|
16459
16462
|
};
|
|
16460
16463
|
type ValidateInvoice = {
|
|
@@ -16741,9 +16744,9 @@ type CreditNote = {
|
|
|
16741
16744
|
/**
|
|
16742
16745
|
* Credit Note Embed
|
|
16743
16746
|
*/
|
|
16744
|
-
_embed?:
|
|
16747
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
16745
16748
|
fiscal_year?: _heyapi_475_;
|
|
16746
|
-
currency?:
|
|
16749
|
+
currency?: _heyapi_770_;
|
|
16747
16750
|
owner?: _heyapi_434_;
|
|
16748
16751
|
/**
|
|
16749
16752
|
* Credit Note ACL
|
|
@@ -17029,11 +17032,11 @@ type CreditNoteOne = {
|
|
|
17029
17032
|
*/
|
|
17030
17033
|
label?: string;
|
|
17031
17034
|
} | null;
|
|
17032
|
-
_embed?:
|
|
17035
|
+
_embed?: _heyapi_772_;
|
|
17033
17036
|
} & {
|
|
17034
17037
|
rows?: Array<_heyapi_480_>;
|
|
17035
|
-
_embed?:
|
|
17036
|
-
file?:
|
|
17038
|
+
_embed?: _heyapi_772_ & _heyapi_717_ & {
|
|
17039
|
+
file?: _heyapi_636_;
|
|
17037
17040
|
};
|
|
17038
17041
|
};
|
|
17039
17042
|
type CreditNoteCreate = {
|
|
@@ -17144,14 +17147,14 @@ type CreditNoteCreate = {
|
|
|
17144
17147
|
einvoicing_electronic_address?: string | null;
|
|
17145
17148
|
} & {
|
|
17146
17149
|
rows?: Array<_heyapi_480_> | null;
|
|
17147
|
-
parent?:
|
|
17150
|
+
parent?: _heyapi_728_ | null;
|
|
17148
17151
|
/**
|
|
17149
17152
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
17150
17153
|
*/
|
|
17151
17154
|
rate_category_id?: number;
|
|
17152
17155
|
};
|
|
17153
|
-
type CreditNoteUpdate =
|
|
17154
|
-
rows?: Array<
|
|
17156
|
+
type CreditNoteUpdate = _heyapi_775_ & {
|
|
17157
|
+
rows?: Array<_heyapi_766_> | null;
|
|
17155
17158
|
};
|
|
17156
17159
|
type CreditNoteValidate = {
|
|
17157
17160
|
/**
|
|
@@ -17277,7 +17280,7 @@ type CreditNoteCompute = {
|
|
|
17277
17280
|
type?: 'company' | 'individual' | 'contact' | 'opportunity';
|
|
17278
17281
|
}>;
|
|
17279
17282
|
owner?: _heyapi_429_;
|
|
17280
|
-
rows?: Array<
|
|
17283
|
+
rows?: Array<_heyapi_724_>;
|
|
17281
17284
|
};
|
|
17282
17285
|
/**
|
|
17283
17286
|
* Credit notes filters
|
|
@@ -17453,15 +17456,15 @@ type OrderCreate = {
|
|
|
17453
17456
|
shipping_volume?: string;
|
|
17454
17457
|
} & {
|
|
17455
17458
|
rows?: Array<_heyapi_480_> | null;
|
|
17456
|
-
parent?:
|
|
17459
|
+
parent?: _heyapi_728_ | null;
|
|
17457
17460
|
/**
|
|
17458
17461
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
17459
17462
|
*/
|
|
17460
17463
|
rate_category_id?: number;
|
|
17461
17464
|
settings?: _heyapi_469_;
|
|
17462
17465
|
};
|
|
17463
|
-
type OrderUpdate =
|
|
17464
|
-
rows?: Array<
|
|
17466
|
+
type OrderUpdate = _heyapi_781_ & {
|
|
17467
|
+
rows?: Array<_heyapi_766_> | null;
|
|
17465
17468
|
settings?: _heyapi_469_;
|
|
17466
17469
|
};
|
|
17467
17470
|
/**
|
|
@@ -17670,7 +17673,7 @@ type Order = {
|
|
|
17670
17673
|
/**
|
|
17671
17674
|
* Order Embed
|
|
17672
17675
|
*/
|
|
17673
|
-
_embed?:
|
|
17676
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
17674
17677
|
/**
|
|
17675
17678
|
* Order ACL
|
|
17676
17679
|
*/
|
|
@@ -17686,7 +17689,7 @@ type Order = {
|
|
|
17686
17689
|
};
|
|
17687
17690
|
owner?: _heyapi_434_;
|
|
17688
17691
|
fiscal_year?: _heyapi_475_;
|
|
17689
|
-
currency?:
|
|
17692
|
+
currency?: _heyapi_770_;
|
|
17690
17693
|
/**
|
|
17691
17694
|
* Smart-tags linked
|
|
17692
17695
|
*/
|
|
@@ -17953,7 +17956,7 @@ type OrderOne = {
|
|
|
17953
17956
|
* Notes of the order
|
|
17954
17957
|
*/
|
|
17955
17958
|
note?: string;
|
|
17956
|
-
_embed?:
|
|
17959
|
+
_embed?: _heyapi_784_;
|
|
17957
17960
|
/**
|
|
17958
17961
|
* Date of the shipping
|
|
17959
17962
|
*/
|
|
@@ -18005,13 +18008,13 @@ type OrderOne = {
|
|
|
18005
18008
|
/**
|
|
18006
18009
|
* Order Embed
|
|
18007
18010
|
*/
|
|
18008
|
-
_embed?:
|
|
18011
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
18009
18012
|
/**
|
|
18010
18013
|
* Document Payment Terms
|
|
18011
18014
|
*
|
|
18012
18015
|
* Terms of payment of document
|
|
18013
18016
|
*/
|
|
18014
|
-
payment_terms?:
|
|
18017
|
+
payment_terms?: _heyapi_716_ & {
|
|
18015
18018
|
/**
|
|
18016
18019
|
* List of deadlines computed with the payment terms settings
|
|
18017
18020
|
*/
|
|
@@ -18030,7 +18033,7 @@ type OrderOne = {
|
|
|
18030
18033
|
description?: string | null;
|
|
18031
18034
|
}>;
|
|
18032
18035
|
};
|
|
18033
|
-
} &
|
|
18036
|
+
} & _heyapi_717_ & {
|
|
18034
18037
|
/**
|
|
18035
18038
|
* Order ACL
|
|
18036
18039
|
*/
|
|
@@ -18046,7 +18049,7 @@ type OrderOne = {
|
|
|
18046
18049
|
};
|
|
18047
18050
|
owner?: _heyapi_434_;
|
|
18048
18051
|
fiscal_year?: _heyapi_475_;
|
|
18049
|
-
currency?:
|
|
18052
|
+
currency?: _heyapi_770_;
|
|
18050
18053
|
/**
|
|
18051
18054
|
* Smart-tags linked
|
|
18052
18055
|
*/
|
|
@@ -18065,7 +18068,7 @@ type OrderOne = {
|
|
|
18065
18068
|
*/
|
|
18066
18069
|
label?: string;
|
|
18067
18070
|
}>;
|
|
18068
|
-
file?:
|
|
18071
|
+
file?: _heyapi_636_;
|
|
18069
18072
|
};
|
|
18070
18073
|
};
|
|
18071
18074
|
/**
|
|
@@ -18198,7 +18201,7 @@ type OrderCompute = {
|
|
|
18198
18201
|
type?: 'company' | 'individual' | 'contact' | 'opportunity';
|
|
18199
18202
|
}>;
|
|
18200
18203
|
owner?: _heyapi_429_;
|
|
18201
|
-
rows?: Array<
|
|
18204
|
+
rows?: Array<_heyapi_724_>;
|
|
18202
18205
|
shipping_weight?: _heyapi_460_;
|
|
18203
18206
|
};
|
|
18204
18207
|
/**
|
|
@@ -18438,7 +18441,7 @@ type Delivery = {
|
|
|
18438
18441
|
/**
|
|
18439
18442
|
* Delivery Embed
|
|
18440
18443
|
*/
|
|
18441
|
-
_embed?:
|
|
18444
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
18442
18445
|
/**
|
|
18443
18446
|
* Delivery ACL
|
|
18444
18447
|
*/
|
|
@@ -18454,7 +18457,7 @@ type Delivery = {
|
|
|
18454
18457
|
};
|
|
18455
18458
|
owner?: _heyapi_434_;
|
|
18456
18459
|
fiscal_year?: _heyapi_475_;
|
|
18457
|
-
currency?:
|
|
18460
|
+
currency?: _heyapi_770_;
|
|
18458
18461
|
/**
|
|
18459
18462
|
* Smart-tags linked
|
|
18460
18463
|
*/
|
|
@@ -18696,11 +18699,11 @@ type DeliveryOne = {
|
|
|
18696
18699
|
* Total volume of product to ship in m3
|
|
18697
18700
|
*/
|
|
18698
18701
|
shipping_volume?: string;
|
|
18699
|
-
_embed?:
|
|
18702
|
+
_embed?: _heyapi_789_;
|
|
18700
18703
|
} & {
|
|
18701
18704
|
rows?: Array<_heyapi_480_>;
|
|
18702
|
-
_embed?:
|
|
18703
|
-
file?:
|
|
18705
|
+
_embed?: _heyapi_789_ & {
|
|
18706
|
+
file?: _heyapi_636_;
|
|
18704
18707
|
};
|
|
18705
18708
|
};
|
|
18706
18709
|
/**
|
|
@@ -18900,7 +18903,7 @@ type ListFilesOutput = {
|
|
|
18900
18903
|
* Current directory location. The first element is the direct parent of the directory
|
|
18901
18904
|
*/
|
|
18902
18905
|
breadcrumbs?: Array<_heyapi_489_>;
|
|
18903
|
-
} |
|
|
18906
|
+
} | _heyapi_636_;
|
|
18904
18907
|
/**
|
|
18905
18908
|
* Adyen settings
|
|
18906
18909
|
*/
|
|
@@ -19161,7 +19164,7 @@ type ImportPrepareInput = {
|
|
|
19161
19164
|
* List of identifiers
|
|
19162
19165
|
*/
|
|
19163
19166
|
service: ['id' | 'reference'];
|
|
19164
|
-
} |
|
|
19167
|
+
} | _heyapi_805_ | {
|
|
19165
19168
|
/**
|
|
19166
19169
|
* List of identifiers
|
|
19167
19170
|
*/
|
|
@@ -19758,7 +19761,7 @@ type ImportPrepareInput = {
|
|
|
19758
19761
|
/**
|
|
19759
19762
|
* Rate category ids and corresponding prices
|
|
19760
19763
|
*/
|
|
19761
|
-
prices?: Array<
|
|
19764
|
+
prices?: Array<_heyapi_806_>;
|
|
19762
19765
|
} | {
|
|
19763
19766
|
/**
|
|
19764
19767
|
* Row id
|
|
@@ -19839,11 +19842,11 @@ type ImportValidateInput = {
|
|
|
19839
19842
|
* Batch id
|
|
19840
19843
|
*/
|
|
19841
19844
|
batch_id: string;
|
|
19842
|
-
metadata:
|
|
19845
|
+
metadata: _heyapi_808_;
|
|
19843
19846
|
/**
|
|
19844
19847
|
* Rows to validate
|
|
19845
19848
|
*/
|
|
19846
|
-
data: Array<
|
|
19849
|
+
data: Array<_heyapi_809_ | _heyapi_810_ | _heyapi_811_ | _heyapi_812_ | _heyapi_813_ | _heyapi_814_ | _heyapi_815_>;
|
|
19847
19850
|
};
|
|
19848
19851
|
/**
|
|
19849
19852
|
* Import
|
|
@@ -19911,7 +19914,7 @@ type CompanyPreferences = {
|
|
|
19911
19914
|
/**
|
|
19912
19915
|
* System label of tax
|
|
19913
19916
|
*/
|
|
19914
|
-
system_label?: string;
|
|
19917
|
+
system_label?: string | null;
|
|
19915
19918
|
};
|
|
19916
19919
|
/**
|
|
19917
19920
|
* Company preferred pay date.
|
|
@@ -20099,8 +20102,8 @@ type UpdateCompanyPreferences = {
|
|
|
20099
20102
|
value: 'id';
|
|
20100
20103
|
id: number;
|
|
20101
20104
|
};
|
|
20102
|
-
invoice?:
|
|
20103
|
-
proforma?:
|
|
20105
|
+
invoice?: _heyapi_819_ | _heyapi_820_ | _heyapi_821_;
|
|
20106
|
+
proforma?: _heyapi_819_ | _heyapi_820_ | _heyapi_821_;
|
|
20104
20107
|
};
|
|
20105
20108
|
/**
|
|
20106
20109
|
* Id of the rate category selected.
|
|
@@ -20129,7 +20132,7 @@ type IndividualPreferences = {
|
|
|
20129
20132
|
*/
|
|
20130
20133
|
label?: string;
|
|
20131
20134
|
} | null;
|
|
20132
|
-
tax?:
|
|
20135
|
+
tax?: _heyapi_823_;
|
|
20133
20136
|
/**
|
|
20134
20137
|
* Individual preferred pay date.
|
|
20135
20138
|
*/
|
|
@@ -20316,8 +20319,8 @@ type UpdateIndividualPreferences = {
|
|
|
20316
20319
|
value: 'id';
|
|
20317
20320
|
id: number;
|
|
20318
20321
|
};
|
|
20319
|
-
invoice?:
|
|
20320
|
-
proforma?:
|
|
20322
|
+
invoice?: _heyapi_825_ | _heyapi_826_ | _heyapi_827_;
|
|
20323
|
+
proforma?: _heyapi_825_ | _heyapi_826_ | _heyapi_827_;
|
|
20321
20324
|
};
|
|
20322
20325
|
/**
|
|
20323
20326
|
* Id of the rate category selected.
|
|
@@ -20831,7 +20834,7 @@ type ProformaInvoiceOne = {
|
|
|
20831
20834
|
/**
|
|
20832
20835
|
* Proforma Invoice Embed
|
|
20833
20836
|
*/
|
|
20834
|
-
_embed?:
|
|
20837
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
20835
20838
|
/**
|
|
20836
20839
|
* Proforma Invoice ACL
|
|
20837
20840
|
*/
|
|
@@ -20847,7 +20850,7 @@ type ProformaInvoiceOne = {
|
|
|
20847
20850
|
};
|
|
20848
20851
|
owner?: _heyapi_434_;
|
|
20849
20852
|
fiscal_year?: _heyapi_475_;
|
|
20850
|
-
currency?:
|
|
20853
|
+
currency?: _heyapi_770_;
|
|
20851
20854
|
/**
|
|
20852
20855
|
* Smart-tags linked
|
|
20853
20856
|
*/
|
|
@@ -20909,7 +20912,7 @@ type ProformaInvoiceOne = {
|
|
|
20909
20912
|
/**
|
|
20910
20913
|
* Proforma Invoice Embed
|
|
20911
20914
|
*/
|
|
20912
|
-
_embed?:
|
|
20915
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & _heyapi_717_ & {
|
|
20913
20916
|
/**
|
|
20914
20917
|
* Proforma Invoice ACL
|
|
20915
20918
|
*/
|
|
@@ -20925,7 +20928,7 @@ type ProformaInvoiceOne = {
|
|
|
20925
20928
|
};
|
|
20926
20929
|
owner?: _heyapi_434_;
|
|
20927
20930
|
fiscal_year?: _heyapi_475_;
|
|
20928
|
-
currency?:
|
|
20931
|
+
currency?: _heyapi_770_;
|
|
20929
20932
|
/**
|
|
20930
20933
|
* Smart-tags linked
|
|
20931
20934
|
*/
|
|
@@ -21203,8 +21206,8 @@ type SubscriptionCreate = {
|
|
|
21203
21206
|
* - An optional contact can be added, it must be linked to the provided company.
|
|
21204
21207
|
*
|
|
21205
21208
|
*/
|
|
21206
|
-
related: Array<
|
|
21207
|
-
sending:
|
|
21209
|
+
related: Array<_heyapi_837_>;
|
|
21210
|
+
sending: _heyapi_838_;
|
|
21208
21211
|
/**
|
|
21209
21212
|
* Source of payment preferences
|
|
21210
21213
|
*/
|
|
@@ -21222,7 +21225,7 @@ type SubscriptionCreate = {
|
|
|
21222
21225
|
/**
|
|
21223
21226
|
* Interval for subscription deadlines
|
|
21224
21227
|
*/
|
|
21225
|
-
interval:
|
|
21228
|
+
interval: _heyapi_839_ | _heyapi_840_ | _heyapi_841_;
|
|
21226
21229
|
};
|
|
21227
21230
|
/**
|
|
21228
21231
|
* Subscription payment installments to be generated
|
|
@@ -21380,9 +21383,9 @@ type ObjectiveCollectionOutput = {
|
|
|
21380
21383
|
* Objective name
|
|
21381
21384
|
*/
|
|
21382
21385
|
name: string;
|
|
21383
|
-
category:
|
|
21384
|
-
turnover:
|
|
21385
|
-
period:
|
|
21386
|
+
category: _heyapi_845_;
|
|
21387
|
+
turnover: _heyapi_846_;
|
|
21388
|
+
period: _heyapi_847_;
|
|
21386
21389
|
item: {
|
|
21387
21390
|
/**
|
|
21388
21391
|
* linked Item id
|
|
@@ -21393,16 +21396,16 @@ type ObjectiveCollectionOutput = {
|
|
|
21393
21396
|
*/
|
|
21394
21397
|
name: string;
|
|
21395
21398
|
} | null;
|
|
21396
|
-
item_category:
|
|
21399
|
+
item_category: _heyapi_848_;
|
|
21397
21400
|
/**
|
|
21398
21401
|
* Refinements of the objective
|
|
21399
21402
|
*/
|
|
21400
21403
|
refinements: Array<{
|
|
21401
|
-
period?:
|
|
21402
|
-
turnover?:
|
|
21404
|
+
period?: _heyapi_847_;
|
|
21405
|
+
turnover?: _heyapi_846_;
|
|
21403
21406
|
}>;
|
|
21404
|
-
assignee:
|
|
21405
|
-
links:
|
|
21407
|
+
assignee: _heyapi_849_;
|
|
21408
|
+
links: _heyapi_850_;
|
|
21406
21409
|
} & {
|
|
21407
21410
|
_embed?: {
|
|
21408
21411
|
created_by?: _heyapi_434_;
|
|
@@ -21423,8 +21426,8 @@ type ObjectiveTurnoverInput = {
|
|
|
21423
21426
|
* Code of an existing objective category
|
|
21424
21427
|
*/
|
|
21425
21428
|
category: 'turnover' | 'forecast_turnover';
|
|
21426
|
-
period:
|
|
21427
|
-
assignee:
|
|
21429
|
+
period: _heyapi_847_;
|
|
21430
|
+
assignee: _heyapi_852_;
|
|
21428
21431
|
} & unknown & {
|
|
21429
21432
|
/**
|
|
21430
21433
|
* Linked item id
|
|
@@ -21470,7 +21473,7 @@ type ObjectiveTurnoverInput = {
|
|
|
21470
21473
|
*/
|
|
21471
21474
|
date_end: string;
|
|
21472
21475
|
};
|
|
21473
|
-
turnover?:
|
|
21476
|
+
turnover?: _heyapi_853_;
|
|
21474
21477
|
}>;
|
|
21475
21478
|
};
|
|
21476
21479
|
/**
|
|
@@ -21540,8 +21543,8 @@ type ObjectiveOutput = {
|
|
|
21540
21543
|
* Turnover
|
|
21541
21544
|
*/
|
|
21542
21545
|
turnover: {
|
|
21543
|
-
expected:
|
|
21544
|
-
actual:
|
|
21546
|
+
expected: _heyapi_853_;
|
|
21547
|
+
actual: _heyapi_853_;
|
|
21545
21548
|
/**
|
|
21546
21549
|
* Progression of the objective
|
|
21547
21550
|
*/
|
|
@@ -21555,7 +21558,7 @@ type ObjectiveOutput = {
|
|
|
21555
21558
|
*/
|
|
21556
21559
|
days_left: number;
|
|
21557
21560
|
};
|
|
21558
|
-
period:
|
|
21561
|
+
period: _heyapi_847_;
|
|
21559
21562
|
item: {
|
|
21560
21563
|
/**
|
|
21561
21564
|
* linked Item id
|
|
@@ -21580,8 +21583,8 @@ type ObjectiveOutput = {
|
|
|
21580
21583
|
* Refinements of the objective
|
|
21581
21584
|
*/
|
|
21582
21585
|
refinements: Array<{
|
|
21583
|
-
period?:
|
|
21584
|
-
turnover?:
|
|
21586
|
+
period?: _heyapi_847_;
|
|
21587
|
+
turnover?: _heyapi_846_;
|
|
21585
21588
|
}>;
|
|
21586
21589
|
/**
|
|
21587
21590
|
* Assignee
|
|
@@ -21602,7 +21605,7 @@ type ObjectiveOutput = {
|
|
|
21602
21605
|
*/
|
|
21603
21606
|
name?: string;
|
|
21604
21607
|
};
|
|
21605
|
-
links:
|
|
21608
|
+
links: _heyapi_850_;
|
|
21606
21609
|
};
|
|
21607
21610
|
/**
|
|
21608
21611
|
* objective metadatas
|
|
@@ -21613,7 +21616,7 @@ type ObjectiveMetadata = {
|
|
|
21613
21616
|
*/
|
|
21614
21617
|
turnover?: {
|
|
21615
21618
|
data?: {
|
|
21616
|
-
category:
|
|
21619
|
+
category: _heyapi_845_;
|
|
21617
21620
|
currency: string;
|
|
21618
21621
|
assignees_types: Array<{
|
|
21619
21622
|
value: string;
|
|
@@ -21621,14 +21624,14 @@ type ObjectiveMetadata = {
|
|
|
21621
21624
|
order: number;
|
|
21622
21625
|
}>;
|
|
21623
21626
|
assignees: Array<{
|
|
21624
|
-
groups?: Array<
|
|
21625
|
-
staffs?: Array<
|
|
21627
|
+
groups?: Array<_heyapi_857_>;
|
|
21628
|
+
staffs?: Array<_heyapi_857_>;
|
|
21626
21629
|
}>;
|
|
21627
|
-
item_categories: Array<
|
|
21630
|
+
item_categories: Array<_heyapi_857_ & {
|
|
21628
21631
|
parent?: number | null;
|
|
21629
21632
|
logo?: string | null;
|
|
21630
21633
|
}>;
|
|
21631
|
-
durations: Array<
|
|
21634
|
+
durations: Array<_heyapi_857_ & {
|
|
21632
21635
|
period?: {
|
|
21633
21636
|
/**
|
|
21634
21637
|
* The start date
|
|
@@ -21657,20 +21660,20 @@ type ObjectiveMetadata = {
|
|
|
21657
21660
|
/**
|
|
21658
21661
|
* List of Assignees
|
|
21659
21662
|
*/
|
|
21660
|
-
assignee?: Array<
|
|
21663
|
+
assignee?: Array<_heyapi_858_>;
|
|
21661
21664
|
/**
|
|
21662
21665
|
* List of Categories
|
|
21663
21666
|
*/
|
|
21664
|
-
category?: Array<
|
|
21667
|
+
category?: Array<_heyapi_859_>;
|
|
21665
21668
|
};
|
|
21666
21669
|
metadata?: {
|
|
21667
21670
|
choose_product?: boolean;
|
|
21668
21671
|
create_new_staff?: boolean;
|
|
21669
21672
|
create_new_group?: boolean;
|
|
21670
21673
|
};
|
|
21671
|
-
_links?:
|
|
21674
|
+
_links?: _heyapi_850_;
|
|
21672
21675
|
};
|
|
21673
|
-
forecast_turnover?:
|
|
21676
|
+
forecast_turnover?: _heyapi_860_;
|
|
21674
21677
|
};
|
|
21675
21678
|
/**
|
|
21676
21679
|
* objective metadatas upsell
|
|
@@ -21681,7 +21684,7 @@ type ObjectiveMetadataUpsell = {
|
|
|
21681
21684
|
*/
|
|
21682
21685
|
turnover?: {
|
|
21683
21686
|
data?: {
|
|
21684
|
-
assignees_types: Array<
|
|
21687
|
+
assignees_types: Array<_heyapi_857_ & {
|
|
21685
21688
|
/**
|
|
21686
21689
|
* upsell
|
|
21687
21690
|
*/
|
|
@@ -21693,11 +21696,11 @@ type ObjectiveMetadataUpsell = {
|
|
|
21693
21696
|
};
|
|
21694
21697
|
metadata?: {
|
|
21695
21698
|
choose_product: {
|
|
21696
|
-
upsell:
|
|
21699
|
+
upsell: _heyapi_862_;
|
|
21697
21700
|
};
|
|
21698
21701
|
};
|
|
21699
21702
|
};
|
|
21700
|
-
forecast_turnover?:
|
|
21703
|
+
forecast_turnover?: _heyapi_863_;
|
|
21701
21704
|
};
|
|
21702
21705
|
type ObjectiveComputeTurnoverInput = {
|
|
21703
21706
|
/**
|
|
@@ -21707,7 +21710,7 @@ type ObjectiveComputeTurnoverInput = {
|
|
|
21707
21710
|
/**
|
|
21708
21711
|
* Period used to compute the turnover
|
|
21709
21712
|
*/
|
|
21710
|
-
period:
|
|
21713
|
+
period: _heyapi_847_;
|
|
21711
21714
|
/**
|
|
21712
21715
|
* linked item id used to compute the turnover
|
|
21713
21716
|
*/
|
|
@@ -21736,11 +21739,11 @@ type ObjectiveComputeTurnoverOutput = Array<{
|
|
|
21736
21739
|
/**
|
|
21737
21740
|
* Period used to compute the turnover
|
|
21738
21741
|
*/
|
|
21739
|
-
period:
|
|
21742
|
+
period: _heyapi_847_;
|
|
21740
21743
|
/**
|
|
21741
21744
|
* The computed turnover
|
|
21742
21745
|
*/
|
|
21743
|
-
turnover:
|
|
21746
|
+
turnover: _heyapi_853_;
|
|
21744
21747
|
}>;
|
|
21745
21748
|
/**
|
|
21746
21749
|
* ObjectiveTurnoverUpdateInput
|
|
@@ -21750,13 +21753,13 @@ type ObjectiveTurnoverUpdateInput = {
|
|
|
21750
21753
|
* Objective name
|
|
21751
21754
|
*/
|
|
21752
21755
|
name: string;
|
|
21753
|
-
turnover:
|
|
21756
|
+
turnover: _heyapi_853_;
|
|
21754
21757
|
/**
|
|
21755
21758
|
* Refinements of the objective
|
|
21756
21759
|
*/
|
|
21757
21760
|
refinements: Array<{
|
|
21758
|
-
period?:
|
|
21759
|
-
turnover?:
|
|
21761
|
+
period?: _heyapi_847_;
|
|
21762
|
+
turnover?: _heyapi_853_;
|
|
21760
21763
|
}>;
|
|
21761
21764
|
};
|
|
21762
21765
|
/**
|
|
@@ -21990,16 +21993,16 @@ type MarketingAttributeDiffOutput = {
|
|
|
21990
21993
|
/**
|
|
21991
21994
|
* List of new Marketing Attributes to create
|
|
21992
21995
|
*/
|
|
21993
|
-
create: Array<
|
|
21996
|
+
create: Array<_heyapi_874_>;
|
|
21994
21997
|
/**
|
|
21995
21998
|
* List of previous Marketing Attributes to delete
|
|
21996
21999
|
*/
|
|
21997
|
-
delete: Array<
|
|
22000
|
+
delete: Array<_heyapi_874_>;
|
|
21998
22001
|
/**
|
|
21999
22002
|
* List of Marketing Attributes unchanged
|
|
22000
22003
|
*/
|
|
22001
|
-
void: Array<
|
|
22002
|
-
links:
|
|
22004
|
+
void: Array<_heyapi_874_>;
|
|
22005
|
+
links: _heyapi_875_;
|
|
22003
22006
|
};
|
|
22004
22007
|
/**
|
|
22005
22008
|
* Discount including taxes
|
|
@@ -22120,7 +22123,7 @@ type ConsentSettingsOuput = {
|
|
|
22120
22123
|
href: string;
|
|
22121
22124
|
}>;
|
|
22122
22125
|
};
|
|
22123
|
-
type ConsentSettingsInput =
|
|
22126
|
+
type ConsentSettingsInput = _heyapi_880_;
|
|
22124
22127
|
/**
|
|
22125
22128
|
* The marketing consent settings
|
|
22126
22129
|
*/
|
|
@@ -22137,7 +22140,7 @@ type ConsentMarketingSettingsInput = {
|
|
|
22137
22140
|
* Progress Invoice Metadata
|
|
22138
22141
|
*/
|
|
22139
22142
|
type ProgressInvoiceMetadata = {
|
|
22140
|
-
parent?: (
|
|
22143
|
+
parent?: (_heyapi_883_ & {
|
|
22141
22144
|
/**
|
|
22142
22145
|
* Rate category with taxes included
|
|
22143
22146
|
*/
|
|
@@ -22146,7 +22149,7 @@ type ProgressInvoiceMetadata = {
|
|
|
22146
22149
|
* Progress invoice mode
|
|
22147
22150
|
*/
|
|
22148
22151
|
progress_invoice_mode?: 'global' | 'per-line';
|
|
22149
|
-
}) | (
|
|
22152
|
+
}) | (_heyapi_884_ & {
|
|
22150
22153
|
/**
|
|
22151
22154
|
* Rate category with taxes included
|
|
22152
22155
|
*/
|
|
@@ -22165,12 +22168,12 @@ type ProgressInvoiceMetadata = {
|
|
|
22165
22168
|
* Invoice related to the progress invoice, exist only if invoice type is used
|
|
22166
22169
|
*/
|
|
22167
22170
|
document?: (_heyapi_568_ & {
|
|
22168
|
-
rows?: Array<
|
|
22171
|
+
rows?: Array<_heyapi_885_ | _heyapi_886_ | _heyapi_887_ | _heyapi_422_ | _heyapi_423_ | _heyapi_424_ | _heyapi_425_ | _heyapi_426_>;
|
|
22169
22172
|
/**
|
|
22170
22173
|
* The next available progress invoice number
|
|
22171
22174
|
*/
|
|
22172
22175
|
next_progress_invoice_number?: number | null;
|
|
22173
|
-
_embed?:
|
|
22176
|
+
_embed?: _heyapi_888_;
|
|
22174
22177
|
} & {
|
|
22175
22178
|
/**
|
|
22176
22179
|
* Rate category with taxes included
|
|
@@ -22302,7 +22305,7 @@ type ProgressInvoiceMetadata = {
|
|
|
22302
22305
|
/**
|
|
22303
22306
|
* List of bank accounts
|
|
22304
22307
|
*/
|
|
22305
|
-
'bank-accounts'?: Array<
|
|
22308
|
+
'bank-accounts'?: Array<_heyapi_889_>;
|
|
22306
22309
|
/**
|
|
22307
22310
|
* List of VAT modes
|
|
22308
22311
|
*/
|
|
@@ -22353,11 +22356,11 @@ type ProgressInvoiceMetadata = {
|
|
|
22353
22356
|
/**
|
|
22354
22357
|
* List of document layouts
|
|
22355
22358
|
*/
|
|
22356
|
-
document_layouts?: Array<
|
|
22359
|
+
document_layouts?: Array<_heyapi_751_>;
|
|
22357
22360
|
/**
|
|
22358
22361
|
* List of languages
|
|
22359
22362
|
*/
|
|
22360
|
-
languages?: Array<
|
|
22363
|
+
languages?: Array<_heyapi_752_>;
|
|
22361
22364
|
/**
|
|
22362
22365
|
* Tax with embed
|
|
22363
22366
|
*
|
|
@@ -22537,11 +22540,11 @@ type ProgressInvoiceMetadata = {
|
|
|
22537
22540
|
/**
|
|
22538
22541
|
* List of payment terms
|
|
22539
22542
|
*/
|
|
22540
|
-
payment_terms?: Array<
|
|
22543
|
+
payment_terms?: Array<_heyapi_890_>;
|
|
22541
22544
|
/**
|
|
22542
22545
|
* List assigned staff labels
|
|
22543
22546
|
*/
|
|
22544
|
-
assigned_staff_labels?: Array<
|
|
22547
|
+
assigned_staff_labels?: Array<_heyapi_891_>;
|
|
22545
22548
|
/**
|
|
22546
22549
|
* Computed progress invoice
|
|
22547
22550
|
*/
|
|
@@ -22710,6 +22713,10 @@ type ProgressInvoiceMetadata = {
|
|
|
22710
22713
|
* Tax amount
|
|
22711
22714
|
*/
|
|
22712
22715
|
amount?: string;
|
|
22716
|
+
/**
|
|
22717
|
+
* Tax category code (EN 16931), e.g. K for intra-community VAT. Null when the tax has no category.
|
|
22718
|
+
*/
|
|
22719
|
+
category?: string | null;
|
|
22713
22720
|
}>;
|
|
22714
22721
|
deposits?: Array<{
|
|
22715
22722
|
/**
|
|
@@ -22736,11 +22743,11 @@ type ProgressInvoiceMetadata = {
|
|
|
22736
22743
|
/**
|
|
22737
22744
|
* Summary of all document history (includes current document)
|
|
22738
22745
|
*/
|
|
22739
|
-
summary?: Array<
|
|
22746
|
+
summary?: Array<_heyapi_763_ & {
|
|
22740
22747
|
/**
|
|
22741
22748
|
* Credit notes linked to the invoice
|
|
22742
22749
|
*/
|
|
22743
|
-
credit_notes?: Array<
|
|
22750
|
+
credit_notes?: Array<_heyapi_763_>;
|
|
22744
22751
|
}>;
|
|
22745
22752
|
};
|
|
22746
22753
|
/**
|
|
@@ -22883,7 +22890,7 @@ type ProgressInvoiceMetadata = {
|
|
|
22883
22890
|
/**
|
|
22884
22891
|
* List of packagings
|
|
22885
22892
|
*/
|
|
22886
|
-
packagings?: Array<
|
|
22893
|
+
packagings?: Array<_heyapi_892_>;
|
|
22887
22894
|
/**
|
|
22888
22895
|
* List of civilities
|
|
22889
22896
|
*/
|
|
@@ -22905,7 +22912,7 @@ type ProgressInvoiceMetadata = {
|
|
|
22905
22912
|
* Compliance state of the parent document on creation, or of the edited document on update
|
|
22906
22913
|
*/
|
|
22907
22914
|
is_document_compliant?: boolean;
|
|
22908
|
-
company_einvoicing?:
|
|
22915
|
+
company_einvoicing?: _heyapi_893_;
|
|
22909
22916
|
/**
|
|
22910
22917
|
* E-invoicing routing address identifier (document value if set, otherwise third default)
|
|
22911
22918
|
*/
|
|
@@ -22915,7 +22922,7 @@ type ProgressInvoiceMetadata = {
|
|
|
22915
22922
|
* Update Progress Invoice
|
|
22916
22923
|
*/
|
|
22917
22924
|
type ProgressInvoiceUpdate = {
|
|
22918
|
-
rows?: Array<
|
|
22925
|
+
rows?: Array<_heyapi_758_ | _heyapi_759_ | _heyapi_760_ | _heyapi_422_ | _heyapi_423_ | _heyapi_424_ | _heyapi_425_ | _heyapi_426_ | _heyapi_895_ | _heyapi_896_ | _heyapi_761_ | _heyapi_464_ | _heyapi_465_ | _heyapi_466_ | {
|
|
22919
22926
|
/**
|
|
22920
22927
|
* Row Identifier
|
|
22921
22928
|
*/
|
|
@@ -22930,7 +22937,7 @@ type ProgressInvoiceUpdate = {
|
|
|
22930
22937
|
* Date of the invoice
|
|
22931
22938
|
*/
|
|
22932
22939
|
date?: string;
|
|
22933
|
-
validate?:
|
|
22940
|
+
validate?: _heyapi_897_;
|
|
22934
22941
|
/**
|
|
22935
22942
|
* Subject of the invoice
|
|
22936
22943
|
*/
|
|
@@ -23033,8 +23040,8 @@ type ProgressInvoiceUpdate = {
|
|
|
23033
23040
|
*/
|
|
23034
23041
|
shipping_volume?: string;
|
|
23035
23042
|
shipping_weight?: _heyapi_460_;
|
|
23036
|
-
payment_terms?:
|
|
23037
|
-
settings?:
|
|
23043
|
+
payment_terms?: _heyapi_727_;
|
|
23044
|
+
settings?: _heyapi_898_;
|
|
23038
23045
|
/**
|
|
23039
23046
|
* Analytic code of document
|
|
23040
23047
|
*/
|
|
@@ -23252,7 +23259,7 @@ type ProposalModel = {
|
|
|
23252
23259
|
/**
|
|
23253
23260
|
* Proposal document
|
|
23254
23261
|
*/
|
|
23255
|
-
type ProposalDocument =
|
|
23262
|
+
type ProposalDocument = _heyapi_906_ & {
|
|
23256
23263
|
/**
|
|
23257
23264
|
* Proposal document link
|
|
23258
23265
|
*/
|
|
@@ -23283,7 +23290,7 @@ type ProposalDocument = _heyapi_901_ & {
|
|
|
23283
23290
|
*/
|
|
23284
23291
|
readonly file_id?: number;
|
|
23285
23292
|
_embed?: {
|
|
23286
|
-
file?:
|
|
23293
|
+
file?: _heyapi_636_;
|
|
23287
23294
|
};
|
|
23288
23295
|
};
|
|
23289
23296
|
/**
|
|
@@ -23581,6 +23588,19 @@ type PurInvoiceOne = {
|
|
|
23581
23588
|
* Purchase invoice number
|
|
23582
23589
|
*/
|
|
23583
23590
|
number?: string;
|
|
23591
|
+
/**
|
|
23592
|
+
* Amounts of the purchase invoice
|
|
23593
|
+
*/
|
|
23594
|
+
readonly amounts?: {
|
|
23595
|
+
/**
|
|
23596
|
+
* Total amount without taxes
|
|
23597
|
+
*/
|
|
23598
|
+
total_excl_tax?: string;
|
|
23599
|
+
/**
|
|
23600
|
+
* Total amount including taxes
|
|
23601
|
+
*/
|
|
23602
|
+
total_incl_tax?: string;
|
|
23603
|
+
};
|
|
23584
23604
|
/**
|
|
23585
23605
|
* Objects linked to the purchase invoice :
|
|
23586
23606
|
* - There can be only one company or one individual at a time (required)
|
|
@@ -23599,6 +23619,10 @@ type PurInvoiceOne = {
|
|
|
23599
23619
|
*/
|
|
23600
23620
|
type?: 'company' | 'individual' | 'opportunity' | 'contact';
|
|
23601
23621
|
}>;
|
|
23622
|
+
/**
|
|
23623
|
+
* Status of the purchase invoice
|
|
23624
|
+
*/
|
|
23625
|
+
status?: 'draft' | 'due' | 'payinprogress' | 'paid' | 'late' | 'cancelled';
|
|
23602
23626
|
};
|
|
23603
23627
|
/**
|
|
23604
23628
|
* Purchase credit note
|
|
@@ -23612,6 +23636,19 @@ type PurCreditNoteOne = {
|
|
|
23612
23636
|
* Purchase credit note number
|
|
23613
23637
|
*/
|
|
23614
23638
|
number?: string;
|
|
23639
|
+
/**
|
|
23640
|
+
* Amounts of the purchase credit note
|
|
23641
|
+
*/
|
|
23642
|
+
readonly amounts?: {
|
|
23643
|
+
/**
|
|
23644
|
+
* Total amount without taxes
|
|
23645
|
+
*/
|
|
23646
|
+
total_excl_tax?: string;
|
|
23647
|
+
/**
|
|
23648
|
+
* Total amount including taxes
|
|
23649
|
+
*/
|
|
23650
|
+
total_incl_tax?: string;
|
|
23651
|
+
};
|
|
23615
23652
|
/**
|
|
23616
23653
|
* Objects linked to the purchase credit note :
|
|
23617
23654
|
* - There can be only one company or one individual at a time (required)
|
|
@@ -23630,6 +23667,10 @@ type PurCreditNoteOne = {
|
|
|
23630
23667
|
*/
|
|
23631
23668
|
type?: 'company' | 'individual' | 'opportunity' | 'contact';
|
|
23632
23669
|
}>;
|
|
23670
|
+
/**
|
|
23671
|
+
* Status of the purchase credit note
|
|
23672
|
+
*/
|
|
23673
|
+
status?: 'draft' | 'stored' | 'partialspend' | 'spent' | 'cancelled';
|
|
23633
23674
|
};
|
|
23634
23675
|
/**
|
|
23635
23676
|
* Purchase delivery
|
|
@@ -23643,6 +23684,19 @@ type PurDeliveryOne = {
|
|
|
23643
23684
|
* Purchase delivery number
|
|
23644
23685
|
*/
|
|
23645
23686
|
number?: string;
|
|
23687
|
+
/**
|
|
23688
|
+
* Amounts of the purchase delivery
|
|
23689
|
+
*/
|
|
23690
|
+
readonly amounts?: {
|
|
23691
|
+
/**
|
|
23692
|
+
* Total amount without taxes
|
|
23693
|
+
*/
|
|
23694
|
+
total_excl_tax?: string;
|
|
23695
|
+
/**
|
|
23696
|
+
* Total amount including taxes
|
|
23697
|
+
*/
|
|
23698
|
+
total_incl_tax?: string;
|
|
23699
|
+
};
|
|
23646
23700
|
/**
|
|
23647
23701
|
* Objects linked to the purchase delivery :
|
|
23648
23702
|
* - There can be only one company or one individual at a time (required)
|
|
@@ -23661,6 +23715,10 @@ type PurDeliveryOne = {
|
|
|
23661
23715
|
*/
|
|
23662
23716
|
type?: 'company' | 'individual' | 'opportunity' | 'contact';
|
|
23663
23717
|
}>;
|
|
23718
|
+
/**
|
|
23719
|
+
* Status of the purchase delivery
|
|
23720
|
+
*/
|
|
23721
|
+
status?: 'draft' | 'partialinvoiced' | 'invoiced';
|
|
23664
23722
|
};
|
|
23665
23723
|
/**
|
|
23666
23724
|
* Purchase order
|
|
@@ -23674,6 +23732,19 @@ type PurOrderOne = {
|
|
|
23674
23732
|
* Purchase order number
|
|
23675
23733
|
*/
|
|
23676
23734
|
number?: string;
|
|
23735
|
+
/**
|
|
23736
|
+
* Amounts of the purchase order
|
|
23737
|
+
*/
|
|
23738
|
+
readonly amounts?: {
|
|
23739
|
+
/**
|
|
23740
|
+
* Total amount without taxes
|
|
23741
|
+
*/
|
|
23742
|
+
total_excl_tax?: string;
|
|
23743
|
+
/**
|
|
23744
|
+
* Total amount including taxes
|
|
23745
|
+
*/
|
|
23746
|
+
total_incl_tax?: string;
|
|
23747
|
+
};
|
|
23677
23748
|
/**
|
|
23678
23749
|
* Objects linked to the purchase order :
|
|
23679
23750
|
* - There can be only one company or one individual at a time (required)
|
|
@@ -23692,6 +23763,10 @@ type PurOrderOne = {
|
|
|
23692
23763
|
*/
|
|
23693
23764
|
type?: 'company' | 'individual' | 'opportunity' | 'contact';
|
|
23694
23765
|
}>;
|
|
23766
|
+
/**
|
|
23767
|
+
* Status of the purchase order
|
|
23768
|
+
*/
|
|
23769
|
+
status?: 'draft' | 'sent' | 'read' | 'accepted' | 'expired' | 'partialinvoiced' | 'invoiced' | 'cancelled';
|
|
23695
23770
|
};
|
|
23696
23771
|
/**
|
|
23697
23772
|
* Create model
|
|
@@ -26916,7 +26991,7 @@ type DealsWritable = {
|
|
|
26916
26991
|
*/
|
|
26917
26992
|
related?: Array<{
|
|
26918
26993
|
id?: number;
|
|
26919
|
-
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery';
|
|
26994
|
+
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
26920
26995
|
}>;
|
|
26921
26996
|
/**
|
|
26922
26997
|
* Owner of the task
|
|
@@ -27850,7 +27925,7 @@ type TaskCollectionItemWritable = _heyapi_439_ & {
|
|
|
27850
27925
|
*
|
|
27851
27926
|
* Objects add to response. Use embed parameter
|
|
27852
27927
|
*/
|
|
27853
|
-
_embed?:
|
|
27928
|
+
_embed?: _heyapi_577_;
|
|
27854
27929
|
};
|
|
27855
27930
|
/**
|
|
27856
27931
|
* Label
|
|
@@ -27935,7 +28010,7 @@ type LabelBaseItemWritable = {
|
|
|
27935
28010
|
*/
|
|
27936
28011
|
related?: Array<{
|
|
27937
28012
|
id?: number;
|
|
27938
|
-
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery';
|
|
28013
|
+
type?: 'opportunity' | 'company' | 'individual' | 'contact' | 'invoice' | 'creditnote' | 'estimate' | 'order' | 'delivery' | 'model' | 'purchase-invoice' | 'purchase-creditnote' | 'purchase-order' | 'purchase-delivery' | 'item';
|
|
27939
28014
|
}>;
|
|
27940
28015
|
/**
|
|
27941
28016
|
* Owner of the task
|
|
@@ -27965,7 +28040,7 @@ type SearchResultWritable = Array<({
|
|
|
27965
28040
|
object?: {
|
|
27966
28041
|
type?: 'contact' | 'company' | 'individual' | 'opportunity' | 'purchase' | 'item' | 'declination' | 'document' | 'staff' | 'redactor';
|
|
27967
28042
|
id?: number;
|
|
27968
|
-
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
28043
|
+
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'model' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
27969
28044
|
};
|
|
27970
28045
|
/**
|
|
27971
28046
|
* Status archived or not
|
|
@@ -28022,7 +28097,7 @@ type SearchResultWritable = Array<({
|
|
|
28022
28097
|
*/
|
|
28023
28098
|
country_code?: string;
|
|
28024
28099
|
} | null;
|
|
28025
|
-
delivery_address?:
|
|
28100
|
+
delivery_address?: _heyapi_585_;
|
|
28026
28101
|
/**
|
|
28027
28102
|
* Company's main contact
|
|
28028
28103
|
*/
|
|
@@ -28048,7 +28123,7 @@ type SearchResultWritable = Array<({
|
|
|
28048
28123
|
* Company reference
|
|
28049
28124
|
*/
|
|
28050
28125
|
reference?: string;
|
|
28051
|
-
}) | (
|
|
28126
|
+
}) | (_heyapi_586_ & {
|
|
28052
28127
|
/**
|
|
28053
28128
|
* Individual first name
|
|
28054
28129
|
*/
|
|
@@ -28074,13 +28149,13 @@ type SearchResultWritable = Array<({
|
|
|
28074
28149
|
*/
|
|
28075
28150
|
phone_number?: string | null;
|
|
28076
28151
|
email?: string | null;
|
|
28077
|
-
invoicing_address?:
|
|
28078
|
-
delivery_address?:
|
|
28152
|
+
invoicing_address?: _heyapi_585_;
|
|
28153
|
+
delivery_address?: _heyapi_585_;
|
|
28079
28154
|
/**
|
|
28080
28155
|
* Individual reference
|
|
28081
28156
|
*/
|
|
28082
28157
|
reference?: string;
|
|
28083
|
-
}) | (
|
|
28158
|
+
}) | (_heyapi_586_ & {
|
|
28084
28159
|
/**
|
|
28085
28160
|
* Opportunity ident
|
|
28086
28161
|
*/
|
|
@@ -28120,7 +28195,7 @@ type SearchResultWritable = Array<({
|
|
|
28120
28195
|
*/
|
|
28121
28196
|
civility?: 'mr' | 'mrs' | 'ms';
|
|
28122
28197
|
});
|
|
28123
|
-
}) | (
|
|
28198
|
+
}) | (_heyapi_586_ & {
|
|
28124
28199
|
/**
|
|
28125
28200
|
* Contact first name
|
|
28126
28201
|
*/
|
|
@@ -28163,13 +28238,13 @@ type SearchResultWritable = Array<({
|
|
|
28163
28238
|
*/
|
|
28164
28239
|
id?: number;
|
|
28165
28240
|
}>;
|
|
28166
|
-
invoicing_address?:
|
|
28167
|
-
delivery_address?:
|
|
28168
|
-
}) | (
|
|
28241
|
+
invoicing_address?: _heyapi_585_;
|
|
28242
|
+
delivery_address?: _heyapi_585_;
|
|
28243
|
+
}) | (_heyapi_586_ & {
|
|
28169
28244
|
/**
|
|
28170
28245
|
* Purchase status
|
|
28171
28246
|
*/
|
|
28172
|
-
status?: 'draft' | 'due' | 'payinprogress' | 'paid' | 'late' | 'cancelled' | 'sent' | 'read' | 'accepted' | 'expired' | '
|
|
28247
|
+
status?: 'draft' | 'due' | 'payinprogress' | 'paid' | 'late' | 'cancelled' | 'sent' | 'read' | 'accepted' | 'expired' | 'partialinvoiced' | 'invoiced' | 'stored' | 'spent' | 'partialspend';
|
|
28173
28248
|
/**
|
|
28174
28249
|
* Purchase number
|
|
28175
28250
|
*/
|
|
@@ -28213,7 +28288,7 @@ type SearchResultWritable = Array<({
|
|
|
28213
28288
|
*/
|
|
28214
28289
|
civility?: 'mr' | 'mrs' | 'ms';
|
|
28215
28290
|
});
|
|
28216
|
-
}) | (
|
|
28291
|
+
}) | (_heyapi_586_ & {
|
|
28217
28292
|
/**
|
|
28218
28293
|
* Item number
|
|
28219
28294
|
*/
|
|
@@ -28226,7 +28301,7 @@ type SearchResultWritable = Array<({
|
|
|
28226
28301
|
* Item description
|
|
28227
28302
|
*/
|
|
28228
28303
|
description?: string | null;
|
|
28229
|
-
}) | (
|
|
28304
|
+
}) | (_heyapi_586_ & {
|
|
28230
28305
|
/**
|
|
28231
28306
|
* Item declination number
|
|
28232
28307
|
*/
|
|
@@ -28247,7 +28322,7 @@ type SearchResultWritable = Array<({
|
|
|
28247
28322
|
number?: string;
|
|
28248
28323
|
name?: string;
|
|
28249
28324
|
};
|
|
28250
|
-
}) | (
|
|
28325
|
+
}) | (_heyapi_586_ & {
|
|
28251
28326
|
/**
|
|
28252
28327
|
* Document status
|
|
28253
28328
|
*/
|
|
@@ -28291,7 +28366,7 @@ type SearchResultWritable = Array<({
|
|
|
28291
28366
|
*/
|
|
28292
28367
|
civility?: 'mr' | 'mrs' | 'ms';
|
|
28293
28368
|
});
|
|
28294
|
-
}) | (
|
|
28369
|
+
}) | (_heyapi_586_ & {
|
|
28295
28370
|
/**
|
|
28296
28371
|
* Staff's first name
|
|
28297
28372
|
*/
|
|
@@ -28320,7 +28395,7 @@ type SearchResultWritable = Array<({
|
|
|
28320
28395
|
* Staff's job
|
|
28321
28396
|
*/
|
|
28322
28397
|
position?: string | null;
|
|
28323
|
-
}) | (
|
|
28398
|
+
}) | (_heyapi_586_ & {
|
|
28324
28399
|
/**
|
|
28325
28400
|
* Ticket status
|
|
28326
28401
|
*/
|
|
@@ -28334,7 +28409,7 @@ type SearchResultWritable = Array<({
|
|
|
28334
28409
|
*/
|
|
28335
28410
|
index?: string;
|
|
28336
28411
|
related?: Array<string>;
|
|
28337
|
-
}) | (
|
|
28412
|
+
}) | (_heyapi_586_ & {
|
|
28338
28413
|
/**
|
|
28339
28414
|
* Redactor status
|
|
28340
28415
|
*/
|
|
@@ -28348,7 +28423,7 @@ type SearchResultWritable = Array<({
|
|
|
28348
28423
|
*/
|
|
28349
28424
|
ident?: string;
|
|
28350
28425
|
related?: Array<string>;
|
|
28351
|
-
}) | (
|
|
28426
|
+
}) | (_heyapi_586_ & {
|
|
28352
28427
|
/**
|
|
28353
28428
|
* Redactor template name
|
|
28354
28429
|
*/
|
|
@@ -28369,7 +28444,7 @@ type SearchResultBaseItemWritable = {
|
|
|
28369
28444
|
object?: {
|
|
28370
28445
|
type?: 'contact' | 'company' | 'individual' | 'opportunity' | 'purchase' | 'item' | 'declination' | 'document' | 'staff' | 'redactor';
|
|
28371
28446
|
id?: number;
|
|
28372
|
-
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
28447
|
+
sub_type?: 'contact' | 'opportunity' | 'client' | 'prospect' | 'supplier' | 'purInvoice' | 'purDelivery' | 'purOrder' | 'purCreditNote' | 'product' | 'packaging' | 'shipping' | 'service' | 'declination' | 'invoice' | 'estimate' | 'creditnote' | 'order' | 'model' | 'delivery' | 'proforma' | 'staff' | 'document' | 'template';
|
|
28373
28448
|
};
|
|
28374
28449
|
/**
|
|
28375
28450
|
* Status archived or not
|
|
@@ -28443,13 +28518,13 @@ type PhoneCallItemWritable = {
|
|
|
28443
28518
|
/**
|
|
28444
28519
|
* PhoneCall
|
|
28445
28520
|
*/
|
|
28446
|
-
type PhoneCallCollectionItemWritable =
|
|
28447
|
-
_embed?:
|
|
28521
|
+
type PhoneCallCollectionItemWritable = _heyapi_592_ & {
|
|
28522
|
+
_embed?: _heyapi_593_;
|
|
28448
28523
|
};
|
|
28449
28524
|
/**
|
|
28450
28525
|
* Calendar Event
|
|
28451
28526
|
*/
|
|
28452
|
-
type CalendarEventItemWritable =
|
|
28527
|
+
type CalendarEventItemWritable = _heyapi_598_ & {
|
|
28453
28528
|
_embed?: unknown;
|
|
28454
28529
|
};
|
|
28455
28530
|
/**
|
|
@@ -28494,13 +28569,13 @@ type ActivityWritable = {
|
|
|
28494
28569
|
object?: {
|
|
28495
28570
|
type: string;
|
|
28496
28571
|
id: string | number;
|
|
28497
|
-
model?: _heyapi_435_ | _heyapi_438_ | _heyapi_439_ | _heyapi_437_ | _heyapi_436_ |
|
|
28572
|
+
model?: _heyapi_435_ | _heyapi_438_ | _heyapi_439_ | _heyapi_437_ | _heyapi_436_ | _heyapi_606_ | _heyapi_598_ | _heyapi_607_ | null;
|
|
28498
28573
|
};
|
|
28499
28574
|
/**
|
|
28500
28575
|
* List all direct and indirect relations of the activity’s main object
|
|
28501
28576
|
*/
|
|
28502
28577
|
related?: Array<{
|
|
28503
|
-
id?:
|
|
28578
|
+
id?: _heyapi_608_;
|
|
28504
28579
|
type?: string;
|
|
28505
28580
|
}>;
|
|
28506
28581
|
};
|
|
@@ -28608,15 +28683,15 @@ type EmailEngineItemWritable = {
|
|
|
28608
28683
|
/**
|
|
28609
28684
|
* An array of name+email pairs the message was sent to.
|
|
28610
28685
|
*/
|
|
28611
|
-
to?: Array<
|
|
28686
|
+
to?: Array<_heyapi_614_>;
|
|
28612
28687
|
/**
|
|
28613
28688
|
* An array of name+email pairs the message was cc'd to.
|
|
28614
28689
|
*/
|
|
28615
|
-
cc?: Array<
|
|
28690
|
+
cc?: Array<_heyapi_614_>;
|
|
28616
28691
|
/**
|
|
28617
28692
|
* An array of name+email pairs the message was bcc'd to. For received mail this is nearly always empty.
|
|
28618
28693
|
*/
|
|
28619
|
-
bcc?: Array<
|
|
28694
|
+
bcc?: Array<_heyapi_614_>;
|
|
28620
28695
|
/**
|
|
28621
28696
|
* Private email or not
|
|
28622
28697
|
*/
|
|
@@ -28734,7 +28809,7 @@ type EmailTemplateOutputWritable = {
|
|
|
28734
28809
|
* Content of template
|
|
28735
28810
|
*/
|
|
28736
28811
|
content?: string;
|
|
28737
|
-
attachments?:
|
|
28812
|
+
attachments?: _heyapi_636_;
|
|
28738
28813
|
/**
|
|
28739
28814
|
* Content to call AI
|
|
28740
28815
|
*/
|
|
@@ -28767,7 +28842,7 @@ type EmailTemplateItemOutputWritable = {
|
|
|
28767
28842
|
/**
|
|
28768
28843
|
* Attachment objects
|
|
28769
28844
|
*/
|
|
28770
|
-
attachments?: Array<
|
|
28845
|
+
attachments?: Array<_heyapi_636_>;
|
|
28771
28846
|
/**
|
|
28772
28847
|
* Template used in automation
|
|
28773
28848
|
*/
|
|
@@ -28800,19 +28875,19 @@ type EmailProviderMessageWritable = {
|
|
|
28800
28875
|
* The body of the message
|
|
28801
28876
|
*/
|
|
28802
28877
|
content?: string;
|
|
28803
|
-
from?:
|
|
28878
|
+
from?: _heyapi_614_;
|
|
28804
28879
|
/**
|
|
28805
28880
|
* An array of name/email address pairs that the email message was sent to
|
|
28806
28881
|
*/
|
|
28807
|
-
to?: Array<
|
|
28882
|
+
to?: Array<_heyapi_614_>;
|
|
28808
28883
|
/**
|
|
28809
28884
|
* An array of name/email address pairs that the email message was CC'd to
|
|
28810
28885
|
*/
|
|
28811
|
-
cc?: Array<
|
|
28886
|
+
cc?: Array<_heyapi_614_>;
|
|
28812
28887
|
/**
|
|
28813
28888
|
* An array of name/email address pairs that the email message was BCC'd to
|
|
28814
28889
|
*/
|
|
28815
|
-
bcc?: Array<
|
|
28890
|
+
bcc?: Array<_heyapi_614_>;
|
|
28816
28891
|
/**
|
|
28817
28892
|
* Indicates whether the email message has been read by the user
|
|
28818
28893
|
*/
|
|
@@ -28820,7 +28895,7 @@ type EmailProviderMessageWritable = {
|
|
|
28820
28895
|
/**
|
|
28821
28896
|
* Attachment objects
|
|
28822
28897
|
*/
|
|
28823
|
-
attachments?: Array<
|
|
28898
|
+
attachments?: Array<_heyapi_648_>;
|
|
28824
28899
|
/**
|
|
28825
28900
|
* The date and time of the most recent message in the thread
|
|
28826
28901
|
*/
|
|
@@ -28832,7 +28907,7 @@ type EmailProviderMessageWritable = {
|
|
|
28832
28907
|
id?: number;
|
|
28833
28908
|
type?: string;
|
|
28834
28909
|
}>;
|
|
28835
|
-
_links?:
|
|
28910
|
+
_links?: _heyapi_649_;
|
|
28836
28911
|
};
|
|
28837
28912
|
type PaymentMethodWritable = {
|
|
28838
28913
|
_embed?: {
|
|
@@ -29545,7 +29620,7 @@ type InvoiceOneWritable = {
|
|
|
29545
29620
|
* If the invoice is sent to accounting
|
|
29546
29621
|
*/
|
|
29547
29622
|
is_sent_to_accounting?: boolean;
|
|
29548
|
-
_embed?:
|
|
29623
|
+
_embed?: _heyapi_715_;
|
|
29549
29624
|
/**
|
|
29550
29625
|
* Date of the shipping
|
|
29551
29626
|
*/
|
|
@@ -29901,13 +29976,13 @@ type InvoiceOneWritable = {
|
|
|
29901
29976
|
*/
|
|
29902
29977
|
is_optional?: boolean;
|
|
29903
29978
|
}>;
|
|
29904
|
-
_embed?:
|
|
29979
|
+
_embed?: _heyapi_715_ & {
|
|
29905
29980
|
/**
|
|
29906
29981
|
* Document Payment Terms
|
|
29907
29982
|
*
|
|
29908
29983
|
* Terms of payment of document
|
|
29909
29984
|
*/
|
|
29910
|
-
payment_terms?:
|
|
29985
|
+
payment_terms?: _heyapi_716_ & {
|
|
29911
29986
|
/**
|
|
29912
29987
|
* List of deadlines computed with the payment terms settings
|
|
29913
29988
|
*/
|
|
@@ -29938,7 +30013,7 @@ type InvoiceOneWritable = {
|
|
|
29938
30013
|
description?: string | null;
|
|
29939
30014
|
}>;
|
|
29940
30015
|
};
|
|
29941
|
-
} &
|
|
30016
|
+
} & _heyapi_717_ & {
|
|
29942
30017
|
/**
|
|
29943
30018
|
* Automatic Dunning
|
|
29944
30019
|
*/
|
|
@@ -30037,7 +30112,7 @@ type InvoiceOneWritable = {
|
|
|
30037
30112
|
}>;
|
|
30038
30113
|
};
|
|
30039
30114
|
settings?: _heyapi_476_;
|
|
30040
|
-
file?:
|
|
30115
|
+
file?: _heyapi_636_;
|
|
30041
30116
|
};
|
|
30042
30117
|
};
|
|
30043
30118
|
type InvoiceOrProgressInvoiceOneWritable = InvoiceOneWritable | (_heyapi_568_ & {
|
|
@@ -30076,8 +30151,8 @@ type InvoiceOrProgressInvoiceOneWritable = InvoiceOneWritable | (_heyapi_568_ &
|
|
|
30076
30151
|
* The next available progress invoice number
|
|
30077
30152
|
*/
|
|
30078
30153
|
next_progress_invoice_number?: number | null;
|
|
30079
|
-
_embed?:
|
|
30080
|
-
automatic_dunning?:
|
|
30154
|
+
_embed?: _heyapi_715_ & _heyapi_719_ & _heyapi_717_ & {
|
|
30155
|
+
automatic_dunning?: _heyapi_720_;
|
|
30081
30156
|
settings?: {
|
|
30082
30157
|
pdf_display?: {
|
|
30083
30158
|
/**
|
|
@@ -30165,10 +30240,10 @@ type InvoiceOrProgressInvoiceOneWritable = InvoiceOneWritable | (_heyapi_568_ &
|
|
|
30165
30240
|
show_terms_and_conditions_text?: boolean;
|
|
30166
30241
|
};
|
|
30167
30242
|
} & _heyapi_476_;
|
|
30168
|
-
file?:
|
|
30243
|
+
file?: _heyapi_636_;
|
|
30169
30244
|
};
|
|
30170
30245
|
});
|
|
30171
|
-
type ProgressInvoiceOneWritable =
|
|
30246
|
+
type ProgressInvoiceOneWritable = _heyapi_722_;
|
|
30172
30247
|
type InvoiceComputeWritable = {
|
|
30173
30248
|
/**
|
|
30174
30249
|
* date of the invoice
|
|
@@ -30205,7 +30280,7 @@ type InvoiceComputeWritable = {
|
|
|
30205
30280
|
* payments methods allowed on the estimate
|
|
30206
30281
|
*/
|
|
30207
30282
|
payment_method_ids?: Array<number> | null;
|
|
30208
|
-
rows?: Array<
|
|
30283
|
+
rows?: Array<_heyapi_724_>;
|
|
30209
30284
|
shipping_weight?: _heyapi_460_;
|
|
30210
30285
|
};
|
|
30211
30286
|
type InvoiceCreateWritable = {
|
|
@@ -30224,7 +30299,7 @@ type InvoiceCreateWritable = {
|
|
|
30224
30299
|
* @deprecated
|
|
30225
30300
|
*/
|
|
30226
30301
|
due_date?: string;
|
|
30227
|
-
payment_terms?:
|
|
30302
|
+
payment_terms?: _heyapi_727_;
|
|
30228
30303
|
/**
|
|
30229
30304
|
* Created date of invoice
|
|
30230
30305
|
*/
|
|
@@ -30405,7 +30480,7 @@ type InvoiceCreateWritable = {
|
|
|
30405
30480
|
* Parent object id
|
|
30406
30481
|
*/
|
|
30407
30482
|
id?: number;
|
|
30408
|
-
} |
|
|
30483
|
+
} | _heyapi_728_ | null;
|
|
30409
30484
|
/**
|
|
30410
30485
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
30411
30486
|
*/
|
|
@@ -30841,7 +30916,7 @@ type DepositInvoiceUpdateWritable = {
|
|
|
30841
30916
|
* Currency code of the invoice
|
|
30842
30917
|
*/
|
|
30843
30918
|
currency?: string;
|
|
30844
|
-
related?:
|
|
30919
|
+
related?: _heyapi_731_;
|
|
30845
30920
|
/**
|
|
30846
30921
|
* Company or individual name displayed on the invoice. If not provided, use company_name of the parent document.
|
|
30847
30922
|
*/
|
|
@@ -30874,7 +30949,7 @@ type DepositInvoiceUpdateWritable = {
|
|
|
30874
30949
|
* Analytic code of document
|
|
30875
30950
|
*/
|
|
30876
30951
|
analytic_code?: string | null;
|
|
30877
|
-
payment_terms?:
|
|
30952
|
+
payment_terms?: _heyapi_732_;
|
|
30878
30953
|
/**
|
|
30879
30954
|
* Bank account id
|
|
30880
30955
|
*/
|
|
@@ -30891,7 +30966,7 @@ type DepositInvoiceUpdateWritable = {
|
|
|
30891
30966
|
* Document Layout
|
|
30892
30967
|
*/
|
|
30893
30968
|
layout_id?: number;
|
|
30894
|
-
settings?:
|
|
30969
|
+
settings?: _heyapi_733_;
|
|
30895
30970
|
/**
|
|
30896
30971
|
* Sale type of the document: product (goods), service, or mixed. If not provided, it is automatically detected from the document rows.
|
|
30897
30972
|
*/
|
|
@@ -30905,20 +30980,20 @@ type DepositInvoiceUpdateWritable = {
|
|
|
30905
30980
|
* Deposit Invoice Compute
|
|
30906
30981
|
*/
|
|
30907
30982
|
type DepositInvoiceComputeInputWritable = {
|
|
30908
|
-
parent:
|
|
30983
|
+
parent: _heyapi_735_;
|
|
30909
30984
|
/**
|
|
30910
30985
|
* Rows of the deposit invoice. There must be as many deposit lines as there are VAT rates in the parent document. For example, if the parent document has products with VAT rates of 20% and 5.5%, there must be two 'deposit' rows."
|
|
30911
30986
|
*
|
|
30912
30987
|
*/
|
|
30913
|
-
rows: Array<
|
|
30988
|
+
rows: Array<_heyapi_738_ | _heyapi_739_ | _heyapi_423_ | _heyapi_422_>;
|
|
30914
30989
|
/**
|
|
30915
30990
|
* Deposit invoice id, if already created
|
|
30916
30991
|
*/
|
|
30917
30992
|
id?: number | null;
|
|
30918
30993
|
};
|
|
30919
30994
|
type DepositInvoiceOneWritable = _heyapi_568_ & {
|
|
30920
|
-
rows?: Array<
|
|
30921
|
-
_embed?:
|
|
30995
|
+
rows?: Array<_heyapi_742_ | _heyapi_422_ | _heyapi_423_>;
|
|
30996
|
+
_embed?: _heyapi_743_;
|
|
30922
30997
|
};
|
|
30923
30998
|
/**
|
|
30924
30999
|
* Deposit Invoice Metadata
|
|
@@ -30926,16 +31001,16 @@ type DepositInvoiceOneWritable = _heyapi_568_ & {
|
|
|
30926
31001
|
type DepositInvoiceMetadataWritable = {
|
|
30927
31002
|
parent?: (_heyapi_472_ & {
|
|
30928
31003
|
rows: Array<_heyapi_480_>;
|
|
30929
|
-
}) | (
|
|
31004
|
+
}) | (_heyapi_747_ & {
|
|
30930
31005
|
rows?: Array<_heyapi_480_>;
|
|
30931
|
-
}) | (
|
|
31006
|
+
}) | (_heyapi_749_ & {
|
|
30932
31007
|
rows?: Array<_heyapi_480_>;
|
|
30933
31008
|
});
|
|
30934
31009
|
/**
|
|
30935
31010
|
* Current invoice, exist only if invoice type is used
|
|
30936
31011
|
*/
|
|
30937
31012
|
document?: (_heyapi_568_ & {
|
|
30938
|
-
rows?: Array<
|
|
31013
|
+
rows?: Array<_heyapi_742_ | _heyapi_422_ | _heyapi_423_>;
|
|
30939
31014
|
}) | null;
|
|
30940
31015
|
law_texts?: {
|
|
30941
31016
|
/**
|
|
@@ -31079,11 +31154,11 @@ type DepositInvoiceMetadataWritable = {
|
|
|
31079
31154
|
/**
|
|
31080
31155
|
* List of document layouts
|
|
31081
31156
|
*/
|
|
31082
|
-
document_layouts?: Array<
|
|
31157
|
+
document_layouts?: Array<_heyapi_751_>;
|
|
31083
31158
|
/**
|
|
31084
31159
|
* List of languages
|
|
31085
31160
|
*/
|
|
31086
|
-
languages?: Array<
|
|
31161
|
+
languages?: Array<_heyapi_752_>;
|
|
31087
31162
|
/**
|
|
31088
31163
|
* List of payment terms
|
|
31089
31164
|
*/
|
|
@@ -31120,7 +31195,7 @@ type DepositInvoiceMetadataWritable = {
|
|
|
31120
31195
|
/**
|
|
31121
31196
|
* Payment term translations
|
|
31122
31197
|
*/
|
|
31123
|
-
translations?: Array<
|
|
31198
|
+
translations?: Array<_heyapi_753_>;
|
|
31124
31199
|
};
|
|
31125
31200
|
}>;
|
|
31126
31201
|
/**
|
|
@@ -31147,7 +31222,7 @@ type DepositInvoiceMetadataWritable = {
|
|
|
31147
31222
|
/**
|
|
31148
31223
|
* Assigned staff translations
|
|
31149
31224
|
*/
|
|
31150
|
-
translations?: Array<
|
|
31225
|
+
translations?: Array<_heyapi_754_>;
|
|
31151
31226
|
};
|
|
31152
31227
|
}>;
|
|
31153
31228
|
permissions?: {
|
|
@@ -31388,13 +31463,13 @@ type ProgressInvoiceCreateWritable = {
|
|
|
31388
31463
|
* Bar code ID for progress-catalog row
|
|
31389
31464
|
*/
|
|
31390
31465
|
sku_id?: number | null;
|
|
31391
|
-
}) | (
|
|
31466
|
+
}) | (_heyapi_756_ & {
|
|
31392
31467
|
type?: 'progress-single';
|
|
31393
31468
|
/**
|
|
31394
31469
|
* Purchase amount
|
|
31395
31470
|
*/
|
|
31396
31471
|
purchase_amount?: string;
|
|
31397
|
-
}) | (
|
|
31472
|
+
}) | (_heyapi_756_ & {
|
|
31398
31473
|
type?: 'progress-shipping' | 'progress-packaging';
|
|
31399
31474
|
}) | _heyapi_422_ | _heyapi_423_ | _heyapi_424_ | _heyapi_425_ | _heyapi_426_>;
|
|
31400
31475
|
/**
|
|
@@ -31873,7 +31948,7 @@ type ProgressInvoiceComputeWritable = {
|
|
|
31873
31948
|
* Rows of the progress invoice. There must be at least one progress row.
|
|
31874
31949
|
*
|
|
31875
31950
|
*/
|
|
31876
|
-
rows: Array<_heyapi_424_ |
|
|
31951
|
+
rows: Array<_heyapi_424_ | _heyapi_758_ | _heyapi_759_ | _heyapi_760_ | _heyapi_422_ | ({
|
|
31877
31952
|
/**
|
|
31878
31953
|
* ID of the progress invoice row
|
|
31879
31954
|
*/
|
|
@@ -31907,20 +31982,20 @@ type ProgressInvoiceComputeWritable = {
|
|
|
31907
31982
|
* Bar code ID for progress-catalog row
|
|
31908
31983
|
*/
|
|
31909
31984
|
sku_id?: number | null;
|
|
31910
|
-
}) | (
|
|
31985
|
+
}) | (_heyapi_761_ & {
|
|
31911
31986
|
/**
|
|
31912
31987
|
* Purchase amount
|
|
31913
31988
|
*/
|
|
31914
31989
|
purchase_amount?: string;
|
|
31915
|
-
}) |
|
|
31990
|
+
}) | _heyapi_761_ | {
|
|
31916
31991
|
/**
|
|
31917
31992
|
* Row Identifier
|
|
31918
31993
|
*/
|
|
31919
31994
|
id: number;
|
|
31920
31995
|
}>;
|
|
31921
31996
|
};
|
|
31922
|
-
type InvoiceUpdateWritable =
|
|
31923
|
-
rows?: Array<
|
|
31997
|
+
type InvoiceUpdateWritable = _heyapi_765_ & {
|
|
31998
|
+
rows?: Array<_heyapi_766_> | null;
|
|
31924
31999
|
settings?: _heyapi_469_;
|
|
31925
32000
|
};
|
|
31926
32001
|
/**
|
|
@@ -32140,9 +32215,9 @@ type CreditNoteWritable = {
|
|
|
32140
32215
|
/**
|
|
32141
32216
|
* Credit Note Embed
|
|
32142
32217
|
*/
|
|
32143
|
-
_embed?:
|
|
32218
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
32144
32219
|
fiscal_year?: _heyapi_475_;
|
|
32145
|
-
currency?:
|
|
32220
|
+
currency?: _heyapi_770_;
|
|
32146
32221
|
owner?: _heyapi_434_;
|
|
32147
32222
|
/**
|
|
32148
32223
|
* Credit Note ACL
|
|
@@ -32381,11 +32456,11 @@ type CreditNoteOneWritable = {
|
|
|
32381
32456
|
*/
|
|
32382
32457
|
label?: string;
|
|
32383
32458
|
} | null;
|
|
32384
|
-
_embed?:
|
|
32459
|
+
_embed?: _heyapi_772_;
|
|
32385
32460
|
} & {
|
|
32386
32461
|
rows?: Array<_heyapi_480_>;
|
|
32387
|
-
_embed?:
|
|
32388
|
-
file?:
|
|
32462
|
+
_embed?: _heyapi_772_ & _heyapi_717_ & {
|
|
32463
|
+
file?: _heyapi_636_;
|
|
32389
32464
|
};
|
|
32390
32465
|
};
|
|
32391
32466
|
type CreditNoteCreateWritable = {
|
|
@@ -32496,14 +32571,14 @@ type CreditNoteCreateWritable = {
|
|
|
32496
32571
|
einvoicing_electronic_address?: string | null;
|
|
32497
32572
|
} & {
|
|
32498
32573
|
rows?: Array<_heyapi_480_> | null;
|
|
32499
|
-
parent?:
|
|
32574
|
+
parent?: _heyapi_728_ | null;
|
|
32500
32575
|
/**
|
|
32501
32576
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
32502
32577
|
*/
|
|
32503
32578
|
rate_category_id?: number;
|
|
32504
32579
|
};
|
|
32505
|
-
type CreditNoteUpdateWritable =
|
|
32506
|
-
rows?: Array<
|
|
32580
|
+
type CreditNoteUpdateWritable = _heyapi_775_ & {
|
|
32581
|
+
rows?: Array<_heyapi_766_> | null;
|
|
32507
32582
|
};
|
|
32508
32583
|
/**
|
|
32509
32584
|
* Credit Note
|
|
@@ -32608,7 +32683,7 @@ type CreditNoteComputeWritable = {
|
|
|
32608
32683
|
*/
|
|
32609
32684
|
type?: 'company' | 'individual' | 'contact' | 'opportunity';
|
|
32610
32685
|
}>;
|
|
32611
|
-
rows?: Array<
|
|
32686
|
+
rows?: Array<_heyapi_724_>;
|
|
32612
32687
|
};
|
|
32613
32688
|
type OrderCreateWritable = {
|
|
32614
32689
|
/**
|
|
@@ -32752,15 +32827,15 @@ type OrderCreateWritable = {
|
|
|
32752
32827
|
shipping_volume?: string;
|
|
32753
32828
|
} & {
|
|
32754
32829
|
rows?: Array<_heyapi_480_> | null;
|
|
32755
|
-
parent?:
|
|
32830
|
+
parent?: _heyapi_728_ | null;
|
|
32756
32831
|
/**
|
|
32757
32832
|
* Rate Category to apply on document (By default, the rate_category_id will be that of company)
|
|
32758
32833
|
*/
|
|
32759
32834
|
rate_category_id?: number;
|
|
32760
32835
|
settings?: _heyapi_469_;
|
|
32761
32836
|
};
|
|
32762
|
-
type OrderUpdateWritable =
|
|
32763
|
-
rows?: Array<
|
|
32837
|
+
type OrderUpdateWritable = _heyapi_781_ & {
|
|
32838
|
+
rows?: Array<_heyapi_766_> | null;
|
|
32764
32839
|
settings?: _heyapi_469_;
|
|
32765
32840
|
};
|
|
32766
32841
|
/**
|
|
@@ -32869,7 +32944,7 @@ type OrderWritable = {
|
|
|
32869
32944
|
/**
|
|
32870
32945
|
* Order Embed
|
|
32871
32946
|
*/
|
|
32872
|
-
_embed?:
|
|
32947
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
32873
32948
|
/**
|
|
32874
32949
|
* Order ACL
|
|
32875
32950
|
*/
|
|
@@ -32885,7 +32960,7 @@ type OrderWritable = {
|
|
|
32885
32960
|
};
|
|
32886
32961
|
owner?: _heyapi_434_;
|
|
32887
32962
|
fiscal_year?: _heyapi_475_;
|
|
32888
|
-
currency?:
|
|
32963
|
+
currency?: _heyapi_770_;
|
|
32889
32964
|
/**
|
|
32890
32965
|
* Smart-tags linked
|
|
32891
32966
|
*/
|
|
@@ -33044,7 +33119,7 @@ type OrderOneWritable = {
|
|
|
33044
33119
|
* Notes of the order
|
|
33045
33120
|
*/
|
|
33046
33121
|
note?: string;
|
|
33047
|
-
_embed?:
|
|
33122
|
+
_embed?: _heyapi_784_;
|
|
33048
33123
|
/**
|
|
33049
33124
|
* Date of the shipping
|
|
33050
33125
|
*/
|
|
@@ -33088,13 +33163,13 @@ type OrderOneWritable = {
|
|
|
33088
33163
|
/**
|
|
33089
33164
|
* Order Embed
|
|
33090
33165
|
*/
|
|
33091
|
-
_embed?:
|
|
33166
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
33092
33167
|
/**
|
|
33093
33168
|
* Document Payment Terms
|
|
33094
33169
|
*
|
|
33095
33170
|
* Terms of payment of document
|
|
33096
33171
|
*/
|
|
33097
|
-
payment_terms?:
|
|
33172
|
+
payment_terms?: _heyapi_716_ & {
|
|
33098
33173
|
/**
|
|
33099
33174
|
* List of deadlines computed with the payment terms settings
|
|
33100
33175
|
*/
|
|
@@ -33113,7 +33188,7 @@ type OrderOneWritable = {
|
|
|
33113
33188
|
description?: string | null;
|
|
33114
33189
|
}>;
|
|
33115
33190
|
};
|
|
33116
|
-
} &
|
|
33191
|
+
} & _heyapi_717_ & {
|
|
33117
33192
|
/**
|
|
33118
33193
|
* Order ACL
|
|
33119
33194
|
*/
|
|
@@ -33129,7 +33204,7 @@ type OrderOneWritable = {
|
|
|
33129
33204
|
};
|
|
33130
33205
|
owner?: _heyapi_434_;
|
|
33131
33206
|
fiscal_year?: _heyapi_475_;
|
|
33132
|
-
currency?:
|
|
33207
|
+
currency?: _heyapi_770_;
|
|
33133
33208
|
/**
|
|
33134
33209
|
* Smart-tags linked
|
|
33135
33210
|
*/
|
|
@@ -33148,7 +33223,7 @@ type OrderOneWritable = {
|
|
|
33148
33223
|
*/
|
|
33149
33224
|
label?: string;
|
|
33150
33225
|
}>;
|
|
33151
|
-
file?:
|
|
33226
|
+
file?: _heyapi_636_;
|
|
33152
33227
|
};
|
|
33153
33228
|
};
|
|
33154
33229
|
/**
|
|
@@ -33203,7 +33278,7 @@ type OrderComputeWritable = {
|
|
|
33203
33278
|
type?: 'company' | 'individual' | 'contact' | 'opportunity';
|
|
33204
33279
|
}>;
|
|
33205
33280
|
owner?: unknown;
|
|
33206
|
-
rows?: Array<
|
|
33281
|
+
rows?: Array<_heyapi_724_>;
|
|
33207
33282
|
shipping_weight?: _heyapi_460_;
|
|
33208
33283
|
};
|
|
33209
33284
|
/**
|
|
@@ -33340,7 +33415,7 @@ type DeliveryWritable = {
|
|
|
33340
33415
|
/**
|
|
33341
33416
|
* Delivery Embed
|
|
33342
33417
|
*/
|
|
33343
|
-
_embed?:
|
|
33418
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
33344
33419
|
/**
|
|
33345
33420
|
* Delivery ACL
|
|
33346
33421
|
*/
|
|
@@ -33356,7 +33431,7 @@ type DeliveryWritable = {
|
|
|
33356
33431
|
};
|
|
33357
33432
|
owner?: _heyapi_434_;
|
|
33358
33433
|
fiscal_year?: _heyapi_475_;
|
|
33359
|
-
currency?:
|
|
33434
|
+
currency?: _heyapi_770_;
|
|
33360
33435
|
/**
|
|
33361
33436
|
* Smart-tags linked
|
|
33362
33437
|
*/
|
|
@@ -33495,7 +33570,7 @@ type DeliveryOneWritable = {
|
|
|
33495
33570
|
* Total volume of product to ship in m3
|
|
33496
33571
|
*/
|
|
33497
33572
|
shipping_volume?: string;
|
|
33498
|
-
_embed?:
|
|
33573
|
+
_embed?: _heyapi_789_;
|
|
33499
33574
|
} & {
|
|
33500
33575
|
rows?: Array<_heyapi_480_>;
|
|
33501
33576
|
};
|
|
@@ -33520,7 +33595,7 @@ type ListFilesOutputWritable = {
|
|
|
33520
33595
|
* Current directory location. The first element is the direct parent of the directory
|
|
33521
33596
|
*/
|
|
33522
33597
|
breadcrumbs?: Array<_heyapi_489_>;
|
|
33523
|
-
} |
|
|
33598
|
+
} | _heyapi_636_;
|
|
33524
33599
|
/**
|
|
33525
33600
|
* File schema
|
|
33526
33601
|
*
|
|
@@ -33624,7 +33699,7 @@ type CompanyPreferencesWritable = {
|
|
|
33624
33699
|
/**
|
|
33625
33700
|
* System label of tax
|
|
33626
33701
|
*/
|
|
33627
|
-
system_label?: string;
|
|
33702
|
+
system_label?: string | null;
|
|
33628
33703
|
};
|
|
33629
33704
|
/**
|
|
33630
33705
|
* Company preferred pay date.
|
|
@@ -33770,7 +33845,7 @@ type IndividualPreferencesWritable = {
|
|
|
33770
33845
|
*/
|
|
33771
33846
|
label?: string;
|
|
33772
33847
|
} | null;
|
|
33773
|
-
tax?:
|
|
33848
|
+
tax?: _heyapi_823_;
|
|
33774
33849
|
/**
|
|
33775
33850
|
* Individual preferred pay date.
|
|
33776
33851
|
*/
|
|
@@ -34287,7 +34362,7 @@ type ProformaInvoiceOneWritable = {
|
|
|
34287
34362
|
/**
|
|
34288
34363
|
* Proforma Invoice Embed
|
|
34289
34364
|
*/
|
|
34290
|
-
_embed?:
|
|
34365
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & {
|
|
34291
34366
|
/**
|
|
34292
34367
|
* Proforma Invoice ACL
|
|
34293
34368
|
*/
|
|
@@ -34303,7 +34378,7 @@ type ProformaInvoiceOneWritable = {
|
|
|
34303
34378
|
};
|
|
34304
34379
|
owner?: _heyapi_434_;
|
|
34305
34380
|
fiscal_year?: _heyapi_475_;
|
|
34306
|
-
currency?:
|
|
34381
|
+
currency?: _heyapi_770_;
|
|
34307
34382
|
/**
|
|
34308
34383
|
* Smart-tags linked
|
|
34309
34384
|
*/
|
|
@@ -34357,7 +34432,7 @@ type ProformaInvoiceOneWritable = {
|
|
|
34357
34432
|
/**
|
|
34358
34433
|
* Proforma Invoice Embed
|
|
34359
34434
|
*/
|
|
34360
|
-
_embed?:
|
|
34435
|
+
_embed?: _heyapi_769_ & _heyapi_450_ & _heyapi_717_ & {
|
|
34361
34436
|
/**
|
|
34362
34437
|
* Proforma Invoice ACL
|
|
34363
34438
|
*/
|
|
@@ -34373,7 +34448,7 @@ type ProformaInvoiceOneWritable = {
|
|
|
34373
34448
|
};
|
|
34374
34449
|
owner?: _heyapi_434_;
|
|
34375
34450
|
fiscal_year?: _heyapi_475_;
|
|
34376
|
-
currency?:
|
|
34451
|
+
currency?: _heyapi_770_;
|
|
34377
34452
|
/**
|
|
34378
34453
|
* Smart-tags linked
|
|
34379
34454
|
*/
|
|
@@ -34408,9 +34483,9 @@ type ObjectiveCollectionOutputWritable = {
|
|
|
34408
34483
|
* Objective name
|
|
34409
34484
|
*/
|
|
34410
34485
|
name: string;
|
|
34411
|
-
category:
|
|
34412
|
-
turnover:
|
|
34413
|
-
period:
|
|
34486
|
+
category: _heyapi_845_;
|
|
34487
|
+
turnover: _heyapi_846_;
|
|
34488
|
+
period: _heyapi_847_;
|
|
34414
34489
|
item: {
|
|
34415
34490
|
/**
|
|
34416
34491
|
* linked Item id
|
|
@@ -34421,16 +34496,16 @@ type ObjectiveCollectionOutputWritable = {
|
|
|
34421
34496
|
*/
|
|
34422
34497
|
name: string;
|
|
34423
34498
|
} | null;
|
|
34424
|
-
item_category:
|
|
34499
|
+
item_category: _heyapi_848_;
|
|
34425
34500
|
/**
|
|
34426
34501
|
* Refinements of the objective
|
|
34427
34502
|
*/
|
|
34428
34503
|
refinements: Array<{
|
|
34429
|
-
period?:
|
|
34430
|
-
turnover?:
|
|
34504
|
+
period?: _heyapi_847_;
|
|
34505
|
+
turnover?: _heyapi_846_;
|
|
34431
34506
|
}>;
|
|
34432
|
-
assignee:
|
|
34433
|
-
links:
|
|
34507
|
+
assignee: _heyapi_849_;
|
|
34508
|
+
links: _heyapi_850_;
|
|
34434
34509
|
} & {
|
|
34435
34510
|
_embed?: {
|
|
34436
34511
|
created_by?: _heyapi_434_;
|
|
@@ -34476,7 +34551,7 @@ type DiscountInclTaxesOutputWritable = {
|
|
|
34476
34551
|
* Progress Invoice Metadata
|
|
34477
34552
|
*/
|
|
34478
34553
|
type ProgressInvoiceMetadataWritable = {
|
|
34479
|
-
parent?: (
|
|
34554
|
+
parent?: (_heyapi_883_ & {
|
|
34480
34555
|
/**
|
|
34481
34556
|
* Rate category with taxes included
|
|
34482
34557
|
*/
|
|
@@ -34485,7 +34560,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
34485
34560
|
* Progress invoice mode
|
|
34486
34561
|
*/
|
|
34487
34562
|
progress_invoice_mode?: 'global' | 'per-line';
|
|
34488
|
-
}) | (
|
|
34563
|
+
}) | (_heyapi_884_ & {
|
|
34489
34564
|
/**
|
|
34490
34565
|
* Rate category with taxes included
|
|
34491
34566
|
*/
|
|
@@ -34504,7 +34579,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
34504
34579
|
* Invoice related to the progress invoice, exist only if invoice type is used
|
|
34505
34580
|
*/
|
|
34506
34581
|
document?: (_heyapi_568_ & {
|
|
34507
|
-
rows?: Array<
|
|
34582
|
+
rows?: Array<_heyapi_885_ | _heyapi_886_ | _heyapi_887_ | _heyapi_422_ | _heyapi_423_ | _heyapi_424_ | _heyapi_425_ | _heyapi_426_>;
|
|
34508
34583
|
/**
|
|
34509
34584
|
* The next available progress invoice number
|
|
34510
34585
|
*/
|
|
@@ -34640,7 +34715,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
34640
34715
|
/**
|
|
34641
34716
|
* List of bank accounts
|
|
34642
34717
|
*/
|
|
34643
|
-
'bank-accounts'?: Array<
|
|
34718
|
+
'bank-accounts'?: Array<_heyapi_889_>;
|
|
34644
34719
|
/**
|
|
34645
34720
|
* List of VAT modes
|
|
34646
34721
|
*/
|
|
@@ -34691,11 +34766,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
34691
34766
|
/**
|
|
34692
34767
|
* List of document layouts
|
|
34693
34768
|
*/
|
|
34694
|
-
document_layouts?: Array<
|
|
34769
|
+
document_layouts?: Array<_heyapi_751_>;
|
|
34695
34770
|
/**
|
|
34696
34771
|
* List of languages
|
|
34697
34772
|
*/
|
|
34698
|
-
languages?: Array<
|
|
34773
|
+
languages?: Array<_heyapi_752_>;
|
|
34699
34774
|
/**
|
|
34700
34775
|
* Tax with embed
|
|
34701
34776
|
*
|
|
@@ -34875,11 +34950,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
34875
34950
|
/**
|
|
34876
34951
|
* List of payment terms
|
|
34877
34952
|
*/
|
|
34878
|
-
payment_terms?: Array<
|
|
34953
|
+
payment_terms?: Array<_heyapi_890_>;
|
|
34879
34954
|
/**
|
|
34880
34955
|
* List assigned staff labels
|
|
34881
34956
|
*/
|
|
34882
|
-
assigned_staff_labels?: Array<
|
|
34957
|
+
assigned_staff_labels?: Array<_heyapi_891_>;
|
|
34883
34958
|
/**
|
|
34884
34959
|
* Computed progress invoice
|
|
34885
34960
|
*/
|
|
@@ -35048,6 +35123,10 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
35048
35123
|
* Tax amount
|
|
35049
35124
|
*/
|
|
35050
35125
|
amount?: string;
|
|
35126
|
+
/**
|
|
35127
|
+
* Tax category code (EN 16931), e.g. K for intra-community VAT. Null when the tax has no category.
|
|
35128
|
+
*/
|
|
35129
|
+
category?: string | null;
|
|
35051
35130
|
}>;
|
|
35052
35131
|
deposits?: Array<{
|
|
35053
35132
|
/**
|
|
@@ -35074,11 +35153,11 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
35074
35153
|
/**
|
|
35075
35154
|
* Summary of all document history (includes current document)
|
|
35076
35155
|
*/
|
|
35077
|
-
summary?: Array<
|
|
35156
|
+
summary?: Array<_heyapi_763_ & {
|
|
35078
35157
|
/**
|
|
35079
35158
|
* Credit notes linked to the invoice
|
|
35080
35159
|
*/
|
|
35081
|
-
credit_notes?: Array<
|
|
35160
|
+
credit_notes?: Array<_heyapi_763_>;
|
|
35082
35161
|
}>;
|
|
35083
35162
|
};
|
|
35084
35163
|
/**
|
|
@@ -35221,7 +35300,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
35221
35300
|
/**
|
|
35222
35301
|
* List of packagings
|
|
35223
35302
|
*/
|
|
35224
|
-
packagings?: Array<
|
|
35303
|
+
packagings?: Array<_heyapi_892_>;
|
|
35225
35304
|
/**
|
|
35226
35305
|
* List of civilities
|
|
35227
35306
|
*/
|
|
@@ -35243,7 +35322,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
35243
35322
|
* Compliance state of the parent document on creation, or of the edited document on update
|
|
35244
35323
|
*/
|
|
35245
35324
|
is_document_compliant?: boolean;
|
|
35246
|
-
company_einvoicing?:
|
|
35325
|
+
company_einvoicing?: _heyapi_893_;
|
|
35247
35326
|
/**
|
|
35248
35327
|
* E-invoicing routing address identifier (document value if set, otherwise third default)
|
|
35249
35328
|
*/
|
|
@@ -35253,7 +35332,7 @@ type ProgressInvoiceMetadataWritable = {
|
|
|
35253
35332
|
* Update Progress Invoice
|
|
35254
35333
|
*/
|
|
35255
35334
|
type ProgressInvoiceUpdateWritable = {
|
|
35256
|
-
rows?: Array<
|
|
35335
|
+
rows?: Array<_heyapi_758_ | _heyapi_759_ | _heyapi_760_ | _heyapi_422_ | _heyapi_423_ | _heyapi_424_ | _heyapi_425_ | _heyapi_426_ | _heyapi_895_ | _heyapi_896_ | _heyapi_761_ | _heyapi_464_ | _heyapi_465_ | _heyapi_466_ | {
|
|
35257
35336
|
/**
|
|
35258
35337
|
* Row Identifier
|
|
35259
35338
|
*/
|
|
@@ -35268,7 +35347,7 @@ type ProgressInvoiceUpdateWritable = {
|
|
|
35268
35347
|
* Date of the invoice
|
|
35269
35348
|
*/
|
|
35270
35349
|
date?: string;
|
|
35271
|
-
validate?:
|
|
35350
|
+
validate?: _heyapi_897_;
|
|
35272
35351
|
/**
|
|
35273
35352
|
* Subject of the invoice
|
|
35274
35353
|
*/
|
|
@@ -35371,8 +35450,8 @@ type ProgressInvoiceUpdateWritable = {
|
|
|
35371
35450
|
*/
|
|
35372
35451
|
shipping_volume?: string;
|
|
35373
35452
|
shipping_weight?: _heyapi_460_;
|
|
35374
|
-
payment_terms?:
|
|
35375
|
-
settings?:
|
|
35453
|
+
payment_terms?: _heyapi_727_;
|
|
35454
|
+
settings?: _heyapi_898_;
|
|
35376
35455
|
/**
|
|
35377
35456
|
* Analytic code of document
|
|
35378
35457
|
*/
|
|
@@ -35421,7 +35500,7 @@ type ProposalModelWritable = {
|
|
|
35421
35500
|
/**
|
|
35422
35501
|
* Proposal document
|
|
35423
35502
|
*/
|
|
35424
|
-
type ProposalDocumentWritable =
|
|
35503
|
+
type ProposalDocumentWritable = _heyapi_906_ & {
|
|
35425
35504
|
/**
|
|
35426
35505
|
* Proposal document link
|
|
35427
35506
|
*/
|
|
@@ -35448,7 +35527,7 @@ type ProposalDocumentWritable = _heyapi_901_ & {
|
|
|
35448
35527
|
type?: 'contact' | 'company' | 'individual' | 'opportunity' | 'document' | 'item' | 'rental' | 'ticket';
|
|
35449
35528
|
}>;
|
|
35450
35529
|
_embed?: {
|
|
35451
|
-
file?:
|
|
35530
|
+
file?: _heyapi_636_;
|
|
35452
35531
|
};
|
|
35453
35532
|
};
|
|
35454
35533
|
type EInvoicingMandateInputWritable = {
|
|
@@ -35701,12 +35780,12 @@ type CrmActivityEmbed = Array<'aggregations' | 'aggregations.by_event' | 'aggreg
|
|
|
35701
35780
|
* 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 />
|
|
35702
35781
|
*
|
|
35703
35782
|
*/
|
|
35704
|
-
type OpportunityEmbed = Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
35783
|
+
type OpportunityEmbed = Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_1039_>;
|
|
35705
35784
|
/**
|
|
35706
35785
|
* 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 />
|
|
35707
35786
|
*
|
|
35708
35787
|
*/
|
|
35709
|
-
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' |
|
|
35788
|
+
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_1039_>;
|
|
35710
35789
|
/**
|
|
35711
35790
|
* The order field
|
|
35712
35791
|
*/
|
|
@@ -35789,12 +35868,12 @@ type FavouriteFiltersOrder = (typeof FavouriteFiltersOrder)[keyof typeof Favouri
|
|
|
35789
35868
|
* 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>
|
|
35790
35869
|
*
|
|
35791
35870
|
*/
|
|
35792
|
-
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' |
|
|
35871
|
+
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_1039_>;
|
|
35793
35872
|
/**
|
|
35794
35873
|
* 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>
|
|
35795
35874
|
*
|
|
35796
35875
|
*/
|
|
35797
|
-
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' |
|
|
35876
|
+
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_1039_>;
|
|
35798
35877
|
/**
|
|
35799
35878
|
* The order field
|
|
35800
35879
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -35851,7 +35930,7 @@ type Autocomplete = string;
|
|
|
35851
35930
|
* - `ex with both: type[]=company&type[]=item.product`
|
|
35852
35931
|
*
|
|
35853
35932
|
*/
|
|
35854
|
-
type SearchType = Array<'company' | 'company.client' | 'company.prospect' | 'company.supplier' | 'individual' | 'individual.client' | 'individual.prospect' | 'individual.supplier' | 'contact' | 'opportunity' | 'purchase' | 'purchase.purInvoice' | 'purchase.purDelivery' | 'purchase.purOrder' | 'purchase.purCreditNote' | 'item' | 'item.product' | 'item.packaging' | 'item.shipping' | 'item.service' | 'declination' | 'declination.product' | 'declination.declination' | 'document' | 'document.estimate' | 'document.invoice' | 'document.delivery' | 'document.order' | 'document.proforma' | 'document.creditnote' | 'staff' | 'ticket' | 'redactor' | 'redactor.document' | 'redactor.template'>;
|
|
35933
|
+
type SearchType = Array<'company' | 'company.client' | 'company.prospect' | 'company.supplier' | 'individual' | 'individual.client' | 'individual.prospect' | 'individual.supplier' | 'contact' | 'opportunity' | 'purchase' | 'purchase.purInvoice' | 'purchase.purDelivery' | 'purchase.purOrder' | 'purchase.purCreditNote' | 'item' | 'item.product' | 'item.packaging' | 'item.shipping' | 'item.service' | 'declination' | 'declination.product' | 'declination.declination' | 'document' | 'document.estimate' | 'document.invoice' | 'document.delivery' | 'document.order' | 'document.proforma' | 'document.creditnote' | 'document.model' | 'staff' | 'ticket' | 'redactor' | 'redactor.document' | 'redactor.template'>;
|
|
35855
35934
|
/**
|
|
35856
35935
|
* The order field
|
|
35857
35936
|
*/
|
|
@@ -36078,11 +36157,11 @@ type CorporationStaffEmbed = Array<'predicted_licenses' | 'aggregations.count_li
|
|
|
36078
36157
|
/**
|
|
36079
36158
|
* Additional object included in the result
|
|
36080
36159
|
*/
|
|
36081
|
-
type InvoiceEmbed = Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
36160
|
+
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_1039_>;
|
|
36082
36161
|
/**
|
|
36083
36162
|
* Additional object included in the result
|
|
36084
36163
|
*/
|
|
36085
|
-
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' |
|
|
36164
|
+
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_1039_>;
|
|
36086
36165
|
/**
|
|
36087
36166
|
* Order field
|
|
36088
36167
|
*/
|
|
@@ -36101,11 +36180,11 @@ type InvoiceOrder = (typeof InvoiceOrder)[keyof typeof InvoiceOrder];
|
|
|
36101
36180
|
/**
|
|
36102
36181
|
* Additional object included in the result
|
|
36103
36182
|
*/
|
|
36104
|
-
type CreditNoteEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' |
|
|
36183
|
+
type CreditNoteEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | _heyapi_1039_>;
|
|
36105
36184
|
/**
|
|
36106
36185
|
* Additional object included in the result
|
|
36107
36186
|
*/
|
|
36108
|
-
type CreditNoteOneEmbed = Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
36187
|
+
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_1039_>;
|
|
36109
36188
|
/**
|
|
36110
36189
|
* Order field
|
|
36111
36190
|
*/
|
|
@@ -36151,11 +36230,11 @@ type ImportType = (typeof ImportType)[keyof typeof ImportType];
|
|
|
36151
36230
|
/**
|
|
36152
36231
|
* Additional object included in the result
|
|
36153
36232
|
*/
|
|
36154
|
-
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' |
|
|
36233
|
+
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_1039_>;
|
|
36155
36234
|
/**
|
|
36156
36235
|
* Additional object included in the result
|
|
36157
36236
|
*/
|
|
36158
|
-
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' |
|
|
36237
|
+
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_1039_>;
|
|
36159
36238
|
/**
|
|
36160
36239
|
* Order field
|
|
36161
36240
|
*/
|
|
@@ -36175,11 +36254,11 @@ type OrderOrder = (typeof OrderOrder)[keyof typeof OrderOrder];
|
|
|
36175
36254
|
/**
|
|
36176
36255
|
* Additional object included in the result
|
|
36177
36256
|
*/
|
|
36178
|
-
type DeliveryEmbed = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' |
|
|
36257
|
+
type DeliveryEmbed = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | _heyapi_1039_>;
|
|
36179
36258
|
/**
|
|
36180
36259
|
* Additional object included in the result
|
|
36181
36260
|
*/
|
|
36182
|
-
type DeliveryEmbedOne = Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
36261
|
+
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_1039_>;
|
|
36183
36262
|
/**
|
|
36184
36263
|
* Order field
|
|
36185
36264
|
*/
|
|
@@ -36538,7 +36617,7 @@ type GetCompaniesResponses = {
|
|
|
36538
36617
|
/**
|
|
36539
36618
|
* E-invoicing routing addresses listed for the company in the French e-invoicing directory. Null when no routing address is available.
|
|
36540
36619
|
*/
|
|
36541
|
-
einvoicing_electronic_addresses?: Array<
|
|
36620
|
+
einvoicing_electronic_addresses?: Array<_heyapi_1130_> | null;
|
|
36542
36621
|
} | null;
|
|
36543
36622
|
/**
|
|
36544
36623
|
* Main contact
|
|
@@ -36575,7 +36654,7 @@ type GetCompaniesResponses = {
|
|
|
36575
36654
|
/**
|
|
36576
36655
|
* Company acl
|
|
36577
36656
|
*/
|
|
36578
|
-
acl?:
|
|
36657
|
+
acl?: _heyapi_1131_ | null;
|
|
36579
36658
|
/**
|
|
36580
36659
|
* Smart-tags linked
|
|
36581
36660
|
*/
|
|
@@ -36761,7 +36840,7 @@ type CreateCompanyResponses = {
|
|
|
36761
36840
|
/**
|
|
36762
36841
|
* E-invoicing routing addresses listed for the company in the French e-invoicing directory. Null when no routing address is available.
|
|
36763
36842
|
*/
|
|
36764
|
-
einvoicing_electronic_addresses?: Array<
|
|
36843
|
+
einvoicing_electronic_addresses?: Array<_heyapi_1130_> | null;
|
|
36765
36844
|
} | null;
|
|
36766
36845
|
/**
|
|
36767
36846
|
* Main contact
|
|
@@ -36798,7 +36877,7 @@ type CreateCompanyResponses = {
|
|
|
36798
36877
|
/**
|
|
36799
36878
|
* Company acl
|
|
36800
36879
|
*/
|
|
36801
|
-
acl?:
|
|
36880
|
+
acl?: _heyapi_1131_ | null;
|
|
36802
36881
|
/**
|
|
36803
36882
|
* Smart-tags linked
|
|
36804
36883
|
*/
|
|
@@ -36982,7 +37061,7 @@ type SearchCompaniesResponses = {
|
|
|
36982
37061
|
/**
|
|
36983
37062
|
* E-invoicing routing addresses listed for the company in the French e-invoicing directory. Null when no routing address is available.
|
|
36984
37063
|
*/
|
|
36985
|
-
einvoicing_electronic_addresses?: Array<
|
|
37064
|
+
einvoicing_electronic_addresses?: Array<_heyapi_1130_> | null;
|
|
36986
37065
|
} | null;
|
|
36987
37066
|
/**
|
|
36988
37067
|
* Main contact
|
|
@@ -37019,7 +37098,7 @@ type SearchCompaniesResponses = {
|
|
|
37019
37098
|
/**
|
|
37020
37099
|
* Company acl
|
|
37021
37100
|
*/
|
|
37022
|
-
acl?:
|
|
37101
|
+
acl?: _heyapi_1131_ | null;
|
|
37023
37102
|
/**
|
|
37024
37103
|
* Smart-tags linked
|
|
37025
37104
|
*/
|
|
@@ -37290,7 +37369,7 @@ type GetCompanyResponses = {
|
|
|
37290
37369
|
/**
|
|
37291
37370
|
* E-invoicing routing addresses listed for the company in the French e-invoicing directory. Null when no routing address is available.
|
|
37292
37371
|
*/
|
|
37293
|
-
einvoicing_electronic_addresses?: Array<
|
|
37372
|
+
einvoicing_electronic_addresses?: Array<_heyapi_1130_> | null;
|
|
37294
37373
|
} | null;
|
|
37295
37374
|
/**
|
|
37296
37375
|
* Main contact
|
|
@@ -37327,7 +37406,7 @@ type GetCompanyResponses = {
|
|
|
37327
37406
|
/**
|
|
37328
37407
|
* Company acl
|
|
37329
37408
|
*/
|
|
37330
|
-
acl?:
|
|
37409
|
+
acl?: _heyapi_1131_ | null;
|
|
37331
37410
|
/**
|
|
37332
37411
|
* Smart-tags linked
|
|
37333
37412
|
*/
|
|
@@ -37512,7 +37591,7 @@ type UpdateCompanyResponses = {
|
|
|
37512
37591
|
/**
|
|
37513
37592
|
* E-invoicing routing addresses listed for the company in the French e-invoicing directory. Null when no routing address is available.
|
|
37514
37593
|
*/
|
|
37515
|
-
einvoicing_electronic_addresses?: Array<
|
|
37594
|
+
einvoicing_electronic_addresses?: Array<_heyapi_1130_> | null;
|
|
37516
37595
|
} | null;
|
|
37517
37596
|
/**
|
|
37518
37597
|
* Main contact
|
|
@@ -37549,7 +37628,7 @@ type UpdateCompanyResponses = {
|
|
|
37549
37628
|
/**
|
|
37550
37629
|
* Company acl
|
|
37551
37630
|
*/
|
|
37552
|
-
acl?:
|
|
37631
|
+
acl?: _heyapi_1131_ | null;
|
|
37553
37632
|
/**
|
|
37554
37633
|
* Smart-tags linked
|
|
37555
37634
|
*/
|
|
@@ -38863,7 +38942,7 @@ type GetContactCompaniesResponses = {
|
|
|
38863
38942
|
/**
|
|
38864
38943
|
* E-invoicing routing addresses listed for the company in the French e-invoicing directory. Null when no routing address is available.
|
|
38865
38944
|
*/
|
|
38866
|
-
einvoicing_electronic_addresses?: Array<
|
|
38945
|
+
einvoicing_electronic_addresses?: Array<_heyapi_1130_> | null;
|
|
38867
38946
|
} | null;
|
|
38868
38947
|
/**
|
|
38869
38948
|
* Main contact
|
|
@@ -38900,7 +38979,7 @@ type GetContactCompaniesResponses = {
|
|
|
38900
38979
|
/**
|
|
38901
38980
|
* Company acl
|
|
38902
38981
|
*/
|
|
38903
|
-
acl?:
|
|
38982
|
+
acl?: _heyapi_1131_ | null;
|
|
38904
38983
|
/**
|
|
38905
38984
|
* Smart-tags linked
|
|
38906
38985
|
*/
|
|
@@ -40687,7 +40766,7 @@ type GetEstimatesData = {
|
|
|
40687
40766
|
* 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>
|
|
40688
40767
|
*
|
|
40689
40768
|
*/
|
|
40690
|
-
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' |
|
|
40769
|
+
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_1039_>;
|
|
40691
40770
|
/**
|
|
40692
40771
|
* The order field
|
|
40693
40772
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -40711,7 +40790,7 @@ type CreateEstimateData = {
|
|
|
40711
40790
|
* 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>
|
|
40712
40791
|
*
|
|
40713
40792
|
*/
|
|
40714
|
-
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' |
|
|
40793
|
+
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_1039_>;
|
|
40715
40794
|
/**
|
|
40716
40795
|
* 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>
|
|
40717
40796
|
*
|
|
@@ -40752,7 +40831,7 @@ type SearchEstimatesData = {
|
|
|
40752
40831
|
* 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>
|
|
40753
40832
|
*
|
|
40754
40833
|
*/
|
|
40755
|
-
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' |
|
|
40834
|
+
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_1039_>;
|
|
40756
40835
|
/**
|
|
40757
40836
|
* The order field
|
|
40758
40837
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -40809,7 +40888,7 @@ type ExportEstimatesData = {
|
|
|
40809
40888
|
* 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>
|
|
40810
40889
|
*
|
|
40811
40890
|
*/
|
|
40812
|
-
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' |
|
|
40891
|
+
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_1039_>;
|
|
40813
40892
|
/**
|
|
40814
40893
|
* The order field
|
|
40815
40894
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
@@ -41710,7 +41789,7 @@ type GetEstimateData = {
|
|
|
41710
41789
|
* 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>
|
|
41711
41790
|
*
|
|
41712
41791
|
*/
|
|
41713
|
-
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' |
|
|
41792
|
+
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_1039_>;
|
|
41714
41793
|
};
|
|
41715
41794
|
url: '/estimates/{id}';
|
|
41716
41795
|
};
|
|
@@ -41745,7 +41824,7 @@ type UpdateEstimateData = {
|
|
|
41745
41824
|
* 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>
|
|
41746
41825
|
*
|
|
41747
41826
|
*/
|
|
41748
|
-
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' |
|
|
41827
|
+
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_1039_>;
|
|
41749
41828
|
};
|
|
41750
41829
|
url: '/estimates/{id}';
|
|
41751
41830
|
};
|
|
@@ -41774,7 +41853,7 @@ type UpdateEstimateStatusData = {
|
|
|
41774
41853
|
* 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>
|
|
41775
41854
|
*
|
|
41776
41855
|
*/
|
|
41777
|
-
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' |
|
|
41856
|
+
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_1039_>;
|
|
41778
41857
|
};
|
|
41779
41858
|
url: '/estimates/{id}/status';
|
|
41780
41859
|
};
|
|
@@ -42321,7 +42400,7 @@ type GetOrdersData = {
|
|
|
42321
42400
|
/**
|
|
42322
42401
|
* Additional object included in the result
|
|
42323
42402
|
*/
|
|
42324
|
-
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' |
|
|
42403
|
+
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_1039_>;
|
|
42325
42404
|
/**
|
|
42326
42405
|
* Order field
|
|
42327
42406
|
*/
|
|
@@ -42351,7 +42430,7 @@ type CreateOrderData = {
|
|
|
42351
42430
|
/**
|
|
42352
42431
|
* Additional object included in the result
|
|
42353
42432
|
*/
|
|
42354
|
-
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' |
|
|
42433
|
+
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_1039_>;
|
|
42355
42434
|
};
|
|
42356
42435
|
url: '/orders';
|
|
42357
42436
|
};
|
|
@@ -42387,7 +42466,7 @@ type GetOrderData = {
|
|
|
42387
42466
|
/**
|
|
42388
42467
|
* Additional object included in the result
|
|
42389
42468
|
*/
|
|
42390
|
-
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' |
|
|
42469
|
+
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_1039_>;
|
|
42391
42470
|
};
|
|
42392
42471
|
url: '/orders/{id}';
|
|
42393
42472
|
};
|
|
@@ -42410,7 +42489,7 @@ type UpdateOrderData = {
|
|
|
42410
42489
|
/**
|
|
42411
42490
|
* Additional object included in the result
|
|
42412
42491
|
*/
|
|
42413
|
-
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' |
|
|
42492
|
+
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_1039_>;
|
|
42414
42493
|
};
|
|
42415
42494
|
url: '/orders/{id}';
|
|
42416
42495
|
};
|
|
@@ -42445,7 +42524,7 @@ type SearchOrdersData = {
|
|
|
42445
42524
|
/**
|
|
42446
42525
|
* Additional object included in the result
|
|
42447
42526
|
*/
|
|
42448
|
-
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' |
|
|
42527
|
+
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_1039_>;
|
|
42449
42528
|
/**
|
|
42450
42529
|
* Order field
|
|
42451
42530
|
*/
|
|
@@ -43853,7 +43932,7 @@ type GetDeliveriesData = {
|
|
|
43853
43932
|
/**
|
|
43854
43933
|
* Additional object included in the result
|
|
43855
43934
|
*/
|
|
43856
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' |
|
|
43935
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | _heyapi_1039_>;
|
|
43857
43936
|
/**
|
|
43858
43937
|
* Order field
|
|
43859
43938
|
*/
|
|
@@ -43895,7 +43974,7 @@ type SearchDeliveriesData = {
|
|
|
43895
43974
|
/**
|
|
43896
43975
|
* Additional object included in the result
|
|
43897
43976
|
*/
|
|
43898
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' |
|
|
43977
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | _heyapi_1039_>;
|
|
43899
43978
|
/**
|
|
43900
43979
|
* Order field
|
|
43901
43980
|
*/
|
|
@@ -43925,7 +44004,7 @@ type GetDeliveryData = {
|
|
|
43925
44004
|
/**
|
|
43926
44005
|
* Additional object included in the result
|
|
43927
44006
|
*/
|
|
43928
|
-
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' |
|
|
44007
|
+
embed?: Array<'acl' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'owner' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'settings' | 'assigned_staff' | 'file' | _heyapi_1039_>;
|
|
43929
44008
|
};
|
|
43930
44009
|
url: '/deliveries/{id}';
|
|
43931
44010
|
};
|
|
@@ -43948,7 +44027,7 @@ type GetIndividualsData = {
|
|
|
43948
44027
|
* 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 />
|
|
43949
44028
|
*
|
|
43950
44029
|
*/
|
|
43951
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
44030
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_1039_>;
|
|
43952
44031
|
/**
|
|
43953
44032
|
* The order direction
|
|
43954
44033
|
*/
|
|
@@ -44026,7 +44105,7 @@ type GetIndividualsResponses = {
|
|
|
44026
44105
|
/**
|
|
44027
44106
|
* Individual acl
|
|
44028
44107
|
*/
|
|
44029
|
-
acl?:
|
|
44108
|
+
acl?: _heyapi_1381_ | null;
|
|
44030
44109
|
/**
|
|
44031
44110
|
* Smart-tags linked
|
|
44032
44111
|
*/
|
|
@@ -44139,7 +44218,7 @@ type CreateIndividualData = {
|
|
|
44139
44218
|
* 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 />
|
|
44140
44219
|
*
|
|
44141
44220
|
*/
|
|
44142
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
44221
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_1039_>;
|
|
44143
44222
|
/**
|
|
44144
44223
|
* 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>
|
|
44145
44224
|
*
|
|
@@ -44206,7 +44285,7 @@ type CreateIndividualResponses = {
|
|
|
44206
44285
|
/**
|
|
44207
44286
|
* Individual acl
|
|
44208
44287
|
*/
|
|
44209
|
-
acl?:
|
|
44288
|
+
acl?: _heyapi_1381_ | null;
|
|
44210
44289
|
/**
|
|
44211
44290
|
* Smart-tags linked
|
|
44212
44291
|
*/
|
|
@@ -44310,7 +44389,7 @@ type SearchIndividualsData = {
|
|
|
44310
44389
|
* 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 />
|
|
44311
44390
|
*
|
|
44312
44391
|
*/
|
|
44313
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
44392
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_1039_>;
|
|
44314
44393
|
/**
|
|
44315
44394
|
* The order direction
|
|
44316
44395
|
*/
|
|
@@ -44385,7 +44464,7 @@ type SearchIndividualsResponses = {
|
|
|
44385
44464
|
/**
|
|
44386
44465
|
* Individual acl
|
|
44387
44466
|
*/
|
|
44388
|
-
acl?:
|
|
44467
|
+
acl?: _heyapi_1381_ | null;
|
|
44389
44468
|
/**
|
|
44390
44469
|
* Smart-tags linked
|
|
44391
44470
|
*/
|
|
@@ -44585,7 +44664,7 @@ type GetIndividualData = {
|
|
|
44585
44664
|
* 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 />
|
|
44586
44665
|
*
|
|
44587
44666
|
*/
|
|
44588
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
44667
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_1039_>;
|
|
44589
44668
|
/**
|
|
44590
44669
|
* 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>
|
|
44591
44670
|
*
|
|
@@ -44648,7 +44727,7 @@ type GetIndividualResponses = {
|
|
|
44648
44727
|
/**
|
|
44649
44728
|
* Individual acl
|
|
44650
44729
|
*/
|
|
44651
|
-
acl?:
|
|
44730
|
+
acl?: _heyapi_1381_ | null;
|
|
44652
44731
|
/**
|
|
44653
44732
|
* Smart-tags linked
|
|
44654
44733
|
*/
|
|
@@ -44760,7 +44839,7 @@ type UpdateIndividualData = {
|
|
|
44760
44839
|
* 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 />
|
|
44761
44840
|
*
|
|
44762
44841
|
*/
|
|
44763
|
-
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' |
|
|
44842
|
+
embed?: Array<'invoicing_address' | 'delivery_address' | 'main_contact' | 'dunning_contact' | 'invoicing_contact' | 'opportunities' | 'estimates' | 'invoices' | 'orders' | 'deliveries' | 'acl' | 'smart_tags' | 'owner' | _heyapi_1039_>;
|
|
44764
44843
|
/**
|
|
44765
44844
|
* 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>
|
|
44766
44845
|
*
|
|
@@ -44827,7 +44906,7 @@ type UpdateIndividualResponses = {
|
|
|
44827
44906
|
/**
|
|
44828
44907
|
* Individual acl
|
|
44829
44908
|
*/
|
|
44830
|
-
acl?:
|
|
44909
|
+
acl?: _heyapi_1381_ | null;
|
|
44831
44910
|
/**
|
|
44832
44911
|
* Smart-tags linked
|
|
44833
44912
|
*/
|
|
@@ -46934,7 +47013,7 @@ type GetTaxesResponses = {
|
|
|
46934
47013
|
/**
|
|
46935
47014
|
* Tax with embed
|
|
46936
47015
|
*/
|
|
46937
|
-
data: Array<
|
|
47016
|
+
data: Array<_heyapi_823_ & {
|
|
46938
47017
|
/**
|
|
46939
47018
|
* Optional objects added through the embed parameter
|
|
46940
47019
|
*/
|
|
@@ -47173,7 +47252,7 @@ type CreateTaxResponses = {
|
|
|
47173
47252
|
*
|
|
47174
47253
|
* Tax created
|
|
47175
47254
|
*/
|
|
47176
|
-
201:
|
|
47255
|
+
201: _heyapi_823_ & {
|
|
47177
47256
|
/**
|
|
47178
47257
|
* Optional objects added through the embed parameter
|
|
47179
47258
|
*/
|
|
@@ -47280,7 +47359,7 @@ type SearchTaxesResponses = {
|
|
|
47280
47359
|
*/
|
|
47281
47360
|
200: {
|
|
47282
47361
|
pagination: Pagination;
|
|
47283
|
-
data: Array<
|
|
47362
|
+
data: Array<_heyapi_823_ & {
|
|
47284
47363
|
/**
|
|
47285
47364
|
* Optional objects added through the embed parameter
|
|
47286
47365
|
*/
|
|
@@ -47401,7 +47480,7 @@ type GetTaxResponses = {
|
|
|
47401
47480
|
*
|
|
47402
47481
|
* Tax fetched
|
|
47403
47482
|
*/
|
|
47404
|
-
200:
|
|
47483
|
+
200: _heyapi_823_ & {
|
|
47405
47484
|
/**
|
|
47406
47485
|
* Optional objects added through the embed parameter
|
|
47407
47486
|
*/
|
|
@@ -47650,7 +47729,7 @@ type UpdateTaxResponses = {
|
|
|
47650
47729
|
*
|
|
47651
47730
|
* Tax updated
|
|
47652
47731
|
*/
|
|
47653
|
-
200:
|
|
47732
|
+
200: _heyapi_823_ & {
|
|
47654
47733
|
/**
|
|
47655
47734
|
* Optional objects added through the embed parameter
|
|
47656
47735
|
*/
|
|
@@ -50832,7 +50911,7 @@ type GetOpportunityData = {
|
|
|
50832
50911
|
* 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 />
|
|
50833
50912
|
*
|
|
50834
50913
|
*/
|
|
50835
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
50914
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_1039_>;
|
|
50836
50915
|
/**
|
|
50837
50916
|
* 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>
|
|
50838
50917
|
*
|
|
@@ -50867,7 +50946,7 @@ type PatchOpportunityData = {
|
|
|
50867
50946
|
* 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 />
|
|
50868
50947
|
*
|
|
50869
50948
|
*/
|
|
50870
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
50949
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_1039_>;
|
|
50871
50950
|
/**
|
|
50872
50951
|
* 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>
|
|
50873
50952
|
*
|
|
@@ -50904,7 +50983,7 @@ type UpdateOpportunityData = {
|
|
|
50904
50983
|
* 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 />
|
|
50905
50984
|
*
|
|
50906
50985
|
*/
|
|
50907
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
50986
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_1039_>;
|
|
50908
50987
|
/**
|
|
50909
50988
|
* 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>
|
|
50910
50989
|
*
|
|
@@ -50966,7 +51045,7 @@ type GetOpportunitiesData = {
|
|
|
50966
51045
|
* 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 />
|
|
50967
51046
|
*
|
|
50968
51047
|
*/
|
|
50969
|
-
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' |
|
|
51048
|
+
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_1039_>;
|
|
50970
51049
|
/**
|
|
50971
51050
|
* 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>
|
|
50972
51051
|
*
|
|
@@ -50998,7 +51077,7 @@ type CreateOpportunityData = {
|
|
|
50998
51077
|
* 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 />
|
|
50999
51078
|
*
|
|
51000
51079
|
*/
|
|
51001
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
51080
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_1039_>;
|
|
51002
51081
|
/**
|
|
51003
51082
|
* 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>
|
|
51004
51083
|
*
|
|
@@ -51085,7 +51164,7 @@ type SearchOpportunitiesData = {
|
|
|
51085
51164
|
* 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 />
|
|
51086
51165
|
*
|
|
51087
51166
|
*/
|
|
51088
|
-
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' |
|
|
51167
|
+
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_1039_>;
|
|
51089
51168
|
/**
|
|
51090
51169
|
* 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>
|
|
51091
51170
|
*
|
|
@@ -51142,7 +51221,7 @@ type ExportOpportunitiesData = {
|
|
|
51142
51221
|
* 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 />
|
|
51143
51222
|
*
|
|
51144
51223
|
*/
|
|
51145
|
-
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' |
|
|
51224
|
+
embed?: Array<'estimates' | 'individual' | 'invoices' | 'orders' | 'deliveries' | 'proformas' | 'creditnotes' | 'assigned_staffs' | 'company' | 'contacts' | 'acl' | 'currency' | 'smart_tags' | _heyapi_1039_>;
|
|
51146
51225
|
};
|
|
51147
51226
|
url: '/opportunities/export';
|
|
51148
51227
|
};
|
|
@@ -55191,7 +55270,7 @@ type SearchData = {
|
|
|
55191
55270
|
* - `ex with both: type[]=company&type[]=item.product`
|
|
55192
55271
|
*
|
|
55193
55272
|
*/
|
|
55194
|
-
type?: Array<'company' | 'company.client' | 'company.prospect' | 'company.supplier' | 'individual' | 'individual.client' | 'individual.prospect' | 'individual.supplier' | 'contact' | 'opportunity' | 'purchase' | 'purchase.purInvoice' | 'purchase.purDelivery' | 'purchase.purOrder' | 'purchase.purCreditNote' | 'item' | 'item.product' | 'item.packaging' | 'item.shipping' | 'item.service' | 'declination' | 'declination.product' | 'declination.declination' | 'document' | 'document.estimate' | 'document.invoice' | 'document.delivery' | 'document.order' | 'document.proforma' | 'document.creditnote' | 'staff' | 'ticket' | 'redactor' | 'redactor.document' | 'redactor.template'>;
|
|
55273
|
+
type?: Array<'company' | 'company.client' | 'company.prospect' | 'company.supplier' | 'individual' | 'individual.client' | 'individual.prospect' | 'individual.supplier' | 'contact' | 'opportunity' | 'purchase' | 'purchase.purInvoice' | 'purchase.purDelivery' | 'purchase.purOrder' | 'purchase.purCreditNote' | 'item' | 'item.product' | 'item.packaging' | 'item.shipping' | 'item.service' | 'declination' | 'declination.product' | 'declination.declination' | 'document' | 'document.estimate' | 'document.invoice' | 'document.delivery' | 'document.order' | 'document.proforma' | 'document.creditnote' | 'document.model' | 'staff' | 'ticket' | 'redactor' | 'redactor.document' | 'redactor.template'>;
|
|
55195
55274
|
/**
|
|
55196
55275
|
* Pagination limit
|
|
55197
55276
|
*/
|
|
@@ -56812,7 +56891,7 @@ type GetInvoiceData = {
|
|
|
56812
56891
|
/**
|
|
56813
56892
|
* Additional object included in the result
|
|
56814
56893
|
*/
|
|
56815
|
-
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' |
|
|
56894
|
+
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_1039_>;
|
|
56816
56895
|
};
|
|
56817
56896
|
url: '/invoices/{id}';
|
|
56818
56897
|
};
|
|
@@ -56835,7 +56914,7 @@ type UpdateInvoiceData = {
|
|
|
56835
56914
|
/**
|
|
56836
56915
|
* Additional object included in the result
|
|
56837
56916
|
*/
|
|
56838
|
-
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' |
|
|
56917
|
+
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_1039_>;
|
|
56839
56918
|
};
|
|
56840
56919
|
url: '/invoices/{id}';
|
|
56841
56920
|
};
|
|
@@ -56870,7 +56949,7 @@ type GetInvoicesData = {
|
|
|
56870
56949
|
/**
|
|
56871
56950
|
* Additional object included in the result
|
|
56872
56951
|
*/
|
|
56873
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
56952
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_1039_>;
|
|
56874
56953
|
/**
|
|
56875
56954
|
* Order field
|
|
56876
56955
|
*/
|
|
@@ -56895,7 +56974,7 @@ type CreateInvoiceData = {
|
|
|
56895
56974
|
/**
|
|
56896
56975
|
* Additional object included in the result
|
|
56897
56976
|
*/
|
|
56898
|
-
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' |
|
|
56977
|
+
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_1039_>;
|
|
56899
56978
|
/**
|
|
56900
56979
|
* 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>
|
|
56901
56980
|
*
|
|
@@ -56935,7 +57014,7 @@ type SearchInvoicesData = {
|
|
|
56935
57014
|
/**
|
|
56936
57015
|
* Additional object included in the result
|
|
56937
57016
|
*/
|
|
56938
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
57017
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_1039_>;
|
|
56939
57018
|
/**
|
|
56940
57019
|
* Order field
|
|
56941
57020
|
*/
|
|
@@ -56985,7 +57064,7 @@ type ExportInvoicesData = {
|
|
|
56985
57064
|
/**
|
|
56986
57065
|
* Additional object included in the result
|
|
56987
57066
|
*/
|
|
56988
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
57067
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_1039_>;
|
|
56989
57068
|
/**
|
|
56990
57069
|
* Order field
|
|
56991
57070
|
*/
|
|
@@ -58316,7 +58395,7 @@ type GetCreditNoteData = {
|
|
|
58316
58395
|
/**
|
|
58317
58396
|
* Additional object included in the result
|
|
58318
58397
|
*/
|
|
58319
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
58398
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_1039_>;
|
|
58320
58399
|
};
|
|
58321
58400
|
url: '/credit-notes/{id}';
|
|
58322
58401
|
};
|
|
@@ -58339,7 +58418,7 @@ type UpdateCreditNoteData = {
|
|
|
58339
58418
|
/**
|
|
58340
58419
|
* Additional object included in the result
|
|
58341
58420
|
*/
|
|
58342
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
58421
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_1039_>;
|
|
58343
58422
|
};
|
|
58344
58423
|
url: '/credit-notes/{id}';
|
|
58345
58424
|
};
|
|
@@ -58374,7 +58453,7 @@ type GetCreditNotesData = {
|
|
|
58374
58453
|
/**
|
|
58375
58454
|
* Additional object included in the result
|
|
58376
58455
|
*/
|
|
58377
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' |
|
|
58456
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | _heyapi_1039_>;
|
|
58378
58457
|
/**
|
|
58379
58458
|
* Order field
|
|
58380
58459
|
*/
|
|
@@ -58399,7 +58478,7 @@ type CreateCreditNoteData = {
|
|
|
58399
58478
|
/**
|
|
58400
58479
|
* Additional object included in the result
|
|
58401
58480
|
*/
|
|
58402
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' |
|
|
58481
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'discount_incl_taxes' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'file' | _heyapi_1039_>;
|
|
58403
58482
|
/**
|
|
58404
58483
|
* 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>
|
|
58405
58484
|
*
|
|
@@ -58439,7 +58518,7 @@ type SearchCreditNotesData = {
|
|
|
58439
58518
|
/**
|
|
58440
58519
|
* Additional object included in the result
|
|
58441
58520
|
*/
|
|
58442
|
-
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' |
|
|
58521
|
+
embed?: Array<'fiscal_year' | 'related' | 'contact' | 'company' | 'individual' | 'currency' | 'owner' | 'acl' | 'smart_tags' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | _heyapi_1039_>;
|
|
58443
58522
|
/**
|
|
58444
58523
|
* Order field
|
|
58445
58524
|
*/
|
|
@@ -61338,7 +61417,7 @@ type UpdateModelData = {
|
|
|
61338
61417
|
* Invoice's owner (staff id)
|
|
61339
61418
|
*/
|
|
61340
61419
|
owner_id?: number;
|
|
61341
|
-
rows?: Array<
|
|
61420
|
+
rows?: Array<_heyapi_2249_> | null;
|
|
61342
61421
|
};
|
|
61343
61422
|
path: {
|
|
61344
61423
|
/**
|
|
@@ -61526,7 +61605,7 @@ type ConvertModelResponses = {
|
|
|
61526
61605
|
* Rate Category applied on document
|
|
61527
61606
|
*/
|
|
61528
61607
|
rate_category_id?: number;
|
|
61529
|
-
rows?: Array<
|
|
61608
|
+
rows?: Array<_heyapi_724_> | null;
|
|
61530
61609
|
/**
|
|
61531
61610
|
* Note of the document
|
|
61532
61611
|
*/
|
|
@@ -61754,7 +61833,7 @@ type GetDepositInvoicesData = {
|
|
|
61754
61833
|
/**
|
|
61755
61834
|
* Additional object included in the result
|
|
61756
61835
|
*/
|
|
61757
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
61836
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_1039_>;
|
|
61758
61837
|
/**
|
|
61759
61838
|
* Order field
|
|
61760
61839
|
*/
|
|
@@ -61780,7 +61859,7 @@ type CreateDepositInvoiceData = {
|
|
|
61780
61859
|
/**
|
|
61781
61860
|
* Additional object included in the result
|
|
61782
61861
|
*/
|
|
61783
|
-
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' |
|
|
61862
|
+
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_1039_>;
|
|
61784
61863
|
};
|
|
61785
61864
|
url: '/deposit-invoices';
|
|
61786
61865
|
};
|
|
@@ -61815,7 +61894,7 @@ type SearchDepositInvoicesData = {
|
|
|
61815
61894
|
/**
|
|
61816
61895
|
* Additional object included in the result
|
|
61817
61896
|
*/
|
|
61818
|
-
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' |
|
|
61897
|
+
embed?: Array<'acl' | 'owner' | 'related' | 'contact' | 'individual' | 'company' | 'fiscal_year' | 'currency' | 'smart_tags' | 'deposits' | 'invoicing_address' | 'delivery_address' | 'issuer_address' | 'payment_method_ids' | _heyapi_1039_>;
|
|
61819
61898
|
/**
|
|
61820
61899
|
* Order field
|
|
61821
61900
|
*/
|
|
@@ -61884,7 +61963,7 @@ type GetDepositInvoiceData = {
|
|
|
61884
61963
|
/**
|
|
61885
61964
|
* Additional object included in the result
|
|
61886
61965
|
*/
|
|
61887
|
-
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' |
|
|
61966
|
+
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_1039_>;
|
|
61888
61967
|
};
|
|
61889
61968
|
url: '/deposit-invoices/{id}';
|
|
61890
61969
|
};
|
|
@@ -61907,7 +61986,7 @@ type UpdateDepositInvoiceData = {
|
|
|
61907
61986
|
/**
|
|
61908
61987
|
* Additional object included in the result
|
|
61909
61988
|
*/
|
|
61910
|
-
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' |
|
|
61989
|
+
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_1039_>;
|
|
61911
61990
|
};
|
|
61912
61991
|
url: '/deposit-invoices/{id}';
|
|
61913
61992
|
};
|
|
@@ -63763,7 +63842,7 @@ type CreateProgressInvoiceData = {
|
|
|
63763
63842
|
/**
|
|
63764
63843
|
* Additional object included in the result
|
|
63765
63844
|
*/
|
|
63766
|
-
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' |
|
|
63845
|
+
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_1039_>;
|
|
63767
63846
|
/**
|
|
63768
63847
|
* 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>
|
|
63769
63848
|
*
|
|
@@ -63776,7 +63855,7 @@ type CreateProgressInvoiceResponses = {
|
|
|
63776
63855
|
/**
|
|
63777
63856
|
* Progress invoice created
|
|
63778
63857
|
*/
|
|
63779
|
-
201:
|
|
63858
|
+
201: _heyapi_722_;
|
|
63780
63859
|
};
|
|
63781
63860
|
type CreateProgressInvoiceResponse = CreateProgressInvoiceResponses[keyof CreateProgressInvoiceResponses];
|
|
63782
63861
|
type ComputeProgressInvoiceData = {
|
|
@@ -63804,7 +63883,7 @@ type UpdateProgressInvoiceData = {
|
|
|
63804
63883
|
/**
|
|
63805
63884
|
* Additional object included in the result
|
|
63806
63885
|
*/
|
|
63807
|
-
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' |
|
|
63886
|
+
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_1039_>;
|
|
63808
63887
|
/**
|
|
63809
63888
|
* 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>
|
|
63810
63889
|
*
|
|
@@ -63817,7 +63896,7 @@ type UpdateProgressInvoiceResponses = {
|
|
|
63817
63896
|
/**
|
|
63818
63897
|
* Progress invoice updated
|
|
63819
63898
|
*/
|
|
63820
|
-
200:
|
|
63899
|
+
200: _heyapi_722_;
|
|
63821
63900
|
};
|
|
63822
63901
|
type UpdateProgressInvoiceResponse = UpdateProgressInvoiceResponses[keyof UpdateProgressInvoiceResponses];
|
|
63823
63902
|
type GetPaymentTermsData = {
|
|
@@ -71137,7 +71216,7 @@ declare const DealsSchema: {
|
|
|
71137
71216
|
readonly type: {
|
|
71138
71217
|
readonly type: "string";
|
|
71139
71218
|
readonly example: "opportunity";
|
|
71140
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery"];
|
|
71219
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
71141
71220
|
};
|
|
71142
71221
|
};
|
|
71143
71222
|
};
|
|
@@ -75402,6 +75481,21 @@ declare const TaskItemSchema: {
|
|
|
75402
75481
|
}, {
|
|
75403
75482
|
readonly $ref: "#/components/schemas/EstimateOne/allOf/0";
|
|
75404
75483
|
readonly title: "Estimate";
|
|
75484
|
+
}, {
|
|
75485
|
+
readonly $ref: "#/components/schemas/ModelOne/allOf/0";
|
|
75486
|
+
readonly title: "Model";
|
|
75487
|
+
}, {
|
|
75488
|
+
readonly $ref: "#/components/schemas/purCreditNoteOne/allOf/0";
|
|
75489
|
+
readonly title: "Purchase Credit Note";
|
|
75490
|
+
}, {
|
|
75491
|
+
readonly $ref: "#/components/schemas/purDeliveryOne/allOf/0";
|
|
75492
|
+
readonly title: "Purchase Delivery";
|
|
75493
|
+
}, {
|
|
75494
|
+
readonly $ref: "#/components/schemas/purInvoiceOne/allOf/0";
|
|
75495
|
+
readonly title: "Purchase Invoice";
|
|
75496
|
+
}, {
|
|
75497
|
+
readonly $ref: "#/components/schemas/purOrderOne/allOf/0";
|
|
75498
|
+
readonly title: "Purchase Order";
|
|
75405
75499
|
}];
|
|
75406
75500
|
};
|
|
75407
75501
|
};
|
|
@@ -75551,7 +75645,7 @@ declare const TaskCreateItemSchema: {
|
|
|
75551
75645
|
readonly type: {
|
|
75552
75646
|
readonly type: "string";
|
|
75553
75647
|
readonly example: "opportunity";
|
|
75554
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "estimate", "invoice", "creditnote", "order", "delivery"];
|
|
75648
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "estimate", "invoice", "creditnote", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
75555
75649
|
};
|
|
75556
75650
|
};
|
|
75557
75651
|
};
|
|
@@ -75593,7 +75687,7 @@ declare const TaskCreateItemSchema: {
|
|
|
75593
75687
|
readonly type: {
|
|
75594
75688
|
readonly type: "string";
|
|
75595
75689
|
readonly example: "opportunity";
|
|
75596
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "estimate", "invoice", "creditnote", "order", "delivery"];
|
|
75690
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "estimate", "invoice", "creditnote", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
75597
75691
|
};
|
|
75598
75692
|
};
|
|
75599
75693
|
};
|
|
@@ -75704,7 +75798,7 @@ declare const TaskUpdateItemSchema: {
|
|
|
75704
75798
|
readonly type: {
|
|
75705
75799
|
readonly type: "string";
|
|
75706
75800
|
readonly example: "opportunity";
|
|
75707
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "estimate", "invoice", "creditnote", "order", "delivery"];
|
|
75801
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "estimate", "invoice", "creditnote", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
75708
75802
|
};
|
|
75709
75803
|
};
|
|
75710
75804
|
};
|
|
@@ -76050,7 +76144,7 @@ declare const LabelBaseItemSchema: {
|
|
|
76050
76144
|
readonly type: {
|
|
76051
76145
|
readonly type: "string";
|
|
76052
76146
|
readonly example: "opportunity";
|
|
76053
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery"];
|
|
76147
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
76054
76148
|
};
|
|
76055
76149
|
};
|
|
76056
76150
|
};
|
|
@@ -76173,7 +76267,7 @@ declare const SearchResultSchema: {
|
|
|
76173
76267
|
};
|
|
76174
76268
|
readonly sub_type: {
|
|
76175
76269
|
readonly type: "string";
|
|
76176
|
-
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "delivery", "proforma", "staff", "document", "template"];
|
|
76270
|
+
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "model", "delivery", "proforma", "staff", "document", "template"];
|
|
76177
76271
|
readonly nullable: false;
|
|
76178
76272
|
};
|
|
76179
76273
|
};
|
|
@@ -76587,7 +76681,7 @@ declare const SearchResultSchema: {
|
|
|
76587
76681
|
readonly description: "Purchase status";
|
|
76588
76682
|
readonly type: "string";
|
|
76589
76683
|
readonly example: "read";
|
|
76590
|
-
readonly enum: readonly ["draft", "due", "payinprogress", "paid", "late", "cancelled", "sent", "read", "accepted", "expired", "
|
|
76684
|
+
readonly enum: readonly ["draft", "due", "payinprogress", "paid", "late", "cancelled", "sent", "read", "accepted", "expired", "partialinvoiced", "invoiced", "stored", "spent", "partialspend"];
|
|
76591
76685
|
};
|
|
76592
76686
|
readonly number: {
|
|
76593
76687
|
readonly description: "Purchase number";
|
|
@@ -77003,7 +77097,7 @@ declare const SearchResultBaseItemSchema: {
|
|
|
77003
77097
|
};
|
|
77004
77098
|
readonly sub_type: {
|
|
77005
77099
|
readonly type: "string";
|
|
77006
|
-
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "delivery", "proforma", "staff", "document", "template"];
|
|
77100
|
+
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "model", "delivery", "proforma", "staff", "document", "template"];
|
|
77007
77101
|
readonly nullable: false;
|
|
77008
77102
|
};
|
|
77009
77103
|
};
|
|
@@ -80950,7 +81044,7 @@ declare const RecordPaymentSchema: {
|
|
|
80950
81044
|
readonly vat_amount: {
|
|
80951
81045
|
readonly type: "string";
|
|
80952
81046
|
};
|
|
80953
|
-
readonly
|
|
81047
|
+
readonly amount_excl_vat: {
|
|
80954
81048
|
readonly type: "string";
|
|
80955
81049
|
};
|
|
80956
81050
|
};
|
|
@@ -80992,9 +81086,6 @@ declare const PaymentContextSchema: {
|
|
|
80992
81086
|
readonly type: {
|
|
80993
81087
|
readonly type: "string";
|
|
80994
81088
|
};
|
|
80995
|
-
readonly third_id: {
|
|
80996
|
-
readonly type: "integer";
|
|
80997
|
-
};
|
|
80998
81089
|
readonly total_amount: {
|
|
80999
81090
|
readonly type: "string";
|
|
81000
81091
|
};
|
|
@@ -81032,7 +81123,7 @@ declare const PaymentContextSchema: {
|
|
|
81032
81123
|
readonly vat_amount: {
|
|
81033
81124
|
readonly type: "string";
|
|
81034
81125
|
};
|
|
81035
|
-
readonly
|
|
81126
|
+
readonly amount_excl_vat: {
|
|
81036
81127
|
readonly type: "string";
|
|
81037
81128
|
};
|
|
81038
81129
|
};
|
|
@@ -89699,6 +89790,11 @@ declare const ComputedProgresssInvoiceSchema: {
|
|
|
89699
89790
|
readonly type: "string";
|
|
89700
89791
|
readonly description: "Tax amount";
|
|
89701
89792
|
};
|
|
89793
|
+
readonly category: {
|
|
89794
|
+
readonly type: "string";
|
|
89795
|
+
readonly description: "Tax category code (EN 16931), e.g. K for intra-community VAT. Null when the tax has no category.";
|
|
89796
|
+
readonly nullable: true;
|
|
89797
|
+
};
|
|
89702
89798
|
};
|
|
89703
89799
|
};
|
|
89704
89800
|
};
|
|
@@ -95165,6 +95261,7 @@ declare const CompanyPreferencesSchema: {
|
|
|
95165
95261
|
readonly type: "string";
|
|
95166
95262
|
readonly description: "System label of tax";
|
|
95167
95263
|
readonly example: "Intracom";
|
|
95264
|
+
readonly nullable: true;
|
|
95168
95265
|
};
|
|
95169
95266
|
};
|
|
95170
95267
|
};
|
|
@@ -99414,6 +99511,11 @@ declare const ProgressInvoiceMetadataSchema: {
|
|
|
99414
99511
|
readonly type: "string";
|
|
99415
99512
|
readonly description: "Tax amount";
|
|
99416
99513
|
};
|
|
99514
|
+
readonly category: {
|
|
99515
|
+
readonly type: "string";
|
|
99516
|
+
readonly description: "Tax category code (EN 16931), e.g. K for intra-community VAT. Null when the tax has no category.";
|
|
99517
|
+
readonly nullable: true;
|
|
99518
|
+
};
|
|
99417
99519
|
};
|
|
99418
99520
|
};
|
|
99419
99521
|
};
|
|
@@ -100781,6 +100883,23 @@ declare const purInvoiceOneSchema: {
|
|
|
100781
100883
|
readonly description: "Purchase invoice number";
|
|
100782
100884
|
readonly example: "F_INV-20250916-00002";
|
|
100783
100885
|
};
|
|
100886
|
+
readonly amounts: {
|
|
100887
|
+
readonly type: "object";
|
|
100888
|
+
readonly readOnly: true;
|
|
100889
|
+
readonly description: "Amounts of the purchase invoice";
|
|
100890
|
+
readonly properties: {
|
|
100891
|
+
readonly total_excl_tax: {
|
|
100892
|
+
readonly type: "string";
|
|
100893
|
+
readonly description: "Total amount without taxes";
|
|
100894
|
+
readonly example: "933.07";
|
|
100895
|
+
};
|
|
100896
|
+
readonly total_incl_tax: {
|
|
100897
|
+
readonly type: "string";
|
|
100898
|
+
readonly description: "Total amount including taxes";
|
|
100899
|
+
readonly example: "1119.68";
|
|
100900
|
+
};
|
|
100901
|
+
};
|
|
100902
|
+
};
|
|
100784
100903
|
readonly related: {
|
|
100785
100904
|
readonly description: "Objects linked to the purchase invoice :\n - There can be only one company or one individual at a time (required)\n - For Company & Individual, only `supplier` type is allowed\n - Contact is the contact of company linked to the purchase invoice. There may be no or one contact.\n - Opportunity is the opportunity linked to the purchase invoice. There may be zero or more opportunities linked to purchase invoice\n";
|
|
100786
100905
|
readonly type: "array";
|
|
@@ -100802,6 +100921,13 @@ declare const purInvoiceOneSchema: {
|
|
|
100802
100921
|
};
|
|
100803
100922
|
};
|
|
100804
100923
|
};
|
|
100924
|
+
readonly status: {
|
|
100925
|
+
readonly type: "string";
|
|
100926
|
+
readonly readOnly: true;
|
|
100927
|
+
readonly description: "Status of the purchase invoice";
|
|
100928
|
+
readonly example: "paid";
|
|
100929
|
+
readonly enum: readonly ["draft", "due", "payinprogress", "paid", "late", "cancelled"];
|
|
100930
|
+
};
|
|
100805
100931
|
};
|
|
100806
100932
|
}];
|
|
100807
100933
|
};
|
|
@@ -100822,6 +100948,23 @@ declare const purCreditNoteOneSchema: {
|
|
|
100822
100948
|
readonly description: "Purchase credit note number";
|
|
100823
100949
|
readonly example: "F_AVR-20250916-00002";
|
|
100824
100950
|
};
|
|
100951
|
+
readonly amounts: {
|
|
100952
|
+
readonly type: "object";
|
|
100953
|
+
readonly readOnly: true;
|
|
100954
|
+
readonly description: "Amounts of the purchase credit note";
|
|
100955
|
+
readonly properties: {
|
|
100956
|
+
readonly total_excl_tax: {
|
|
100957
|
+
readonly type: "string";
|
|
100958
|
+
readonly description: "Total amount without taxes";
|
|
100959
|
+
readonly example: "933.07";
|
|
100960
|
+
};
|
|
100961
|
+
readonly total_incl_tax: {
|
|
100962
|
+
readonly type: "string";
|
|
100963
|
+
readonly description: "Total amount including taxes";
|
|
100964
|
+
readonly example: "1119.68";
|
|
100965
|
+
};
|
|
100966
|
+
};
|
|
100967
|
+
};
|
|
100825
100968
|
readonly related: {
|
|
100826
100969
|
readonly description: "Objects linked to the purchase credit note :\n - There can be only one company or one individual at a time (required)\n - For Company & Individual, only `supplier` type is allowed\n - Contact is the contact of company linked to the purchase credit note. There may be no or one contact.\n - Opportunity is the opportunity linked to the purchase credit note. There may be zero or more opportunities linked to purchase credit note\n";
|
|
100827
100970
|
readonly type: "array";
|
|
@@ -100843,6 +100986,13 @@ declare const purCreditNoteOneSchema: {
|
|
|
100843
100986
|
};
|
|
100844
100987
|
};
|
|
100845
100988
|
};
|
|
100989
|
+
readonly status: {
|
|
100990
|
+
readonly type: "string";
|
|
100991
|
+
readonly readOnly: true;
|
|
100992
|
+
readonly description: "Status of the purchase credit note";
|
|
100993
|
+
readonly example: "spent";
|
|
100994
|
+
readonly enum: readonly ["draft", "stored", "partialspend", "spent", "cancelled"];
|
|
100995
|
+
};
|
|
100846
100996
|
};
|
|
100847
100997
|
}];
|
|
100848
100998
|
};
|
|
@@ -100863,6 +101013,23 @@ declare const purDeliveryOneSchema: {
|
|
|
100863
101013
|
readonly description: "Purchase delivery number";
|
|
100864
101014
|
readonly example: "F_DEL-20250916-00002";
|
|
100865
101015
|
};
|
|
101016
|
+
readonly amounts: {
|
|
101017
|
+
readonly type: "object";
|
|
101018
|
+
readonly readOnly: true;
|
|
101019
|
+
readonly description: "Amounts of the purchase delivery";
|
|
101020
|
+
readonly properties: {
|
|
101021
|
+
readonly total_excl_tax: {
|
|
101022
|
+
readonly type: "string";
|
|
101023
|
+
readonly description: "Total amount without taxes";
|
|
101024
|
+
readonly example: "933.07";
|
|
101025
|
+
};
|
|
101026
|
+
readonly total_incl_tax: {
|
|
101027
|
+
readonly type: "string";
|
|
101028
|
+
readonly description: "Total amount including taxes";
|
|
101029
|
+
readonly example: "1119.68";
|
|
101030
|
+
};
|
|
101031
|
+
};
|
|
101032
|
+
};
|
|
100866
101033
|
readonly related: {
|
|
100867
101034
|
readonly description: "Objects linked to the purchase delivery :\n - There can be only one company or one individual at a time (required)\n - For Company & Individual, only `supplier` type is allowed\n - Contact is the contact of company linked to the purchase delivery. There may be no or one contact.\n - Opportunity is the opportunity linked to the purchase delivery. There may be zero or more opportunities linked to purchase delivery\n";
|
|
100868
101035
|
readonly type: "array";
|
|
@@ -100884,6 +101051,13 @@ declare const purDeliveryOneSchema: {
|
|
|
100884
101051
|
};
|
|
100885
101052
|
};
|
|
100886
101053
|
};
|
|
101054
|
+
readonly status: {
|
|
101055
|
+
readonly type: "string";
|
|
101056
|
+
readonly readOnly: true;
|
|
101057
|
+
readonly description: "Status of the purchase delivery";
|
|
101058
|
+
readonly example: "invoiced";
|
|
101059
|
+
readonly enum: readonly ["draft", "partialinvoiced", "invoiced"];
|
|
101060
|
+
};
|
|
100887
101061
|
};
|
|
100888
101062
|
}];
|
|
100889
101063
|
};
|
|
@@ -100904,6 +101078,23 @@ declare const purOrderOneSchema: {
|
|
|
100904
101078
|
readonly description: "Purchase order number";
|
|
100905
101079
|
readonly example: "F_ORD-20250916-00002";
|
|
100906
101080
|
};
|
|
101081
|
+
readonly amounts: {
|
|
101082
|
+
readonly type: "object";
|
|
101083
|
+
readonly readOnly: true;
|
|
101084
|
+
readonly description: "Amounts of the purchase order";
|
|
101085
|
+
readonly properties: {
|
|
101086
|
+
readonly total_excl_tax: {
|
|
101087
|
+
readonly type: "string";
|
|
101088
|
+
readonly description: "Total amount without taxes";
|
|
101089
|
+
readonly example: "933.07";
|
|
101090
|
+
};
|
|
101091
|
+
readonly total_incl_tax: {
|
|
101092
|
+
readonly type: "string";
|
|
101093
|
+
readonly description: "Total amount including taxes";
|
|
101094
|
+
readonly example: "1119.68";
|
|
101095
|
+
};
|
|
101096
|
+
};
|
|
101097
|
+
};
|
|
100907
101098
|
readonly related: {
|
|
100908
101099
|
readonly description: "Objects linked to the purchase order :\n - There can be only one company or one individual at a time (required)\n - For Company & Individual, only `supplier` type is allowed\n - Contact is the contact of company linked to the purchase order. There may be no or one contact.\n - Opportunity is the opportunity linked to the purchase order. There may be zero or more opportunities linked to purchase order\n";
|
|
100909
101100
|
readonly type: "array";
|
|
@@ -100925,6 +101116,13 @@ declare const purOrderOneSchema: {
|
|
|
100925
101116
|
};
|
|
100926
101117
|
};
|
|
100927
101118
|
};
|
|
101119
|
+
readonly status: {
|
|
101120
|
+
readonly type: "string";
|
|
101121
|
+
readonly readOnly: true;
|
|
101122
|
+
readonly description: "Status of the purchase order";
|
|
101123
|
+
readonly example: "invoiced";
|
|
101124
|
+
readonly enum: readonly ["draft", "sent", "read", "accepted", "expired", "partialinvoiced", "invoiced", "cancelled"];
|
|
101125
|
+
};
|
|
100928
101126
|
};
|
|
100929
101127
|
}];
|
|
100930
101128
|
};
|
|
@@ -105139,7 +105337,7 @@ declare const DealsWritableSchema: {
|
|
|
105139
105337
|
readonly type: {
|
|
105140
105338
|
readonly type: "string";
|
|
105141
105339
|
readonly example: "opportunity";
|
|
105142
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery"];
|
|
105340
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
105143
105341
|
};
|
|
105144
105342
|
};
|
|
105145
105343
|
};
|
|
@@ -106877,7 +107075,7 @@ declare const LabelBaseItemWritableSchema: {
|
|
|
106877
107075
|
readonly type: {
|
|
106878
107076
|
readonly type: "string";
|
|
106879
107077
|
readonly example: "opportunity";
|
|
106880
|
-
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery"];
|
|
107078
|
+
readonly enum: readonly ["opportunity", "company", "individual", "contact", "invoice", "creditnote", "estimate", "order", "delivery", "model", "purchase-invoice", "purchase-creditnote", "purchase-order", "purchase-delivery", "item"];
|
|
106881
107079
|
};
|
|
106882
107080
|
};
|
|
106883
107081
|
};
|
|
@@ -106936,7 +107134,7 @@ declare const SearchResultWritableSchema: {
|
|
|
106936
107134
|
};
|
|
106937
107135
|
readonly sub_type: {
|
|
106938
107136
|
readonly type: "string";
|
|
106939
|
-
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "delivery", "proforma", "staff", "document", "template"];
|
|
107137
|
+
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "model", "delivery", "proforma", "staff", "document", "template"];
|
|
106940
107138
|
readonly nullable: false;
|
|
106941
107139
|
};
|
|
106942
107140
|
};
|
|
@@ -107322,7 +107520,7 @@ declare const SearchResultWritableSchema: {
|
|
|
107322
107520
|
readonly description: "Purchase status";
|
|
107323
107521
|
readonly type: "string";
|
|
107324
107522
|
readonly example: "read";
|
|
107325
|
-
readonly enum: readonly ["draft", "due", "payinprogress", "paid", "late", "cancelled", "sent", "read", "accepted", "expired", "
|
|
107523
|
+
readonly enum: readonly ["draft", "due", "payinprogress", "paid", "late", "cancelled", "sent", "read", "accepted", "expired", "partialinvoiced", "invoiced", "stored", "spent", "partialspend"];
|
|
107326
107524
|
};
|
|
107327
107525
|
readonly number: {
|
|
107328
107526
|
readonly description: "Purchase number";
|
|
@@ -107732,7 +107930,7 @@ declare const SearchResultBaseItemWritableSchema: {
|
|
|
107732
107930
|
};
|
|
107733
107931
|
readonly sub_type: {
|
|
107734
107932
|
readonly type: "string";
|
|
107735
|
-
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "delivery", "proforma", "staff", "document", "template"];
|
|
107933
|
+
readonly enum: readonly ["contact", "opportunity", "client", "prospect", "supplier", "purInvoice", "purDelivery", "purOrder", "purCreditNote", "product", "packaging", "shipping", "service", "declination", "invoice", "estimate", "creditnote", "order", "model", "delivery", "proforma", "staff", "document", "template"];
|
|
107736
107934
|
readonly nullable: false;
|
|
107737
107935
|
};
|
|
107738
107936
|
};
|
|
@@ -115897,6 +116095,7 @@ declare const CompanyPreferencesWritableSchema: {
|
|
|
115897
116095
|
readonly type: "string";
|
|
115898
116096
|
readonly description: "System label of tax";
|
|
115899
116097
|
readonly example: "Intracom";
|
|
116098
|
+
readonly nullable: true;
|
|
115900
116099
|
};
|
|
115901
116100
|
};
|
|
115902
116101
|
};
|
|
@@ -117830,6 +118029,11 @@ declare const ProgressInvoiceMetadataWritableSchema: {
|
|
|
117830
118029
|
readonly type: "string";
|
|
117831
118030
|
readonly description: "Tax amount";
|
|
117832
118031
|
};
|
|
118032
|
+
readonly category: {
|
|
118033
|
+
readonly type: "string";
|
|
118034
|
+
readonly description: "Tax category code (EN 16931), e.g. K for intra-community VAT. Null when the tax has no category.";
|
|
118035
|
+
readonly nullable: true;
|
|
118036
|
+
};
|
|
117833
118037
|
};
|
|
117834
118038
|
};
|
|
117835
118039
|
};
|