senddr partner api -- Invoice

Invoices

Invoice API URL: http://api.senddr.com/v1.0/Invoices.aspx

Note: 

• The value used for <invoice_type /> can be 'source' or 'destination'
• The value used for <senddr_invoice_status /> can be ‘Source hold’, ‘Destination hold’, ‘Approved’, ‘Queued’, ‘Delivered’, ‘Deleted’, ‘Rejected’, 'Delivery failure', 'Customer paid' 
• The value used for <invoice_type_name /> can be 'Invoice', 'Credit Note', 'Purchase Invoice', 'Purchase Credit'
• The value used for <approval_status /> can be 'Approved/Active', 'Draft', 'Suspended (Billing)', 'Paused','Deleted'

invoice.list

Returns a list of invoice details. Results are ordered by descending <senddr_invoiceID />.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="invoice.list">
<date_from>2013-01-01</date_from>
<date_to>2013-06-01</date_to>
<!-- source or destination -->  
<invoice_type>source</invoice_type>
</request>

Response

<?xml version="1.0" encoding="UTF-8"?>
<invoices>
   <invoice>
      <senddr_invoiceID>4799</senddr_invoiceID>
      <senddr_date_created>2013-03-11T15:25:30.683</senddr_date_created>
      <senddr_invoice_status>Source hold</senddr_invoice_status>
      <approval_status>Approved/Active</approval_status>
      <invoice_type_name>Invoice</invoice_type_name>
      <invoice_number>INV-0042</invoice_number>
      <invoice_reference />
      <invoice_date>2013-03-11T15:08:07.513</invoice_date>
      <invoice_due_date>2013-03-12T00:00:00</invoice_due_date>
      <invoice_expected_payment_date>2013-03-11T15:25:30.600</invoice_expected_payment_date>
      <purchase_order_number />
      <invoice_desc />
      <invoice_notes>No Notes</invoice_notes>
      <invoice_tax_amount>0.000000</invoice_tax_amount>
      <invoice_net_amount>21.000000</invoice_net_amount>
      <invoice_amount>21.000000</invoice_amount>
      <invoice_amount_paid>0.000000</invoice_amount_paid>
      <invoice_amount_outstanding>21.000000</invoice_amount_outstanding>
      <invoice_discount_amount>0.000000</invoice_discount_amount>
      <invoice_discount_percent>0.000000</invoice_discount_percent>
      <invoice_uid>9CB5A7DE-E975-4442-928D-3E8F42864708</invoice_uid>
      <currency_code>EUR</currency_code>
      <exchange_rate>1.00000000</exchange_rate>
      <exchange_date>2013-03-11T15:25:30.600</exchange_date>
      <terms_desc />
      <terms_days>0</terms_days>
      <site_id />
      <site_code />
      <document_url />
      <from_invoice_ref>03bf67a2-ad21-43e5-95fa-870b6700b049</from_invoice_ref>
      <invoice_item>
         <invoice_itemID>16226</invoice_itemID>
         <invoice_item_desc>xero items desc</invoice_item_desc>
         <invoice_item_tax_amount>0.000000</invoice_item_tax_amount>
         <invoice_item_net_amount>0.000000</invoice_item_net_amount>
         <invoice_item_amount>21.000000</invoice_item_amount>
         <invoice_item_discount_amount>0.000000</invoice_item_discount_amount>
         <invoice_item_discount_percent>0.000000</invoice_item_discount_percent>
         <item_qty>1.000000</item_qty>
         <item_unit_price>21.000000</item_unit_price>
         <item_code />
         <line_number>0</line_number>
         <tax_code>OUTPUT</tax_code>
         <purchase_order_number />
         <purchase_order_line_number />
         <account_code />
      </invoice_item>
      <company>
         <contactID>12171</contactID>
         <company_person_firstname />
         <company_person_secondname />
         <contact_name>Demo Company (Global)</contact_name>
         <contact_email>xero@senddr.com</contact_email>
         <address1 />
         <address2 />
         <address3 />
         <address4 />
         <country_code>IE</country_code>
         <contact_telephone />
         <contact_fax />
         <tax_reference>101-2-303</tax_reference>
         <company_reference />
      </company>
   </invoice>
</invoices>

invoice.create

Create a new invoice complete with line items and company details. If successful, returns the <senddr_invoiceID /> of the newly created invoice.

Request

