Scada
Click here for a complete list of operations.
CUDLiquidation
CUD Liquidation
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/CUDLiquidation"
<?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>
<CUDLiquidation xmlns="Scada">
<Operation>string</Operation>
<Data>
<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>
<id_contract>int</id_contract>
<brief_year>int</brief_year>
<brief_month>int</brief_month>
<id_concept>int</id_concept>
<concept_name>string</concept_name>
<value>double</value>
<subtotal>double</subtotal>
<message>string</message>
<formula>string</formula>
<formula_value>string</formula_value>
<id_type>int</id_type>
<id_liquidation_concept>int</id_liquidation_concept>
<id_liquidation>int</id_liquidation>
<id_formula>int</id_formula>
<id_currency>int</id_currency>
<currency_name>string</currency_name>
<result>string</result>
<comes_from_contract>boolean</comes_from_contract>
<read_security_level>int</read_security_level>
<write_security_level>int</write_security_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<start_date>dateTime</start_date>
<end_date>dateTime</end_date>
<measurement_value>double</measurement_value>
</ClsLiquidationConcept>
<ClsLiquidationConcept>
<id_contract>int</id_contract>
<brief_year>int</brief_year>
<brief_month>int</brief_month>
<id_concept>int</id_concept>
<concept_name>string</concept_name>
<value>double</value>
<subtotal>double</subtotal>
<message>string</message>
<formula>string</formula>
<formula_value>string</formula_value>
<id_type>int</id_type>
<id_liquidation_concept>int</id_liquidation_concept>
<id_liquidation>int</id_liquidation>
<id_formula>int</id_formula>
<id_currency>int</id_currency>
<currency_name>string</currency_name>
<result>string</result>
<comes_from_contract>boolean</comes_from_contract>
<read_security_level>int</read_security_level>
<write_security_level>int</write_security_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<start_date>dateTime</start_date>
<end_date>dateTime</end_date>
<measurement_value>double</measurement_value>
</ClsLiquidationConcept>
</liquidation_concepts>
<liquidation_histories>
<ClsLiquidationHistory>
<id_liquidation_history>int</id_liquidation_history>
<id_brief>int</id_brief>
<id_reference_point>int</id_reference_point>
<id_device_history>int</id_device_history>
<id_column>int</id_column>
<history_datetime>dateTime</history_datetime>
<column_value>double</column_value>
<is_estimated>boolean</is_estimated>
<conversion_factor>double</conversion_factor>
<read_security_level>int</read_security_level>
<write_secuity_level>int</write_secuity_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<is_missing_conversion_factor>boolean</is_missing_conversion_factor>
<id_node>int</id_node>
</ClsLiquidationHistory>
<ClsLiquidationHistory>
<id_liquidation_history>int</id_liquidation_history>
<id_brief>int</id_brief>
<id_reference_point>int</id_reference_point>
<id_device_history>int</id_device_history>
<id_column>int</id_column>
<history_datetime>dateTime</history_datetime>
<column_value>double</column_value>
<is_estimated>boolean</is_estimated>
<conversion_factor>double</conversion_factor>
<read_security_level>int</read_security_level>
<write_secuity_level>int</write_secuity_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<is_missing_conversion_factor>boolean</is_missing_conversion_factor>
<id_node>int</id_node>
</ClsLiquidationHistory>
</liquidation_histories>
<settlement_start_date>dateTime</settlement_start_date>
<settlement_end_date>dateTime</settlement_end_date>
<measurement_value>double</measurement_value>
</Data>
</CUDLiquidation>
</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>
<CUDLiquidationResponse xmlns="Scada">
<CUDLiquidationResult>
<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 xsi:nil="true" />
<liquidation_histories xsi:nil="true" />
<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 xsi:nil="true" />
<liquidation_histories xsi:nil="true" />
<settlement_start_date>dateTime</settlement_start_date>
<settlement_end_date>dateTime</settlement_end_date>
<measurement_value>double</measurement_value>
</ClsLiquidationHeader>
</Data>
</CUDLiquidationResult>
</CUDLiquidationResponse>
</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>
<CUDLiquidation xmlns="Scada">
<Operation>string</Operation>
<Data>
<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>
<id_contract>int</id_contract>
<brief_year>int</brief_year>
<brief_month>int</brief_month>
<id_concept>int</id_concept>
<concept_name>string</concept_name>
<value>double</value>
<subtotal>double</subtotal>
<message>string</message>
<formula>string</formula>
<formula_value>string</formula_value>
<id_type>int</id_type>
<id_liquidation_concept>int</id_liquidation_concept>
<id_liquidation>int</id_liquidation>
<id_formula>int</id_formula>
<id_currency>int</id_currency>
<currency_name>string</currency_name>
<result>string</result>
<comes_from_contract>boolean</comes_from_contract>
<read_security_level>int</read_security_level>
<write_security_level>int</write_security_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<start_date>dateTime</start_date>
<end_date>dateTime</end_date>
<measurement_value>double</measurement_value>
</ClsLiquidationConcept>
<ClsLiquidationConcept>
<id_contract>int</id_contract>
<brief_year>int</brief_year>
<brief_month>int</brief_month>
<id_concept>int</id_concept>
<concept_name>string</concept_name>
<value>double</value>
<subtotal>double</subtotal>
<message>string</message>
<formula>string</formula>
<formula_value>string</formula_value>
<id_type>int</id_type>
<id_liquidation_concept>int</id_liquidation_concept>
<id_liquidation>int</id_liquidation>
<id_formula>int</id_formula>
<id_currency>int</id_currency>
<currency_name>string</currency_name>
<result>string</result>
<comes_from_contract>boolean</comes_from_contract>
<read_security_level>int</read_security_level>
<write_security_level>int</write_security_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<start_date>dateTime</start_date>
<end_date>dateTime</end_date>
<measurement_value>double</measurement_value>
</ClsLiquidationConcept>
</liquidation_concepts>
<liquidation_histories>
<ClsLiquidationHistory>
<id_liquidation_history>int</id_liquidation_history>
<id_brief>int</id_brief>
<id_reference_point>int</id_reference_point>
<id_device_history>int</id_device_history>
<id_column>int</id_column>
<history_datetime>dateTime</history_datetime>
<column_value>double</column_value>
<is_estimated>boolean</is_estimated>
<conversion_factor>double</conversion_factor>
<read_security_level>int</read_security_level>
<write_secuity_level>int</write_secuity_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<is_missing_conversion_factor>boolean</is_missing_conversion_factor>
<id_node>int</id_node>
</ClsLiquidationHistory>
<ClsLiquidationHistory>
<id_liquidation_history>int</id_liquidation_history>
<id_brief>int</id_brief>
<id_reference_point>int</id_reference_point>
<id_device_history>int</id_device_history>
<id_column>int</id_column>
<history_datetime>dateTime</history_datetime>
<column_value>double</column_value>
<is_estimated>boolean</is_estimated>
<conversion_factor>double</conversion_factor>
<read_security_level>int</read_security_level>
<write_secuity_level>int</write_secuity_level>
<creation_datetime>dateTime</creation_datetime>
<modification_datetime>dateTime</modification_datetime>
<record_status>boolean</record_status>
<is_missing_conversion_factor>boolean</is_missing_conversion_factor>
<id_node>int</id_node>
</ClsLiquidationHistory>
</liquidation_histories>
<settlement_start_date>dateTime</settlement_start_date>
<settlement_end_date>dateTime</settlement_end_date>
<measurement_value>double</measurement_value>
</Data>
</CUDLiquidation>
</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>
<CUDLiquidationResponse xmlns="Scada">
<CUDLiquidationResult>
<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 xsi:nil="true" />
<liquidation_histories xsi:nil="true" />
<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 xsi:nil="true" />
<liquidation_histories xsi:nil="true" />
<settlement_start_date>dateTime</settlement_start_date>
<settlement_end_date>dateTime</settlement_end_date>
<measurement_value>double</measurement_value>
</ClsLiquidationHeader>
</Data>
</CUDLiquidationResult>
</CUDLiquidationResponse>
</soap12:Body>
</soap12:Envelope>