Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • AbstractInvoiceBuilder
  • InvoiceBuilder

Interfaces

  • InvoiceBuilderInterface
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class InvoiceBuilder

Invoice builder

Blesta\Core\Pricing\Presenter\Build\Options\AbstractOptions implements Blesta\Core\Pricing\Presenter\Build\Options\OptionsInterface
Extended by Blesta\Core\Pricing\Presenter\Build\Invoice\AbstractInvoiceBuilder implements Blesta\Core\Pricing\Presenter\Build\Invoice\InvoiceBuilderInterface
Extended by Blesta\Core\Pricing\Presenter\Build\Invoice\InvoiceBuilder
Namespace: Blesta\Core\Pricing\Presenter\Build\Invoice
Package: blesta\core\Pricing\Presenter\Build\Invoice
Copyright: Copyright (c) 2019, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at core/Pricing/Presenter/Build/Invoice/InvoiceBuilder.php
Methods summary
public InvoicePresenter
# build( stdClass $invoice )

Retrieve an InvoicePresenter

Retrieve an InvoicePresenter

Parameters

$invoice

An stdClass object representing the invoice, including: - id The invoice ID - id_code The invoice ID code - client_id The ID of the client the invoice is associated with - date_billed The date the invoice is billed for - date_due The date the invoice is due on - autodebit 1 or 0, whether the invoice can be autodebited - status The invoice status (e.g. 'active', 'proforma', etc.) - currency The ISO 4217 3-character currency code - line_items An array of stdClass objects representing each line item - id The line item ID - service_id The ID of the service this line item correlates to, if any - description The line item description - qty The line item quantity - amount The line item unit cost - taxes An array of stdClass objects representing each tax rules for this line item - id The tax rule ID - level The tax level (1 or 2) - name The name of the tax rule - amount The tax rule amount - type The tax type ('inclusive' or 'exclusive') - country The tax rule country the rule applies to - state The tax rule state/province the rule applies to - status The status of the tax rule (e.g. 'active') - cascade 1 or 0, whether or not tax rules cascade - meta An array of stdClass objects representing each meta key/value pair - key The meta key - value The meta value

Returns

InvoicePresenter
An instance of the InvoicePresenter
Methods inherited from Blesta\Core\Pricing\Presenter\Build\Invoice\AbstractInvoiceBuilder
__construct()
Methods inherited from Blesta\Core\Pricing\Presenter\Build\Options\AbstractOptions
discounts(), formatDiscounts(), formatOptions(), formatSettings(), formatTaxes(), options(), settings(), taxes()
Properties inherited from Blesta\Core\Pricing\Presenter\Build\Invoice\AbstractInvoiceBuilder
$formatFactory, $itemFactory, $presenterFactory, $pricingFactory, $serviceFactory
Properties inherited from Blesta\Core\Pricing\Presenter\Build\Options\AbstractOptions
$discounts, $options, $settings, $taxes
Blesta API documentation generated by ApiGen