Blesta
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • areyouahuman
      • auth
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
        • default
      • exchange
        • rates
          • google
            • finance
          • yahoo
            • finance
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • quickbooks
            • invoice
      • json
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • recaptcha
      • reports
        • aging
          • invoices
        • custom
          • report
        • invoice
          • creation
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • components
      • input
      • record
    • helpers
      • color
      • data
        • structure
      • date
      • form
      • html
      • javascript
      • xml
    • lib
  • None
  • PHP

Classes

  • InvoiceDelivery

Class InvoiceDelivery

Invoice Delivery component

Consolidates invoice creation and delivery. Supports email, interfax, and postalmethods.

Package: blesta\components\invoice\delivery
Copyright: Copyright (c) 2011, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/invoice_delivery/invoice_delivery.php

Methods summary

public
# __construct( )

Initialize the Invoice Delivery object

Initialize the Invoice Delivery object

public
# deliverInvoices( array $invoice_ids, string $delivery_method, mixed $deliver_to = null, string $from_staff_id = null, array $options = null )

Delivers a set of invoices using the given delivery method. All invoices are compiled together into a single document.

Delivers a set of invoices using the given delivery method. All invoices are compiled together into a single document.

Parameters

$invoice_ids
array
$invoice_ids An array of invoice IDs to deliver
$delivery_method
string
$delivery_method The delivery method (email, interfax, postalmethods)
$deliver_to
mixed
$deliver_to The destination of the invoices, a string or array of email addresses or fax numbers (optional, can not override invoice postal address)
$from_staff_id
string
$from_staff_id The ID of the staff member this invoice is to be delivered from (optional)
$options
array
$options An array of additional options to pass and may include: - base_client_url The base URL to the client interface - email_template The email template name to use (optional) - email_tags An array of key/value tag replacements (optional) - language The language to use (optional, defaults to the invoice client's language, or the system's language otherwise)
public
# downloadInvoices( array $invoice_ids, array $options = null )

Offers for download a set of invoices. All invoices are compiled together into a single document.

Offers for download a set of invoices. All invoices are compiled together into a single document.

Parameters

$invoice_ids
array
$invoice_ids A numerically-indexed array of invoice IDs from which to download
$options
array
$options An array of options including (optional): - language The language to use (optional, defaults to the invoice client's language, or the system's language otherwise)
public array
# errors( )

Returns an errors raised

Returns an errors raised

Returns

array
An array of errors, boolean false if no errors were set

Magic methods summary

Blesta API documentation generated by ApiGen 2.8.0