<?xml version="1.0" encoding="utf-8" ?>
<request method="invoice.create">  
<invoices>
  <invoice>
    <invoice_type_name>Invoice</invoice_type_name>
    <invoice_number>INV0007</invoice_number>
    <invoice_reference>ref0007</invoice_reference>
    <invoice_date>2013-05-22T00:00:00</invoice_date>
    <invoice_due_date>2013-05-22T09:18:54.327</invoice_due_date>
    <invoice_expected_payment_date>2013-05-22T09:18:54.327</invoice_expected_payment_date>
    <purchase_order_number/>
    <invoice_desc/>
    <invoice_notes/>
    <invoice_tax_amount>0.0000</invoice_tax_amount>
    <invoice_net_amount>0.0000</invoice_net_amount>
    <invoice_amount>5.0000</invoice_amount>
    <invoice_amount_paid>0.0000</invoice_amount_paid>
    <invoice_amount_outstanding>0.0000</invoice_amount_outstanding>
    <invoice_discount_amount>0.0000</invoice_discount_amount>
    <invoice_discount_percent>0.0000</invoice_discount_percent>
    <currency_code>EUR</currency_code>
    <exchange_rate>0.0000</exchange_rate>
    <exchange_date>2013-05-02T09:18:54.327</exchange_date>
    <terms_desc/>
    <terms_days>0</terms_days>
    <site_id/>
    <site_code/>
    <document_url/>
    <invoice_item>
      <invoice_item_desc>FreshMilk</invoice_item_desc>
      <invoice_item_tax_amount>0.0000</invoice_item_tax_amount>
      <invoice_item_net_amount>0.0000</invoice_item_net_amount>
      <invoice_item_amount>5.0000</invoice_item_amount>
      <invoice_item_discount_amount>0.0000</invoice_item_discount_amount>
      <invoice_item_discount_percent>0.0000</invoice_item_discount_percent>
      <item_qty>1.0000</item_qty>
      <item_unit_price>5.0000</item_unit_price>
      <item_code/>
      <line_number>0</line_number>
      <tax_code/>
      <purchase_order_number/>
      <purchase_order_line_number/>
      <account_code/>
    </invoice_item>
    <company>
      <company_person_firstname/>
      <company_person_secondname/>
      <contact_name>yendo demo co</contact_name>
      <contact_email>yendo@senddr.com</contact_email>
      <address1/>
      <address2/>
      <address3/>
      <address4/>
      <country_code>IE</country_code>
      <contact_telephone/>
      <contact_fax/>
      <tax_reference/>
      <company_reference/>
    </company>
  </invoice>
</invoices>
</request>  

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <code>0</code>
   <message>Invoice Added</message>
   <type>invoice</type>
   <senddr_invoiceID>5058</senddr_invoiceID>
</response>

invoice.update

Update an existing invoice with the given invoice_uid. Any invoice header fields left out of the request will remain unchanged.

• If you do not specify a <invoice_item> element, the existing lines will remain unchanged. If you do specify <invoice_item> elements the original ones will be replaced by the new ones.

Request

<?xml version="1.0" encoding="utf-8" ?>
<request method="invoice.update">  
<invoices>
  <invoice>
     <!-- Invoice_uid is required -->
    <invoice_uid>78AFA779-F341-46A8-AE0C-6F4260AEA0ED</invoice_uid>
     <!-- Optional filed-->
    <purchase_order_number>po123456</purchase_order_number>  
    <invoice_amount>35.0000</invoice_amount>
    <!-- nothing or everything -->
    <invoice_items>
    <invoice_item>
      <invoice_item_desc>FreshMilk35</invoice_item_desc>
      <invoice_item_tax_amount>0.0000</invoice_item_tax_amount>
      <invoice_item_net_amount>0.0000</invoice_item_net_amount>
      <invoice_item_amount>35.0000</invoice_item_amount>
      <invoice_item_discount_amount>0.0000</invoice_item_discount_amount>
      <invoice_item_discount_percent>0.0000</invoice_item_discount_percent>
      <item_qty>1.0000</item_qty>
      <item_unit_price>35.0000</item_unit_price>
      <item_code/>
      <line_number>0</line_number>
      <tax_code/>
      <purchase_order_number/>
      <purchase_order_line_number/>
      <account_code/>
    </invoice_item>
    </invoice_items>
  </invoice>
</invoices>
</request>  

Response

<?xml version="1.0" encoding="utf-8"?>
<response>
  <code>
  </code>
  <message>Invoice Update Successful</message>
  <type>invoice</type>
</response>

invoice.status

Update the status for an existing invoice with the given invoice_uid and new status name(senddr_invoice_status).

The value used for <senddr_invoice_status /> can be ‘Source hold’, ‘Destination hold’, ‘Approved’, ‘Queued’, ‘Delivered’, ‘Deleted’, ‘Rejected’, 'Delivery failure', 'Customer paid' 

There are some limit to update status, the new status must depend on old one.

Old Status	Legal New Status
Source hold	Destination hold, Deleted
Destination hold	Approved, Rejected
Delivered	Delivery failure,Customer paid

Request

<?xml version="1.0" encoding="utf-8" ?>
<request method="invoice.status">  
<invoices>
  <invoice>
    <invoice_uid>DC0F0953-88C9-42E4-A4A6-EF6072B07BDC</invoice_uid>
    <senddr_invoice_status>customer hold</senddr_invoice_status> 
  </invoice>
</invoices>
</request>  

Response

<?xml version="1.0" encoding="utf-8"?>
<response>
  <code>
  </code>
  <message>Invoice Status Update Successful</message>
  <type>invoice</type>
</response>