Merge pull request #926 from fattureincloud/BOE-2508-add-get-tax-prof…

…ile-call-to-api-spec-docs

added get tax profile method

models/responses/GetTaxProfileResponse.yaml

@@ -0,0 +1,5 @@
+title: GetTaxProfileResponse
+type: object
+properties:
+  data:
+    $ref: ../schemas/TaxProfile.yaml

models/schemas/TaxProfile.yaml

@@ -0,0 +1,85 @@
+title: TaxProfile
+type: object
+properties:
+  company_type:
+    type: string
+    description: The company type
+    nullable: true
+  company_subtype:
+    type: string
+    description: The company subtype
+    nullable: true
+  profession:
+    type: string
+    description: The profession
+    nullable: true
+  regime:
+    type: string
+    description: The applied regime
+    nullable: true
+  rivalsa_name:
+    type: string
+    description: The name of the rivalsa
+    nullable: true
+  default_rivalsa:
+    type: number
+    description: The default rivalsa amount
+    nullable: true
+  cassa_name:
+    type: string
+    description: The name of the cassa
+    nullable: true
+  default_cassa:
+    type: number
+    description: The default cassa amount
+    nullable: true
+  default_cassa_taxable:
+    type: number
+    description: The default taxable amount for the cassa
+    nullable: true
+  cassa2_name:
+    type: string
+    description: The name of the second cassa
+    nullable: true
+  default_cassa2:
+    type: number
+    description: The default second cassa amount
+    nullable: true
+  default_cassa2_taxable:
+    type: number
+    description: The default taxable amount for the second cassa
+    nullable: true
+  default_withholding_tax:
+    type: number
+    description: The default withholding tax
+    nullable: true
+  default_withholding_tax_taxable:
+    type: number
+    description: The default taxable amount for the withholding tax
+    nullable: true
+  default_other_withholding_tax:
+    type: number
+    description: The default other withholding tax
+    nullable: true
+  enasarco:
+    type: boolean
+    description: If it has enasarco
+    nullable: true
+  enasarco_type:
+    type: string
+    description: The enasarco type
+    nullable: true
+  contributions_percentage:
+    type: number
+    description: The contributions percentage
+    nullable: true
+  profit_coefficient:
+    type: number
+    description: The profit coefficient
+    nullable: true
+  med:
+    type: boolean
+    description: If the health card system is active
+    nullable: true
+  default_vat:
+    $ref: ./VatType.yaml

models/schemas/VatType.yaml

@@ -45,3 +45,7 @@ properties:
     type: boolean
     description: Is the vat type disabled
     nullable: true
+  default:
+    description: If the vat type is default
+    type: boolean
+    nullable: true

openapi.yaml

@@ -2753,6 +2753,21 @@ paths:
                     iban: IT17Q0051343200000003497636
                     sia: T1234
                     virtual: false
+  /c/{company_id}/settings/tax_profile:
+    parameters:
+      - $ref: '#/components/parameters/company_id'
+    get:
+      summary: Get Tax Profile
+      operationId: getTaxProfile
+      tags:
+        - Settings
+      responses:
+        '200':
+          $ref: '#/components/responses/GetTaxProfileResponse'
+      description: Gets the Tax Profile
+      security:
+        - OAuth2AuthenticationCodeFlow:
+            - 'settings:r'
   /c/{company_id}/settings/payment_accounts/{payment_account_id}:
     parameters:
       - $ref: '#/components/parameters/company_id'
@@ -8953,5 +8968,45 @@ components:
                 data:
                   limit: 3000
                   usage: 100
+    GetTaxProfileResponse:
+      description: Example response
+      content:
+        application/json:
+          schema:
+            $ref: ./models/responses/GetTaxProfileResponse.yaml
+          examples:
+            example-1:
+              value:
+                data:
+                  company_type: individual
+                  company_subtype: artigiani
+                  profession: null
+                  regime: forfettario_5
+                  rivalsa_name: ''
+                  default_rivalsa: 0
+                  cassa_name: ''
+                  default_cassa: 0
+                  default_cassa_taxable: 100
+                  cassa2_name: ''
+                  default_cassa2: 0
+                  default_cassa2_taxable: 0
+                  default_withholding_tax: 0
+                  default_withholding_tax_taxable: 100
+                  default_other_withholding_tax: 0
+                  enasarco: false
+                  enasarco_type: null
+                  contributions_percentage: 0
+                  med: false
+                  default_vat:
+                    id: 66
+                    value: 0
+                    description: Contribuenti forfettari
+                    notes: 'Operazione non soggetta a IVA ai sensi dell''art. 1, commi 54-89, Legge n. 190\/2014 e succ. modifiche\/integrazioni'
+                    e_invoice: true
+                    ei_type: 2.2
+                    ei_description: 'Non soggetta art. 1\/54-89 L. 190\/2014 e succ. modifiche\/integrazioni'
+                    editable: false
+                    is_disabled: false
+                    default: true
 security:
   - OAuth2AuthenticationCodeFlow: []