feat: make tax codes and inclusion configurable in billing profiles (#…

…2156)

api/client/javascript/src/client/schemas.d.ts

@@ -2223,10 +2223,10 @@ export interface components {
        * @default false
        */
       progressiveBilling?: boolean
-      /** @description Default tax behavior for the invoice.
+      /** @description Default tax configuration to apply to the invoices.
        *
        *     Each line can override the tax behavior. If not set, the provider's defaults are used. */
-      taxBehavior?: components['schemas']['TaxBehavior']
+      defaultTaxConfig?: components['schemas']['TaxConfig']
     }
     /**
      * Workflow payment settings
@@ -4751,10 +4751,10 @@ export interface components {
        * @example P1D
        */
       dueAfter?: string
-      /** @description Default tax behavior for the invoice.
+      /** @description Default tax configuration to apply to the invoices.
        *
        *     Each line can override the tax behavior. If not set, the provider's defaults are used. */
-      taxBehavior?: components['schemas']['TaxBehavior']
+      defaultTaxConfig?: components['schemas']['TaxConfig']
     }
     /** @description InvoiceWorkflowReplaceUpdate represents the update model for an invoice workflow.
      *

api/openapi.cloud.yaml

@@ -8720,11 +8720,11 @@ components:
           type: boolean
           description: Should progressive billing be allowed for this workflow?
           default: false
-        taxBehavior:
+        defaultTaxConfig:
           allOf:
-            - $ref: '#/components/schemas/TaxBehavior'
+            - $ref: '#/components/schemas/TaxConfig'
           description: |-
-            Default tax behavior for the invoice.
+            Default tax configuration to apply to the invoices.
 
             Each line can override the tax behavior. If not set, the provider's defaults are used.
       description: BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow
@@ -12332,11 +12332,11 @@ components:
           description: The period after which the invoice is due.
           example: P1D
           default: P7D
-        taxBehavior:
+        defaultTaxConfig:
           allOf:
-            - $ref: '#/components/schemas/TaxBehavior'
+            - $ref: '#/components/schemas/TaxConfig'
           description: |-
-            Default tax behavior for the invoice.
+            Default tax configuration to apply to the invoices.
 
             Each line can override the tax behavior. If not set, the provider's defaults are used.
       description: InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow.

api/openapi.yaml

@@ -8407,11 +8407,11 @@ components:
           type: boolean
           description: Should progressive billing be allowed for this workflow?
           default: false
-        taxBehavior:
+        defaultTaxConfig:
           allOf:
-            - $ref: '#/components/schemas/TaxBehavior'
+            - $ref: '#/components/schemas/TaxConfig'
           description: |-
-            Default tax behavior for the invoice.
+            Default tax configuration to apply to the invoices.
 
             Each line can override the tax behavior. If not set, the provider's defaults are used.
       description: BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow
@@ -12098,11 +12098,11 @@ components:
           description: The period after which the invoice is due.
           example: P1D
           default: P7D
-        taxBehavior:
+        defaultTaxConfig:
           allOf:
-            - $ref: '#/components/schemas/TaxBehavior'
+            - $ref: '#/components/schemas/TaxConfig'
           description: |-
-            Default tax behavior for the invoice.
+            Default tax configuration to apply to the invoices.
 
             Each line can override the tax behavior. If not set, the provider's defaults are used.
       description: InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow.

api/spec/src/billing/profile.tsp

@@ -398,12 +398,12 @@ model BillingWorkflowInvoicingSettings {
   progressiveBilling?: boolean = false;
 
   /**
-   * Default tax behavior for the invoice.
+   * Default tax configuration to apply to the invoices.
    *
    * Each line can override the tax behavior. If not set, the provider's defaults are used.
    */
   @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update)
