.. meta::
  :description: Wired API, transactions
  :keywords: Wired, xml, api, channel manager, booking engine, transactions

Transactions
************

Introduction
-------------

WuBook services generate costs. Such costs are generally monitored and
managed on the WuBook Account ( https://wubook.net/wauth/wauth/ ).

We also provide a way to programmatically manage them.


Filter params
-------------

For each group of collected costs (balances), we provide the
following status:

   * **current** : services costs not yet claimable;
   * **waiting** : services waiting for a payment;
   * **paid**    : paid services;

Anatomy of the datas
--------------------

Every response is bult with a self-explanatory fields:

======================= =======================     ============================================================================================================
Field                    Type/(default value)         Description
======================= =======================     ============================================================================================================
balance_id               integer/(0)                The balance id (as show on the WuBook Account), in **current** search the value is 0 (mean no transaction)
services                 array of service/[]        service container, a empty array mean no services  
======================= =======================     ============================================================================================================

Below there are a description of the service object (struct):

======================= ================== =======================================================================================================
Field                    Type                  Description
======================= ================== =======================================================================================================
service_name             string             name of service
on_date                  string             date (%d/%m/%Y %H:%M, e.g: 30/12/1970 10:57)
description              string             Description 
cost                     float              service cost  
discounted_cost          float              discounted cost (or empty)
======================= ================== =======================================================================================================


Available functions
-------------------

.. function:: read_balance(token, status [,lcode])

That function returns, if present, the trasactions of a specific property based by the **status** filter argument.
If the lcode parameter is missing, the function returns the account's balance.
The use of read_balance is available both for corporates and direct customers, except for account belonging to a corporate.


.. hidden-code-block:: xml
  :starthidden: True
  
      <!-- BEGIN REQUEST -->
      <methodCall>
        <methodName>read_balance</methodName>
        <params>
          <param>
            <value>
              <string>9941993872.3000</string>
            </value>
          </param>
          <param>
            <value>
              <string>paid</string>
            </value>
          </param>
          <param>
            <value>
              <int>1213394817</int>
            </value>
          </param>
        </params>
      </methodCall>
      <!-- END REQUEST -->

      <!-- START RESPONSE -->
      <methodResponse>
        <params>
          <param>
            <value>
              <array>
                <data>
                  <value>
                    <int>0</int>
                  </value>
                  <value>
                    <array>
                      <data>
                        <value>
                          <struct>
                            <member>
                              <name>balance_id</name>
                              <value>
                                <int>1642498279</int>
                              </value>
                            </member>
                            <member>
                              <name>services</name>
                              <value>
                                <array>
                                  <data>
                                    <value>
                                      <struct>
                                        <member>
                                          <name>on_date</name>
                                          <value>
                                            <string>18/01/2022 10:30</string>
                                          </value>
                                        </member>
                                        <member>
                                          <name>description</name>
                                          <value>
                                            <string>ord</string>
                                          </value>
                                        </member>
                                        <member>
                                          <name>cost</name>
                                          <value>
                                            <double>48.0</double>
                                          </value>
                                        </member>
                                        <member>
                                          <name>discounted_cost</name>
                                          <value>
                                            <double>0.0</double>
                                          </value>
                                        </member>
                                        <member>
                                          <name>service_name</name>
                                          <value>
                                            <string>Online Reception</string>
                                          </value>
                                        </member>
                                      </struct>
                                    </value>
                                  </data>
                                </array>
                              </value>
                            </member>
                          </struct>
                        </value>
                      </data>
                    </array>
                  </value>
                </data>
              </array>
            </value>
          </param>
        </params>
      </methodResponse>
      <!-- END RESPONSE -->


.. function:: read_subaccount_balance(token, status, subaccount_code)

The use of read_subaccount_balance is allowed only for **corporates customers**.
That function returns, if present, the account level trasactions.


.. hidden-code-block:: xml
  :starthidden: True

      <!-- START RESPONSE -->
      <methodResponse>
        <params>
          <param>
            <value>
              <array>
                <data>
                  <value>
                    <int>0</int>
                  </value>
                  <value>
                    <struct>
                      <member>
                        <name>1213394817</name>  <!-- property code -->
                        <value>
                          <array>
                            <data>
                              <value>
                                <struct>
                                  <member>
                                    <name>balance_id</name>
                                    <value>
                                      <int>1642498270</int>
                                    </value>
                                  </member>
                                  <member>
                                    <name>services</name>
                                    <value>
                                      <array>
                                        <data>
                                          <value>
                                            <struct>
                                              <member>
                                                <name>on_date</name>
                                                <value>
                                                  <string>18/01/2022 10:23</string>
                                                </value>
                                              </member>
                                              <member>
                                                <name>description</name>
                                                <value>
                                                  <string>ord</string>
                                                </value>
                                              </member>
                                              <member>
                                                <name>cost</name>
                                                <value>
                                                  <double>48.0</double>
                                                </value>
                                              </member>
                                              <member>
                                                <name>discounted_cost</name>
                                                <value>
                                                  <double>0.0</double>
                                                </value>
                                              </member>
                                              <member>
                                                <name>service_name</name>
                                                <value>
                                                  <string>Online Reception</string>
                                                </value>
                                              </member>
                                            </struct>
                                          </value>
                                        </data>
                                      </array>
                                    </value>
                                  </member>
                                </struct>
                              </value>
                            </data>
                          </array>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </param>
        </params>
      </methodResponse>
      <!-- END RESPONSE -->


Working with waiting balances
------------------------------

That section is for **corporates only**.

======================= =======================
Field                    Type                      
======================= =======================
balance_ids               ArrayOf balance_id     
======================= =======================


.. function:: pay_balance(token, balance_ids)

The pay_balance function provides an on-demand payment,
It is possible to pay **waiting balances**. This call
will charge your registered credit card.

.. function:: detach_balance(token, balance_ids)

The detach_balance function marks the selected balances as **insolvent**.
It is possible to detach only **waiting balances**.

.. function:: pay_balance_with_credit(token, lcode, balance_ids)

The pay_balance_with_credit function provides an on-demand payment, filtered by lodging code (lcode)
It is possible to pay **waiting balances**. 
This call will use your credit.