Scada Web Service

Scada

Click here for a complete list of operations.

CUDBillingLiquidations

CUD Billing Liquidations

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Scada.asmx HTTP/1.1
Host: novoapi.witechusa.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Scada/CUDBillingLiquidations"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ClsSeguridad xmlns="Scada">
      <User>string</User>
      <Password>string</Password>
      <Token>string</Token>
      <DataBaseEngine>ORACLE or MYSQL or SQLSERVER or POSTGRES</DataBaseEngine>
    </ClsSeguridad>
  </soap:Header>
  <soap:Body>
    <CUDBillingLiquidations xmlns="Scada">
      <Operation>string</Operation>
      <Data>
        <ClsLiquidationHeader>
          <id_liquidation>int</id_liquidation>
          <id_contract>int</id_contract>
          <id_reference_point>int</id_reference_point>
          <id_billing_cycle>int</id_billing_cycle>
          <id_agent_end>int</id_agent_end>
          <agent_end_address>string</agent_end_address>
          <id_node>int</id_node>
          <id_payment_method>int</id_payment_method>
          <payment_method_name>string</payment_method_name>
          <id_liquidation_status>int</id_liquidation_status>
          <liquidation_status_name>string</liquidation_status_name>
          <id_currency>int</id_currency>
          <currency_name>string</currency_name>
          <number_of_days_to_pay>int</number_of_days_to_pay>
          <generation_type>string</generation_type>
          <site_id>string</site_id>
          <end_agent_nit>string</end_agent_nit>
          <month>int</month>
          <year>int</year>
          <subtotal_pay>double</subtotal_pay>
          <total_taxes>double</total_taxes>
          <total_pay>double</total_pay>
          <total_energy_amount>double</total_energy_amount>
          <energy_unit_name>string</energy_unit_name>
          <corrected_volume_usage>double</corrected_volume_usage>
          <corrected_volume_unit_name>string</corrected_volume_unit_name>
          <consumption_total>double</consumption_total>
          <due_days>int</due_days>
          <settlement_datetime>dateTime</settlement_datetime>
          <deviation>double</deviation>
          <need_checked>boolean</need_checked>
          <read_security_level>int</read_security_level>
          <write_security_level>int</write_security_level>
          <creation_datetime>dateTime</creation_datetime>
          <modification_datetime />
          <record_status>boolean</record_status>
          <observations>string</observations>
          <estimated>boolean</estimated>
          <cycle_name>string</cycle_name>
          <billing_period>string</billing_period>
          <agent_name>string</agent_name>
          <result>string</result>
          <contract_number>double</contract_number>
          <initial_cycle_date>dateTime</initial_cycle_date>
          <final_cycle_date>dateTime</final_cycle_date>
          <liquidation_concepts>
            <ClsLiquidationConcept xsi:nil="true" />
            <ClsLiquidationConcept xsi:nil="true" />
          </liquidation_concepts>
          <liquidation_histories>
            <ClsLiquidationHistory xsi:nil="true" />
            <ClsLiquidationHistory xsi:nil="true" />
          </liquidation_histories>
          <settlement_start_date>dateTime</settlement_start_date>
          <settlement_end_date>dateTime</settlement_end_date>
          <measurement_value>double</measurement_value>
        </ClsLiquidationHeader>
        <ClsLiquidationHeader>
          <id_liquidation>int</id_liquidation>
          <id_contract>int</id_contract>
          <id_reference_point>int</id_reference_point>
          <id_billing_cycle>int</id_billing_cycle>
          <id_agent_end>int</id_agent_end>
          <agent_end_address>string</agent_end_address>
          <id_node>int</id_node>
          <id_payment_method>int</id_payment_method>
          <payment_method_name>string</payment_method_name>
          <id_liquidation_status>int</id_liquidation_status>
          <liquidation_status_name>string</liquidation_status_name>
          <id_currency>int</id_currency>
          <currency_name>string</currency_name>
          <number_of_days_to_pay>int</number_of_days_to_pay>
          <generation_type>string</generation_type>
          <site_id>string</site_id>
          <end_agent_nit>string</end_agent_nit>
          <month>int</month>
          <year>int</year>
          <subtotal_pay>double</subtotal_pay>
          <total_taxes>double</total_taxes>
          <total_pay>double</total_pay>
          <total_energy_amount>double</total_energy_amount>
          <energy_unit_name>string</energy_unit_name>
          <corrected_volume_usage>double</corrected_volume_usage>
          <corrected_volume_unit_name>string</corrected_volume_unit_name>
          <consumption_total>double</consumption_total>
          <due_days>int</due_days>
          <settlement_datetime>dateTime</settlement_datetime>
          <deviation>double</deviation>
          <need_checked>boolean</need_checked>
          <read_security_level>int</read_security_level>
          <write_security_level>int</write_security_level>
          <creation_datetime>dateTime</creation_datetime>
          <modification_datetime />
          <record_status>boolean</record_status>
          <observations>string</observations>
          <estimated>boolean</estimated>
          <cycle_name>string</cycle_name>
          <billing_period>string</billing_period>
          <agent_name>string</agent_name>
          <result>string</result>
          <contract_number>double</contract_number>
          <initial_cycle_date>dateTime</initial_cycle_date>
          <final_cycle_date>dateTime</final_cycle_date>
          <liquidation_concepts>
            <ClsLiquidationConcept xsi:nil="true" />
            <ClsLiquidationConcept xsi:nil="true" />
          </liquidation_concepts>
          <liquidation_histories>
            <ClsLiquidationHistory xsi:nil="true" />
            <ClsLiquidationHistory xsi:nil="true" />
          </liquidation_histories>
          <settlement_start_date>dateTime</settlement_start_date>
          <settlement_end_date>dateTime</settlement_end_date>
          <measurement_value>double</measurement_value>
        </ClsLiquidationHeader>
      </Data>
    </CUDBillingLiquidations>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CUDBillingLiquidationsResponse xmlns="Scada">
      <CUDBillingLiquidationsResult>
        <Data>
          <ClsBilling>
            <id_billing>long</id_billing>
            <id_billing_status>int</id_billing_status>
            <billing_status>string</billing_status>
            <bill_number>long</bill_number>
            <bill_datetime>dateTime</bill_datetime>
            <bill_due_datetime>dateTime</bill_due_datetime>
            <last_generation_datetime>dateTime</last_generation_datetime>
            <printed>boolean</printed>
            <creation_user>string</creation_user>
            <creation_user_name>string</creation_user_name>
            <modification_user>string</modification_user>
            <modification_user_name>string</modification_user_name>
            <observations_of_canceled>string</observations_of_canceled>
            <contract_description>string</contract_description>
          </ClsBilling>
          <ClsBilling>
            <id_billing>long</id_billing>
            <id_billing_status>int</id_billing_status>
            <billing_status>string</billing_status>
            <bill_number>long</bill_number>
            <bill_datetime>dateTime</bill_datetime>
            <bill_due_datetime>dateTime</bill_due_datetime>
            <last_generation_datetime>dateTime</last_generation_datetime>
            <printed>boolean</printed>
            <creation_user>string</creation_user>
            <creation_user_name>string</creation_user_name>
            <modification_user>string</modification_user>
            <modification_user_name>string</modification_user_name>
            <observations_of_canceled>string</observations_of_canceled>
            <contract_description>string</contract_description>
          </ClsBilling>
        </Data>
      </CUDBillingLiquidationsResult>
    </CUDBillingLiquidationsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Scada.asmx HTTP/1.1
