This class is an instantion of the Command class, that executes a command pertaining to fetching invoice information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetPackages command:
<mbapi> <command><!-- None --></command> <showXMLHeader><!-- None --></showXMLHeader> <params> <invoiceID><!-- int --></invoiceID> <invoiceNumber><!-- string --></invoiceNumber> <packageID><!-- int --></packageID> <clientID><!-- int --></clientID> <domainID><!-- int --></domainID> <certID><!-- int --></certID> <productID><!-- int --></productID> <taxZoneID><!-- int --></taxZoneID> <invoiceAmount><!-- double --></invoiceAmount> <invoiceAmountLessThan><!-- double --></invoiceAmountLessThan> <invoiceAmountGreaterThan><!-- double --></invoiceAmountGreaterThan> <invoiceAmountPaid><!-- double --></invoiceAmountPaid> <invoiceAmountPaidLessThan><!-- double --></invoiceAmountPaidLessThan> <invoiceAmountPaidGreaterThan><!-- double --></invoiceAmountPaidGreaterThan> <invoiceDateEntered><!-- int --></invoiceDateEntered> <invoiceDateEnteredLessThan><!-- int --></invoiceDateEnteredLessThan> <invoiceDateEnteredGreaterThan><!-- int --></invoiceDateEnteredGreaterThan> <invoiceDateDue><!-- int --></invoiceDateDue> <invoiceDateDueLessThan><!-- int --></invoiceDateDueLessThan> <invoiceDateDueGreaterThan><!-- int --></invoiceDateDueGreaterThan> <invoiceDatePaid><!-- int --></invoiceDatePaid> <invoiceDatePaidLessThan><!-- int --></invoiceDatePaidLessThan> <invoiceDatePaidGreaterThan><!-- int --></invoiceDatePaidGreaterThan> <invoicePaymentMethod><!-- int --></invoicePaymentMethod> <invoiceComments><!-- string --></invoiceComments> <invoiceSubTotal><!-- None --></invoiceSubTotal> <invoiceSubTotalLessThan><!-- None --></invoiceSubTotalLessThan> <invoiceSubTotalGreaterThan><!-- None --></invoiceSubTotalGreaterThan> <invoiceDiscount><!-- None --></invoiceDiscount> <invoiceDiscountLessThan><!-- None --></invoiceDiscountLessThan> <invoiceDiscountGreaterThan><!-- None --></invoiceDiscountGreaterThan> <invoiceTax><!-- None --></invoiceTax> <invoiceTaxLessThan><!-- None --></invoiceTaxLessThan> <invoiceTaxGreaterThan><!-- None --></invoiceTaxGreaterThan> <invoiceStatus><!-- None --></invoiceStatus> <paymentGroupID><!-- None --></paymentGroupID> <getDueInvoicesOnly><!-- int --></getDueInvoicesOnly> <getPaidInovicesOnly><!-- int --></getPaidInovicesOnly> <getInvoiceLineItemsData><!-- None --></getInvoiceLineItemsData> <getInvoiceLineItemsPaymentsData><!-- None --></getInvoiceLineItemsPaymentsData> <getTaxZonesData><!-- None --></getTaxZonesData> <getProductData><!-- None --></getProductData> <getTransactionData><!-- None --></getTransactionData> <getSubscriptionData><!-- None --></getSubscriptionData> <clientStatus><!-- None --></clientStatus> <getInvoiceStats><!-- int --></getInvoiceStats> <mergeContactData><!-- int --></mergeContactData> <sortDir><!-- None --></sortDir> <sortColumn><!-- None --></sortColumn> <recordOffset><!-- None --></recordOffset> <numRecords><!-- None --></numRecords> </params> </mbapi>
None
mbapi
command
showXMLHeader
params
invoiceID
The ID of the invoice to fetch. This will always select at most 1 invoice item.
invoiceNumber
The invoice number, can contain string characters.
packageID
The ID of the package to fetch. This will always select invoices generated for this package.
clientID
The ID of the client to fetch invoices for
domainID
The ID of the domain to fetch. This will always select invoices generated for this domain.
certID
The ID of the cert to fetch. This will always select invoices generated for this cert.
productID
The ID of the product to fetch. This will always select invoices generated for this product.
taxZoneID
The ID of the tax zone to fetch. This will always select invoices generated for this tax zone.
invoiceAmount
The amount of the invoice to fetch. This will always select invoices generated for this amount.
invoiceAmountLessThan
The greatest amount of the invoice to fetch. This will always select invoices less than the greatest amount.
invoiceAmountGreaterThan
The least amount of the invoice to fetch. This will always select invoices greater than the least amount.
invoiceAmountPaid
The amount paid of the invoice to fetch. This will always select invoices with the exact amount paid.
invoiceAmountPaidLessThan
The greatest amount paid of the invoice to fetch. This will always select invoices less than the greatest amount paid.
invoiceAmountPaidGreaterThan
The least amount paid of the invoice to fetch. This will always select invoices greater than the least amount paid.
invoiceDateEntered
The date created unix timestamp of the invoice to fetch. This will always select invoices with the exact date created unix timestamp.
invoiceDateEnteredLessThan
The greatest date created unix timestamp of the invoice to fetch. This will always select invoices less than the greatest date created unix timestamp.
invoiceDateEnteredGreaterThan
The least date created unix timestamp of the invoice to fetch. This will always select invoices greater than the least date created unix timestamp.
invoiceDateDue
The date due unix timestamp of the invoice to fetch. This will always select invoices with the exact date due unix timestamp.
invoiceDateDueLessThan
The greatest date due unix timestamp of the invoice to fetch. This will always select invoices less than the greatest date due unix timestamp.
invoiceDateDueGreaterThan
The least date due unix timestamp of the invoice to fetch. This will always select invoices greater than the least date due unix timestamp.
invoiceDatePaid
The date paid unix timestamp of the invoice to fetch. This will always select invoices with the exact date paid unix timestamp.
invoiceDatePaidLessThan
The greatest date paid unix timestamp of the invoice to fetch. This will always select invoices less than the greatest date paid unix timestamp.
invoiceDatePaidGreaterThan
The least date paid unix timestamp of the invoice to fetch. This will always select invoices greater than the least date paid unix timestamp.
invoicePaymentMethod
The ID of the payment method of the invoice to fetch. This will always select invoices with the same payment methods.
invoiceComments
A string in the involice comments of the invoice to fetch. This will always select invoices with a like string in the comments.
invoiceSubTotal
invoiceSubTotalLessThan
invoiceSubTotalGreaterThan
invoiceDiscount
invoiceDiscountLessThan
invoiceDiscountGreaterThan
invoiceTax
invoiceTaxLessThan
invoiceTaxGreaterThan
invoiceStatus
paymentGroupID
getDueInvoicesOnly
Set to 1 to return only invoices that are due in full or partial.
getPaidInovicesOnly
Set to 1 to return only invoices that are paid in full.
getInvoiceLineItemsData
getInvoiceLineItemsPaymentsData
getTaxZonesData
getProductData
getTransactionData
getSubscriptionData
clientStatus
getInvoiceStats
Set to 1 obtain a count of invoices grouped by status. Useful for overview pages.
mergeContactData
Set to 1 merge the company data to each invoice in the response.
sortDir
sortColumn
recordOffset
numRecords