The invoice
module
- class magento.models.invoice.Invoice(data, client)[source]View on GitHub
Bases:
Model
Wrapper for the
invoices
endpoint- DOCUMENTATION: str = 'https://adobe-commerce.redoc.ly/2.3.7-admin/tag/invoices'
Link to the Official Magento 2 API documentation for the endpoint wrapped by the Model
- __init__(data, client)[source]View on GitHub
Initialize an Invoice object using an API response from the
invoices
endpoint
- property excluded_keys: List[str]
API response keys that shouldn’t be set as object attributes by
set_attrs()
- Returns
list of API response keys that shouldn’t be set as attributes
- property items: List[InvoiceItem]
The invoiced items, returned as a list of
InvoiceItem
objects
- class magento.models.invoice.InvoiceItem(item, invoice)[source]View on GitHub
Bases:
Model
Wraps an item entry of an
Invoice
- DOCUMENTATION: str = 'https://adobe-commerce.redoc.ly/2.3.7-admin/tag/invoicesid'
Link to the Official Magento 2 API documentation for the endpoint wrapped by the Model
- __init__(item, invoice)[source]View on GitHub
Initialize an InvoiceItem of an
Invoice
- data_endpoint(scope=None)[source]View on GitHub
No data endpoint exists for invoice items
- query_endpoint()[source]View on GitHub
No search endpoint exists for invoice items
- property excluded_keys: List[str]
API response keys that shouldn’t be set as object attributes by
set_attrs()
- Returns
list of API response keys that shouldn’t be set as attributes