feat(multientities): Support for invoice custom sections for billing entities

lago_python_client/models/__init__.py

@@ -65,6 +65,10 @@
     InvoiceFee as InvoiceFee,
 )
 from .invoice_item import InvoiceItemResponse as InvoiceItemResponse
+from .invoice_custom_section import (
+    InvoiceCustomSectionResponse as InvoiceCustomSectionResponse,
+    InvoiceCustomSectionsResponseList as InvoiceCustomSectionsResponseList,
+)
 from .minimum_commitment import (
     MinimumCommitment as MinimumCommitment,
     MinimumCommitmentResponse as MinimumCommitmentResponse,

lago_python_client/models/billing_entity.py

@@ -1,7 +1,9 @@
 from typing import Optional, List
+from datetime import datetime
+
 from ..base_model import BaseModel, BaseResponseModel
 from .tax import TaxesResponse
-from datetime import datetime
+from .invoice_custom_section import InvoiceCustomSectionsResponseList
 
 
 class BillingEntityBillingConfiguration(BaseModel):
@@ -60,6 +62,7 @@ class BillingEntityUpdate(BaseModel):
     tax_codes: Optional[List[str]]
     email_settings: Optional[List[str]]
     billing_configuration: Optional[BillingEntityBillingConfiguration]
+    invoice_custom_section_codes: Optional[List[str]]
 
 
 class BillingEntityResponse(BaseResponseModel):
@@ -92,5 +95,6 @@ class BillingEntityResponse(BaseResponseModel):
     invoice_grace_period: Optional[int]
     email_settings: Optional[List[str]]
     taxes: Optional[TaxesResponse]
+    selected_invoice_custom_sections: Optional[InvoiceCustomSectionsResponseList]
     created_at: datetime
     updated_at: datetime

lago_python_client/models/customer.py

@@ -5,6 +5,7 @@
 from ..base_model import BaseResponseModel
 
 from .tax import TaxesResponse
+from .invoice_custom_section import InvoiceCustomSectionsResponseList
 
 
 class CustomerBillingConfiguration(BaseModel):
@@ -75,21 +76,6 @@ class MetadataResponseList(BaseModel):
     __root__: List[MetadataResponse]
 
 
-class InvoiceCustomSection(BaseModel):
-    lago_id: Optional[str]
-    code: Optional[str]
-    name: Optional[str]
-    description: Optional[str]
-    details: Optional[str]
-    display_name: Optional[str]
-    applied_to_organization: Optional[bool]
-    created_at: Optional[str]
-
-
-class InvoiceCustomSectionsResponseList(BaseModel):
-    __root__: List[InvoiceCustomSection]
-
-
 class Customer(BaseModel):
     external_id: str
     address_line1: Optional[str]

lago_python_client/models/invoice_custom_section.py

@@ -0,0 +1,17 @@
+from typing import List, Optional
+
+from ..base_model import BaseResponseModel
+
+
+class InvoiceCustomSectionResponse(BaseResponseModel):
+    lago_id: Optional[str]
+    code: Optional[str]
+    name: Optional[str]
+    description: Optional[str]
+    details: Optional[str]
+    display_name: Optional[str]
+    applied_to_organization: Optional[bool]  # Deprecated
+
+
+class InvoiceCustomSectionsResponseList(BaseResponseModel):
+    __root__: List[InvoiceCustomSectionResponse]

tests/fixtures/billing_entity.json

@@ -35,6 +35,16 @@
                 "created_at": "2022-04-29T08:59:51Z"
             }
         ],
+        "selected_invoice_custom_sections": [
+            {
+                "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
+                "name": "custom_section_name",
+                "code": "custom_section_code",
+                "description": "custom_section_description",
+                "details": "custom_section_details",
+                "display_name": "custom_section_display_name"
+            }
+        ],
         "email_settings": [
             "invoice.finalized",
             "payment_receipt.created"

tests/fixtures/billing_entity_index.json

@@ -26,16 +26,6 @@
             "invoice_grace_period": 3,
             "document_locale": "en",
             "tax_identification_number": "TAX123456",
-            "taxes": [
-                {
-                    "lago_id": "b7ab2926-1de8-4428-9bcd-779314ac129b",
-                    "name": "tax_name",
-                    "code": "tax_code",
-                    "rate": 15.0,
-                    "description": "tax_desc",
-                    "created_at": "2022-04-29T08:59:51Z"
-                }
-            ],
             "email_settings": [
                 "invoice.finalized",
                 "payment_receipt.created"
@@ -70,24 +60,6 @@
             "invoice_grace_period": 3,
             "document_locale": "fr",
             "tax_identification_number": "TAX654321",
-            "taxes": [
-                {
-                    "lago_id": "b7ab2926-1de8-4428-9bcd-779314ac129b",
-                    "name": "tax_name",
-                    "code": "tax_code",
-                    "rate": 15.0,
-                    "description": "tax_desc",
-                    "created_at": "2022-04-29T08:59:51Z"
-                },
-                {
-                    "lago_id": "986212f2-25dd-431c-a3cf-421588b40489",
-                    "name": "tax_name_2",
-                    "code": "tax_code_2",
-                    "rate": 27.5,
-                    "description": "tax_description_2",
-                    "created_at": "2022-04-29T08:59:51Z"
-                }
-            ],
             "email_settings": [
                 "invoice.finalized"
             ],

tests/fixtures/customer.json

@@ -79,6 +79,16 @@
         "applied_to_organization": false,
         "created_at": "2022-04-29T08:59:51Z"
       }
+    ],
+    "applicable_invoice_custom_sections": [
+      {
+          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
+          "name": "custom_section_name",
+          "code": "custom_section_code",
+          "description": "custom_section_description",
+          "details": "custom_section_details",
+          "display_name": "custom_section_display_name"
+      }
     ]
   }
 }

tests/test_billing_entity_client.py

@@ -77,6 +77,7 @@ def update_billing_entity_input():
             invoice_grace_period=5,
             document_locale="fr",
         ),
+        invoice_custom_section_codes=["custom_section_1", "custom_section_2"],
     )
 
 

tests/test_customer_client.py

@@ -95,6 +95,7 @@ def test_valid_create_customers_request(httpx_mock: HTTPXMock):
     assert response.shipping_address.state == "XZ"
     assert response.integration_customers.__root__[0].external_customer_id == "test-12345"
     assert response.integration_customers.__root__[0].type == "netsuite"
+    assert response.applicable_invoice_custom_sections.__root__[0].code == "custom_section_code"
     assert response.metadata.__root__[0].lago_id == "12345"
     assert response.metadata.__root__[0].key == "key"
     assert response.metadata.__root__[0].value == "value"