diff options
author | Ivan Kohler <ivan@freeside.biz> | 2015-01-21 01:20:41 -0800 |
---|---|---|
committer | Ivan Kohler <ivan@freeside.biz> | 2015-01-21 01:20:41 -0800 |
commit | ddbe06e47316e996f909dc534a9aeabe7b47d0f3 (patch) | |
tree | ee2ee7cda9eda67c89561eeee6035d3ccde6ffd1 /FS/FS/cust_credit.pm | |
parent | 908a4522939c0225ef4e7ba4236dab2eebe9daca (diff) |
update api docs for cust_credit_source_bill_pkg changes, RT#32706
Diffstat (limited to 'FS/FS/cust_credit.pm')
-rw-r--r-- | FS/FS/cust_credit.pm | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm index dde847a..9eb624e 100644 --- a/FS/FS/cust_credit.pm +++ b/FS/FS/cust_credit.pm @@ -132,11 +132,27 @@ sub cust_unlinked_msg { ' (cust_credit.crednum '. $self->crednum. ')'; } -=item insert +=item insert [ OPTION => VALUE ... ] Adds this credit to the database ("Posts" the credit). If there is an error, returns the error, otherwise returns false. +Ooptions are passed as a list of keys and values. Available options: + +=over 4 + +=item reason_type + +L<FS::reason_type|Reason> type for newly-inserted reason + +=item cust_credit_source_bill_pkg + +An arrayref of +L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bilL_pkg> objects. +They will have their crednum set and will be inserted along with this credit. + +=back + =cut sub insert { |