@erp-galoper/types 1.0.1816 → 1.0.1818

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 +253 -0
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -20395,6 +20395,38 @@ export interface paths {
20395
20395
  patch?: never;
20396
20396
  trace?: never;
20397
20397
  };
20398
+ "/api/v1/reports/receivables-by-customer-region/": {
20399
+ parameters: {
20400
+ query?: never;
20401
+ header?: never;
20402
+ path?: never;
20403
+ cookie?: never;
20404
+ };
20405
+ /**
20406
+ * Get Receivables By Customer Region Report View
20407
+ * @description Receivables by Customer Region Report - Outstanding receivables grouped by region and customer.
20408
+ *
20409
+ * **Possible Responses:**
20410
+ * - 200: Report data grouped by region and customer with unpaid invoices
20411
+ * - 400:
20412
+ * - regionsWithIds{ids}NotFound
20413
+ * - branchDoesNotExist
20414
+ * - 403:
20415
+ * - permissionDenied
20416
+ * - noBranchAccess
20417
+ *
20418
+ * **Permission Keys:**
20419
+ * - receivablesbycustomerregionreport: ["view"]
20420
+ */
20421
+ get: operations["reports_receivablesreport_views_get_receivables_by_customer_region_report_view"];
20422
+ put?: never;
20423
+ post?: never;
20424
+ delete?: never;
20425
+ options?: never;
20426
+ head?: never;
20427
+ patch?: never;
20428
+ trace?: never;
20429
+ };
20398
20430
  "/api/v1/task/status": {
20399
20431
  parameters: {
20400
20432
  query?: never;
@@ -24372,6 +24404,12 @@ export interface components {
24372
24404
  BasePermissionsSchema_Report_Project_ProjectstatementEnum: "export" | "view";
24373
24405
  /** BasePermissionsSchema_Report_Sales */
24374
24406
  BasePermissionsSchema_Report_Sales: {
24407
+ /**
24408
+ * Receivablesbycustomerregionreport
24409
+ * @description receivablesbycustomerregionreport actions
24410
+ * @default []
24411
+ */
24412
+ receivablesbycustomerregionreport: components["schemas"]["BasePermissionsSchema_Report_Sales_ReceivablesbycustomerregionreportEnum"][];
24375
24413
  /**
24376
24414
  * Salesbybrandreport
24377
24415
  * @description salesbybrandreport actions
@@ -24421,6 +24459,11 @@ export interface components {
24421
24459
  */
24422
24460
  salestrendreport: components["schemas"]["BasePermissionsSchema_Report_Sales_SalestrendreportEnum"][];
24423
24461
  };
24462
+ /**
24463
+ * BasePermissionsSchema_Report_Sales_ReceivablesbycustomerregionreportEnum
24464
+ * @enum {string}
24465
+ */
24466
+ BasePermissionsSchema_Report_Sales_ReceivablesbycustomerregionreportEnum: "export" | "view";
24424
24467
  /**
24425
24468
  * BasePermissionsSchema_Report_Sales_SalesbybrandreportEnum
24426
24469
  * @enum {string}
@@ -32951,6 +32994,11 @@ export interface components {
32951
32994
  /** Secondarybalance */
32952
32995
  secondaryBalance: number;
32953
32996
  };
32997
+ /**
32998
+ * CustomerClassificationTypeEnum
32999
+ * @enum {string}
33000
+ */
33001
+ CustomerClassificationTypeEnum: "debtor" | "paymentInAdvance";
32954
33002
  /** CustomerContactSchema */
32955
33003
  CustomerContactSchema: {
32956
33004
  /** Id */
@@ -33011,6 +33059,12 @@ export interface components {
33011
33059
  */
33012
33060
  branches: components["schemas"]["CompanyCustomerBranchSchema"][];
33013
33061
  paymentTerm: components["schemas"]["PaymentTermsEnumSchema"];
33062
+ customerType: components["schemas"]["CustomerClassificationTypeEnum"];
33063
+ /**
33064
+ * Classificationtypes
33065
+ * @default []
33066
+ */
33067
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33014
33068
  };
33015
33069
  /** CustomerGroupInfoSchema */
33016
33070
  CustomerGroupInfoSchema: {
@@ -33152,6 +33206,12 @@ export interface components {
33152
33206
  */
33153
33207
  walkInPos: boolean | null;
33154
33208
  accountClassification?: components["schemas"]["AccountClassificationSchema"] | null;
33209
+ /**
33210
+ * Classificationtypes
33211
+ * @default []
33212
+ */
33213
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33214
+ customerType: components["schemas"]["CustomerClassificationTypeEnum"];
33155
33215
  /**
33156
33216
  * Isresident
33157
33217
  * @default true
@@ -33309,6 +33369,11 @@ export interface components {
33309
33369
  attachments: string[];
33310
33370
  /** @default net30Days */
33311
33371
  paymentTerm: components["schemas"]["PaymentTermsEnumSchema"];
33372
+ /**
33373
+ * Classificationtypes
33374
+ * @description debtor is always required. Must include all existing types. New types can be added but existing ones cannot be removed.
33375
+ */
33376
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33312
33377
  };
33313
33378
  /** UpdateContactShipmentInformationSchema */
33314
33379
  UpdateContactShipmentInformationSchema: {
@@ -33392,6 +33457,12 @@ export interface components {
33392
33457
  /** Email */
33393
33458
  email?: string | null;
33394
33459
  accountClassification?: components["schemas"]["AccountClassificationSchema"] | null;
33460
+ /**
33461
+ * Classificationtypes
33462
+ * @default []
33463
+ */
33464
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33465
+ customerType: components["schemas"]["CustomerClassificationTypeEnum"];
33395
33466
  /**
33396
33467
  * Isresident
33397
33468
  * @default true
@@ -33501,6 +33572,11 @@ export interface components {
33501
33572
  companyRegistrationNumber?: string;
33502
33573
  /** @default net30Days */
33503
33574
  paymentTerm: components["schemas"]["PaymentTermsEnumSchema"];
33575
+ /**
33576
+ * Classificationtypes
33577
+ * @description debtor is always required. Must include all existing types. New types can be added but existing ones cannot be removed.
33578
+ */
33579
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33504
33580
  };
33505
33581
  /** CreateCustomerBranchSchema */
33506
33582
  CreateCustomerBranchSchema: {
@@ -33639,6 +33715,11 @@ export interface components {
33639
33715
  walkInPos: boolean | null;
33640
33716
  /** Accountclassification */
33641
33717
  accountClassification: number;
33718
+ /**
33719
+ * Classificationtypes
33720
+ * @description debtor is always required. Optionally include paymentInAdvance (e.g. ["debtor", "paymentInAdvance"]).
33721
+ */
33722
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33642
33723
  /**
33643
33724
  * Isresident
33644
33725
  * @description field should has default true and always disabled
@@ -33711,6 +33792,11 @@ export interface components {
33711
33792
  isResident: boolean;
33712
33793
  /** Accountclassification */
33713
33794
  accountClassification: number;
33795
+ /**
33796
+ * Classificationtypes
33797
+ * @description debtor is always required. Optionally include paymentInAdvance (e.g. ["debtor", "paymentInAdvance"]).
33798
+ */
33799
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33714
33800
  /**
33715
33801
  * Group
33716
33802
  * Format: uuid
@@ -33809,6 +33895,12 @@ export interface components {
33809
33895
  /** Email */
33810
33896
  email?: string | null;
33811
33897
  accountClassification?: components["schemas"]["AccountClassificationSchema"] | null;
33898
+ /**
33899
+ * Classificationtypes
33900
+ * @default []
33901
+ */
33902
+ classificationTypes: components["schemas"]["CustomerClassificationTypeEnum"][];
33903
+ customerType: components["schemas"]["CustomerClassificationTypeEnum"];
33812
33904
  /**
33813
33905
  * Isresident
33814
33906
  * @default true
@@ -33885,7 +33977,18 @@ export interface components {
33885
33977
  companyBalance: number;
33886
33978
  /** Secondarybalance */
33887
33979
  secondaryBalance: number;
33980
+ type: components["schemas"]["SupplierTypeEnum"];
33981
+ /**
33982
+ * Classificationtypes
33983
+ * @default []
33984
+ */
33985
+ classificationTypes: components["schemas"]["SupplierClassificationTypeEnum"][];
33888
33986
  };
33987
+ /**
33988
+ * SupplierClassificationTypeEnum
33989
+ * @enum {string}
33990
+ */
33991
+ SupplierClassificationTypeEnum: "creditor" | "paymentInAdvance" | "expense";
33889
33992
  /** SupplierForListSchema */
33890
33993
  SupplierForListSchema: {
33891
33994
  /**
@@ -33925,6 +34028,11 @@ export interface components {
33925
34028
  /** Banks */
33926
34029
  banks: components["schemas"]["BankAccountsSharedSchema"][];
33927
34030
  type: components["schemas"]["SupplierTypeEnum"];
34031
+ /**
34032
+ * Classificationtypes
34033
+ * @default []
34034
+ */
34035
+ classificationTypes: components["schemas"]["SupplierClassificationTypeEnum"][];
33928
34036
  };
33929
34037
  /** SupplierListSchema */
33930
34038
  SupplierListSchema: {
@@ -33999,6 +34107,11 @@ export interface components {
33999
34107
  region?: number | null;
34000
34108
  /** Accountclassification */
34001
34109
  accountClassification?: number | null;
34110
+ /**
34111
+ * Classificationtypes
34112
+ * @description creditor is always required. Optionally include paymentInAdvance and expense (e.g. ["creditor", "paymentInAdvance"]).
34113
+ */
34114
+ classificationTypes: components["schemas"]["SupplierClassificationTypeEnum"][];
34002
34115
  /**
34003
34116
  * Isresident
34004
34117
  * @description field should has default true and always disabled
@@ -34088,6 +34201,11 @@ export interface components {
34088
34201
  note?: string | null;
34089
34202
  region: components["schemas"]["RegionCommonSchema"] | null;
34090
34203
  accountClassification?: components["schemas"]["AccountClassificationSchema"] | null;
34204
+ /**
34205
+ * Classificationtypes
34206
+ * @default []
34207
+ */
34208
+ classificationTypes: components["schemas"]["SupplierClassificationTypeEnum"][];
34091
34209
  /**
34092
34210
  * Isresident
34093
34211
  * @default true
@@ -34209,6 +34327,11 @@ export interface components {
34209
34327
  group?: string;
34210
34328
  /** Companyregistrationnumber */
34211
34329
  companyRegistrationNumber?: string;
34330
+ /**
34331
+ * Classificationtypes
34332
+ * @description creditor is always required. Must include all existing types. New types can be added but existing ones cannot be removed.
34333
+ */
34334
+ classificationTypes: components["schemas"]["SupplierClassificationTypeEnum"][];
34212
34335
  };
34213
34336
  /** UpdateSupplierBankSchema */
34214
34337
  UpdateSupplierBankSchema: {
@@ -59649,6 +59772,83 @@ export interface components {
59649
59772
  */
59650
59773
  growthPercentage?: number | null;
59651
59774
  };
59775
+ /** ReceivablesByCustomerRegionContactSchema */
59776
+ ReceivablesByCustomerRegionContactSchema: {
59777
+ /** Name */
59778
+ name?: string | null;
59779
+ /** Phone */
59780
+ phone?: string | null;
59781
+ };
59782
+ /** ReceivablesByCustomerRegionCustomerSchema */
59783
+ ReceivablesByCustomerRegionCustomerSchema: {
59784
+ /**
59785
+ * Id
59786
+ * Format: uuid
59787
+ */
59788
+ id: string;
59789
+ /** Name */
59790
+ name: string;
59791
+ /** Phone */
59792
+ phone?: string | null;
59793
+ region?: components["schemas"]["RegionCommonSchema"] | null;
59794
+ city?: components["schemas"]["CommonCity"] | null;
59795
+ /** Address */
59796
+ address?: string | null;
59797
+ contactPerson?: components["schemas"]["ReceivablesByCustomerRegionContactSchema"] | null;
59798
+ totalOutstanding: components["schemas"]["CurrencyAmountSchema"];
59799
+ /** Invoices */
59800
+ invoices: components["schemas"]["ReceivablesByCustomerRegionInvoiceSchema"][];
59801
+ };
59802
+ /** ReceivablesByCustomerRegionInvoiceSchema */
59803
+ ReceivablesByCustomerRegionInvoiceSchema: {
59804
+ /** Id */
59805
+ id: string;
59806
+ /**
59807
+ * Date
59808
+ * Format: date
59809
+ */
59810
+ date: string;
59811
+ /** Duedate */
59812
+ dueDate?: string | null;
59813
+ total: components["schemas"]["CurrencyAmountSchema"];
59814
+ remaining: components["schemas"]["CurrencyAmountSchema"];
59815
+ };
59816
+ /** ReceivablesByCustomerRegionRegionSchema */
59817
+ ReceivablesByCustomerRegionRegionSchema: {
59818
+ /** Id */
59819
+ id: number;
59820
+ /** Country */
59821
+ country: string;
59822
+ /** Region */
59823
+ region: string;
59824
+ totalOutstanding: components["schemas"]["CurrencyAmountSchema"];
59825
+ /** Customercount */
59826
+ customerCount: number;
59827
+ /** Customers */
59828
+ customers: components["schemas"]["ReceivablesByCustomerRegionCustomerSchema"][];
59829
+ };
59830
+ /** ReceivablesByCustomerRegionReportMetaSchema */
59831
+ ReceivablesByCustomerRegionReportMetaSchema: {
59832
+ /**
59833
+ * Generatedat
59834
+ * Format: date-time
59835
+ */
59836
+ generatedAt: string;
59837
+ /**
59838
+ * Asofdate
59839
+ * Format: date
59840
+ */
59841
+ asOfDate: string;
59842
+ /** Totalcustomers */
59843
+ totalCustomers: number;
59844
+ totalOutstanding: components["schemas"]["CurrencyAmountSchema"];
59845
+ /** Regions */
59846
+ regions: components["schemas"]["ReceivablesByCustomerRegionRegionSchema"][];
59847
+ };
59848
+ /** ReceivablesByCustomerRegionReportSchema */
59849
+ ReceivablesByCustomerRegionReportSchema: {
59850
+ reportMeta: components["schemas"]["ReceivablesByCustomerRegionReportMetaSchema"];
59851
+ };
59652
59852
  /** RetrieveStatus */
59653
59853
  RetrieveStatus: {
59654
59854
  /**
@@ -102425,6 +102625,59 @@ export interface operations {
102425
102625
  };
102426
102626
  };
102427
102627
  };
102628
+ reports_receivablesreport_views_get_receivables_by_customer_region_report_view: {
102629
+ parameters: {
102630
+ query?: {
102631
+ /** @description Sales region(s) to filter customers (defaults to all regions) */
102632
+ regionIds?: number[] | null;
102633
+ /** @description Show invoices unpaid as of this date */
102634
+ asOfDate?: string | null;
102635
+ /** @description Filter by assigned sales manager */
102636
+ salesManagerId?: string | null;
102637
+ /** @description Filter by customer category */
102638
+ customerGroupIds?: string[] | null;
102639
+ /** @description Only include customers with overdue invoices */
102640
+ includeOverdueOnly?: boolean;
102641
+ /** @description Sort customers by city or sort regions alphabetically */
102642
+ sortBy?: "region" | "city";
102643
+ /** @description Branch filter (defaults to current branch) */
102644
+ branchesIds?: string[] | null;
102645
+ };
102646
+ header?: never;
102647
+ path?: never;
102648
+ cookie?: never;
102649
+ };
102650
+ requestBody?: never;
102651
+ responses: {
102652
+ /** @description OK */
102653
+ 200: {
102654
+ headers: {
102655
+ [name: string]: unknown;
102656
+ };
102657
+ content: {
102658
+ "application/json": components["schemas"]["ReceivablesByCustomerRegionReportSchema"];
102659
+ };
102660
+ };
102661
+ /** @description Bad Request */
102662
+ 400: {
102663
+ headers: {
102664
+ [name: string]: unknown;
102665
+ };
102666
+ content: {
102667
+ "application/json": components["schemas"]["ErrorMessages"];
102668
+ };
102669
+ };
102670
+ /** @description Forbidden */
102671
+ 403: {
102672
+ headers: {
102673
+ [name: string]: unknown;
102674
+ };
102675
+ content: {
102676
+ "application/json": components["schemas"]["MessageResponse"];
102677
+ };
102678
+ };
102679
+ };
102680
+ };
102428
102681
  task_views_list_status_by_order: {
102429
102682
  parameters: {
102430
102683
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.1816",
3
+ "version": "1.0.1818",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": ["openapi.ts"],