@erp-galoper/types 1.0.2087 → 1.0.2089

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.
Files changed (2) hide show
  1. package/openapi.ts +60 -227
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -29387,15 +29387,19 @@ export interface components {
29387
29387
  id: string;
29388
29388
  /** Name */
29389
29389
  name: string;
29390
- /** Taxtype */
29391
- taxType: unknown;
29390
+ taxType: components["schemas"]["TaxType"];
29392
29391
  /** Type */
29393
- type: unknown[];
29392
+ type: components["schemas"]["TaxTypes"][];
29394
29393
  /** Ratepercentage */
29395
29394
  ratePercentage: number | null;
29396
29395
  /** Fixedamount */
29397
29396
  fixedAmount?: number | null;
29398
29397
  };
29398
+ /**
29399
+ * TaxType
29400
+ * @enum {string}
29401
+ */
29402
+ TaxType: "vat" | "stampDuty" | "other";
29399
29403
  /**
29400
29404
  * TaxTypes
29401
29405
  * @enum {string}
@@ -41881,11 +41885,6 @@ export interface components {
41881
41885
  */
41882
41886
  stampDutyPayable?: number | null;
41883
41887
  };
41884
- /**
41885
- * TaxType
41886
- * @enum {string}
41887
- */
41888
- TaxType: "vat" | "stampDuty" | "other";
41889
41888
  /** ListTaxes */
