feat: expose external ids (#1933)

openmeterio · Dec 9, 2024 · 7054e80 · 7054e80
1 parent 8eb5d7b
commit 7054e80
Show file tree

Hide file tree

Showing 6 changed files with 898 additions and 714 deletions.
diff --git a/api/api.gen.go b/api/api.gen.go
diff --git a/api/openapi.cloud.yaml b/api/openapi.cloud.yaml
@@ -11139,6 +11139,11 @@ components:
             $ref: '#/components/schemas/ValidationIssue'
           description: Validation issues reported by the invoice workflow.
           readOnly: true
+        externalIDs:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceAppExternalIDs'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
       description: Invoice represents an invoice in the system.
     InvoiceAction:
       type: string
@@ -11149,6 +11154,22 @@ components:
         - retry
         - void
       description: InvoiceAction represents the actions that can be performed on an invoice.
+    InvoiceAppExternalIDs:
+      type: object
+      properties:
+        Invoicing:
+          type: string
+          description: The external ID of the invoice in the invoicing app if available.
+          readOnly: true
+        Tax:
+          type: string
+          description: The external ID of the invoice in the tax app if available.
+          readOnly: true
+        Payment:
+          type: string
+          description: The external ID of the invoice in the payment app if available.
+          readOnly: true
+      description: InvoiceAppExternalIDs contains the external IDs of the invoice in other apps such as Stripe.
     InvoiceDocumentRef:
       type: object
       allOf:
@@ -11302,6 +11323,11 @@ components:
           format: date-time
           example: 2023-01-01T01:01:01.001Z
           description: The time this line item should be invoiced.
+        externalIDs:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
         type:
           type: string
           enum:
@@ -11489,6 +11515,18 @@ components:
           usage_based: '#/components/schemas/InvoiceUsageBasedLine'
           flat_fee: '#/components/schemas/InvoiceFlatFeeLine'
       description: BillingInvoiceLine represents a line item that is sold to the customer based on a specific (unit) price.
+    InvoiceLineAppExternalIDs:
+      type: object
+      properties:
+        Invoicing:
+          type: string
+          description: The external ID of the invoice in the invoicing app if available.
+          readOnly: true
+        Tax:
+          type: string
+          description: The external ID of the invoice in the tax app if available.
+          readOnly: true
+      description: InvoiceLineAppExternalIDs contains the external IDs of the invoice in other apps such as Stripe.
     InvoiceLineDiscount:
       type: object
       required:
@@ -11934,6 +11972,11 @@ components:
           format: date-time
           example: 2023-01-01T01:01:01.001Z
           description: The time this line item should be invoiced.
+        externalIDs:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
         type:
           type: string
           enum:

diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -10829,6 +10829,11 @@ components:
             $ref: '#/components/schemas/ValidationIssue'
           description: Validation issues reported by the invoice workflow.
           readOnly: true
+        externalIDs:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceAppExternalIDs'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
       description: Invoice represents an invoice in the system.
     InvoiceAction:
       type: string
@@ -10839,6 +10844,22 @@ components:
         - retry
         - void
       description: InvoiceAction represents the actions that can be performed on an invoice.
+    InvoiceAppExternalIDs:
+      type: object
+      properties:
+        Invoicing:
+          type: string
+          description: The external ID of the invoice in the invoicing app if available.
+          readOnly: true
+        Tax:
+          type: string
+          description: The external ID of the invoice in the tax app if available.
+          readOnly: true
+        Payment:
+          type: string
+          description: The external ID of the invoice in the payment app if available.
+          readOnly: true
+      description: InvoiceAppExternalIDs contains the external IDs of the invoice in other apps such as Stripe.
     InvoiceDocumentRef:
       type: object
       allOf:
@@ -10992,6 +11013,11 @@ components:
           format: date-time
           example: 2023-01-01T01:01:01.001Z
           description: The time this line item should be invoiced.
+        externalIDs:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
         type:
           type: string
           enum:
@@ -11179,6 +11205,18 @@ components:
           usage_based: '#/components/schemas/InvoiceUsageBasedLine'
           flat_fee: '#/components/schemas/InvoiceFlatFeeLine'
       description: BillingInvoiceLine represents a line item that is sold to the customer based on a specific (unit) price.
+    InvoiceLineAppExternalIDs:
+      type: object
+      properties:
+        Invoicing:
+          type: string
+          description: The external ID of the invoice in the invoicing app if available.
+          readOnly: true
+        Tax:
+          type: string
+          description: The external ID of the invoice in the tax app if available.
+          readOnly: true
+      description: InvoiceLineAppExternalIDs contains the external IDs of the invoice in other apps such as Stripe.
     InvoiceLineDiscount:
       type: object
       required:
@@ -11624,6 +11662,11 @@ components:
           format: date-time
           example: 2023-01-01T01:01:01.001Z
           description: The time this line item should be invoiced.
+        externalIDs:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
         type:
           type: string
           enum:

diff --git a/api/spec/src/billing/invoices/invoice.tsp b/api/spec/src/billing/invoices/invoice.tsp
@@ -189,6 +189,12 @@ model Invoice {
    */
   @visibility("read")
   validationIssues?: ValidationIssue[];
+
+  /**
+   * External IDs of the invoice in other apps such as Stripe.
+   */
+  @visibility("read")
+  externalIDs?: InvoiceAppExternalIDs;
 }
 
 /**
@@ -568,6 +574,12 @@ model InvoiceLineBase {
    */
   @visibility("read", "create", "update")
   invoiceAt: DateTime;
+
+  /**
+   * External IDs of the invoice in other apps such as Stripe.
+   */
+  @visibility("read")
+  externalIDs?: InvoiceLineAppExternalIDs;
 }
 
 /**
@@ -836,3 +848,45 @@ model ValidationIssue {
   @visibility("read")
   metadata?: Metadata;
 }
+
+/**
+ * InvoiceAppExternalIDs contains the external IDs of the invoice in other apps such as Stripe.
+ */
+@friendlyName("InvoiceAppExternalIDs")
+model InvoiceAppExternalIDs {
+  /**
+   * The external ID of the invoice in the invoicing app if available.
+   */
+  @visibility("read")
+  Invoicing?: string;
+
+  /**
+   * The external ID of the invoice in the tax app if available.
+   */
+  @visibility("read")
+  Tax?: string;
+
+  /**
+   * The external ID of the invoice in the payment app if available.
+   */
+  @visibility("read")
+  Payment?: string;
+}
+
+/**
+ * InvoiceLineAppExternalIDs contains the external IDs of the invoice in other apps such as Stripe.
+ */
+@friendlyName("InvoiceLineAppExternalIDs")
+model InvoiceLineAppExternalIDs {
+  /**
+   * The external ID of the invoice in the invoicing app if available.
+   */
+  @visibility("read")
+  Invoicing?: string;
+
+  /**
+   * The external ID of the invoice in the tax app if available.
+   */
+  @visibility("read")
+  Tax?: string;
+}
diff --git a/openmeter/billing/httpdriver/invoice.go b/openmeter/billing/httpdriver/invoice.go
@@ -385,6 +385,10 @@ func mapInvoiceToAPI(invoice billing.Invoice) (api.Invoice, error) {
 					Field:     lo.EmptyableToPtr(v.Path),
 				}
 			})),
