Module "invoice"

Description

Invoice Module

This module allows you to retrieve all the information regarding
an invoice. This is only textual information, if you need more
details concerning the specific products on an invoice, you need
to consult the order information linked to this invoice.

→ SOAP WSDL

Available methods

Details

int count

Count the invoices that match certain criteria. Often used in
combination with the get_paged() method.

Parameters

  • array $extra_conditions Extra conditions such as a search

Returns

  • int $count The number of invoices that matched

array count_totals

Count the invoice totals on invoices that match certain
criteria. Often used in combination with the get_paged()
method to know the outstanding amount of invoices

Parameters

  • array $extra_conditions Extra conditions such as a search

Returns

  • array $count The amount of the invoices that matched

array get_by_id

Retrieve all invoice information by supplying its ID

Parameters

  • int $id The invoice ID

Returns

  • array $info Array containing all the invoice information

array get_by_number

Retrieve all invoice information by supplying its number

Parameters

  • int $number The invoice number

Returns

  • array $info Array containing all the invoice information

array get_by_reseller

Retrieve all invoices for a specific reseller. The retruned
array contains all the information returned by the single
invoice calls.

Parameters

  • int $reseller_id The reseller to get invoices for

Returns

  • array $invoice_data Array containing all information of all invoices

array get_by_user

Retrieve all invoices for a specific user

Parameters

  • int $user_id The user to get invoices for

Returns

  • array $invoice_data Array containing all information of all invoices for this user

array get_paged

Retrieve all invoices available for the currently
authenticated user. The returned array contains all the
information returned by the single invoice calls.

Parameters

  • string $sort The field to sort on, can be any field related to an invoice
  • string $direction The sorting direction, can be either ASC or DESC
  • int $page The page number you want to retrieve
  • array $extra_conditions Extra conditions such as a search

Returns

  • array $invoice_data Array containing all information of all invoices in the resultset

array get_pdf

Get the invoice PDF by supplying its ID

Parameters

  • int $id The invoice ID

Returns

  • array $file