41890
41889
  ListTaxes: {
41891
41890
  info: components["schemas"]["PageInfoSchema"];
@@ -42134,10 +42133,10 @@ export interface components {
42134
42133
  ListTaxRules: {
42135
42134
  info: components["schemas"]["PageInfoSchema"];
42136
42135
  /** Results */
42137
- results: components["schemas"]["RetrieveTaxRuleInList"][];
42136
+ results: components["schemas"]["RetrieveTaxRule"][];
42138
42137
  };
42139
- /** RetrieveTaxRuleInList */
42140
- RetrieveTaxRuleInList: {
42138
+ /** RetrieveTaxRule */
42139
+ RetrieveTaxRule: {
42141
42140
  /**
42142
42141
  * Datecreated
42143
42142
  * Format: date-time
@@ -42173,6 +42172,8 @@ export interface components {
42173
42172
  * @default []
42174
42173
  */
42175
42174
  itemCategories: components["schemas"]["ItemCategorySummaryInfo"][] | null;
42175
+ /** Candelete */
42176
+ canDelete: boolean;
42176
42177
  taxApplication: components["schemas"]["TaxApplication"];
42177
42178
  /** Exemptionpercent */
42178
42179
  exemptionPercent?: number | null;
@@ -42184,8 +42185,6 @@ export interface components {
42184
42185
  chargeBearer?: string | null;
42185
42186
  /** Isactive */
42186
42187
  isActive: boolean;
42187
- /** Candelete */
42188
- canDelete: boolean;
42189
42188
  };
42190
42189
  /** UpdateTaxRule */
42191
42190
  UpdateTaxRule: {
@@ -42218,55 +42217,6 @@ export interface components {
42218
42217
  /** Isactive */
42219
42218
  isActive?: boolean | null;
42220
42219
  };
42221
- /** RetrieveTaxRule */
42222
- RetrieveTaxRule: {
42223
- /**
42224
- * Datecreated
42225
- * Format: date-time
42226
- */
42227
- dateCreated: string;
42228
- /** Datemodified */
42229
- dateModified: string | null;
42230
- createdBy: components["schemas"]["RecordUserSchema"];
42231
- modifiedBy: components["schemas"]["RecordUserSchema"] | null;
42232
- /**
42233
- * Id
42234
- * Format: uuid
42235
- */
42236
- id: string;
42237
- tax: components["schemas"]["TaxSharedSchema"];
42238
- /**
42239
- * Customers
42240
- * @default []
42241
- */
42242
- customers: components["schemas"]["AccountSummaryInfo"][] | null;
42243
- /**
42244
- * Customergroups
42245
- * @default []
42246
- */
42247
- customerGroups: components["schemas"]["ContactSegmentationSharedSchema"][] | null;
42248
- /**
42249
- * Items
42250
- * @default []
42251
- */
42252
- items: components["schemas"]["ItemSummaryInfo"][] | null;
42253
- /**
42254
- * Itemcategories
42255
- * @default []
42256
- */
42257
- itemCategories: components["schemas"]["ItemCategorySummaryInfo"][] | null;
42258
- taxApplication: components["schemas"]["TaxApplication"];
42259
- /** Exemptionpercent */
42260
- exemptionPercent?: number | null;
42261
- exemptionMethod?: components["schemas"]["ExemptionMethod"] | null;
42262
- /**
42263
- * Chargebearer
42264
- * @description Who bears the stamp duty charge. Only set (always 'customer' for now) when the rule's tax is of type stampDuty; null otherwise.
42265
- */
42266
- chargeBearer?: string | null;
42267
- /** Isactive */
42268
- isActive: boolean;
42269
- };
42270
42220
  /** AccountingSettingResponseSchema */
42271
42221
  AccountingSettingResponseSchema: {
42272
42222
  /** Code */
@@ -45217,7 +45167,7 @@ export interface components {
45217
45167
  /**
45218
45168
  * Taxes
45219
45169
  * @description - visible when supplier is resident
45220
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
45170
+ * - get taxes from /api/v1/settings/accounting/taxes/
45221
45171
  * - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals purchase
45222
45172
  */
45223
45173
  taxes?: string[] | null;
@@ -45289,7 +45239,7 @@ export interface components {
45289
45239
  * Format: uuid
45290
45240
  * @description - tax id
45291
45241
  * - visible when supplier is not resident
45292
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
45242
+ * - get taxes from /api/v1/settings/accounting/taxes/
45293
45243
  */
45294
45244
  tax?: string;
45295
45245
  /**
@@ -45644,7 +45594,7 @@ export interface components {
45644
45594
  * Tax
45645
45595
  * Format: uuid
45646
45596
  * @description - visible when entity is not resident
45647
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase or sale with respect to document and taxType not equals stampDuty
45597
+ * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase or sale with respect to document
45648
45598
  */
45649
45599
  tax?: string;
45650
45600
  /** Items */
@@ -46071,7 +46021,7 @@ export interface components {
46071
46021
  /**
46072
46022
  * Taxes
46073
46023
  * @description - visible when supplier is resident
46074
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
46024
+ * - get taxes from /api/v1/settings/accounting/taxes/
46075
46025
  * - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals purchase
46076
46026
  */
46077
46027
  taxes?: string[] | null;
@@ -46156,7 +46106,7 @@ export interface components {
46156
46106
  * Format: uuid
46157
46107
  * @description - tax id
46158
46108
  * - visible when supplier is not resident
46159
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
46109
+ * - get taxes from /api/v1/settings/accounting/taxes/
46160
46110
  */
46161
46111
  tax?: string;
46162
46112
  /**
@@ -47857,7 +47807,7 @@ export interface components {
47857
47807
  * Format: uuid
47858
47808
  * @description - tax id
47859
47809
  * - visible when supplier is not resident
47860
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
47810
+ * - get taxes from /api/v1/settings/accounting/taxes/
47861
47811
  */
47862
47812
  tax?: string;
47863
47813
  /**
@@ -47933,7 +47883,7 @@ export interface components {
47933
47883
  /**
47934
47884
  * Taxes
47935
47885
  * @description - visible when supplier is resident
47936
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
47886
+ * - get taxes from /api/v1/settings/accounting/taxes/
47937
47887
  * - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals purchase
47938
47888
  */
47939
47889
  taxes: string[];
@@ -48012,7 +47962,7 @@ export interface components {
48012
47962
  /**
48013
47963
  * Taxes
48014
47964
  * @description - visible when supplier is resident
48015
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
47965
+ * - get taxes from /api/v1/settings/accounting/taxes/
48016
47966
  * - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals purchase
48017
47967
  */
48018
47968
  taxes: string[];
@@ -48121,7 +48071,7 @@ export interface components {
48121
48071
  * Format: uuid
48122
48072
  * @description - tax id
48123
48073
  * - visible when supplier is not resident
48124
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals purchase and taxType not equals stampDuty
48074
+ * - get taxes from /api/v1/settings/accounting/taxes/
48125
48075
  */
48126
48076
  tax?: string;
48127
48077
  /**
@@ -54071,47 +54021,14 @@ export interface components {
54071
54021
  taxes: string[];
54072
54022
  /**
54073
54023
  * Taxexemptions
54074
- * @description Per-tax exemption validity/info for this item (hasValidExemption, exemptionPercent, applyExemption)
54075
54024
  * @default []
54076
54025
  */
54077
- taxExemptions: components["schemas"]["TaxExemptionInfoSchema"][];
54026
+ taxExemptions: components["schemas"]["TaxExemptionSelectionResponseSchema"][];
54078
54027
  /**
54079
54028
  * Exemptionamount
54080
54029
  * @description Total tax amount exempted for this item
54081
54030
  */
54082
54031
  exemptionAmount?: string | null;
54083
- /**
54084
- * Hasstampduty
54085
- * @description Whether stamp duty is applicable for this item's customer/item scope (based on active stamp-duty TaxRule matching), regardless of the document's applyStampDuty.
54086
- * @default false
54087
- */
54088
- hasStampDuty: boolean;
54089
- /**
54090
- * Applystampduty
54091
- * @description Whether stamp duty was actually applied to this item (true only when the document's applyStampDuty was requested AND hasStampDuty is true for this item).
54092
- * @default false
54093
- */
54094
- applyStampDuty: boolean;
54095
- /**
54096
- * Stampdutychargebearer
54097
- * @description Who bears the stamp duty charge (only 'customer' is currently supported); null when not applicable.
54098
- */
54099
- stampDutyChargeBearer?: string | null;
54100
- /**
54101
- * Stampdutyamount
54102
- * @description Stamp duty amount for this item in document/customer currency
54103
- */
54104
- stampDutyAmount?: string | null;
54105
- /**
54106
- * Secondarystampdutyamount
54107
- * @description Stamp duty amount for this item in secondary (USD) currency
54108
- */
54109
- secondaryStampDutyAmount?: string | null;
54110
- /**
54111
- * Companystampdutyamount
54112
- * @description Stamp duty amount for this item in company currency
54113
- */
54114
- companyStampDutyAmount?: string | null;
54115
54032
  /**
54116
54033
  * Subtotal
54117
54034
  * @description This field represents gross subtotal for the item
@@ -54255,60 +54172,32 @@ export interface components {
54255
54172
  * @description Total line item discount amount in company currency
54256
54173
  */
54257
54174
  companyLineDiscountAmount?: string | null;
54258
- /**
54259
- * Hasstampduty
54260
- * @description Whether stamp duty is applicable for at least one line item's customer/item scope (based on active stamp-duty TaxRule matching), regardless of applyStampDuty.
54261
- * @default false
54262
- */
54263
- hasStampDuty: boolean;
54264
- /**
54265
- * Applystampduty
54266
- * @description Whether stamp duty was actually applied to at least one line item (true only when applyStampDuty was requested AND hasStampDuty is true for that item). Amounts below are aggregated from the per-item stampDutyAmount fields (see items[].stampDutyAmount).
54267
- * @default false
54268
- */
54269
- applyStampDuty: boolean;
54270
- /**
54271
- * Stampdutychargebearer
54272
- * @description Who bears the stamp duty charge (only 'customer' is currently supported); null when not applicable.
54273
- */
54274
- stampDutyChargeBearer?: string | null;
54275
- /**
54276
- * Stampdutyamount
54277
- * @description Aggregated stamp duty amount (sum of applied line items) in document/customer currency
54278
- */
54279
- stampDutyAmount?: string | null;
54280
- /**
54281
- * Secondarystampdutyamount
54282
- * @description Aggregated stamp duty amount in secondary (USD) currency
54283
- */
54284
- secondaryStampDutyAmount?: string | null;
54285
- /**
54286
- * Companystampdutyamount
54287
- * @description Aggregated stamp duty amount in company currency
54288
- */
54289
- companyStampDutyAmount?: string | null;
54290
54175
  /** Items */
54291
54176
  items: components["schemas"]["SalesItemTotalCalculated"][];
54292
54177
  };
54293
- /** TaxExemptionInfoSchema */
54294
- TaxExemptionInfoSchema: {
54178
+ /** TaxExemptionSelectionResponseSchema */
54179
+ TaxExemptionSelectionResponseSchema: {
54295
54180
  /**
54296
54181
  * Tax
54297
54182
  * Format: uuid
54183
+ * @description Tax id for which a tax rule is selected
54298
54184
  */
54299
54185
  tax: string;
54300
54186
  /**
54301
- * Hasvalidexemption
54302
- * @default false
54303
- */
54304
- hasValidExemption: boolean;
54305
- /** Exemptionpercent */
54306
- exemptionPercent?: number | null;
54307
- /**
54308
- * Applyexemption
54309
- * @default false
54187
+ * Rule
54188
+ * Format: uuid
54189
+ * @description Selected tax rule id for the tax
54310
54190
  */
54311
- applyExemption: boolean;
54191
+ rule: string;
54192
+ };
54193
+ /** CalculateTotalsErrorResponse */
54194
+ CalculateTotalsErrorResponse: {
54195
+ /** Message */
54196
+ message?: string | null;
54197
+ /** Code */
54198
+ code?: string | null;
54199
+ /** Errors */
54200
+ errors?: components["schemas"]["ErrorMessageSchema"][] | null;
54312
54201
  };
54313
54202
  /** SalesItemTotal */
54314
54203
  SalesItemTotal: {
@@ -54342,7 +54231,7 @@ export interface components {
54342
54231
  promotionsAndOffers?: string[];
54343
54232
  /**
54344
54233
  * Taxes
54345
- * @description - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals sales and taxType not equals stampDuty
54234
+ * @description - get taxes from /api/v1/settings/accounting/taxes/
54346
54235
  * - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals sales
54347
54236
  * @default []
54348
54237
  */
@@ -54354,25 +54243,11 @@ export interface components {
54354
54243
  */
54355
54244
  includeTaxInUnitPrice: boolean;
54356
54245
  /**
54357
- * Applyexemption
54358
- * @description - List of objects, each specifying a tax id and whether to apply its exemption.
54359
- * - If applyExemption is true for a tax, and a valid (active) TaxRule exists for that tax
54360
- * matching this item/customer scope, the tax exemption percentage from that rule is
54361
- * applied, reducing the tax amount calculated for that tax on this item.
54246
+ * Taxexemptions
54247
+ * @description List of selected tax rule ids per tax for this item.
54362
54248
  * @default []
54363
54249
  */
54364
- applyExemption: components["schemas"]["TaxExemptionApplySchema"][];
54365
- /**
54366
- * Applystampduty
54367
- * @description - Stamp duty is not a regular tax: like a tax exemption, it is toggled per line item.
54368
- * It only checks whether this line item/the document customer are within a valid
54369
- * (active) stamp-duty TaxRule scope.
54370
- * - If true AND stamp duty is applicable for this item (hasStampDuty in the response is
54371
- * true for this item), the response returns this item's stamp duty amount, added to
54372
- * this item's total and to the document's aggregated totals.
54373
- * @default false
54374
- */
54375
- applyStampDuty: boolean;
54250
+ taxExemptions: components["schemas"]["TaxExemptionSelectionSchema"][];
54376
54251
  };
54377
54252
  /** SalesTotalCalculationRequest */
54378
54253
  SalesTotalCalculationRequest: {
@@ -54405,27 +54280,26 @@ export interface components {
54405
54280
  * Tax
54406
54281
  * Format: uuid
54407
54282
  * @description - tax id
54408
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals sales and taxType not equals stampDuty
54283
+ * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals sales
54409
54284
  */
54410
54285
  tax?: string;
54411
54286
  /** Items */
54412
54287
  items: components["schemas"]["SalesItemTotal"][];
54413
54288
  };
54414
- /** TaxExemptionApplySchema */
54415
- TaxExemptionApplySchema: {
54289
+ /** TaxExemptionSelectionSchema */
54290
+ TaxExemptionSelectionSchema: {
54416
54291
  /**
54417
54292
  * Tax
54418
54293
  * Format: uuid
54419
- * @description Tax id to apply/skip exemption for
54294
+ * @description Tax id for which a tax rule is selected
54420
54295
  */
54421
54296
  tax: string;
54422
54297
  /**
54423
- * Applyexemption
54424
- * @description - If true, and a valid (active) TaxRule exists for this tax matching
54425
- * this item/customer scope, the tax exemption percentage from that rule is applied,
54426
- * reducing the tax amount calculated for that tax on this item.
54298
+ * Rule
54299
+ * Format: uuid
54300
+ * @description Selected tax rule id for the tax
54427
54301
  */
54428
- applyExemption: boolean;
54302
+ rule: string;
54429
54303
  };
54430
54304
  /** CustomerBranchSharedSchema */
54431
54305
  CustomerBranchSharedSchema: {
@@ -54893,7 +54767,7 @@ export interface components {
54893
54767
  /**
54894
54768
  * Taxes
54895
54769
  * @description - visible when customer is resident
54896
- * - get taxes from /api/v1/settings/accounting/taxes/ and filter by type equals sales and taxType not equals stampDuty
54770
+ * - get taxes from /api/v1/settings/accounting/taxes/
54897
54771
  * - get default value(s) from /api/v1/inventory/items/{id}/ and filter by type equals sales
54898
54772
  * @default []
54899
54773
  */
@@ -59626,46 +59500,11 @@ export interface components {
59626
59500
  */
59627
59501
  companyExemptionAmount: string;
59628
59502
  /**
59629
- * Appliedexemptions
59630
- * @description Per-tax exemption info that was applied when the item was last calculated/saved
59631
- * @default []
59632
- */
59633
- appliedExemptions: components["schemas"]["TaxExemptionInfoSchema"][] | null;
59634
- /**
59635
- * Hasstampduty
59636
- * @description Whether stamp duty is applicable for this item's customer/item scope (based on active stamp-duty TaxRule matching)
59637
- * @default false
59638
- */
59639
- hasStampDuty: boolean;
59640
- /**
59641
- * Appliedstampduties
59642
- * @description List of stamp duty tax ids that were applied to this item
59503
+ * Taxexemptions
59504
+ * @description Selected tax rule ids per tax for this item
59643
59505
  * @default []
59644
59506
  */
59645
- appliedStampDuties: components["schemas"]["TaxSharedSchema"][];
59646
- /**
59647
- * Stampdutychargebearer
59648
- * @description Who bears the stamp duty charge (only 'customer' is currently supported); null when not applicable.
59649
- */
59650
- stampDutyChargeBearer?: string | null;
59651
- /**
59652
- * Stampdutyamount
59653
- * @description Stamp duty amount for this item in document/customer currency
59654
- * @default 0
59655
- */
59656
- stampDutyAmount: string;
59657
- /**
59658
- * Secondarystampdutyamount
59659
- * @description Stamp duty amount for this item in secondary (USD) currency
59660
- * @default 0
59661
- */
59662
- secondaryStampDutyAmount: string;
59663
- /**
59664
- * Companystampdutyamount
59665
- * @description Stamp duty amount for this item in company currency
59666
- * @default 0
59667
- */
59668
- companyStampDutyAmount: string;
59507
+ taxExemptions: components["schemas"]["TaxExemptionSelectionResponseSchema"][] | null;
59669
59508
  /**
59670
59509
  * Total
59671
59510
  * @description This field is a number representing grand total for the item.
@@ -60116,11 +59955,11 @@ export interface components {
60116
59955
  */
60117
59956
  includeTaxInUnitPrice: boolean;
60118
59957
  /**
60119
- * Appliedexemptions
60120
- * @description List of tax exemption ids to apply for this item
59958
+ * Taxexemptions
59959
+ * @description List of selected tax rule ids per tax for this item
60121
59960
  * @default []
60122
59961
  */
60123
- appliedExemptions: string[];
59962
+ taxExemptions: components["schemas"]["TaxExemptionSelectionSchema"][];
60124
59963
  /**
60125
59964
  * Dimensionallocations
60126
59965
  * @description - Optional per-line override. Field name: `dimensionAllocations` on each line/item row.
@@ -60131,12 +59970,6 @@ export interface components {
60131
59970
  * `dimensionIsInactive`, `duplicateDimension`, `invalidPercentage`, `dimensionAllocationsMustTotal100`.
60132
59971
  */
60133
59972
  dimensionAllocations?: components["schemas"]["DimensionAllocationInput"][] | null;
60134
- /**
60135
- * Appliedstampduties
60136
- * @description List of stamp duty tax ids to apply for this item
60137
- * @default []
60138
- */
60139
- appliedStampDuties: string[];
60140
59973
  };
60141
59974
  /** CreateUpdateSalesInvoiceSchema */
60142
59975
  CreateUpdateSalesInvoiceSchema: {
@@ -102514,7 +102347,7 @@ export interface operations {
102514
102347
  [name: string]: unknown;
102515
102348
  };
102516
102349
  content: {
102517
- "application/json": components["schemas"]["MessageWithCode"];
102350
+ "application/json": components["schemas"]["CalculateTotalsErrorResponse"];
102518
102351
  };
102519
102352
  };
102520
102353
  /** @description Internal Server Error */
@@ -104987,7 +104820,7 @@ export interface operations {
104987
104820
  [name: string]: unknown;
104988
104821
  };
104989
104822
  content: {
104990
- "application/json": components["schemas"]["MessageWithCode"];
104823
+ "application/json": components["schemas"]["CalculateTotalsErrorResponse"];
104991
104824
  };
104992
104825
  };
104993
104826
  /** @description Internal Server Error */
@@ -107196,7 +107029,7 @@ export interface operations {
107196
107029
  [name: string]: unknown;
107197
107030
  };
107198
107031
  content: {
107199
- "application/json": components["schemas"]["MessageWithCode"];
107032
+ "application/json": components["schemas"]["CalculateTotalsErrorResponse"];
107200
107033
  };
107201
107034
  };
107202
107035
  /** @description Internal Server Error */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.2087",
3
+ "version": "1.0.2089",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": [