Host: novoapi.witechusa.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ClsSeguridad xmlns="Scada">
      <User>string</User>
      <Password>string</Password>
      <Token>string</Token>
      <DataBaseEngine>ORACLE or MYSQL or SQLSERVER or POSTGRES</DataBaseEngine>
    </ClsSeguridad>
  </soap12:Header>
  <soap12:Body>
    <CUDBillingLiquidations xmlns="Scada">
      <Operation>string</Operation>
      <Data>
        <ClsLiquidationHeader>
          <id_liquidation>int</id_liquidation>
          <id_contract>int</id_contract>
          <id_reference_point>int</id_reference_point>
          <id_billing_cycle>int</id_billing_cycle>
          <id_agent_end>int</id_agent_end>
          <agent_end_address>string</agent_end_address>
          <id_node>int</id_node>
          <id_payment_method>int</id_payment_method>
          <payment_method_name>string</payment_method_name>
          <id_liquidation_status>int</id_liquidation_status>
          <liquidation_status_name>string</liquidation_status_name>
          <id_currency>int</id_currency>
          <currency_name>string</currency_name>
          <number_of_days_to_pay>int</number_of_days_to_pay>
          <generation_type>string</generation_type>
          <site_id>string</site_id>
          <end_agent_nit>string</end_agent_nit>
          <month>int</month>
          <year>int</year>
          <subtotal_pay>double</subtotal_pay>
          <total_taxes>double</total_taxes>
          <total_pay>double</total_pay>
          <total_energy_amount>double</total_energy_amount>
          <energy_unit_name>string</energy_unit_name>
          <corrected_volume_usage>double</corrected_volume_usage>
          <corrected_volume_unit_name>string</corrected_volume_unit_name>
          <consumption_total>double</consumption_total>
          <due_days>int</due_days>
          <settlement_datetime>dateTime</settlement_datetime>
          <deviation>double</deviation>
          <need_checked>boolean</need_checked>
          <read_security_level>int</read_security_level>
          <write_security_level>int</write_security_level>
          <creation_datetime>dateTime</creation_datetime>
          <modification_datetime />
          <record_status>boolean</record_status>
          <observations>string</observations>
          <estimated>boolean</estimated>
          <cycle_name>string</cycle_name>
          <billing_period>string</billing_period>
          <agent_name>string</agent_name>
          <result>string</result>
          <contract_number>double</contract_number>
          <initial_cycle_date>dateTime</initial_cycle_date>
          <final_cycle_date>dateTime</final_cycle_date>
          <liquidation_concepts>
            <ClsLiquidationConcept xsi:nil="true" />
            <ClsLiquidationConcept xsi:nil="true" />
          </liquidation_concepts>
          <liquidation_histories>
            <ClsLiquidationHistory xsi:nil="true" />
            <ClsLiquidationHistory xsi:nil="true" />
          </liquidation_histories>
          <settlement_start_date>dateTime</settlement_start_date>
          <settlement_end_date>dateTime</settlement_end_date>
          <measurement_value>double</measurement_value>
        </ClsLiquidationHeader>
        <ClsLiquidationHeader>
          <id_liquidation>int</id_liquidation>
          <id_contract>int</id_contract>
          <id_reference_point>int</id_reference_point>
          <id_billing_cycle>int</id_billing_cycle>
          <id_agent_end>int</id_agent_end>
          <agent_end_address>string</agent_end_address>
          <id_node>int</id_node>
          <id_payment_method>int</id_payment_method>
          <payment_method_name>string</payment_method_name>
          <id_liquidation_status>int</id_liquidation_status>
          <liquidation_status_name>string</liquidation_status_name>
          <id_currency>int</id_currency>
          <currency_name>string</currency_name>
          <number_of_days_to_pay>int</number_of_days_to_pay>
          <generation_type>string</generation_type>
          <site_id>string</site_id>
          <end_agent_nit>string</end_agent_nit>
          <month>int</month>
          <year>int</year>
          <subtotal_pay>double</subtotal_pay>
          <total_taxes>double</total_taxes>
          <total_pay>double</total_pay>
          <total_energy_amount>double</total_energy_amount>
          <energy_unit_name>string</energy_unit_name>
          <corrected_volume_usage>double</corrected_volume_usage>
          <corrected_volume_unit_name>string</corrected_volume_unit_name>
          <consumption_total>double</consumption_total>
          <due_days>int</due_days>
          <settlement_datetime>dateTime</settlement_datetime>
          <deviation>double</deviation>
          <need_checked>boolean</need_checked>
          <read_security_level>int</read_security_level>
          <write_security_level>int</write_security_level>
          <creation_datetime>dateTime</creation_datetime>
          <modification_datetime />
          <record_status>boolean</record_status>
          <observations>string</observations>
          <estimated>boolean</estimated>
          <cycle_name>string</cycle_name>
          <billing_period>string</billing_period>
          <agent_name>string</agent_name>
          <result>string</result>
          <contract_number>double</contract_number>
          <initial_cycle_date>dateTime</initial_cycle_date>
          <final_cycle_date>dateTime</final_cycle_date>
          <liquidation_concepts>
            <ClsLiquidationConcept xsi:nil="true" />
            <ClsLiquidationConcept xsi:nil="true" />
          </liquidation_concepts>
          <liquidation_histories>
            <ClsLiquidationHistory xsi:nil="true" />
            <ClsLiquidationHistory xsi:nil="true" />
          </liquidation_histories>
          <settlement_start_date>dateTime</settlement_start_date>
          <settlement_end_date>dateTime</settlement_end_date>
          <measurement_value>double</measurement_value>
        </ClsLiquidationHeader>
      </Data>
    </CUDBillingLiquidations>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CUDBillingLiquidationsResponse xmlns="Scada">
      <CUDBillingLiquidationsResult>
        <Data>
          <ClsBilling>
            <id_billing>long</id_billing>
            <id_billing_status>int</id_billing_status>
            <billing_status>string</billing_status>
            <bill_number>long</bill_number>
            <bill_datetime>dateTime</bill_datetime>
            <bill_due_datetime>dateTime</bill_due_datetime>
            <last_generation_datetime>dateTime</last_generation_datetime>
            <printed>boolean</printed>
            <creation_user>string</creation_user>
            <creation_user_name>string</creation_user_name>
            <modification_user>string</modification_user>
            <modification_user_name>string</modification_user_name>
            <observations_of_canceled>string</observations_of_canceled>
            <contract_description>string</contract_description>
          </ClsBilling>
          <ClsBilling>
            <id_billing>long</id_billing>
            <id_billing_status>int</id_billing_status>
            <billing_status>string</billing_status>
            <bill_number>long</bill_number>
            <bill_datetime>dateTime</bill_datetime>
            <bill_due_datetime>dateTime</bill_due_datetime>
            <last_generation_datetime>dateTime</last_generation_datetime>
            <printed>boolean</printed>
            <creation_user>string</creation_user>
            <creation_user_name>string</creation_user_name>
            <modification_user>string</modification_user>
            <modification_user_name>string</modification_user_name>
            <observations_of_canceled>string</observations_of_canceled>
            <contract_description>string</contract_description>
          </ClsBilling>
        </Data>
      </CUDBillingLiquidationsResult>
    </CUDBillingLiquidationsResponse>
  </soap12:Body>
</soap12:Envelope>