API Module Financial searchTransactionResellerRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 10:12, 30 November 2017

Module Reseller > Search Transactions

Module	reseller
Command name	searchTransactionResellerRequest
Use	Retrieves a list of transactions from your reseller account
Input	limit (default value: 100, maximum value: 1000) offset (default value: 0) startCreationDate format: yyyy-mm-dd (inclusive) endCreationDate format: yyyy-mm-dd (exclusive: a value of '2017-11-30' will include up to '2017-11-29')
Output	type creationDate action subject quantity setup price discount vat total

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchTransactionResellerRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'limit' => 2,
    'startCreationDate' => '2010-12-01',
    'endCreationDate' => '2010-12-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>
  <searchTransactionResellerRequest>
    <limit>2</limit>
    <startCreationDate>2010-12-01</startCreationDate>
    <endCreationDate>2010-12-30</endCreationDate>
  </searchTransactionResellerRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>
      <results>
        <array>
          <item>
            <type>transaction</type>
            <creationDate>2010-12-01 23:02:29</creationDate>
            <action>RENEW</action>
            <subject>domain-database.com</subject>
            <quantity>1</quantity>
            <setup>
              <product>
                <price>0.00</price>
                <currency>USD</currency>
              </product>
              <reseller>
                <price>0.00</price>
                <currency>EUR</currency>
              </reseller>
            </setup>
            <price>
              <product>
                <price>12.95</price>
                <currency>USD</currency>
              </product>
              <reseller>
                <price>9.76</price>
                <currency>EUR</currency>
              </reseller>
            </price>
            <discount>30.89</discount>
            <vat>19</vat>
            <total>
              <product>
                <price>10.65</price>
                <currency>USD</currency>
              </product>
              <reseller>
                <price>8.03</price>
                <currency>EUR</currency>
              </reseller>
            </total>
          </item>
          <item>
            <type>transaction</type>
            <creationDate>2010-12-02 15:15:03</creationDate>
            <action>NEW</action>
            <subject>domain-gaming.com</subject>
            <quantity>1</quantity>
            <setup>
              <product>
                <price>0.00</price>
                <currency>USD</currency>
              </product>
              <reseller>
                <price>0.00</price>
                <currency>EUR</currency>
              </reseller>
            </setup>
            <price>
              <product>
                <price>12.95</price>
                <currency>USD</currency>
              </product>
              <reseller>
                <price>9.68</price>
                <currency>EUR</currency>
              </reseller>
            </price>
            <discount>30.89</discount>
            <vat>19</vat>
            <total>
              <product>
                <price>10.65</price>
                <currency>USD</currency>
              </product>
              <reseller>
                <price>7.96</price>
                <currency>EUR</currency>
              </reseller>
            </total>
          </item>
        </array>
      </results>
      <total>42</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''
+*startCreationDate ''format: yyyy-mm-dd'' (''inclusive'')
-*endCreationDate ''format: yyyy-mm-dd''
+*endCreationDate ''format: yyyy-mm-dd'' (''exclusive: a value of '2017-11-30' will include up to '2017-11-29''')
 |- style="vertical-align:top;"
 |'''Output'''
@@ Line 35: / Line 35: @@
 ===Using PHP class===
   $request = new OP_Request;
-  $request->setCommand('searchInvoiceResellerRequest')
+  $request->setCommand('searchTransactionResellerRequest')
     ->setAuth(array('username' => 'username', 'password' => 'password'))
     ->setArgs(array(
-      'startCreationDate' => '2010-01-01',
+     'limit' => 2,
-      'endCreationDate' => '2010-03-31'
+      'startCreationDate' => '2010-12-01',
+      'endCreationDate' => '2010-12-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>
@@ Line 59: / Line 61: @@
   <openXML>
     <reply>
-      < code>0</code>
+      <nowiki><code>0</code></nowiki>
       <desc />
       <data>