-  taxBehavior?: OpenMeter.ProductCatalog.TaxBehavior;
+  defaultTaxConfig?: OpenMeter.ProductCatalog.TaxConfig;
 }
 
 /**

openmeter/billing/adapter/customeroverride.go

@@ -31,7 +31,7 @@ func (a *adapter) CreateCustomerOverride(ctx context.Context, input billing.Crea
 			SetNillableInvoiceDueAfter(input.Invoicing.DueAfter.ISOStringPtrOrNil()).
 			SetNillableInvoiceCollectionMethod(input.Payment.CollectionMethod).
 			SetNillableInvoiceProgressiveBilling(input.Invoicing.ProgressiveBilling).
-			SetNillableInvoiceTaxBehavior(input.Invoicing.TaxBehavior).
+			SetNillableInvoiceDefaultTaxConfig(input.Invoicing.DefaultTaxConfig).
 			Save(ctx)
 		if err != nil {
 			return nil, err
@@ -73,7 +73,7 @@ func (a *adapter) UpdateCustomerOverride(ctx context.Context, input billing.Upda
 			SetOrClearInvoiceDueAfter(input.Invoicing.DueAfter.ISOStringPtrOrNil()).
 			SetOrClearInvoiceCollectionMethod(input.Payment.CollectionMethod).
 			SetOrClearInvoiceProgressiveBilling(input.Invoicing.ProgressiveBilling).
-			SetOrClearInvoiceTaxBehavior(input.Invoicing.TaxBehavior)
+			SetOrClearInvoiceDefaultTaxConfig(input.Invoicing.DefaultTaxConfig)
 
 		if input.ResetDeletedAt {
 			update = update.ClearDeletedAt()
@@ -265,7 +265,7 @@ func mapCustomerOverrideFromDB(dbOverride *db.BillingCustomerOverride) (*billing
 			DraftPeriod:        draftPeriod,
 			DueAfter:           dueAfter,
 			ProgressiveBilling: dbOverride.InvoiceProgressiveBilling,
-			TaxBehavior:        dbOverride.InvoiceTaxBehavior,
+			DefaultTaxConfig:   lo.EmptyableToPtr(dbOverride.InvoiceDefaultTaxConfig),
 		},
 
 		Payment: billing.PaymentOverrideConfig{

openmeter/billing/adapter/profile.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/samber/lo"
+
 	"github.com/openmeterio/openmeter/api"
 	appentitybase "github.com/openmeterio/openmeter/openmeter/app/entity/base"
 	"github.com/openmeterio/openmeter/openmeter/billing"
@@ -82,7 +84,7 @@ func (a *adapter) createWorkflowConfig(ctx context.Context, ns string, input bil
 		SetInvoiceDueAfter(input.Invoicing.DueAfter.ISOString()).
 		SetInvoiceCollectionMethod(input.Payment.CollectionMethod).
 		SetInvoiceProgressiveBilling(input.Invoicing.ProgressiveBilling).
-		SetNillableInvoiceTaxBehavior(input.Invoicing.TaxBehavior).
+		SetNillableInvoiceDefaultTaxSettings(input.Invoicing.DefaultTaxConfig).
 		Save(ctx)
 }
 
@@ -313,7 +315,7 @@ func (a *adapter) updateWorkflowConfig(ctx context.Context, ns string, id string
 		SetInvoiceDueAfter(input.Invoicing.DueAfter.ISOString()).
 		SetInvoiceCollectionMethod(input.Payment.CollectionMethod).
 		SetInvoiceProgressiveBilling(input.Invoicing.ProgressiveBilling).
-		SetOrClearInvoiceTaxBehavior(input.Invoicing.TaxBehavior).
+		SetOrClearInvoiceDefaultTaxSettings(input.Invoicing.DefaultTaxConfig).
 		Save(ctx)
 }
 
@@ -406,7 +408,7 @@ func mapWorkflowConfigFromDB(dbWC *db.BillingWorkflowConfig) (billing.WorkflowCo
 			DraftPeriod:        draftPeriod,
 			DueAfter:           dueAfter,
 			ProgressiveBilling: dbWC.InvoiceProgressiveBilling,
-			TaxBehavior:        dbWC.InvoiceTaxBehavior,
+			DefaultTaxConfig:   lo.EmptyableToPtr(dbWC.InvoiceDefaultTaxSettings),
 		},
 
 		Payment: billing.PaymentConfig{

openmeter/billing/customeroverride.go

@@ -77,11 +77,11 @@ func (c *CollectionOverrideConfig) Validate() error {
 }
 
 type InvoicingOverrideConfig struct {
-	AutoAdvance        *bool                       `json:"autoAdvance,omitempty"`
-	DraftPeriod        *datex.Period               `json:"draftPeriod,omitempty"`
-	DueAfter           *datex.Period               `json:"dueAfter,omitempty"`
-	ProgressiveBilling *bool                       `json:"progressiveBilling,omitempty"`
-	TaxBehavior        *productcatalog.TaxBehavior `json:"taxBehavior,omitempty"`
+	AutoAdvance        *bool                     `json:"autoAdvance,omitempty"`
+	DraftPeriod        *datex.Period             `json:"draftPeriod,omitempty"`
+	DueAfter           *datex.Period             `json:"dueAfter,omitempty"`
+	ProgressiveBilling *bool                     `json:"progressiveBilling,omitempty"`
+	DefaultTaxConfig   *productcatalog.TaxConfig `json:"defaultTaxConfig,omitempty"`
 }
 
 func (c *InvoicingOverrideConfig) Validate() error {
@@ -97,9 +97,9 @@ func (c *InvoicingOverrideConfig) Validate() error {
 		return fmt.Errorf("draft period must be greater or equal to 0")
 	}
 
-	if c.TaxBehavior != nil {
-		if err := c.TaxBehavior.Validate(); err != nil {
-			return fmt.Errorf("invalid tax behavior: %s", *c.TaxBehavior)
+	if c.DefaultTaxConfig != nil {
+		if err := c.DefaultTaxConfig.Validate(); err != nil {
+			return fmt.Errorf("invalid default tax config: %w", err)
 		}
 	}
 

openmeter/billing/defaults.go

@@ -22,7 +22,7 @@ var DefaultWorkflowConfig = WorkflowConfig{
 		DraftPeriod:        lo.Must(datex.ISOString("P1D").Parse()),
 		DueAfter:           lo.Must(datex.ISOString("P1W").Parse()),
 		ProgressiveBilling: false,
-		TaxBehavior:        nil,
+		DefaultTaxConfig:   nil,
 	},
 	Payment: PaymentConfig{
 		CollectionMethod: CollectionMethodChargeAutomatically,

openmeter/billing/httpdriver/profile.go

@@ -13,7 +13,6 @@ import (
 	"github.com/openmeterio/openmeter/api"
 	appentitybase "github.com/openmeterio/openmeter/openmeter/app/entity/base"
 	"github.com/openmeterio/openmeter/openmeter/billing"
-	"github.com/openmeterio/openmeter/openmeter/productcatalog"
 	"github.com/openmeterio/openmeter/pkg/datex"
 	"github.com/openmeterio/openmeter/pkg/defaultx"
 	"github.com/openmeterio/openmeter/pkg/framework/commonhttp"
@@ -395,7 +394,7 @@ func fromAPIBillingWorkflow(i api.BillingWorkflow) (billing.WorkflowConfig, erro
 			DraftPeriod:        draftPeriod,
 			DueAfter:           dueAfter,
 			ProgressiveBilling: lo.FromPtrOr(i.Invoicing.ProgressiveBilling, def.Invoicing.ProgressiveBilling),
-			TaxBehavior:        (*productcatalog.TaxBehavior)(i.Invoicing.TaxBehavior),
+			DefaultTaxConfig:   mapTaxConfigToEntity(i.Invoicing.DefaultTaxConfig),
 		},
 
 		Payment: billing.PaymentConfig{
@@ -578,7 +577,7 @@ func mapWorkflowConfigToAPI(c billing.WorkflowConfig) api.BillingWorkflow {
 			DraftPeriod:        lo.EmptyableToPtr(c.Invoicing.DraftPeriod.String()),
 			DueAfter:           lo.EmptyableToPtr(c.Invoicing.DueAfter.String()),
 			ProgressiveBilling: lo.ToPtr(c.Invoicing.ProgressiveBilling),
-			TaxBehavior:        (*api.TaxBehavior)(c.Invoicing.TaxBehavior),
+			DefaultTaxConfig:   mapTaxConfigToAPI(c.Invoicing.DefaultTaxConfig),
 		},
 
 		Payment: &api.BillingWorkflowPaymentSettings{
@@ -601,7 +600,7 @@ func mapWorkflowConfigSettingsToAPI(c billing.WorkflowConfig) api.BillingWorkflo
 			DraftPeriod:        lo.EmptyableToPtr(c.Invoicing.DraftPeriod.String()),
 			DueAfter:           lo.EmptyableToPtr(c.Invoicing.DueAfter.String()),
 			ProgressiveBilling: lo.ToPtr(c.Invoicing.ProgressiveBilling),
-			TaxBehavior:        (*api.TaxBehavior)(c.Invoicing.TaxBehavior),
+			DefaultTaxConfig:   mapTaxConfigToAPI(c.Invoicing.DefaultTaxConfig),
 		},
 
 		Payment: &api.BillingWorkflowPaymentSettings{

openmeter/billing/invoice.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/openmeterio/openmeter/api"
 	customerentity "github.com/openmeterio/openmeter/openmeter/customer/entity"
+	"github.com/openmeterio/openmeter/openmeter/productcatalog"
 	"github.com/openmeterio/openmeter/pkg/clock"
 	"github.com/openmeterio/openmeter/pkg/currencyx"
 	"github.com/openmeterio/openmeter/pkg/models"
@@ -397,21 +398,12 @@ func (i *Invoice) getLeafLines() []*Line {
 // unless the line already has a tax behavior set.
 func (i *Invoice) GetLeafLinesWithConsolidatedTaxBehavior() []*Line {
 	leafLines := i.getLeafLines()
-	if i.Workflow.Config.Invoicing.TaxBehavior == nil {
+	if i.Workflow.Config.Invoicing.DefaultTaxConfig == nil {
 		return leafLines
 	}
 
 	return lo.Map(leafLines, func(line *Line, _ int) *Line {
-		if line.TaxConfig == nil {
-			line.TaxConfig = &TaxConfig{
-				Behavior: i.Workflow.Config.Invoicing.TaxBehavior,
-			}
-			return line
-		}
-
-		if line.TaxConfig.Behavior == nil {
-			line.TaxConfig.Behavior = i.Workflow.Config.Invoicing.TaxBehavior
-		}
+		line.TaxConfig = productcatalog.MergeTaxConfigs(i.Workflow.Config.Invoicing.DefaultTaxConfig, line.TaxConfig)
 		return line
 	})
 }

openmeter/billing/profile.go

@@ -94,11 +94,11 @@ func (c *CollectionConfig) Validate() error {
 
 // InvoiceConfig groups fields related to invoice settings.
 type InvoicingConfig struct {
-	AutoAdvance        bool                        `json:"autoAdvance,omitempty"`
-	DraftPeriod        datex.Period                `json:"draftPeriod,omitempty"`
-	DueAfter           datex.Period                `json:"dueAfter,omitempty"`
-	ProgressiveBilling bool                        `json:"progressiveBilling,omitempty"`
-	TaxBehavior        *productcatalog.TaxBehavior `json:"taxBehavior,omitempty"`
+	AutoAdvance        bool                      `json:"autoAdvance,omitempty"`
+	DraftPeriod        datex.Period              `json:"draftPeriod,omitempty"`
+	DueAfter           datex.Period              `json:"dueAfter,omitempty"`
+	ProgressiveBilling bool                      `json:"progressiveBilling,omitempty"`
+	DefaultTaxConfig   *productcatalog.TaxConfig `json:"defaultTaxConfig,omitempty"`
 }
 
 func (c *InvoicingConfig) Validate() error {
@@ -110,8 +110,8 @@ func (c *InvoicingConfig) Validate() error {
 		return fmt.Errorf("due after must be greater or equal to 0")
 	}
 
-	if c.TaxBehavior != nil {
-		if err := c.TaxBehavior.Validate(); err != nil {
+	if c.DefaultTaxConfig != nil {
+		if err := c.DefaultTaxConfig.Validate(); err != nil {
 			return fmt.Errorf("invalid tax behavior: %w", err)
 		}
 	}
@@ -285,7 +285,7 @@ func (p Profile) Merge(o *CustomerOverride) Profile {
 		DraftPeriod:        lo.FromPtrOr(o.Invoicing.DraftPeriod, p.WorkflowConfig.Invoicing.DraftPeriod),
 		DueAfter:           lo.FromPtrOr(o.Invoicing.DueAfter, p.WorkflowConfig.Invoicing.DueAfter),
 		ProgressiveBilling: lo.FromPtrOr(o.Invoicing.ProgressiveBilling, p.WorkflowConfig.Invoicing.ProgressiveBilling),
-		TaxBehavior:        lo.CoalesceOrEmpty(o.Invoicing.TaxBehavior, p.WorkflowConfig.Invoicing.TaxBehavior),
+		DefaultTaxConfig:   productcatalog.MergeTaxConfigs(o.Invoicing.DefaultTaxConfig, p.WorkflowConfig.Invoicing.DefaultTaxConfig),
 	}
 
 	p.WorkflowConfig.Payment = PaymentConfig{