+		ExternalIDs: lo.EmptyableToPtr(api.InvoiceAppExternalIDs{
+			Invoicing: lo.EmptyableToPtr(invoice.ExternalIDs.Invoicing),
+			Payment:   lo.EmptyableToPtr(invoice.ExternalIDs.Payment),
+		}),
 	}
 
 	if invoice.Workflow != nil {

diff --git a/openmeter/billing/httpdriver/invoiceline.go b/openmeter/billing/httpdriver/invoiceline.go
@@ -500,6 +500,10 @@ func mapFeeLineToAPI(line *billing.Line) (api.InvoiceLine, error) {
 		Discounts: mapDiscountsToAPI(line.Discounts),
 		Totals:    mapTotalsToAPI(line.Totals),
 		Children:  children,
+
+		ExternalIDs: &api.InvoiceLineAppExternalIDs{
+			Invoicing: lo.EmptyableToPtr(line.ExternalIDs.Invoicing),
+		},
 	}
 
 	out := api.InvoiceLine{}
@@ -556,6 +560,10 @@ func mapUsageBasedLineToAPI(line *billing.Line) (api.InvoiceLine, error) {
 		Discounts: mapDiscountsToAPI(line.Discounts),
 		Children:  children,
 		Totals:    mapTotalsToAPI(line.Totals),
+
+		ExternalIDs: lo.EmptyableToPtr(api.InvoiceLineAppExternalIDs{
+			Invoicing: lo.EmptyableToPtr(line.ExternalIDs.Invoicing),
+		}),
 	}
 
 	out := api.InvoiceLine{}