FA(3) invoice builder
Public FA(3) facade and chainable builder methods.
Operations
Section titled “Operations”| Operation | Summary | Variants |
|---|---|---|
| FA(3) builder: Create | Public StandardInvoiceBuilder.create API surface. | Builder |
| FA(3) builder: Header | Set the header value. | Builder |
| FA(3) builder: Header model | Set the invoice header from an existing domain model. | Builder |
| FA(3) builder: Seller | Set the seller party from address and identifier fields. | Builder |
| FA(3) builder: Seller model | Set the seller from an existing domain model. | Builder |
| FA(3) builder: Buyer | Set the buyer party from address and identifier fields. | Builder |
| FA(3) builder: Buyer model | Set the buyer from an existing domain model. | Builder |
| FA(3) builder: Third party | Add a third-party subject from address, identity, and role fields. | Builder |
| FA(3) builder: Add third party model | Add an existing third-party domain model. | Builder |
| FA(3) builder: Replace third parties | Replace all third-party subjects. | Builder |
| FA(3) builder: Clear third parties | Remove all third-party subjects. | Builder |
| FA(3) builder: Footer model | Set the footer from an existing domain model. | Builder |
| FA(3) builder: Attachment model | Set the attachment from an existing domain model. | Builder |
| FA(3) builder: Standard | Start a standard invoice body builder. | Builder |
| FA(3) builder: Simplified | Start a simplified invoice body builder. | Builder |
| FA(3) builder: Correction | Start a correction invoice body builder. | Builder |
| FA(3) builder: Advance | Start an advance invoice body builder or sub-builder. | Builder |
| FA(3) builder: Settlement | Start a settlement invoice body builder or sub-builder. | Builder |
| FA(3) builder: Correction advance | Start a correction advance invoice body builder. | Builder |
| FA(3) builder: Correction settlement | Start a correction settlement invoice body builder. | Builder |
| FA(3) builder: Dump state | Return a serializable draft snapshot of the current builder state. | Builder |
| FA(3) builder: Dump state json | Return the current builder state as JSON. | Builder |
| FA(3) builder: Load state | Load builder state from a serializable draft snapshot. | Builder |
| FA(3) builder: From state | Create a builder from a serializable draft snapshot. | Builder |
| FA(3) builder: From state json | Create a builder from serialized JSON state. | Builder |
| FA(3) builder: From invoice | Create a builder initialized from an existing invoice. | Builder |
| FA(3) builder: Build | Build the corresponding FA(3) domain model. | Builder |
| FA(3) builder: To spec | Convert the built invoice to the generated FA(3) schema model. | Builder |
| FA(3) builder: To xml | Serialize the built invoice to XML bytes. | Builder |
FA(3) facade exports
Section titled “FA(3) facade exports”Generated from ksef2.fa3.__all__.
| Symbol | Import | Source |
|---|---|---|
ContactInfo | from ksef2.fa3 import ContactInfo | src/ksef2/domain/models/fa3/__init__.py |
FA3InvoiceBuilder | from ksef2.fa3 import FA3InvoiceBuilder | src/ksef2/fa3/__init__.py |
InvoiceAddress | from ksef2.fa3 import InvoiceAddress | src/ksef2/domain/models/fa3/__init__.py |
InvoiceEntity | from ksef2.fa3 import InvoiceEntity | src/ksef2/domain/models/fa3/__init__.py |
InvoiceHeader | from ksef2.fa3 import InvoiceHeader | src/ksef2/domain/models/fa3/__init__.py |
InvoiceSummaryOverrides | from ksef2.fa3 import InvoiceSummaryOverrides | src/ksef2/domain/models/fa3/body/__init__.py |
InvoiceThirdParty | from ksef2.fa3 import InvoiceThirdParty | src/ksef2/domain/models/fa3/__init__.py |
KsefInvoice | from ksef2.fa3 import KsefInvoice | src/ksef2/domain/models/fa3/__init__.py |
KsefInvoiceDraft | from ksef2.fa3 import KsefInvoiceDraft | src/ksef2/domain/models/fa3/__init__.py |
SaleCategory | from ksef2.fa3 import SaleCategory | src/ksef2/domain/models/fa3/body/__init__.py |
TaxRegime | from ksef2.fa3 import TaxRegime | src/ksef2/domain/models/fa3/body/__init__.py |
VatClassification | from ksef2.fa3 import VatClassification | src/ksef2/domain/models/fa3/body/__init__.py |
VatRate | from ksef2.fa3 import VatRate | src/ksef2/domain/models/fa3/body/__init__.py |
VatTreatment | from ksef2.fa3 import VatTreatment | src/ksef2/domain/models/fa3/body/__init__.py |