@chift/chift-nodejs 1.0.27 → 1.0.29
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/src/modules/api.d.ts +114 -1
- package/dist/src/modules/consumer.d.ts +23 -1
- package/dist/src/modules/consumer.js +2 -0
- package/dist/src/modules/consumers.d.ts +111 -1
- package/dist/src/modules/consumers.js +2 -2
- package/dist/src/modules/ecommerce.d.ts +2 -2
- package/dist/src/modules/invoicing.d.ts +2 -2
- package/dist/src/modules/sync.d.ts +88 -0
- package/dist/src/types/public-api/schema.d.ts +697 -699
- package/dist/test/modules/consumers.test.js +14 -0
- package/package.json +2 -2
- package/src/types/public-api/schema.d.ts +697 -699
|
@@ -3087,16 +3087,14 @@ export interface components {
|
|
|
3087
3087
|
* @description Scope of the VAT code, indicating its applicability. Use 'nat' for VAT codes that apply to local/domestic sales or purchases, 'eu' for cross-border transactions within the EU, and 'int' for transactions with countries outside the EU.
|
|
3088
3088
|
* @default unknown
|
|
3089
3089
|
*/
|
|
3090
|
-
scope:
|
|
3091
|
-
| components['schemas']['backbone_common__models__accounting__common__VatCodeScope']
|
|
3092
|
-
| null;
|
|
3090
|
+
scope: components['schemas']['VatCodeScope'] | null;
|
|
3093
3091
|
/**
|
|
3094
3092
|
* Rate
|
|
3095
3093
|
* @description VAT rate associated with the VAT code. This is the percentage rate applied to the amount when this VAT code is used.
|
|
3096
3094
|
*/
|
|
3097
3095
|
rate: number;
|
|
3098
3096
|
/** @description Type of the VAT code, indicating whether it is a sales tax or purchase tax. This helps in understanding how the VAT code is applied in transactions. */
|
|
3099
|
-
type: components['schemas']['
|
|
3097
|
+
type: components['schemas']['VatCodeType'];
|
|
3100
3098
|
/**
|
|
3101
3099
|
* Deductible Account
|
|
3102
3100
|
* @description Ledger account number used for the deductible part of the VAT code. This is typically used for purchase transactions where VAT can be deducted.
|
|
@@ -3176,6 +3174,33 @@ export interface components {
|
|
|
3176
3174
|
*/
|
|
3177
3175
|
country?: string | null;
|
|
3178
3176
|
};
|
|
3177
|
+
/** AddressItemIn */
|
|
3178
|
+
AddressItemIn: {
|
|
3179
|
+
address_type: components['schemas']['AddressType'];
|
|
3180
|
+
/** Name */
|
|
3181
|
+
name?: string | null;
|
|
3182
|
+
/** Number */
|
|
3183
|
+
number?: string | null;
|
|
3184
|
+
/** Box */
|
|
3185
|
+
box?: string | null;
|
|
3186
|
+
/** Phone */
|
|
3187
|
+
phone?: string | null;
|
|
3188
|
+
/** Mobile */
|
|
3189
|
+
mobile?: string | null;
|
|
3190
|
+
/** Email */
|
|
3191
|
+
email?: string | null;
|
|
3192
|
+
/** Street */
|
|
3193
|
+
street: string;
|
|
3194
|
+
/** City */
|
|
3195
|
+
city: string;
|
|
3196
|
+
/** Postal Code */
|
|
3197
|
+
postal_code: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* Country
|
|
3200
|
+
* @description Format: ISO 3166-1 codes.
|
|
3201
|
+
*/
|
|
3202
|
+
country: string;
|
|
3203
|
+
};
|
|
3179
3204
|
/** AddressItemInInvoicing */
|
|
3180
3205
|
AddressItemInInvoicing: {
|
|
3181
3206
|
address_type: components['schemas']['AddressTypeInvoicing'];
|
|
@@ -3203,6 +3228,62 @@ export interface components {
|
|
|
3203
3228
|
*/
|
|
3204
3229
|
country: string;
|
|
3205
3230
|
};
|
|
3231
|
+
/** AddressItemOut */
|
|
3232
|
+
AddressItemOut: {
|
|
3233
|
+
address_type: components['schemas']['AddressType'];
|
|
3234
|
+
/** Company Name */
|
|
3235
|
+
company_name?: string | null;
|
|
3236
|
+
/** First Name */
|
|
3237
|
+
first_name?: string | null;
|
|
3238
|
+
/** Last Name */
|
|
3239
|
+
last_name?: string | null;
|
|
3240
|
+
/** Street */
|
|
3241
|
+
street?: string | null;
|
|
3242
|
+
/** Number */
|
|
3243
|
+
number?: string | null;
|
|
3244
|
+
/** Box */
|
|
3245
|
+
box?: string | null;
|
|
3246
|
+
/** City */
|
|
3247
|
+
city?: string | null;
|
|
3248
|
+
/** Postal Code */
|
|
3249
|
+
postal_code?: string | null;
|
|
3250
|
+
/**
|
|
3251
|
+
* Country
|
|
3252
|
+
* @description Format: ISO 3166-1 codes.
|
|
3253
|
+
*/
|
|
3254
|
+
country?: string | null;
|
|
3255
|
+
/** Phone */
|
|
3256
|
+
phone?: string | null;
|
|
3257
|
+
/** Email */
|
|
3258
|
+
email?: string | null;
|
|
3259
|
+
};
|
|
3260
|
+
/** AddressItemOut */
|
|
3261
|
+
'AddressItemOut-Input': {
|
|
3262
|
+
address_type: components['schemas']['AddressType'];
|
|
3263
|
+
/** Name */
|
|
3264
|
+
name?: string | null;
|
|
3265
|
+
/** Number */
|
|
3266
|
+
number?: string | null;
|
|
3267
|
+
/** Box */
|
|
3268
|
+
box?: string | null;
|
|
3269
|
+
/** Phone */
|
|
3270
|
+
phone?: string | null;
|
|
3271
|
+
/** Mobile */
|
|
3272
|
+
mobile?: string | null;
|
|
3273
|
+
/** Email */
|
|
3274
|
+
email?: string | null;
|
|
3275
|
+
/** Street */
|
|
3276
|
+
street?: string | null;
|
|
3277
|
+
/** City */
|
|
3278
|
+
city?: string | null;
|
|
3279
|
+
/** Postal Code */
|
|
3280
|
+
postal_code?: string | null;
|
|
3281
|
+
/**
|
|
3282
|
+
* Country
|
|
3283
|
+
* @description Format: ISO 3166-1 codes.
|
|
3284
|
+
*/
|
|
3285
|
+
country?: string | null;
|
|
3286
|
+
};
|
|
3206
3287
|
/** AddressItemOutInvoicing */
|
|
3207
3288
|
AddressItemOutInvoicing: {
|
|
3208
3289
|
address_type: components['schemas']['AddressTypeInvoicing'];
|
|
@@ -3510,7 +3591,7 @@ export interface components {
|
|
|
3510
3591
|
AttachmentItemIn: {
|
|
3511
3592
|
/** Base64 String */
|
|
3512
3593
|
base64_string: string;
|
|
3513
|
-
document_type: components['schemas']['
|
|
3594
|
+
document_type: components['schemas']['DocumentType'];
|
|
3514
3595
|
};
|
|
3515
3596
|
/** AttachmentItemOut */
|
|
3516
3597
|
AttachmentItemOut: {
|
|
@@ -4050,9 +4131,7 @@ export interface components {
|
|
|
4050
4131
|
* @description Status of the transaction
|
|
4051
4132
|
* @example pending
|
|
4052
4133
|
*/
|
|
4053
|
-
status?:
|
|
4054
|
-
| components['schemas']['backbone_common__models__banking__common__TransactionStatus']
|
|
4055
|
-
| null;
|
|
4134
|
+
status?: components['schemas']['TransactionStatus'] | null;
|
|
4056
4135
|
/** @description Extra information about the attachments linked to the invoice. */
|
|
4057
4136
|
attachments_info?: components['schemas']['ItemAttachmentInfoOut'];
|
|
4058
4137
|
};
|
|
@@ -4794,7 +4873,7 @@ export interface components {
|
|
|
4794
4873
|
/** ChiftPage[ProductItem] */
|
|
4795
4874
|
ChiftPage_ProductItem_: {
|
|
4796
4875
|
/** Items */
|
|
4797
|
-
items: components['schemas']['
|
|
4876
|
+
items: components['schemas']['ProductItem-Output'][];
|
|
4798
4877
|
/** Total */
|
|
4799
4878
|
total: number;
|
|
4800
4879
|
/** Page */
|
|
@@ -4955,7 +5034,7 @@ export interface components {
|
|
|
4955
5034
|
* Addresses
|
|
4956
5035
|
* @description List of addresses associated with the client.
|
|
4957
5036
|
*/
|
|
4958
|
-
addresses: components['schemas']['
|
|
5037
|
+
addresses: components['schemas']['AddressItemIn'][];
|
|
4959
5038
|
/**
|
|
4960
5039
|
* Account Number
|
|
4961
5040
|
* @description Number of ledger account assigned to the client in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.). This is typically the ledger account used for posting receivables. In some systems, each customer has a dedicated account; in others, a shared control account is used and customer balances are tracked in a subledger.
|
|
@@ -5084,6 +5163,11 @@ export interface components {
|
|
|
5084
5163
|
addresses:
|
|
5085
5164
|
| components['schemas']['backbone_common__models__common__AddressItemOut'][]
|
|
5086
5165
|
| null;
|
|
5166
|
+
/**
|
|
5167
|
+
* Third Party Account
|
|
5168
|
+
* @description Third party account number/code representing the client in the accounting software.
|
|
5169
|
+
*/
|
|
5170
|
+
third_party_account?: string | null;
|
|
5087
5171
|
};
|
|
5088
5172
|
/** ClientItemUpdate */
|
|
5089
5173
|
ClientItemUpdate: {
|
|
@@ -5184,9 +5268,7 @@ export interface components {
|
|
|
5184
5268
|
* @description List of addresses associated with the client.
|
|
5185
5269
|
* @default []
|
|
5186
5270
|
*/
|
|
5187
|
-
addresses:
|
|
5188
|
-
| components['schemas']['backbone_common__models__common__AddressItemOut'][]
|
|
5189
|
-
| null;
|
|
5271
|
+
addresses: components['schemas']['AddressItemOut-Input'][] | null;
|
|
5190
5272
|
};
|
|
5191
5273
|
/** ClosureItem */
|
|
5192
5274
|
ClosureItem: {
|
|
@@ -5275,9 +5357,7 @@ export interface components {
|
|
|
5275
5357
|
* Addresses
|
|
5276
5358
|
* @default []
|
|
5277
5359
|
*/
|
|
5278
|
-
addresses:
|
|
5279
|
-
| components['schemas']['backbone_common__models__commerce__common__AddressItemOut'][]
|
|
5280
|
-
| null;
|
|
5360
|
+
addresses: components['schemas']['AddressItemOut'][] | null;
|
|
5281
5361
|
/** Created On */
|
|
5282
5362
|
created_on?: string | null;
|
|
5283
5363
|
};
|
|
@@ -5310,6 +5390,40 @@ export interface components {
|
|
|
5310
5390
|
/** Values */
|
|
5311
5391
|
values: string[];
|
|
5312
5392
|
};
|
|
5393
|
+
/** ConnectionItem */
|
|
5394
|
+
ConnectionItem: {
|
|
5395
|
+
/** One Api */
|
|
5396
|
+
one_api?: number | null;
|
|
5397
|
+
/** Connection Type */
|
|
5398
|
+
connection_type?: number | null;
|
|
5399
|
+
/**
|
|
5400
|
+
* Display Order
|
|
5401
|
+
* @default 0
|
|
5402
|
+
*/
|
|
5403
|
+
display_order: number;
|
|
5404
|
+
/**
|
|
5405
|
+
* Display Hidden
|
|
5406
|
+
* @default false
|
|
5407
|
+
*/
|
|
5408
|
+
display_hidden: boolean;
|
|
5409
|
+
};
|
|
5410
|
+
/** ConnectionItem */
|
|
5411
|
+
'ConnectionItem-Input': {
|
|
5412
|
+
/** One Api */
|
|
5413
|
+
one_api?: number | null;
|
|
5414
|
+
/** Connection Type */
|
|
5415
|
+
connection_type?: number | null;
|
|
5416
|
+
/**
|
|
5417
|
+
* Display Order
|
|
5418
|
+
* @default 0
|
|
5419
|
+
*/
|
|
5420
|
+
display_order: number;
|
|
5421
|
+
/**
|
|
5422
|
+
* Display Hidden
|
|
5423
|
+
* @default false
|
|
5424
|
+
*/
|
|
5425
|
+
display_hidden: boolean;
|
|
5426
|
+
};
|
|
5313
5427
|
/** ConsumerItem */
|
|
5314
5428
|
ConsumerItem: {
|
|
5315
5429
|
/**
|
|
@@ -5644,7 +5758,7 @@ export interface components {
|
|
|
5644
5758
|
}[];
|
|
5645
5759
|
} | null;
|
|
5646
5760
|
/** Connections */
|
|
5647
|
-
connections: components['schemas']['
|
|
5761
|
+
connections: components['schemas']['ConnectionItem-Input'][];
|
|
5648
5762
|
/**
|
|
5649
5763
|
* Mappings
|
|
5650
5764
|
* @default []
|
|
@@ -5768,6 +5882,23 @@ export interface components {
|
|
|
5768
5882
|
[key: string]: unknown;
|
|
5769
5883
|
} | null;
|
|
5770
5884
|
};
|
|
5885
|
+
/** CredentialItem */
|
|
5886
|
+
'CredentialItem-Input': {
|
|
5887
|
+
/** Key */
|
|
5888
|
+
key: string;
|
|
5889
|
+
/** Value */
|
|
5890
|
+
value: string;
|
|
5891
|
+
};
|
|
5892
|
+
/** CredentialItem */
|
|
5893
|
+
'CredentialItem-Output': {
|
|
5894
|
+
/** Name */
|
|
5895
|
+
name: string;
|
|
5896
|
+
/**
|
|
5897
|
+
* Optional
|
|
5898
|
+
* @default false
|
|
5899
|
+
*/
|
|
5900
|
+
optional: boolean;
|
|
5901
|
+
};
|
|
5771
5902
|
/** DataItem */
|
|
5772
5903
|
DataItem: {
|
|
5773
5904
|
/** Data */
|
|
@@ -5796,9 +5927,7 @@ export interface components {
|
|
|
5796
5927
|
/** Name */
|
|
5797
5928
|
name: string;
|
|
5798
5929
|
/** @default active */
|
|
5799
|
-
status:
|
|
5800
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
5801
|
-
| null;
|
|
5930
|
+
status: components['schemas']['Status'] | null;
|
|
5802
5931
|
definition: components['schemas']['DatastoreDef'];
|
|
5803
5932
|
};
|
|
5804
5933
|
/** DatastoreColumn */
|
|
@@ -5825,11 +5954,25 @@ export interface components {
|
|
|
5825
5954
|
*/
|
|
5826
5955
|
search_column?: string | null;
|
|
5827
5956
|
};
|
|
5957
|
+
/** DiscountItem */
|
|
5958
|
+
DiscountItem: {
|
|
5959
|
+
/** Name */
|
|
5960
|
+
name: string;
|
|
5961
|
+
/** Description */
|
|
5962
|
+
description: string;
|
|
5963
|
+
/** Amount */
|
|
5964
|
+
amount: number;
|
|
5965
|
+
};
|
|
5828
5966
|
/**
|
|
5829
5967
|
* DiscountType
|
|
5830
5968
|
* @enum {string}
|
|
5831
5969
|
*/
|
|
5832
5970
|
DiscountType: 'OFFERED' | 'UNKNOWN' | 'LOSS';
|
|
5971
|
+
/**
|
|
5972
|
+
* DocumentType
|
|
5973
|
+
* @enum {string}
|
|
5974
|
+
*/
|
|
5975
|
+
DocumentType: 'customer_document' | 'supplier_document' | 'employee_expense';
|
|
5833
5976
|
/** EmployeeItem */
|
|
5834
5977
|
EmployeeItem: {
|
|
5835
5978
|
/**
|
|
@@ -6210,9 +6353,7 @@ export interface components {
|
|
|
6210
6353
|
* Discounts
|
|
6211
6354
|
* @default []
|
|
6212
6355
|
*/
|
|
6213
|
-
discounts:
|
|
6214
|
-
| components['schemas']['backbone_common__models__commerce__common__DiscountItem'][]
|
|
6215
|
-
| null;
|
|
6356
|
+
discounts: components['schemas']['DiscountItem'][] | null;
|
|
6216
6357
|
/** Untaxed Amount */
|
|
6217
6358
|
untaxed_amount: number;
|
|
6218
6359
|
/** Tax Amount */
|
|
@@ -6469,9 +6610,7 @@ export interface components {
|
|
|
6469
6610
|
/** Name */
|
|
6470
6611
|
name: string;
|
|
6471
6612
|
/** @default active */
|
|
6472
|
-
status:
|
|
6473
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
6474
|
-
| null;
|
|
6613
|
+
status: components['schemas']['Status'] | null;
|
|
6475
6614
|
definition: components['schemas']['DatastoreDef'];
|
|
6476
6615
|
};
|
|
6477
6616
|
/** FlowDataStoreItem */
|
|
@@ -6481,9 +6620,7 @@ export interface components {
|
|
|
6481
6620
|
/** Name */
|
|
6482
6621
|
name: string;
|
|
6483
6622
|
/** @default active */
|
|
6484
|
-
status:
|
|
6485
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
6486
|
-
| null;
|
|
6623
|
+
status: components['schemas']['Status'] | null;
|
|
6487
6624
|
definition: components['schemas']['DatastoreDef'];
|
|
6488
6625
|
};
|
|
6489
6626
|
/** FlowExecution */
|
|
@@ -6739,7 +6876,7 @@ export interface components {
|
|
|
6739
6876
|
name: string;
|
|
6740
6877
|
/** Description */
|
|
6741
6878
|
description?: string | null;
|
|
6742
|
-
status: components['schemas']['
|
|
6879
|
+
status: components['schemas']['Status'];
|
|
6743
6880
|
api: components['schemas']['Api'];
|
|
6744
6881
|
/** Logo Url */
|
|
6745
6882
|
logo_url: string;
|
|
@@ -6750,9 +6887,7 @@ export interface components {
|
|
|
6750
6887
|
* @description List of post-connections that can be activated for this integration.
|
|
6751
6888
|
* @default []
|
|
6752
6889
|
*/
|
|
6753
|
-
post_connections:
|
|
6754
|
-
| components['schemas']['backbone_api__app__routers__integrations__PostConnectionItem'][]
|
|
6755
|
-
| null;
|
|
6890
|
+
post_connections: components['schemas']['PostConnectionItem-Output'][] | null;
|
|
6756
6891
|
/**
|
|
6757
6892
|
* Operations Coverage
|
|
6758
6893
|
* @description List of operations coverage for this integration.
|
|
@@ -6764,9 +6899,7 @@ export interface components {
|
|
|
6764
6899
|
* @description List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.
|
|
6765
6900
|
* @default []
|
|
6766
6901
|
*/
|
|
6767
|
-
credentials:
|
|
6768
|
-
| components['schemas']['backbone_api__app__routers__integrations__CredentialItem'][]
|
|
6769
|
-
| null;
|
|
6902
|
+
credentials: components['schemas']['CredentialItem-Output'][] | null;
|
|
6770
6903
|
/**
|
|
6771
6904
|
* Supported Countries
|
|
6772
6905
|
* @description Country codes (ISO 3166-1 alpha-2) where this integration is supported. If not defined, the integration is supported globally.
|
|
@@ -6821,92 +6954,196 @@ export interface components {
|
|
|
6821
6954
|
*/
|
|
6822
6955
|
invoice_correction_debit_account_number?: string | null;
|
|
6823
6956
|
};
|
|
6824
|
-
/**
|
|
6825
|
-
|
|
6957
|
+
/** InvoiceItem */
|
|
6958
|
+
'InvoiceItem-Input': {
|
|
6826
6959
|
/**
|
|
6827
|
-
*
|
|
6828
|
-
*
|
|
6829
|
-
* @description Due date of the item.
|
|
6960
|
+
* Currency
|
|
6961
|
+
* @description Currency matching target sofware name
|
|
6830
6962
|
*/
|
|
6831
|
-
|
|
6963
|
+
currency: string;
|
|
6964
|
+
/** @description Invoice type */
|
|
6965
|
+
invoice_type: components['schemas']['InvoiceType'];
|
|
6966
|
+
/** @description Status */
|
|
6967
|
+
status: components['schemas']['InvoiceStatus'];
|
|
6832
6968
|
/**
|
|
6833
|
-
*
|
|
6834
|
-
*
|
|
6969
|
+
* Invoice Date
|
|
6970
|
+
* Format: date
|
|
6971
|
+
* @description Invoicing date
|
|
6835
6972
|
*/
|
|
6836
|
-
|
|
6973
|
+
invoice_date: string;
|
|
6837
6974
|
/**
|
|
6838
|
-
*
|
|
6839
|
-
* @description
|
|
6975
|
+
* Tax Amount
|
|
6976
|
+
* @description Taxes amount
|
|
6840
6977
|
*/
|
|
6841
|
-
|
|
6978
|
+
tax_amount: number;
|
|
6842
6979
|
/**
|
|
6843
|
-
* Amount
|
|
6844
|
-
* @description
|
|
6980
|
+
* Untaxed Amount
|
|
6981
|
+
* @description Untaxed amount
|
|
6845
6982
|
*/
|
|
6846
|
-
|
|
6847
|
-
};
|
|
6848
|
-
/** InvoiceItemInMonoAnalyticPlan */
|
|
6849
|
-
InvoiceItemInMonoAnalyticPlan: {
|
|
6850
|
-
/** @description Specifies the type of invoice */
|
|
6851
|
-
invoice_type: components['schemas']['backbone_common__models__accounting__common__InvoiceType'];
|
|
6983
|
+
untaxed_amount: number;
|
|
6852
6984
|
/**
|
|
6853
|
-
*
|
|
6854
|
-
* @description
|
|
6985
|
+
* Total
|
|
6986
|
+
* @description Total amount incl. taxes
|
|
6855
6987
|
*/
|
|
6856
|
-
|
|
6988
|
+
total: number;
|
|
6857
6989
|
/**
|
|
6858
|
-
*
|
|
6859
|
-
* @description
|
|
6990
|
+
* Lines
|
|
6991
|
+
* @description Invoice lines
|
|
6992
|
+
* @default []
|
|
6860
6993
|
*/
|
|
6861
|
-
|
|
6994
|
+
lines: components['schemas']['InvoiceLineItem'][];
|
|
6862
6995
|
/**
|
|
6863
|
-
*
|
|
6864
|
-
* @description
|
|
6996
|
+
* Partner Id
|
|
6997
|
+
* @description Technical id of the vendor/customer in Chift
|
|
6865
6998
|
*/
|
|
6866
|
-
|
|
6999
|
+
partner_id?: string | null;
|
|
6867
7000
|
/**
|
|
6868
|
-
*
|
|
6869
|
-
* @description
|
|
7001
|
+
* Invoice Number
|
|
7002
|
+
* @description Number/sequence
|
|
6870
7003
|
*/
|
|
6871
|
-
|
|
7004
|
+
invoice_number?: string | null;
|
|
6872
7005
|
/**
|
|
6873
|
-
*
|
|
6874
|
-
* @description
|
|
7006
|
+
* Due Date
|
|
7007
|
+
* @description Due date
|
|
6875
7008
|
*/
|
|
6876
|
-
|
|
7009
|
+
due_date?: string | null;
|
|
6877
7010
|
/**
|
|
6878
7011
|
* Reference
|
|
6879
|
-
* @description
|
|
7012
|
+
* @description Reference
|
|
6880
7013
|
*/
|
|
6881
7014
|
reference?: string | null;
|
|
6882
7015
|
/**
|
|
6883
7016
|
* Payment Communication
|
|
6884
|
-
* @description
|
|
7017
|
+
* @description Payment communication
|
|
6885
7018
|
*/
|
|
6886
7019
|
payment_communication?: string | null;
|
|
6887
7020
|
/**
|
|
6888
7021
|
* Customer Memo
|
|
6889
|
-
* @description
|
|
7022
|
+
* @description Customer note/memo
|
|
6890
7023
|
*/
|
|
6891
7024
|
customer_memo?: string | null;
|
|
7025
|
+
/** @description Journal */
|
|
7026
|
+
journal_ref?: components['schemas']['FieldRef'] | null;
|
|
7027
|
+
/** @description Specificities for Italy */
|
|
7028
|
+
italian_specificities?: components['schemas']['ItalianSpecificities-Input'] | null;
|
|
7029
|
+
};
|
|
7030
|
+
/** InvoiceItem */
|
|
7031
|
+
'InvoiceItem-Output': {
|
|
6892
7032
|
/**
|
|
6893
|
-
*
|
|
6894
|
-
* @description Technical
|
|
7033
|
+
* Id
|
|
7034
|
+
* @description Technical id in Chift
|
|
6895
7035
|
*/
|
|
6896
|
-
|
|
6897
|
-
/** @description
|
|
6898
|
-
|
|
6899
|
-
| components['schemas']['backbone_common__models__accounting__common__WithholdingTax']
|
|
6900
|
-
| null;
|
|
7036
|
+
id: string;
|
|
7037
|
+
/** @description Technical id in the target software */
|
|
7038
|
+
source_ref: components['schemas']['Ref'];
|
|
6901
7039
|
/**
|
|
6902
|
-
* Invoice
|
|
6903
|
-
*
|
|
6904
|
-
* @
|
|
7040
|
+
* Invoice Number
|
|
7041
|
+
* @description Number/sequence
|
|
7042
|
+
* @example INV-12345
|
|
6905
7043
|
*/
|
|
6906
|
-
|
|
7044
|
+
invoice_number: string | null;
|
|
6907
7045
|
/**
|
|
6908
|
-
*
|
|
6909
|
-
*
|
|
7046
|
+
* Creation Date
|
|
7047
|
+
* @description Creation date of the invoice
|
|
7048
|
+
* @example 2023-10-01T12:00:00
|
|
7049
|
+
*/
|
|
7050
|
+
creation_date?: string | null;
|
|
7051
|
+
/**
|
|
7052
|
+
* Closing Date
|
|
7053
|
+
* @description Closing date of the invoice
|
|
7054
|
+
* @example 2023-10-10T12:00:00
|
|
7055
|
+
*/
|
|
7056
|
+
closing_date?: string | null;
|
|
7057
|
+
/**
|
|
7058
|
+
* Partners
|
|
7059
|
+
* @description List of partners related to the invoice
|
|
7060
|
+
*/
|
|
7061
|
+
partners?: components['schemas']['InvoicePartnerItem'][] | null;
|
|
7062
|
+
};
|
|
7063
|
+
/** InvoiceItemDueDatesOut */
|
|
7064
|
+
InvoiceItemDueDatesOut: {
|
|
7065
|
+
/**
|
|
7066
|
+
* Due Date
|
|
7067
|
+
* Format: date
|
|
7068
|
+
* @description Due date of the item.
|
|
7069
|
+
*/
|
|
7070
|
+
due_date: string;
|
|
7071
|
+
/**
|
|
7072
|
+
* Payment Method
|
|
7073
|
+
* @description Payment method used to pay the invoice on that due date.
|
|
7074
|
+
*/
|
|
7075
|
+
payment_method?: string | null;
|
|
7076
|
+
/**
|
|
7077
|
+
* Payment Method Id
|
|
7078
|
+
* @description Technical ID of the payment method used to pay the invoice on that due date.
|
|
7079
|
+
*/
|
|
7080
|
+
payment_method_id?: string | null;
|
|
7081
|
+
/**
|
|
7082
|
+
* Amount
|
|
7083
|
+
* @description Amount due for the invoice on that due date. A positive amount represents debit on customer invoices and supplier refunds or credit on supplier invoices and customer refunds. A negative amount represents credit on customer invoices and supplier refunds or debit on supplier invoices and customer refunds.
|
|
7084
|
+
*/
|
|
7085
|
+
amount: number;
|
|
7086
|
+
};
|
|
7087
|
+
/** InvoiceItemInMonoAnalyticPlan */
|
|
7088
|
+
InvoiceItemInMonoAnalyticPlan: {
|
|
7089
|
+
/** @description Specifies the type of invoice */
|
|
7090
|
+
invoice_type: components['schemas']['backbone_common__models__accounting__common__InvoiceType'];
|
|
7091
|
+
/**
|
|
7092
|
+
* Invoice Number
|
|
7093
|
+
* @description Unique 'number' of the invoice instance in the accounting software. This is an internal reference number. if not specified, will be automatically generated according to the system’s numbering rules. It does not necessarily match the number displayed on an invoice.It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details
|
|
7094
|
+
*/
|
|
7095
|
+
invoice_number?: string | null;
|
|
7096
|
+
/**
|
|
7097
|
+
* Currency
|
|
7098
|
+
* @description Code (e.g., USD, EUR) of the currency used for invoice amounts.
|
|
7099
|
+
*/
|
|
7100
|
+
currency: string;
|
|
7101
|
+
/**
|
|
7102
|
+
* Untaxed Amount
|
|
7103
|
+
* @description Total amount of the invoice excluding taxes.
|
|
7104
|
+
*/
|
|
7105
|
+
untaxed_amount: number;
|
|
7106
|
+
/**
|
|
7107
|
+
* Tax Amount
|
|
7108
|
+
* @description Total amount of tax applied to the invoice
|
|
7109
|
+
*/
|
|
7110
|
+
tax_amount: number;
|
|
7111
|
+
/**
|
|
7112
|
+
* Total
|
|
7113
|
+
* @description Total amount of the invoice, including taxes (untaxed_amount + tax_amount).
|
|
7114
|
+
*/
|
|
7115
|
+
total: number;
|
|
7116
|
+
/**
|
|
7117
|
+
* Reference
|
|
7118
|
+
* @description Optional reference field used to store an external or contextual identifier related to the entry. For purchase invoices, it typically contains the invoice number issued by the supplier. For sales invoices, it may reference a quote number or any other relevant document. Unlike number, this field is not subject to specific format or character restrictions and can hold free-form text.
|
|
7119
|
+
*/
|
|
7120
|
+
reference?: string | null;
|
|
7121
|
+
/**
|
|
7122
|
+
* Payment Communication
|
|
7123
|
+
* @description Field containing the payment reference or communication associated with the invoice (e.g., bank transfer reference, SEPA remittance message). Often used for reconciliation purposes.
|
|
7124
|
+
*/
|
|
7125
|
+
payment_communication?: string | null;
|
|
7126
|
+
/**
|
|
7127
|
+
* Customer Memo
|
|
7128
|
+
* @description Internal or external note associated with the invoice, typically intended for the customer. Can include additional context, comments, or special instructions related to the transaction.
|
|
7129
|
+
*/
|
|
7130
|
+
customer_memo?: string | null;
|
|
7131
|
+
/**
|
|
7132
|
+
* Payment Term Id
|
|
7133
|
+
* @description Technical ID of the payment term associated with the invoice.
|
|
7134
|
+
*/
|
|
7135
|
+
payment_term_id?: string | null;
|
|
7136
|
+
/** @description Withholding tax information for the invoice. */
|
|
7137
|
+
withholding_tax?: components['schemas']['WithholdingTax'] | null;
|
|
7138
|
+
/**
|
|
7139
|
+
* Invoice Date
|
|
7140
|
+
* Format: date
|
|
7141
|
+
* @description Accounting date of the invoice (format: YYYY-MM-DD).
|
|
7142
|
+
*/
|
|
7143
|
+
invoice_date: string;
|
|
7144
|
+
/**
|
|
7145
|
+
* Due Date
|
|
7146
|
+
* Format: date
|
|
6910
7147
|
* @description Due date for payment or settlement (format: YYYY-MM-DD).
|
|
6911
7148
|
*/
|
|
6912
7149
|
due_date: string;
|
|
@@ -7015,9 +7252,7 @@ export interface components {
|
|
|
7015
7252
|
*/
|
|
7016
7253
|
payment_term_id?: string | null;
|
|
7017
7254
|
/** @description Withholding tax information for the invoice. */
|
|
7018
|
-
withholding_tax?:
|
|
7019
|
-
| components['schemas']['backbone_common__models__accounting__common__WithholdingTax']
|
|
7020
|
-
| null;
|
|
7255
|
+
withholding_tax?: components['schemas']['WithholdingTax'] | null;
|
|
7021
7256
|
/**
|
|
7022
7257
|
* Invoice Date
|
|
7023
7258
|
* Format: date
|
|
@@ -7100,7 +7335,7 @@ export interface components {
|
|
|
7100
7335
|
*/
|
|
7101
7336
|
currency: string;
|
|
7102
7337
|
/** @description Invoice type */
|
|
7103
|
-
invoice_type: components['schemas']['
|
|
7338
|
+
invoice_type: components['schemas']['InvoiceType'];
|
|
7104
7339
|
/** @description Status */
|
|
7105
7340
|
status: components['schemas']['InvoiceStatus'];
|
|
7106
7341
|
/**
|
|
@@ -7243,9 +7478,7 @@ export interface components {
|
|
|
7243
7478
|
*/
|
|
7244
7479
|
payment_term_id?: string | null;
|
|
7245
7480
|
/** @description Withholding tax information for the invoice. */
|
|
7246
|
-
withholding_tax?:
|
|
7247
|
-
| components['schemas']['backbone_common__models__accounting__common__WithholdingTax']
|
|
7248
|
-
| null;
|
|
7481
|
+
withholding_tax?: components['schemas']['WithholdingTax'] | null;
|
|
7249
7482
|
/** Id */
|
|
7250
7483
|
id?: string | null;
|
|
7251
7484
|
/**
|
|
@@ -7346,9 +7579,7 @@ export interface components {
|
|
|
7346
7579
|
*/
|
|
7347
7580
|
payment_term_id?: string | null;
|
|
7348
7581
|
/** @description Withholding tax information for the invoice. */
|
|
7349
|
-
withholding_tax?:
|
|
7350
|
-
| components['schemas']['backbone_common__models__accounting__common__WithholdingTax']
|
|
7351
|
-
| null;
|
|
7582
|
+
withholding_tax?: components['schemas']['WithholdingTax'] | null;
|
|
7352
7583
|
/** Id */
|
|
7353
7584
|
id?: string | null;
|
|
7354
7585
|
/**
|
|
@@ -7417,7 +7648,7 @@ export interface components {
|
|
|
7417
7648
|
*/
|
|
7418
7649
|
currency: string;
|
|
7419
7650
|
/** @description Invoice type */
|
|
7420
|
-
invoice_type: components['schemas']['
|
|
7651
|
+
invoice_type: components['schemas']['InvoiceType'];
|
|
7421
7652
|
/** @description Status */
|
|
7422
7653
|
status: components['schemas']['InvoiceStatus'];
|
|
7423
7654
|
/**
|
|
@@ -7990,6 +8221,16 @@ export interface components {
|
|
|
7990
8221
|
* @enum {string}
|
|
7991
8222
|
*/
|
|
7992
8223
|
InvoiceStatusOut: 'cancelled' | 'draft' | 'posted' | 'paid';
|
|
8224
|
+
/**
|
|
8225
|
+
* InvoiceType
|
|
8226
|
+
* @enum {string}
|
|
8227
|
+
*/
|
|
8228
|
+
InvoiceType:
|
|
8229
|
+
| 'customer_invoice'
|
|
8230
|
+
| 'customer_refund'
|
|
8231
|
+
| 'supplier_invoice'
|
|
8232
|
+
| 'supplier_refund'
|
|
8233
|
+
| 'all';
|
|
7993
8234
|
/** InvoicingBankAccountItem */
|
|
7994
8235
|
InvoicingBankAccountItem: {
|
|
7995
8236
|
/**
|
|
@@ -8085,7 +8326,7 @@ export interface components {
|
|
|
8085
8326
|
/** @description Technical id in the target software */
|
|
8086
8327
|
source_ref: components['schemas']['Ref'];
|
|
8087
8328
|
/** @description Payment status */
|
|
8088
|
-
status: components['schemas']['
|
|
8329
|
+
status: components['schemas']['PaymentStatus'];
|
|
8089
8330
|
/**
|
|
8090
8331
|
* Description
|
|
8091
8332
|
* @description Description
|
|
@@ -8168,7 +8409,7 @@ export interface components {
|
|
|
8168
8409
|
*/
|
|
8169
8410
|
rate: number;
|
|
8170
8411
|
/** @description Type */
|
|
8171
|
-
type: components['schemas']['
|
|
8412
|
+
type: components['schemas']['VatCodeType'];
|
|
8172
8413
|
/**
|
|
8173
8414
|
* Code
|
|
8174
8415
|
* @description Code
|
|
@@ -8178,9 +8419,7 @@ export interface components {
|
|
|
8178
8419
|
* @description Scope
|
|
8179
8420
|
* @default unknown
|
|
8180
8421
|
*/
|
|
8181
|
-
scope:
|
|
8182
|
-
| components['schemas']['backbone_common__models__accounting__common__VatCodeScope']
|
|
8183
|
-
| null;
|
|
8422
|
+
scope: components['schemas']['VatCodeScope'] | null;
|
|
8184
8423
|
/**
|
|
8185
8424
|
* Active
|
|
8186
8425
|
* @description Is the tax active?
|
|
@@ -8900,6 +9139,11 @@ export interface components {
|
|
|
8900
9139
|
* @enum {string}
|
|
8901
9140
|
*/
|
|
8902
9141
|
MiscellaneousOperationStatusOut: 'cancelled' | 'draft' | 'posted' | 'matched';
|
|
9142
|
+
/**
|
|
9143
|
+
* Mode
|
|
9144
|
+
* @enum {string}
|
|
9145
|
+
*/
|
|
9146
|
+
Mode: 'EAT_IN' | 'TAKEAWAY' | 'DELIVERY';
|
|
8903
9147
|
/** MultipleMatchingIn */
|
|
8904
9148
|
MultipleMatchingIn: {
|
|
8905
9149
|
/** Matchings */
|
|
@@ -9121,12 +9365,8 @@ export interface components {
|
|
|
9121
9365
|
/** Order Number */
|
|
9122
9366
|
order_number?: string | null;
|
|
9123
9367
|
customer?: components['schemas']['OrderCustomerItemOut'] | null;
|
|
9124
|
-
billing_address?:
|
|
9125
|
-
|
|
9126
|
-
| null;
|
|
9127
|
-
shipping_address?:
|
|
9128
|
-
| components['schemas']['backbone_common__models__commerce__common__AddressItemOut']
|
|
9129
|
-
| null;
|
|
9368
|
+
billing_address?: components['schemas']['AddressItemOut'] | null;
|
|
9369
|
+
shipping_address?: components['schemas']['AddressItemOut'] | null;
|
|
9130
9370
|
/** Created On */
|
|
9131
9371
|
created_on?: string | null;
|
|
9132
9372
|
/** Last Updated On */
|
|
@@ -9308,9 +9548,7 @@ export interface components {
|
|
|
9308
9548
|
* Discounts
|
|
9309
9549
|
* @default []
|
|
9310
9550
|
*/
|
|
9311
|
-
discounts:
|
|
9312
|
-
| components['schemas']['backbone_common__models__commerce__common__DiscountItem'][]
|
|
9313
|
-
| null;
|
|
9551
|
+
discounts: components['schemas']['DiscountItem'][] | null;
|
|
9314
9552
|
/**
|
|
9315
9553
|
* Gift Card
|
|
9316
9554
|
* @default false
|
|
@@ -9337,9 +9575,7 @@ export interface components {
|
|
|
9337
9575
|
* Categories
|
|
9338
9576
|
* @default []
|
|
9339
9577
|
*/
|
|
9340
|
-
categories:
|
|
9341
|
-
| components['schemas']['backbone_common__models__commerce__common__ProductCategoryItem'][]
|
|
9342
|
-
| null;
|
|
9578
|
+
categories: components['schemas']['ProductCategoryItem'][] | null;
|
|
9343
9579
|
};
|
|
9344
9580
|
/** OrderPaymentMethods */
|
|
9345
9581
|
OrderPaymentMethods: {
|
|
@@ -9865,6 +10101,11 @@ export interface components {
|
|
|
9865
10101
|
* @example 1
|
|
9866
10102
|
*/
|
|
9867
10103
|
delivery_fee: number | null;
|
|
10104
|
+
/**
|
|
10105
|
+
* @description Delivery Mode
|
|
10106
|
+
* @example eat_in
|
|
10107
|
+
*/
|
|
10108
|
+
mode?: components['schemas']['Mode'] | null;
|
|
9868
10109
|
/**
|
|
9869
10110
|
* Currency
|
|
9870
10111
|
* @description Currency of the order
|
|
@@ -9923,9 +10164,7 @@ export interface components {
|
|
|
9923
10164
|
* Bills
|
|
9924
10165
|
* @description Reference to the bills related to this order
|
|
9925
10166
|
*/
|
|
9926
|
-
bills?:
|
|
9927
|
-
| components['schemas']['backbone_common__models__pms__common__InvoiceItem'][]
|
|
9928
|
-
| null;
|
|
10167
|
+
bills?: components['schemas']['InvoiceItem-Output'][] | null;
|
|
9929
10168
|
};
|
|
9930
10169
|
/** PMSOrderLineItem */
|
|
9931
10170
|
PMSOrderLineItem: {
|
|
@@ -10427,6 +10666,11 @@ export interface components {
|
|
|
10427
10666
|
* @example 1
|
|
10428
10667
|
*/
|
|
10429
10668
|
delivery_fee: number | null;
|
|
10669
|
+
/**
|
|
10670
|
+
* @description Delivery Mode
|
|
10671
|
+
* @example eat_in
|
|
10672
|
+
*/
|
|
10673
|
+
mode?: components['schemas']['Mode'] | null;
|
|
10430
10674
|
/**
|
|
10431
10675
|
* Currency
|
|
10432
10676
|
* @description Currency of the order
|
|
@@ -10563,7 +10807,7 @@ export interface components {
|
|
|
10563
10807
|
* Prices
|
|
10564
10808
|
* @description List of prices for the product
|
|
10565
10809
|
*/
|
|
10566
|
-
prices: components['schemas']['
|
|
10810
|
+
prices: components['schemas']['ProductPriceItem'][];
|
|
10567
10811
|
/**
|
|
10568
10812
|
* Accounting Category Ids
|
|
10569
10813
|
* @description Used by a POS to give one or more specific accounting categories to a product item. If not available it will use the category ids
|
|
@@ -10693,6 +10937,11 @@ export interface components {
|
|
|
10693
10937
|
addresses:
|
|
10694
10938
|
| components['schemas']['backbone_common__models__common__AddressItemOut'][]
|
|
10695
10939
|
| null;
|
|
10940
|
+
/**
|
|
10941
|
+
* Third Party Account
|
|
10942
|
+
* @description Third party account number/code representing the client in the accounting software.
|
|
10943
|
+
*/
|
|
10944
|
+
third_party_account?: string | null;
|
|
10696
10945
|
};
|
|
10697
10946
|
/**
|
|
10698
10947
|
* PartnerType
|
|
@@ -10716,9 +10965,7 @@ export interface components {
|
|
|
10716
10965
|
* Credentials
|
|
10717
10966
|
* @description Can be used to update the credentials of an existing connection. Please use the getIntegrations route to see the available credentials for each integration
|
|
10718
10967
|
*/
|
|
10719
|
-
credentials?:
|
|
10720
|
-
| components['schemas']['backbone_api__app__routers__connections__CredentialItem'][]
|
|
10721
|
-
| null;
|
|
10968
|
+
credentials?: components['schemas']['CredentialItem-Input'][] | null;
|
|
10722
10969
|
};
|
|
10723
10970
|
/** Payment */
|
|
10724
10971
|
Payment: {
|
|
@@ -10769,7 +11016,7 @@ export interface components {
|
|
|
10769
11016
|
/** @description Technical id in the target software */
|
|
10770
11017
|
source_ref: components['schemas']['Ref'];
|
|
10771
11018
|
/** @description Payment status */
|
|
10772
|
-
status: components['schemas']['
|
|
11019
|
+
status: components['schemas']['PaymentStatus'];
|
|
10773
11020
|
/**
|
|
10774
11021
|
* Description
|
|
10775
11022
|
* @description Description
|
|
@@ -10872,6 +11119,23 @@ export interface components {
|
|
|
10872
11119
|
| 'MP21'
|
|
10873
11120
|
| 'MP22'
|
|
10874
11121
|
| 'MP23';
|
|
11122
|
+
/**
|
|
11123
|
+
* PaymentStatus
|
|
11124
|
+
* @enum {string}
|
|
11125
|
+
*/
|
|
11126
|
+
PaymentStatus:
|
|
11127
|
+
| 'pending'
|
|
11128
|
+
| 'completed'
|
|
11129
|
+
| 'partially_completed'
|
|
11130
|
+
| 'canceled'
|
|
11131
|
+
| 'failed'
|
|
11132
|
+
| 'unknown'
|
|
11133
|
+
| 'authorized';
|
|
11134
|
+
/**
|
|
11135
|
+
* PaymentStatus
|
|
11136
|
+
* @enum {string}
|
|
11137
|
+
*/
|
|
11138
|
+
'PaymentStatus-Input': 'all' | 'unpaid' | 'paid';
|
|
10875
11139
|
/** PaymentTermAccountInfo */
|
|
10876
11140
|
PaymentTermAccountInfo: {
|
|
10877
11141
|
/**
|
|
@@ -10930,6 +11194,46 @@ export interface components {
|
|
|
10930
11194
|
*/
|
|
10931
11195
|
country?: string | null;
|
|
10932
11196
|
};
|
|
11197
|
+
/** PostConnectionItem */
|
|
11198
|
+
'PostConnectionItem-Input': {
|
|
11199
|
+
/**
|
|
11200
|
+
* Integrationid
|
|
11201
|
+
* @description Can be used to specify the integration code of a specific connector. If specified, the url will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
11202
|
+
*/
|
|
11203
|
+
integrationid?: number | null;
|
|
11204
|
+
/**
|
|
11205
|
+
* Name
|
|
11206
|
+
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
11207
|
+
*/
|
|
11208
|
+
name?: string | null;
|
|
11209
|
+
/**
|
|
11210
|
+
* Credentials
|
|
11211
|
+
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
11212
|
+
*/
|
|
11213
|
+
credentials?: components['schemas']['CredentialItem-Input'][] | null;
|
|
11214
|
+
/**
|
|
11215
|
+
* Country
|
|
11216
|
+
* @description ISO 3166-1 alpha-2 country code to filter connectors by country. Ignored if integrationid is provided.
|
|
11217
|
+
*/
|
|
11218
|
+
country?: string | null;
|
|
11219
|
+
/**
|
|
11220
|
+
* Redirect
|
|
11221
|
+
* @description Indicates whether you want to return to the consumer's redirectUrl after creation (true) or whether you want to stay on the connection selection page (false)(This field is ignored if integrationid is provided)
|
|
11222
|
+
* @default false
|
|
11223
|
+
*/
|
|
11224
|
+
redirect: boolean | null;
|
|
11225
|
+
};
|
|
11226
|
+
/** PostConnectionItem */
|
|
11227
|
+
'PostConnectionItem-Output': {
|
|
11228
|
+
/** Id */
|
|
11229
|
+
id: string;
|
|
11230
|
+
/** Title */
|
|
11231
|
+
title: string;
|
|
11232
|
+
/** Optional */
|
|
11233
|
+
optional: boolean;
|
|
11234
|
+
/** Resource */
|
|
11235
|
+
resource: string;
|
|
11236
|
+
};
|
|
10933
11237
|
/** PostConsumerItem */
|
|
10934
11238
|
PostConsumerItem: {
|
|
10935
11239
|
/**
|
|
@@ -10993,6 +11297,16 @@ export interface components {
|
|
|
10993
11297
|
} & {
|
|
10994
11298
|
[key: string]: unknown;
|
|
10995
11299
|
};
|
|
11300
|
+
/** ProductCategoryItem */
|
|
11301
|
+
ProductCategoryItem: {
|
|
11302
|
+
/**
|
|
11303
|
+
* Id
|
|
11304
|
+
* @description Technical id of the category in Chift
|
|
11305
|
+
*/
|
|
11306
|
+
id: string;
|
|
11307
|
+
/** Name */
|
|
11308
|
+
name: string;
|
|
11309
|
+
};
|
|
10996
11310
|
/** ProductCostItem */
|
|
10997
11311
|
ProductCostItem: {
|
|
10998
11312
|
/** Amount */
|
|
@@ -11000,15 +11314,8 @@ export interface components {
|
|
|
11000
11314
|
/** Currency */
|
|
11001
11315
|
currency: string;
|
|
11002
11316
|
};
|
|
11003
|
-
/**
|
|
11004
|
-
|
|
11005
|
-
/**
|
|
11006
|
-
* Id
|
|
11007
|
-
* @description Technical id in Chift
|
|
11008
|
-
*/
|
|
11009
|
-
id: string;
|
|
11010
|
-
/** @description Technical id in the target software */
|
|
11011
|
-
source_ref: components['schemas']['Ref'];
|
|
11317
|
+
/** ProductItem */
|
|
11318
|
+
'ProductItem-Input': {
|
|
11012
11319
|
/**
|
|
11013
11320
|
* Name
|
|
11014
11321
|
* @description Name
|
|
@@ -11055,20 +11362,9 @@ export interface components {
|
|
|
11055
11362
|
* @default 0
|
|
11056
11363
|
*/
|
|
11057
11364
|
cost: number | null;
|
|
11058
|
-
/**
|
|
11059
|
-
* Available Quantity
|
|
11060
|
-
* @description Available quanity of the product in stock. Will only be used for products that have an inventory (services will always be 0)
|
|
11061
|
-
* @default 0
|
|
11062
|
-
*/
|
|
11063
|
-
available_quantity: number | null;
|
|
11064
11365
|
};
|
|
11065
|
-
/**
|
|
11066
|
-
|
|
11067
|
-
* @enum {string}
|
|
11068
|
-
*/
|
|
11069
|
-
ProductStatus: 'unknown' | 'archived' | 'unpublished' | 'published';
|
|
11070
|
-
/** ProductVariantItem */
|
|
11071
|
-
ProductVariantItem: {
|
|
11366
|
+
/** ProductItem */
|
|
11367
|
+
'ProductItem-Output': {
|
|
11072
11368
|
/**
|
|
11073
11369
|
* Id
|
|
11074
11370
|
* @description Technical id in Chift
|
|
@@ -11076,11 +11372,6 @@ export interface components {
|
|
|
11076
11372
|
id: string;
|
|
11077
11373
|
/** @description Technical id in the target software */
|
|
11078
11374
|
source_ref: components['schemas']['Ref'];
|
|
11079
|
-
/**
|
|
11080
|
-
* Parent Id
|
|
11081
|
-
* @description Technical id of the parent product in Chift
|
|
11082
|
-
*/
|
|
11083
|
-
parent_id: string;
|
|
11084
11375
|
/** Name */
|
|
11085
11376
|
name: string;
|
|
11086
11377
|
/** Description */
|
|
@@ -11091,36 +11382,173 @@ export interface components {
|
|
|
11091
11382
|
* Categories
|
|
11092
11383
|
* @default []
|
|
11093
11384
|
*/
|
|
11094
|
-
categories:
|
|
11095
|
-
| components['schemas']['backbone_common__models__commerce__common__ProductCategoryItem'][]
|
|
11096
|
-
| null;
|
|
11385
|
+
categories: components['schemas']['ProductCategoryItem'][] | null;
|
|
11097
11386
|
/** Created On */
|
|
11098
11387
|
created_on?: string | null;
|
|
11388
|
+
/** Last Updated On */
|
|
11389
|
+
last_updated_on?: string | null;
|
|
11390
|
+
/**
|
|
11391
|
+
* Variants
|
|
11392
|
+
* @default []
|
|
11393
|
+
*/
|
|
11394
|
+
variants: components['schemas']['ProductVariantItem'][] | null;
|
|
11395
|
+
status?: components['schemas']['ProductStatus'] | null;
|
|
11099
11396
|
/** Sku */
|
|
11100
11397
|
sku?: string | null;
|
|
11101
|
-
/** Barcode */
|
|
11102
|
-
barcode?: string | null;
|
|
11103
11398
|
/**
|
|
11104
|
-
*
|
|
11105
|
-
* @
|
|
11399
|
+
* Common Attributes
|
|
11400
|
+
* @description List of attributes that are shared by all variants of the product.
|
|
11401
|
+
* @default []
|
|
11106
11402
|
*/
|
|
11107
|
-
|
|
11403
|
+
common_attributes: components['schemas']['CommonAttributeItem'][] | null;
|
|
11108
11404
|
/**
|
|
11109
|
-
*
|
|
11405
|
+
* Variant Attributes Options
|
|
11110
11406
|
* @default []
|
|
11111
11407
|
*/
|
|
11112
|
-
|
|
11113
|
-
| components['schemas']['
|
|
11408
|
+
variant_attributes_options:
|
|
11409
|
+
| components['schemas']['VariantAttributeOptionItem'][]
|
|
11114
11410
|
| null;
|
|
11115
|
-
unit_cost?: components['schemas']['ProductCostItem'] | null;
|
|
11116
|
-
/** Unit Of Measure */
|
|
11117
|
-
unit_of_measure?: string | null;
|
|
11118
11411
|
/**
|
|
11119
|
-
*
|
|
11120
|
-
* @
|
|
11412
|
+
* Common Images
|
|
11413
|
+
* @description List of images that are shared by all variants of the product.
|
|
11414
|
+
* @default []
|
|
11121
11415
|
*/
|
|
11122
|
-
|
|
11123
|
-
|
|
11416
|
+
common_images: components['schemas']['ImageItem'][] | null;
|
|
11417
|
+
};
|
|
11418
|
+
/** ProductItemOut */
|
|
11419
|
+
ProductItemOut: {
|
|
11420
|
+
/**
|
|
11421
|
+
* Id
|
|
11422
|
+
* @description Technical id in Chift
|
|
11423
|
+
*/
|
|
11424
|
+
id: string;
|
|
11425
|
+
/** @description Technical id in the target software */
|
|
11426
|
+
source_ref: components['schemas']['Ref'];
|
|
11427
|
+
/**
|
|
11428
|
+
* Name
|
|
11429
|
+
* @description Name
|
|
11430
|
+
*/
|
|
11431
|
+
name: string;
|
|
11432
|
+
/**
|
|
11433
|
+
* Unit Price
|
|
11434
|
+
* @description Unit price
|
|
11435
|
+
*/
|
|
11436
|
+
unit_price?: number | null;
|
|
11437
|
+
/**
|
|
11438
|
+
* Tax Id
|
|
11439
|
+
* @description Technical id of the tax in Chift
|
|
11440
|
+
*/
|
|
11441
|
+
tax_id?: string | null;
|
|
11442
|
+
/**
|
|
11443
|
+
* Code
|
|
11444
|
+
* @description Reference/code
|
|
11445
|
+
*/
|
|
11446
|
+
code?: string | null;
|
|
11447
|
+
/**
|
|
11448
|
+
* Unit
|
|
11449
|
+
* @description Unit of measure matching target software name
|
|
11450
|
+
*/
|
|
11451
|
+
unit?: string | null;
|
|
11452
|
+
/**
|
|
11453
|
+
* Category
|
|
11454
|
+
* @description Category matching target software name
|
|
11455
|
+
*/
|
|
11456
|
+
category?: string | null;
|
|
11457
|
+
/**
|
|
11458
|
+
* Currency
|
|
11459
|
+
* @description Currency matching target software name
|
|
11460
|
+
*/
|
|
11461
|
+
currency?: string | null;
|
|
11462
|
+
/**
|
|
11463
|
+
* Description
|
|
11464
|
+
* @description Description
|
|
11465
|
+
*/
|
|
11466
|
+
description?: string | null;
|
|
11467
|
+
/**
|
|
11468
|
+
* Cost
|
|
11469
|
+
* @description Cost of the product
|
|
11470
|
+
* @default 0
|
|
11471
|
+
*/
|
|
11472
|
+
cost: number | null;
|
|
11473
|
+
/**
|
|
11474
|
+
* Available Quantity
|
|
11475
|
+
* @description Available quanity of the product in stock. Will only be used for products that have an inventory (services will always be 0)
|
|
11476
|
+
* @default 0
|
|
11477
|
+
*/
|
|
11478
|
+
available_quantity: number | null;
|
|
11479
|
+
};
|
|
11480
|
+
/** ProductPriceItem */
|
|
11481
|
+
ProductPriceItem: {
|
|
11482
|
+
/**
|
|
11483
|
+
* Unit Price
|
|
11484
|
+
* @description Unit price (without tax) of the product
|
|
11485
|
+
* @example 10
|
|
11486
|
+
*/
|
|
11487
|
+
unit_price: number;
|
|
11488
|
+
/**
|
|
11489
|
+
* Tax Rate
|
|
11490
|
+
* @description Tax rate applied to the product
|
|
11491
|
+
* @example 10
|
|
11492
|
+
*/
|
|
11493
|
+
tax_rate?: number | null;
|
|
11494
|
+
};
|
|
11495
|
+
/**
|
|
11496
|
+
* ProductStatus
|
|
11497
|
+
* @enum {string}
|
|
11498
|
+
*/
|
|
11499
|
+
ProductStatus: 'unknown' | 'archived' | 'unpublished' | 'published';
|
|
11500
|
+
/** ProductVariantItem */
|
|
11501
|
+
ProductVariantItem: {
|
|
11502
|
+
/**
|
|
11503
|
+
* Id
|
|
11504
|
+
* @description Technical id in Chift
|
|
11505
|
+
*/
|
|
11506
|
+
id: string;
|
|
11507
|
+
/** @description Technical id in the target software */
|
|
11508
|
+
source_ref: components['schemas']['Ref'];
|
|
11509
|
+
/**
|
|
11510
|
+
* Parent Id
|
|
11511
|
+
* @description Technical id of the parent product in Chift
|
|
11512
|
+
*/
|
|
11513
|
+
parent_id: string;
|
|
11514
|
+
/** Name */
|
|
11515
|
+
name: string;
|
|
11516
|
+
/** Description */
|
|
11517
|
+
description?: string | null;
|
|
11518
|
+
/** Description Html */
|
|
11519
|
+
description_html?: string | null;
|
|
11520
|
+
/**
|
|
11521
|
+
* Categories
|
|
11522
|
+
* @default []
|
|
11523
|
+
*/
|
|
11524
|
+
categories: components['schemas']['ProductCategoryItem'][] | null;
|
|
11525
|
+
/** Created On */
|
|
11526
|
+
created_on?: string | null;
|
|
11527
|
+
/** Sku */
|
|
11528
|
+
sku?: string | null;
|
|
11529
|
+
/** Barcode */
|
|
11530
|
+
barcode?: string | null;
|
|
11531
|
+
/**
|
|
11532
|
+
* Available Quantity
|
|
11533
|
+
* @default 0
|
|
11534
|
+
*/
|
|
11535
|
+
available_quantity: number | null;
|
|
11536
|
+
/**
|
|
11537
|
+
* Prices
|
|
11538
|
+
* @default []
|
|
11539
|
+
*/
|
|
11540
|
+
prices:
|
|
11541
|
+
| components['schemas']['backbone_common__models__commerce__common__ProductPriceItem'][]
|
|
11542
|
+
| null;
|
|
11543
|
+
unit_cost?: components['schemas']['ProductCostItem'] | null;
|
|
11544
|
+
/** Unit Of Measure */
|
|
11545
|
+
unit_of_measure?: string | null;
|
|
11546
|
+
/**
|
|
11547
|
+
* Weight
|
|
11548
|
+
* @default 0
|
|
11549
|
+
*/
|
|
11550
|
+
weight: number | null;
|
|
11551
|
+
/** Weight Unit */
|
|
11124
11552
|
weight_unit?: string | null;
|
|
11125
11553
|
status?: components['schemas']['ProductStatus'] | null;
|
|
11126
11554
|
/**
|
|
@@ -11200,7 +11628,7 @@ export interface components {
|
|
|
11200
11628
|
}[];
|
|
11201
11629
|
} | null;
|
|
11202
11630
|
/** Connections */
|
|
11203
|
-
connections: components['schemas']['
|
|
11631
|
+
connections: components['schemas']['ConnectionItem'][];
|
|
11204
11632
|
/**
|
|
11205
11633
|
* Mappings
|
|
11206
11634
|
* @default []
|
|
@@ -11284,7 +11712,7 @@ export interface components {
|
|
|
11284
11712
|
/** @description Technical id in the target software */
|
|
11285
11713
|
source_ref: components['schemas']['Ref'];
|
|
11286
11714
|
/** @description Payment status */
|
|
11287
|
-
status: components['schemas']['
|
|
11715
|
+
status: components['schemas']['PaymentStatus'];
|
|
11288
11716
|
/**
|
|
11289
11717
|
* Description
|
|
11290
11718
|
* @description Description
|
|
@@ -11494,6 +11922,11 @@ export interface components {
|
|
|
11494
11922
|
* @enum {string}
|
|
11495
11923
|
*/
|
|
11496
11924
|
States: 'open' | 'closed' | 'all';
|
|
11925
|
+
/**
|
|
11926
|
+
* Status
|
|
11927
|
+
* @enum {string}
|
|
11928
|
+
*/
|
|
11929
|
+
Status: 'active' | 'inactive';
|
|
11497
11930
|
/** SupplierItemIn */
|
|
11498
11931
|
SupplierItemIn: {
|
|
11499
11932
|
/**
|
|
@@ -11592,7 +12025,7 @@ export interface components {
|
|
|
11592
12025
|
* Addresses
|
|
11593
12026
|
* @description List of addresses associated with the supplier.
|
|
11594
12027
|
*/
|
|
11595
|
-
addresses: components['schemas']['
|
|
12028
|
+
addresses: components['schemas']['AddressItemIn'][];
|
|
11596
12029
|
/**
|
|
11597
12030
|
* Account Number
|
|
11598
12031
|
* @description Number of ledger account assigned to the supplier in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.). This is typically the ledger account used for posting payables. In some systems, each supplier has a dedicated account; in others, a shared control account is used and supplier balances are tracked in a subledger.
|
|
@@ -11721,6 +12154,11 @@ export interface components {
|
|
|
11721
12154
|
addresses:
|
|
11722
12155
|
| components['schemas']['backbone_common__models__common__AddressItemOut'][]
|
|
11723
12156
|
| null;
|
|
12157
|
+
/**
|
|
12158
|
+
* Third Party Account
|
|
12159
|
+
* @description Third party account number/code representing the client in the accounting software.
|
|
12160
|
+
*/
|
|
12161
|
+
third_party_account?: string | null;
|
|
11724
12162
|
};
|
|
11725
12163
|
/** SupplierItemUpdate */
|
|
11726
12164
|
SupplierItemUpdate: {
|
|
@@ -11821,9 +12259,7 @@ export interface components {
|
|
|
11821
12259
|
* @description List of addresses associated with the supplier.
|
|
11822
12260
|
* @default []
|
|
11823
12261
|
*/
|
|
11824
|
-
addresses:
|
|
11825
|
-
| components['schemas']['backbone_common__models__common__AddressItemOut'][]
|
|
11826
|
-
| null;
|
|
12262
|
+
addresses: components['schemas']['AddressItemOut-Input'][] | null;
|
|
11827
12263
|
};
|
|
11828
12264
|
/** SyncConsumerItem */
|
|
11829
12265
|
SyncConsumerItem: {
|
|
@@ -11897,12 +12333,12 @@ export interface components {
|
|
|
11897
12333
|
tax_amount: number;
|
|
11898
12334
|
/**
|
|
11899
12335
|
* Vat Account
|
|
11900
|
-
* @description VAT account of the tax line. This is the account number used to book the tax amount. The account is mandatory if tax amount is different from 0
|
|
12336
|
+
* @description VAT ledger account of the tax line. This is the ledger account number used to book the tax amount. The account is mandatory if tax amount is different from 0. The ledger account will ONLY be used when it is mandatory to pass this information to the accounting software.
|
|
11901
12337
|
*/
|
|
11902
12338
|
vat_account?: string | null;
|
|
11903
12339
|
/**
|
|
11904
12340
|
* Reversed Vat Account
|
|
11905
|
-
* @description Reversed VAT account of the tax line. This is the account number used to book the reversed tax amount. The account is mandatory if you are using a reversed VAT code.
|
|
12341
|
+
* @description Reversed VAT ledger account of the tax line. This is the ledger account number used to book the reversed tax amount. The account is mandatory if you are using a reversed VAT code. The ledger account will ONLY be used when it is mandatory to pass this information to the accounting software.
|
|
11906
12342
|
*/
|
|
11907
12343
|
reversed_vat_account?: string | null;
|
|
11908
12344
|
/**
|
|
@@ -12026,6 +12462,11 @@ export interface components {
|
|
|
12026
12462
|
/** Payment Id */
|
|
12027
12463
|
payment_id?: string | null;
|
|
12028
12464
|
};
|
|
12465
|
+
/**
|
|
12466
|
+
* TransactionStatus
|
|
12467
|
+
* @enum {string}
|
|
12468
|
+
*/
|
|
12469
|
+
TransactionStatus: 'pending' | 'declined' | 'completed';
|
|
12029
12470
|
/**
|
|
12030
12471
|
* TriggerPriority
|
|
12031
12472
|
* @enum {string}
|
|
@@ -12110,9 +12551,7 @@ export interface components {
|
|
|
12110
12551
|
*/
|
|
12111
12552
|
currency?: string | null;
|
|
12112
12553
|
/** @description Invoice type of the uploaded document */
|
|
12113
|
-
invoice_type?:
|
|
12114
|
-
| components['schemas']['backbone_common__models__invoicing__common__InvoiceType']
|
|
12115
|
-
| null;
|
|
12554
|
+
invoice_type?: components['schemas']['InvoiceType'] | null;
|
|
12116
12555
|
/** @description Status of the uploaded document */
|
|
12117
12556
|
status?: components['schemas']['InvoiceStatus'] | null;
|
|
12118
12557
|
/**
|
|
@@ -12251,9 +12690,7 @@ export interface components {
|
|
|
12251
12690
|
* Categories
|
|
12252
12691
|
* @default []
|
|
12253
12692
|
*/
|
|
12254
|
-
categories:
|
|
12255
|
-
| components['schemas']['backbone_common__models__commerce__common__ProductCategoryItem'][]
|
|
12256
|
-
| null;
|
|
12693
|
+
categories: components['schemas']['ProductCategoryItem'][] | null;
|
|
12257
12694
|
/** Created On */
|
|
12258
12695
|
created_on?: string | null;
|
|
12259
12696
|
/** Sku */
|
|
@@ -12313,6 +12750,16 @@ export interface components {
|
|
|
12313
12750
|
*/
|
|
12314
12751
|
variant_images: components['schemas']['ImageItem'][] | null;
|
|
12315
12752
|
};
|
|
12753
|
+
/**
|
|
12754
|
+
* VatCodeScope
|
|
12755
|
+
* @enum {string}
|
|
12756
|
+
*/
|
|
12757
|
+
VatCodeScope: 'nat' | 'eu' | 'int' | 'unknown';
|
|
12758
|
+
/**
|
|
12759
|
+
* VatCodeType
|
|
12760
|
+
* @enum {string}
|
|
12761
|
+
*/
|
|
12762
|
+
VatCodeType: 'sale' | 'purchase' | 'both' | 'unknown';
|
|
12316
12763
|
/** WebhookInstanceGetItem */
|
|
12317
12764
|
WebhookInstanceGetItem: {
|
|
12318
12765
|
/**
|
|
@@ -12336,15 +12783,13 @@ export interface components {
|
|
|
12336
12783
|
event: string;
|
|
12337
12784
|
/** Url */
|
|
12338
12785
|
url: string;
|
|
12339
|
-
status: components['schemas']['
|
|
12786
|
+
status: components['schemas']['Status'];
|
|
12340
12787
|
/** Integrationid */
|
|
12341
12788
|
integrationid?: number | null;
|
|
12342
12789
|
};
|
|
12343
12790
|
/** WebhookInstancePatchItem */
|
|
12344
12791
|
WebhookInstancePatchItem: {
|
|
12345
|
-
status?:
|
|
12346
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
12347
|
-
| null;
|
|
12792
|
+
status?: components['schemas']['Status'] | null;
|
|
12348
12793
|
/** Url */
|
|
12349
12794
|
url?: string | null;
|
|
12350
12795
|
/** Signingsecret */
|
|
@@ -12441,6 +12886,24 @@ export interface components {
|
|
|
12441
12886
|
| 'TC20'
|
|
12442
12887
|
| 'TC21'
|
|
12443
12888
|
| 'TC22';
|
|
12889
|
+
/** WithholdingTax */
|
|
12890
|
+
WithholdingTax: {
|
|
12891
|
+
/**
|
|
12892
|
+
* Tax Rate
|
|
12893
|
+
* @description Rate of the withholding tax. Normal withholding tax should have a negative tax rate.
|
|
12894
|
+
*/
|
|
12895
|
+
tax_rate: number;
|
|
12896
|
+
/**
|
|
12897
|
+
* Tax Code
|
|
12898
|
+
* @description Tax code of the withholding tax. This is the Id of the Tax Code in the accounting software.
|
|
12899
|
+
*/
|
|
12900
|
+
tax_code: string;
|
|
12901
|
+
/**
|
|
12902
|
+
* Tax Amount
|
|
12903
|
+
* @description Amount of the withholding tax. This is the amount of the withholding tax that will be applied to the invoice. It should be negative for normal withholding tax.
|
|
12904
|
+
*/
|
|
12905
|
+
tax_amount: number;
|
|
12906
|
+
};
|
|
12444
12907
|
/**
|
|
12445
12908
|
* WithholdingTaxPaymentReason
|
|
12446
12909
|
* @enum {string}
|
|
@@ -12501,91 +12964,10 @@ export interface components {
|
|
|
12501
12964
|
data?: {
|
|
12502
12965
|
[key: string]: unknown;
|
|
12503
12966
|
} | null;
|
|
12504
|
-
status: components['schemas']['
|
|
12967
|
+
status: components['schemas']['Status'];
|
|
12505
12968
|
/** @description For local agent only. Indicates whether the local agent is up and running */
|
|
12506
12969
|
agent?: components['schemas']['LocalAgentInfo'] | null;
|
|
12507
12970
|
};
|
|
12508
|
-
/** CredentialItem */
|
|
12509
|
-
backbone_api__app__routers__connections__CredentialItem: {
|
|
12510
|
-
/** Key */
|
|
12511
|
-
key: string;
|
|
12512
|
-
/** Value */
|
|
12513
|
-
value: string;
|
|
12514
|
-
};
|
|
12515
|
-
/** PostConnectionItem */
|
|
12516
|
-
backbone_api__app__routers__connections__PostConnectionItem: {
|
|
12517
|
-
/**
|
|
12518
|
-
* Integrationid
|
|
12519
|
-
* @description Can be used to specify the integration code of a specific connector. If specified, the url will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
12520
|
-
*/
|
|
12521
|
-
integrationid?: number | null;
|
|
12522
|
-
/**
|
|
12523
|
-
* Name
|
|
12524
|
-
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
12525
|
-
*/
|
|
12526
|
-
name?: string | null;
|
|
12527
|
-
/**
|
|
12528
|
-
* Credentials
|
|
12529
|
-
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
12530
|
-
*/
|
|
12531
|
-
credentials?:
|
|
12532
|
-
| components['schemas']['backbone_api__app__routers__connections__CredentialItem'][]
|
|
12533
|
-
| null;
|
|
12534
|
-
/**
|
|
12535
|
-
* Country
|
|
12536
|
-
* @description ISO 3166-1 alpha-2 country code to filter connectors by country. Ignored if integrationid is provided.
|
|
12537
|
-
*/
|
|
12538
|
-
country?: string | null;
|
|
12539
|
-
/**
|
|
12540
|
-
* Redirect
|
|
12541
|
-
* @description Indicates whether you want to return to the consumer's redirectUrl after creation (true) or whether you want to stay on the connection selection page (false)(This field is ignored if integrationid is provided)
|
|
12542
|
-
* @default false
|
|
12543
|
-
*/
|
|
12544
|
-
redirect: boolean | null;
|
|
12545
|
-
};
|
|
12546
|
-
/** CredentialItem */
|
|
12547
|
-
backbone_api__app__routers__integrations__CredentialItem: {
|
|
12548
|
-
/** Name */
|
|
12549
|
-
name: string;
|
|
12550
|
-
/**
|
|
12551
|
-
* Optional
|
|
12552
|
-
* @default false
|
|
12553
|
-
*/
|
|
12554
|
-
optional: boolean;
|
|
12555
|
-
};
|
|
12556
|
-
/** PostConnectionItem */
|
|
12557
|
-
backbone_api__app__routers__integrations__PostConnectionItem: {
|
|
12558
|
-
/** Id */
|
|
12559
|
-
id: string;
|
|
12560
|
-
/** Title */
|
|
12561
|
-
title: string;
|
|
12562
|
-
/** Optional */
|
|
12563
|
-
optional: boolean;
|
|
12564
|
-
/** Resource */
|
|
12565
|
-
resource: string;
|
|
12566
|
-
};
|
|
12567
|
-
/**
|
|
12568
|
-
* Status
|
|
12569
|
-
* @enum {string}
|
|
12570
|
-
*/
|
|
12571
|
-
backbone_api__app__routers__integrations__Status: 'active' | 'inactive';
|
|
12572
|
-
/** ConnectionItem */
|
|
12573
|
-
backbone_api__app__routers__syncs__ConnectionItem: {
|
|
12574
|
-
/** One Api */
|
|
12575
|
-
one_api?: number | null;
|
|
12576
|
-
/** Connection Type */
|
|
12577
|
-
connection_type?: number | null;
|
|
12578
|
-
/**
|
|
12579
|
-
* Display Order
|
|
12580
|
-
* @default 0
|
|
12581
|
-
*/
|
|
12582
|
-
display_order: number;
|
|
12583
|
-
/**
|
|
12584
|
-
* Display Hidden
|
|
12585
|
-
* @default false
|
|
12586
|
-
*/
|
|
12587
|
-
display_hidden: boolean;
|
|
12588
|
-
};
|
|
12589
12971
|
/**
|
|
12590
12972
|
* DocumentType
|
|
12591
12973
|
* @enum {string}
|
|
@@ -12593,180 +12975,38 @@ export interface components {
|
|
|
12593
12975
|
backbone_common__models__accounting__common__DocumentType: 'invoice' | 'entry';
|
|
12594
12976
|
/**
|
|
12595
12977
|
* InvoiceType
|
|
12596
|
-
* @enum {string}
|
|
12597
|
-
*/
|
|
12598
|
-
backbone_common__models__accounting__common__InvoiceType:
|
|
12599
|
-
| 'customer_invoice'
|
|
12600
|
-
| 'customer_refund'
|
|
12601
|
-
| 'supplier_invoice'
|
|
12602
|
-
| 'supplier_refund';
|
|
12603
|
-
/**
|
|
12604
|
-
|
|
12605
|
-
|
|
12606
|
-
|
|
12607
|
-
|
|
12608
|
-
|
|
12609
|
-
|
|
12610
|
-
|
|
12611
|
-
|
|
12612
|
-
|
|
12613
|
-
|
|
12614
|
-
|
|
|
12615
|
-
|
|
12616
|
-
|
|
12617
|
-
|
|
12618
|
-
|
|
12619
|
-
/**
|
|
12620
|
-
* Tax Rate
|
|
12621
|
-
* @description Rate of the withholding tax. Normal withholding tax should have a negative tax rate.
|
|
12622
|
-
*/
|
|
12623
|
-
tax_rate: number;
|
|
12624
|
-
/**
|
|
12625
|
-
* Tax Code
|
|
12626
|
-
* @description Tax code of the withholding tax. This is the Id of the Tax Code in the accounting software.
|
|
12627
|
-
*/
|
|
12628
|
-
tax_code: string;
|
|
12629
|
-
/**
|
|
12630
|
-
* Tax Amount
|
|
12631
|
-
* @description Amount of the withholding tax. This is the amount of the withholding tax that will be applied to the invoice. It should be negative for normal withholding tax.
|
|
12632
|
-
*/
|
|
12633
|
-
tax_amount: number;
|
|
12634
|
-
};
|
|
12635
|
-
/**
|
|
12636
|
-
* TransactionStatus
|
|
12637
|
-
* @enum {string}
|
|
12638
|
-
*/
|
|
12639
|
-
backbone_common__models__banking__common__TransactionStatus:
|
|
12640
|
-
| 'pending'
|
|
12641
|
-
| 'declined'
|
|
12642
|
-
| 'completed';
|
|
12643
|
-
/** AddressItemIn */
|
|
12644
|
-
backbone_common__models__commerce__common__AddressItemIn: {
|
|
12645
|
-
/** First Name */
|
|
12646
|
-
first_name: string;
|
|
12647
|
-
/** Last Name */
|
|
12648
|
-
last_name: string;
|
|
12649
|
-
/** Street */
|
|
12650
|
-
street: string;
|
|
12651
|
-
/** Number */
|
|
12652
|
-
number: string;
|
|
12653
|
-
/** Box */
|
|
12654
|
-
box?: string | null;
|
|
12655
|
-
/** City */
|
|
12656
|
-
city: string;
|
|
12657
|
-
/** Postal Code */
|
|
12658
|
-
postal_code?: string | null;
|
|
12659
|
-
/**
|
|
12660
|
-
* Country
|
|
12661
|
-
* @description Format: ISO 3166-1 codes.
|
|
12662
|
-
*/
|
|
12663
|
-
country: string;
|
|
12664
|
-
/** Phone */
|
|
12665
|
-
phone?: string | null;
|
|
12666
|
-
/** Email */
|
|
12667
|
-
email?: string | null;
|
|
12668
|
-
};
|
|
12669
|
-
/** AddressItemOut */
|
|
12670
|
-
backbone_common__models__commerce__common__AddressItemOut: {
|
|
12671
|
-
address_type: components['schemas']['AddressType'];
|
|
12672
|
-
/** Company Name */
|
|
12673
|
-
company_name?: string | null;
|
|
12674
|
-
/** First Name */
|
|
12675
|
-
first_name?: string | null;
|
|
12676
|
-
/** Last Name */
|
|
12677
|
-
last_name?: string | null;
|
|
12678
|
-
/** Street */
|
|
12679
|
-
street?: string | null;
|
|
12680
|
-
/** Number */
|
|
12681
|
-
number?: string | null;
|
|
12682
|
-
/** Box */
|
|
12683
|
-
box?: string | null;
|
|
12684
|
-
/** City */
|
|
12685
|
-
city?: string | null;
|
|
12686
|
-
/** Postal Code */
|
|
12687
|
-
postal_code?: string | null;
|
|
12688
|
-
/**
|
|
12689
|
-
* Country
|
|
12690
|
-
* @description Format: ISO 3166-1 codes.
|
|
12691
|
-
*/
|
|
12692
|
-
country?: string | null;
|
|
12693
|
-
/** Phone */
|
|
12694
|
-
phone?: string | null;
|
|
12695
|
-
/** Email */
|
|
12696
|
-
email?: string | null;
|
|
12697
|
-
};
|
|
12698
|
-
/** DiscountItem */
|
|
12699
|
-
backbone_common__models__commerce__common__DiscountItem: {
|
|
12700
|
-
/** Name */
|
|
12701
|
-
name: string;
|
|
12702
|
-
/** Description */
|
|
12703
|
-
description: string;
|
|
12704
|
-
/** Amount */
|
|
12705
|
-
amount: number;
|
|
12706
|
-
};
|
|
12707
|
-
/** ProductCategoryItem */
|
|
12708
|
-
backbone_common__models__commerce__common__ProductCategoryItem: {
|
|
12709
|
-
/**
|
|
12710
|
-
* Id
|
|
12711
|
-
* @description Technical id of the category in Chift
|
|
12712
|
-
*/
|
|
12713
|
-
id: string;
|
|
12714
|
-
/** Name */
|
|
12715
|
-
name: string;
|
|
12716
|
-
};
|
|
12717
|
-
/** ProductItem */
|
|
12718
|
-
backbone_common__models__commerce__common__ProductItem: {
|
|
12719
|
-
/**
|
|
12720
|
-
* Id
|
|
12721
|
-
* @description Technical id in Chift
|
|
12722
|
-
*/
|
|
12723
|
-
id: string;
|
|
12724
|
-
/** @description Technical id in the target software */
|
|
12725
|
-
source_ref: components['schemas']['Ref'];
|
|
12726
|
-
/** Name */
|
|
12727
|
-
name: string;
|
|
12728
|
-
/** Description */
|
|
12729
|
-
description?: string | null;
|
|
12730
|
-
/** Description Html */
|
|
12731
|
-
description_html?: string | null;
|
|
12732
|
-
/**
|
|
12733
|
-
* Categories
|
|
12734
|
-
* @default []
|
|
12735
|
-
*/
|
|
12736
|
-
categories:
|
|
12737
|
-
| components['schemas']['backbone_common__models__commerce__common__ProductCategoryItem'][]
|
|
12738
|
-
| null;
|
|
12739
|
-
/** Created On */
|
|
12740
|
-
created_on?: string | null;
|
|
12741
|
-
/** Last Updated On */
|
|
12742
|
-
last_updated_on?: string | null;
|
|
12743
|
-
/**
|
|
12744
|
-
* Variants
|
|
12745
|
-
* @default []
|
|
12746
|
-
*/
|
|
12747
|
-
variants: components['schemas']['ProductVariantItem'][] | null;
|
|
12748
|
-
status?: components['schemas']['ProductStatus'] | null;
|
|
12749
|
-
/** Sku */
|
|
12750
|
-
sku?: string | null;
|
|
12751
|
-
/**
|
|
12752
|
-
* Common Attributes
|
|
12753
|
-
* @description List of attributes that are shared by all variants of the product.
|
|
12754
|
-
* @default []
|
|
12755
|
-
*/
|
|
12756
|
-
common_attributes: components['schemas']['CommonAttributeItem'][] | null;
|
|
12757
|
-
/**
|
|
12758
|
-
* Variant Attributes Options
|
|
12759
|
-
* @default []
|
|
12760
|
-
*/
|
|
12761
|
-
variant_attributes_options:
|
|
12762
|
-
| components['schemas']['VariantAttributeOptionItem'][]
|
|
12763
|
-
| null;
|
|
12978
|
+
* @enum {string}
|
|
12979
|
+
*/
|
|
12980
|
+
backbone_common__models__accounting__common__InvoiceType:
|
|
12981
|
+
| 'customer_invoice'
|
|
12982
|
+
| 'customer_refund'
|
|
12983
|
+
| 'supplier_invoice'
|
|
12984
|
+
| 'supplier_refund';
|
|
12985
|
+
/** AddressItemIn */
|
|
12986
|
+
backbone_common__models__commerce__common__AddressItemIn: {
|
|
12987
|
+
/** First Name */
|
|
12988
|
+
first_name: string;
|
|
12989
|
+
/** Last Name */
|
|
12990
|
+
last_name: string;
|
|
12991
|
+
/** Street */
|
|
12992
|
+
street: string;
|
|
12993
|
+
/** Number */
|
|
12994
|
+
number: string;
|
|
12995
|
+
/** Box */
|
|
12996
|
+
box?: string | null;
|
|
12997
|
+
/** City */
|
|
12998
|
+
city: string;
|
|
12999
|
+
/** Postal Code */
|
|
13000
|
+
postal_code?: string | null;
|
|
12764
13001
|
/**
|
|
12765
|
-
*
|
|
12766
|
-
* @description
|
|
12767
|
-
* @default []
|
|
13002
|
+
* Country
|
|
13003
|
+
* @description Format: ISO 3166-1 codes.
|
|
12768
13004
|
*/
|
|
12769
|
-
|
|
13005
|
+
country: string;
|
|
13006
|
+
/** Phone */
|
|
13007
|
+
phone?: string | null;
|
|
13008
|
+
/** Email */
|
|
13009
|
+
email?: string | null;
|
|
12770
13010
|
};
|
|
12771
13011
|
/** ProductPriceItem */
|
|
12772
13012
|
backbone_common__models__commerce__common__ProductPriceItem: {
|
|
@@ -12786,33 +13026,6 @@ export interface components {
|
|
|
12786
13026
|
| 'failed'
|
|
12787
13027
|
| 'pending'
|
|
12788
13028
|
| 'success';
|
|
12789
|
-
/** AddressItemIn */
|
|
12790
|
-
backbone_common__models__common__AddressItemIn: {
|
|
12791
|
-
address_type: components['schemas']['AddressType'];
|
|
12792
|
-
/** Name */
|
|
12793
|
-
name?: string | null;
|
|
12794
|
-
/** Number */
|
|
12795
|
-
number?: string | null;
|
|
12796
|
-
/** Box */
|
|
12797
|
-
box?: string | null;
|
|
12798
|
-
/** Phone */
|
|
12799
|
-
phone?: string | null;
|
|
12800
|
-
/** Mobile */
|
|
12801
|
-
mobile?: string | null;
|
|
12802
|
-
/** Email */
|
|
12803
|
-
email?: string | null;
|
|
12804
|
-
/** Street */
|
|
12805
|
-
street: string;
|
|
12806
|
-
/** City */
|
|
12807
|
-
city: string;
|
|
12808
|
-
/** Postal Code */
|
|
12809
|
-
postal_code: string;
|
|
12810
|
-
/**
|
|
12811
|
-
* Country
|
|
12812
|
-
* @description Format: ISO 3166-1 codes.
|
|
12813
|
-
*/
|
|
12814
|
-
country: string;
|
|
12815
|
-
};
|
|
12816
13029
|
/** AddressItemOut */
|
|
12817
13030
|
backbone_common__models__common__AddressItemOut: {
|
|
12818
13031
|
address_type: components['schemas']['AddressType'];
|
|
@@ -12840,151 +13053,6 @@ export interface components {
|
|
|
12840
13053
|
*/
|
|
12841
13054
|
country?: string | null;
|
|
12842
13055
|
};
|
|
12843
|
-
/**
|
|
12844
|
-
* PaymentStatus
|
|
12845
|
-
* @enum {string}
|
|
12846
|
-
*/
|
|
12847
|
-
backbone_common__models__common__PaymentStatus: 'all' | 'unpaid' | 'paid';
|
|
12848
|
-
/**
|
|
12849
|
-
* DocumentType
|
|
12850
|
-
* @enum {string}
|
|
12851
|
-
*/
|
|
12852
|
-
backbone_common__models__invoicing__common__DocumentType:
|
|
12853
|
-
| 'customer_document'
|
|
12854
|
-
| 'supplier_document'
|
|
12855
|
-
| 'employee_expense';
|
|
12856
|
-
/** InvoiceItem */
|
|
12857
|
-
backbone_common__models__invoicing__common__InvoiceItem: {
|
|
12858
|
-
/**
|
|
12859
|
-
* Currency
|
|
12860
|
-
* @description Currency matching target sofware name
|
|
12861
|
-
*/
|
|
12862
|
-
currency: string;
|
|
12863
|
-
/** @description Invoice type */
|
|
12864
|
-
invoice_type: components['schemas']['backbone_common__models__invoicing__common__InvoiceType'];
|
|
12865
|
-
/** @description Status */
|
|
12866
|
-
status: components['schemas']['InvoiceStatus'];
|
|
12867
|
-
/**
|
|
12868
|
-
* Invoice Date
|
|
12869
|
-
* Format: date
|
|
12870
|
-
* @description Invoicing date
|
|
12871
|
-
*/
|
|
12872
|
-
invoice_date: string;
|
|
12873
|
-
/**
|
|
12874
|
-
* Tax Amount
|
|
12875
|
-
* @description Taxes amount
|
|
12876
|
-
*/
|
|
12877
|
-
tax_amount: number;
|
|
12878
|
-
/**
|
|
12879
|
-
* Untaxed Amount
|
|
12880
|
-
* @description Untaxed amount
|
|
12881
|
-
*/
|
|
12882
|
-
untaxed_amount: number;
|
|
12883
|
-
/**
|
|
12884
|
-
* Total
|
|
12885
|
-
* @description Total amount incl. taxes
|
|
12886
|
-
*/
|
|
12887
|
-
total: number;
|
|
12888
|
-
/**
|
|
12889
|
-
* Lines
|
|
12890
|
-
* @description Invoice lines
|
|
12891
|
-
* @default []
|
|
12892
|
-
*/
|
|
12893
|
-
lines: components['schemas']['InvoiceLineItem'][];
|
|
12894
|
-
/**
|
|
12895
|
-
* Partner Id
|
|
12896
|
-
* @description Technical id of the vendor/customer in Chift
|
|
12897
|
-
*/
|
|
12898
|
-
partner_id?: string | null;
|
|
12899
|
-
/**
|
|
12900
|
-
* Invoice Number
|
|
12901
|
-
* @description Number/sequence
|
|
12902
|
-
*/
|
|
12903
|
-
invoice_number?: string | null;
|
|
12904
|
-
/**
|
|
12905
|
-
* Due Date
|
|
12906
|
-
* @description Due date
|
|
12907
|
-
*/
|
|
12908
|
-
due_date?: string | null;
|
|
12909
|
-
/**
|
|
12910
|
-
* Reference
|
|
12911
|
-
* @description Reference
|
|
12912
|
-
*/
|
|
12913
|
-
reference?: string | null;
|
|
12914
|
-
/**
|
|
12915
|
-
* Payment Communication
|
|
12916
|
-
* @description Payment communication
|
|
12917
|
-
*/
|
|
12918
|
-
payment_communication?: string | null;
|
|
12919
|
-
/**
|
|
12920
|
-
* Customer Memo
|
|
12921
|
-
* @description Customer note/memo
|
|
12922
|
-
*/
|
|
12923
|
-
customer_memo?: string | null;
|
|
12924
|
-
/** @description Journal */
|
|
12925
|
-
journal_ref?: components['schemas']['FieldRef'] | null;
|
|
12926
|
-
/** @description Specificities for Italy */
|
|
12927
|
-
italian_specificities?: components['schemas']['ItalianSpecificities-Input'] | null;
|
|
12928
|
-
};
|
|
12929
|
-
/**
|
|
12930
|
-
* InvoiceType
|
|
12931
|
-
* @enum {string}
|
|
12932
|
-
*/
|
|
12933
|
-
backbone_common__models__invoicing__common__InvoiceType:
|
|
12934
|
-
| 'customer_invoice'
|
|
12935
|
-
| 'customer_refund'
|
|
12936
|
-
| 'supplier_invoice'
|
|
12937
|
-
| 'supplier_refund'
|
|
12938
|
-
| 'all';
|
|
12939
|
-
/** ProductItem */
|
|
12940
|
-
backbone_common__models__invoicing__common__ProductItem: {
|
|
12941
|
-
/**
|
|
12942
|
-
* Name
|
|
12943
|
-
* @description Name
|
|
12944
|
-
*/
|
|
12945
|
-
name: string;
|
|
12946
|
-
/**
|
|
12947
|
-
* Unit Price
|
|
12948
|
-
* @description Unit price
|
|
12949
|
-
*/
|
|
12950
|
-
unit_price?: number | null;
|
|
12951
|
-
/**
|
|
12952
|
-
* Tax Id
|
|
12953
|
-
* @description Technical id of the tax in Chift
|
|
12954
|
-
*/
|
|
12955
|
-
tax_id?: string | null;
|
|
12956
|
-
/**
|
|
12957
|
-
* Code
|
|
12958
|
-
* @description Reference/code
|
|
12959
|
-
*/
|
|
12960
|
-
code?: string | null;
|
|
12961
|
-
/**
|
|
12962
|
-
* Unit
|
|
12963
|
-
* @description Unit of measure matching target software name
|
|
12964
|
-
*/
|
|
12965
|
-
unit?: string | null;
|
|
12966
|
-
/**
|
|
12967
|
-
* Category
|
|
12968
|
-
* @description Category matching target software name
|
|
12969
|
-
*/
|
|
12970
|
-
category?: string | null;
|
|
12971
|
-
/**
|
|
12972
|
-
* Currency
|
|
12973
|
-
* @description Currency matching target software name
|
|
12974
|
-
*/
|
|
12975
|
-
currency?: string | null;
|
|
12976
|
-
/**
|
|
12977
|
-
* Description
|
|
12978
|
-
* @description Description
|
|
12979
|
-
*/
|
|
12980
|
-
description?: string | null;
|
|
12981
|
-
/**
|
|
12982
|
-
* Cost
|
|
12983
|
-
* @description Cost of the product
|
|
12984
|
-
* @default 0
|
|
12985
|
-
*/
|
|
12986
|
-
cost: number | null;
|
|
12987
|
-
};
|
|
12988
13056
|
/** WithholdingTax */
|
|
12989
13057
|
backbone_common__models__invoicing__common__WithholdingTax: {
|
|
12990
13058
|
/**
|
|
@@ -13002,51 +13070,6 @@ export interface components {
|
|
|
13002
13070
|
/** @description Payment reason */
|
|
13003
13071
|
payment_reason?: components['schemas']['WithholdingTaxPaymentReason'] | null;
|
|
13004
13072
|
};
|
|
13005
|
-
/**
|
|
13006
|
-
* PaymentStatus
|
|
13007
|
-
* @enum {string}
|
|
13008
|
-
*/
|
|
13009
|
-
backbone_common__models__payment__common__PaymentStatus:
|
|
13010
|
-
| 'pending'
|
|
13011
|
-
| 'completed'
|
|
13012
|
-
| 'partially_completed'
|
|
13013
|
-
| 'canceled'
|
|
13014
|
-
| 'failed'
|
|
13015
|
-
| 'unknown'
|
|
13016
|
-
| 'authorized';
|
|
13017
|
-
/** InvoiceItem */
|
|
13018
|
-
backbone_common__models__pms__common__InvoiceItem: {
|
|
13019
|
-
/**
|
|
13020
|
-
* Id
|
|
13021
|
-
* @description Technical id in Chift
|
|
13022
|
-
*/
|
|
13023
|
-
id: string;
|
|
13024
|
-
/** @description Technical id in the target software */
|
|
13025
|
-
source_ref: components['schemas']['Ref'];
|
|
13026
|
-
/**
|
|
13027
|
-
* Invoice Number
|
|
13028
|
-
* @description Number/sequence
|
|
13029
|
-
* @example INV-12345
|
|
13030
|
-
*/
|
|
13031
|
-
invoice_number: string | null;
|
|
13032
|
-
/**
|
|
13033
|
-
* Creation Date
|
|
13034
|
-
* @description Creation date of the invoice
|
|
13035
|
-
* @example 2023-10-01T12:00:00
|
|
13036
|
-
*/
|
|
13037
|
-
creation_date?: string | null;
|
|
13038
|
-
/**
|
|
13039
|
-
* Closing Date
|
|
13040
|
-
* @description Closing date of the invoice
|
|
13041
|
-
* @example 2023-10-10T12:00:00
|
|
13042
|
-
*/
|
|
13043
|
-
closing_date?: string | null;
|
|
13044
|
-
/**
|
|
13045
|
-
* Partners
|
|
13046
|
-
* @description List of partners related to the invoice
|
|
13047
|
-
*/
|
|
13048
|
-
partners?: components['schemas']['InvoicePartnerItem'][] | null;
|
|
13049
|
-
};
|
|
13050
13073
|
/** ProductCategoryItem */
|
|
13051
13074
|
backbone_common__models__pos__common__ProductCategoryItem: {
|
|
13052
13075
|
/**
|
|
@@ -13074,21 +13097,6 @@ export interface components {
|
|
|
13074
13097
|
*/
|
|
13075
13098
|
id_parent?: string | null;
|
|
13076
13099
|
};
|
|
13077
|
-
/** ProductPriceItem */
|
|
13078
|
-
backbone_common__models__pos__common__ProductPriceItem: {
|
|
13079
|
-
/**
|
|
13080
|
-
* Unit Price
|
|
13081
|
-
* @description Unit price (without tax) of the product
|
|
13082
|
-
* @example 10
|
|
13083
|
-
*/
|
|
13084
|
-
unit_price: number;
|
|
13085
|
-
/**
|
|
13086
|
-
* Tax Rate
|
|
13087
|
-
* @description Tax rate applied to the product
|
|
13088
|
-
* @example 10
|
|
13089
|
-
*/
|
|
13090
|
-
tax_rate?: number | null;
|
|
13091
|
-
};
|
|
13092
13100
|
/** DiscountItem */
|
|
13093
13101
|
backbone_common__models__pos_pms__DiscountItem: {
|
|
13094
13102
|
/**
|
|
@@ -13485,9 +13493,7 @@ export interface operations {
|
|
|
13485
13493
|
};
|
|
13486
13494
|
requestBody?: {
|
|
13487
13495
|
content: {
|
|
13488
|
-
'application/json':
|
|
13489
|
-
| components['schemas']['backbone_api__app__routers__connections__PostConnectionItem']
|
|
13490
|
-
| null;
|
|
13496
|
+
'application/json': components['schemas']['PostConnectionItem-Input'] | null;
|
|
13491
13497
|
};
|
|
13492
13498
|
};
|
|
13493
13499
|
responses: {
|
|
@@ -13719,9 +13725,7 @@ export interface operations {
|
|
|
13719
13725
|
integrations_get_integrations: {
|
|
13720
13726
|
parameters: {
|
|
13721
13727
|
query?: {
|
|
13722
|
-
status?:
|
|
13723
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
13724
|
-
| null;
|
|
13728
|
+
status?: components['schemas']['Status'] | null;
|
|
13725
13729
|
include_coverage?: components['schemas']['BoolParam'] | null;
|
|
13726
13730
|
};
|
|
13727
13731
|
header?: never;
|
|
@@ -13820,9 +13824,7 @@ export interface operations {
|
|
|
13820
13824
|
webhooks_get_webhooks: {
|
|
13821
13825
|
parameters: {
|
|
13822
13826
|
query?: {
|
|
13823
|
-
status?:
|
|
13824
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
13825
|
-
| null;
|
|
13827
|
+
status?: components['schemas']['Status'] | null;
|
|
13826
13828
|
};
|
|
13827
13829
|
header?: never;
|
|
13828
13830
|
path?: never;
|
|
@@ -14660,9 +14662,7 @@ export interface operations {
|
|
|
14660
14662
|
datastores_get_datastores: {
|
|
14661
14663
|
parameters: {
|
|
14662
14664
|
query?: {
|
|
14663
|
-
status?:
|
|
14664
|
-
| components['schemas']['backbone_api__app__routers__integrations__Status']
|
|
14665
|
-
| null;
|
|
14665
|
+
status?: components['schemas']['Status'] | null;
|
|
14666
14666
|
};
|
|
14667
14667
|
header?: never;
|
|
14668
14668
|
path?: never;
|
|
@@ -15758,6 +15758,8 @@ export interface operations {
|
|
|
15758
15758
|
regroup_lines?: components['schemas']['BoolParam'] | null;
|
|
15759
15759
|
/** @description If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call. */
|
|
15760
15760
|
ignore_accounting_id?: boolean;
|
|
15761
|
+
/** @description Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. */
|
|
15762
|
+
force_currency_exchange?: boolean | null;
|
|
15761
15763
|
};
|
|
15762
15764
|
header?: never;
|
|
15763
15765
|
path: {
|
|
@@ -15832,6 +15834,8 @@ export interface operations {
|
|
|
15832
15834
|
regroup_lines?: components['schemas']['BoolParam'] | null;
|
|
15833
15835
|
/** @description If set to true, Chift will not wait for the invoice to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call. */
|
|
15834
15836
|
ignore_accounting_id?: boolean;
|
|
15837
|
+
/** @description Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. */
|
|
15838
|
+
force_currency_exchange?: boolean | null;
|
|
15835
15839
|
};
|
|
15836
15840
|
header?: never;
|
|
15837
15841
|
path: {
|
|
@@ -15911,9 +15915,7 @@ export interface operations {
|
|
|
15911
15915
|
/** @description Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null. */
|
|
15912
15916
|
include_payments?: components['schemas']['BoolParam'] | null;
|
|
15913
15917
|
/** @description Extra filter to retrieve invoices with a specific payment status. */
|
|
15914
|
-
payment_status?:
|
|
15915
|
-
| components['schemas']['backbone_common__models__common__PaymentStatus']
|
|
15916
|
-
| null;
|
|
15918
|
+
payment_status?: components['schemas']['PaymentStatus-Input'] | null;
|
|
15917
15919
|
/** @description Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors. */
|
|
15918
15920
|
updated_after?: string | null;
|
|
15919
15921
|
/** @description Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API. */
|
|
@@ -15981,9 +15983,7 @@ export interface operations {
|
|
|
15981
15983
|
/** @description Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null. */
|
|
15982
15984
|
include_payments?: components['schemas']['BoolParam'] | null;
|
|
15983
15985
|
/** @description Extra filter to retrieve invoices with a specific payment status. */
|
|
15984
|
-
payment_status?:
|
|
15985
|
-
| components['schemas']['backbone_common__models__common__PaymentStatus']
|
|
15986
|
-
| null;
|
|
15986
|
+
payment_status?: components['schemas']['PaymentStatus-Input'] | null;
|
|
15987
15987
|
/** @description Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors. */
|
|
15988
15988
|
updated_after?: string | null;
|
|
15989
15989
|
/** @description Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API. */
|
|
@@ -18097,6 +18097,8 @@ export interface operations {
|
|
|
18097
18097
|
folder_id?: string | null;
|
|
18098
18098
|
/** @description Number of ledger account representing bank account in accounting. Required in cases where the connector does not allow direct linking of the ledger account representing the bank account and the journal representing the bank account, making it necessary to specify it here. */
|
|
18099
18099
|
financial_counterpart_account?: string | null;
|
|
18100
|
+
/** @description Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software. */
|
|
18101
|
+
force_currency_exchange?: boolean | null;
|
|
18100
18102
|
};
|
|
18101
18103
|
header?: never;
|
|
18102
18104
|
path: {
|
|
@@ -19837,7 +19839,7 @@ export interface operations {
|
|
|
19837
19839
|
[name: string]: unknown;
|
|
19838
19840
|
};
|
|
19839
19841
|
content: {
|
|
19840
|
-
'application/json': components['schemas']['
|
|
19842
|
+
'application/json': components['schemas']['ProductItem-Output'];
|
|
19841
19843
|
};
|
|
19842
19844
|
};
|
|
19843
19845
|
/** @description Bad Request */
|
|
@@ -20458,12 +20460,8 @@ export interface operations {
|
|
|
20458
20460
|
size?: number;
|
|
20459
20461
|
date_from?: string | null;
|
|
20460
20462
|
date_to?: string | null;
|
|
20461
|
-
invoice_type?:
|
|
20462
|
-
|
|
20463
|
-
| null;
|
|
20464
|
-
payment_status?:
|
|
20465
|
-
| components['schemas']['backbone_common__models__common__PaymentStatus']
|
|
20466
|
-
| null;
|
|
20463
|
+
invoice_type?: components['schemas']['InvoiceType'] | null;
|
|
20464
|
+
payment_status?: components['schemas']['PaymentStatus-Input'] | null;
|
|
20467
20465
|
updated_after?: string | null;
|
|
20468
20466
|
/** @description Include the invoice lines in the response. By default, invoice lines are included when no extra request is needed to fetch them. If you want to include them explicitly, set this parameter to true. */
|
|
20469
20467
|
include_invoice_lines?: components['schemas']['BoolParam'] | null;
|
|
@@ -20524,7 +20522,7 @@ export interface operations {
|
|
|
20524
20522
|
};
|
|
20525
20523
|
requestBody: {
|
|
20526
20524
|
content: {
|
|
20527
|
-
'application/json': components['schemas']['
|
|
20525
|
+
'application/json': components['schemas']['InvoiceItem-Input'];
|
|
20528
20526
|
};
|
|
20529
20527
|
};
|
|
20530
20528
|
responses: {
|
|
@@ -20805,7 +20803,7 @@ export interface operations {
|
|
|
20805
20803
|
};
|
|
20806
20804
|
requestBody: {
|
|
20807
20805
|
content: {
|
|
20808
|
-
'application/json': components['schemas']['
|
|
20806
|
+
'application/json': components['schemas']['ProductItem-Input'];
|
|
20809
20807
|
};
|
|
20810
20808
|
};
|
|
20811
20809
|
responses: {
|