Module "creditnote"
Description
Available methods
- void add_creditnote_item
- int count
- array count_totals
- array get_by_id
- array get_by_number
- array get_by_user
- array get_paged
- array get_pdf
- int insert
- void mail_invoice
- void regenerate_pdf
- void render
Details
void add_creditnote_item
Add credit note item
Parameters
- int $creditnote_id
- array $details
int count
Count the invoices
Parameters
- array $extra_conditions
Returns
- int $count
array count_totals
Count the invoices
Parameters
- array $extra_conditions
Returns
- array $count
array get_by_id
Get by ID
Parameters
- int $id
Returns
- array $info
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_user
Get by User
Parameters
- int $user_id
Returns
- array $invoice_data
array get_paged
Get paged
Parameters
- string $sort
- string $direction
- int $page
- array $extra_conditions
Returns
- array $invoice_data
array get_pdf
Get the invoice PDF by supplying its ID
Parameters
- int $id The invoice ID
Returns
- array $file
int insert
Insert a new \creditnote
Parameters
- array $details
Returns
- int $id
void mail_invoice
Mail invoice
Parameters
- int $invoice_id
void regenerate_pdf
Regenerate PDF
Parameters
- int $invoice_id
void render
Render
Parameters
- int $credit_note_id