00001 <?php
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034 class Mage_Sales_Model_Order_Invoice_Api extends Mage_Sales_Model_Api_Resource
00035 {
00036 public function __construct()
00037 {
00038 $this->_attributesMap['invoice'] = array(
00039 'invoice_id' => 'entity_id'
00040 );
00041
00042 $this->_attributesMap['invoice_item'] = array(
00043 'item_id' => 'entity_id'
00044 );
00045
00046 $this->_attributesMap['invoice_comment'] = array(
00047 'comment_id' => 'entity_id'
00048 );
00049 }
00050
00051
00052
00053
00054
00055
00056
00057 public function items($filters = null)
00058 {
00059
00060 $collection = Mage::getResourceModel('sales/order_invoice_collection')
00061 ->addAttributeToSelect('order_id')
00062 ->addAttributeToSelect('increment_id')
00063 ->addAttributeToSelect('created_at')
00064 ->addAttributeToSelect('state')
00065 ->addAttributeToSelect('grand_total')
00066 ->addAttributeToSelect('order_currency_code')
00067 ->joinAttribute('billing_firstname', 'order_address/firstname', 'billing_address_id', null, 'left')
00068 ->joinAttribute('billing_lastname', 'order_address/lastname', 'billing_address_id', null, 'left')
00069 ->joinAttribute('order_increment_id', 'order/increment_id', 'order_id', null, 'left')
00070 ->joinAttribute('order_created_at', 'order/created_at', 'order_id', null, 'left');
00071
00072 if (is_array($filters)) {
00073 try {
00074 foreach ($filters as $field => $value) {
00075 if (isset($this->_attributesMap['invoice'][$field])) {
00076 $field = $this->_attributesMap['invoice'][$field];
00077 }
00078
00079 $collection->addFieldToFilter($field, $value);
00080 }
00081 } catch (Mage_Core_Exception $e) {
00082 $this->_fault('filters_invalid', $e->getMessage());
00083 }
00084 }
00085
00086 $result = array();
00087
00088 foreach ($collection as $invoice) {
00089 $result[] = $this->_getAttributes($invoice, 'invoice');
00090 }
00091
00092 return $result;
00093 }
00094
00095
00096
00097
00098
00099
00100
00101 public function info($invoiceIncrementId)
00102 {
00103 $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
00104
00105
00106
00107 if (!$invoice->getId()) {
00108 $this->_fault('not_exists');
00109 }
00110
00111 $result = $this->_getAttributes($invoice, 'invoice');
00112
00113 $result['items'] = array();
00114 foreach ($invoice->getAllItems() as $item) {
00115 $result['items'][] = $this->_getAttributes($item, 'invoice_item');
00116 }
00117
00118 $result['comments'] = array();
00119 foreach ($invoice->getCommentsCollection() as $comment) {
00120 $result['comments'][] = $this->_getAttributes($comment, 'invoice_comment');
00121 }
00122
00123 return $result;
00124 }
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135
00136 public function create($orderIncrementId, $itemsQty, $comment = null, $email = false, $includeComment = false)
00137 {
00138 $order = Mage::getModel('sales/order')->loadByIncrementId($orderIncrementId);
00139
00140
00141
00142
00143
00144 if (!$order->getId()) {
00145 $this->_fault('order_not_exists');
00146 }
00147
00148
00149
00150
00151 if (!$order->canInvoice()) {
00152 $this->_fault('data_invalid', Mage::helper('sales')->__('Can not do invoice for order.'));
00153 }
00154
00155 $invoice = $order->prepareInvoice($itemsQty);
00156
00157 $invoice->register();
00158
00159 if ($comment !== null) {
00160 $invoice->addComment($comment, $email);
00161 }
00162
00163 if ($email) {
00164 $invoice->setEmailSent(true);
00165 }
00166
00167 $invoice->getOrder()->setIsInProcess(true);
00168
00169 try {
00170 $transactionSave = Mage::getModel('core/resource_transaction')
00171 ->addObject($invoice)
00172 ->addObject($invoice->getOrder())
00173 ->save();
00174
00175 $invoice->sendEmail($email, ($includeComment ? $comment : ''));
00176 } catch (Mage_Core_Exception $e) {
00177 $this->_fault('data_invalid', $e->getMessage());
00178 }
00179
00180 return $invoice->getIncrementId();
00181 }
00182
00183
00184
00185
00186
00187
00188
00189
00190
00191
00192 public function addComment($invoiceIncrementId, $comment, $email = false, $includeComment = false)
00193 {
00194 $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
00195
00196
00197
00198 if (!$invoice->getId()) {
00199 $this->_fault('not_exists');
00200 }
00201
00202
00203 try {
00204 $invoice->addComment($comment, $email);
00205 $invoice->sendUpdateEmail($email, ($includeInEmail ? $comment : ''));
00206 $invoice->save();
00207 } catch (Mage_Core_Exception $e) {
00208 $this->_fault('data_invalid', $e->getMessage());
00209 }
00210
00211 return true;
00212 }
00213
00214
00215
00216
00217
00218
00219
00220 public function capture($invoiceIncrementId)
00221 {
00222 $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
00223
00224
00225
00226 if (!$invoice->getId()) {
00227 $this->_fault('not_exists');
00228 }
00229
00230 if (!$invoice->canCapture()) {
00231 $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice can not be captured'));
00232 }
00233
00234 try {
00235 $invoice->capture();
00236 $invoice->getOrder()->setIsInProcess(true);
00237 $transactionSave = Mage::getModel('core/resource_transaction')
00238 ->addObject($invoice)
00239 ->addObject($invoice->getOrder())
00240 ->save();
00241 } catch (Mage_Core_Exception $e) {
00242 $this->_fault('status_not_changed', $e->getMessage());
00243 } catch (Exception $e) {
00244 $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice capture problem'));
00245 }
00246
00247 return true;
00248 }
00249
00250
00251
00252
00253
00254
00255
00256 public function void($invoiceIncrementId)
00257 {
00258 $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
00259
00260
00261
00262 if (!$invoice->getId()) {
00263 $this->_fault('not_exists');
00264 }
00265
00266 if (!$invoice->canVoid()) {
00267 $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice can not be void'));
00268 }
00269
00270 try {
00271 $invoice->void();
00272 $invoice->getOrder()->setIsInProcess(true);
00273 $transactionSave = Mage::getModel('core/resource_transaction')
00274 ->addObject($invoice)
00275 ->addObject($invoice->getOrder())
00276 ->save();
00277 } catch (Mage_Core_Exception $e) {
00278 $this->_fault('status_not_changed', $e->getMessage());
00279 } catch (Exception $e) {
00280 $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice void problem'));
00281 }
00282
00283 return true;
00284 }
00285
00286
00287
00288
00289
00290
00291
00292 public function cancel($invoiceIncrementId)
00293 {
00294 $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
00295
00296
00297
00298 if (!$invoice->getId()) {
00299 $this->_fault('not_exists');
00300 }
00301
00302 if (!$invoice->canCancel()) {
00303 $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice can not be canceled'));
00304 }
00305
00306 try {
00307 $invoice->cancel();
00308 $invoice->getOrder()->setIsInProcess(true);
00309 $transactionSave = Mage::getModel('core/resource_transaction')
00310 ->addObject($invoice)
00311 ->addObject($invoice->getOrder())
00312 ->save();
00313 } catch (Mage_Core_Exception $e) {
00314 $this->_fault('status_not_changed', $e->getMessage());
00315 } catch (Exception $e) {
00316 $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice cancel problem'));
00317 }
00318
00319 return true;
00320 }
00321 }