API Module Financial searchInvoiceResellerRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:14, 17 June 2016

Module Reseller > Search Invoices

Module	reseller
Command name	searchInvoiceResellerRequest
Use	Retrieves a list of invoices from your reseller account
Input	limit (default value: 100, maximum value: 1000) offset (default value: 0) startCreationDate format: yyyy-mm-dd endCreationDate format: yyyy-mm-dd
Output	amount creationDate invoiceNumber invoiceUrl cannot be used outside RCP attachmentUrl cannot be used outside RCP

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchInvoiceResellerRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'startCreationDate' => '2010-01-01',
    'endCreationDate' => '2010-03-31'
  ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchInvoiceResellerRequest>
    <startCreationDate>2010-01-01</startCreationDate>
    <endCreationDate>2010-03-31</endCreationDate>
  </searchInvoiceResellerRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>
      <results>
        <array>
          <item>
            <creationDate>2010-01-31 00:00:00</creationDate>
            <invoiceNumber>OP123482</invoiceNumber>
            <amount>
              <product>
                <price>259.90</price>
                <currency>EUR</currency>
              </product>
              <reseller>
                <price>259.90</price>
                <currency>EUR</currency>
              </reseller>
            </amount>
            <invoiceUrl>http://rest.openprovider.eu/invoice/OP123482?token=</invoiceUrl>
            <attachmentUrl>http://rest.openprovider.eu/attachment/OP123482?token=</attachmentUrl>
          </item>
          <item>
            <creationDate>2010-02-28 00:00:00</creationDate>
            <invoiceNumber>OP123483</invoiceNumber>
            <amount>
              <product>
                <price>204.20</price>
                <currency>EUR</currency>
              </product>
              <reseller>
                <price>204.20</price>
                <currency>EUR</currency>
              </reseller>
            </amount>
            <invoiceUrl>http://rest.openprovider.eu/invoice/OP123483?token=</invoiceUrl>
            <attachmentUrl>http://rest.openprovider.eu/attachment/OP123483?token=</attachmentUrl>
          </item>
          <item>
            <creationDate>2010-03-31 00:00:00</creationDate>
            <invoiceNumber>OP123484</invoiceNumber>
            <amount>
              <product>
                <price>225.92</price>
                <currency>EUR</currency>
              </product>
              <reseller>
                <price>225.92</price>
                <currency>EUR</currency>
              </reseller>
            </amount>
            <invoiceUrl>http://rest.openprovider.eu/invoice/OP123484?token=</invoiceUrl>
            <attachmentUrl>http://rest.openprovider.eu/attachment/OP123484?token=</attachmentUrl>
          </item>
        </array>
      </results>
      <total>3</total>
    </data>
  </reply>
</openXML>

@@ Line 13: / Line 13: @@
 |'''Input'''
 |
-*limit ''default value: 100''
+*[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'')
-*offset ''default value: 0''
+*[[API Format Offset|offset]] (''default value: 0'')
 *startCreationDate ''format: yyyy-mm-dd''
 *endCreationDate ''format: yyyy-mm-dd''