Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Receipt.Cancel

Cancel a receipt

Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Receipt.Cancel

HTTP Method: POST

Message direction	Format	Body
Request	Xml	Example,Schema
Request	Json	Example
Response	Xml	Example,Schema
Response	Json	Example

The following is an example request Xml body:

<ReceiptCancelRequest xmlns="http://api.rivhit.co.il">
  <api_token>String content</api_token>
  <receipt_type>2147483647</receipt_type>
  <receipt_number>2147483647</receipt_number>
  <email_to>String content</email_to>
  <digital_signature>true</digital_signature>
  <signature_pin>String content</signature_pin>
  <comments>String content</comments>
  <request_reference>String content</request_reference>
  <cancellation_date>String content</cancellation_date>
  <cancellation_time>String content</cancellation_time>
</ReceiptCancelRequest>

The following is an example request Json body:

{
	"api_token":"String content",
	"receipt_type":2147483647,
	"receipt_number":2147483647,
	"email_to":"String content",
	"digital_signature":true,
	"signature_pin":"String content",
	"comments":"String content",
	"request_reference":"String content",
	"cancellation_date":"String content",
	"cancellation_time":"String content"
}

The following is an example response Xml body:

<ReceiptCancelResponse xmlns="http://api.rivhit.co.il">
  <error_code>2147483647</error_code>
  <client_message>String content</client_message>
  <debug_message>String content</debug_message>
  <data>
    <status>2147483647</status>
    <cancel_receipt_type>2147483647</cancel_receipt_type>
    <cancel_receipt_number>2147483647</cancel_receipt_number>
    <cancel_receipt_identity>1627aea5-8e0a-4371-9022-9b504344e724</cancel_receipt_identity>
    <cancel_receipt_link>String content</cancel_receipt_link>
  </data>
</ReceiptCancelResponse>

The following is an example response Json body:

{
	"error_code":2147483647,
	"client_message":"String content",
	"debug_message":"String content",
	"data":{
		"status":2147483647,
		"cancel_receipt_type":2147483647,
		"cancel_receipt_number":2147483647,
		"cancel_receipt_identity":"1627aea5-8e0a-4371-9022-9b504344e724",
		"cancel_receipt_link":"String content"
	}
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://api.rivhit.co.il" elementFormDefault="qualified" targetNamespace="http://api.rivhit.co.il" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ReceiptCancelRequest">
    <xs:sequence>
      <xs:element name="api_token" nillable="true" type="xs:string" />
      <xs:element name="receipt_type" type="xs:int" />
      <xs:element name="receipt_number" type="xs:int" />
      <xs:element minOccurs="0" name="email_to" nillable="true" type="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="digital_signature" nillable="true" type="xs:boolean">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="signature_pin" nillable="true" type="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="comments" nillable="true" type="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="request_reference" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="cancellation_date" nillable="true" type="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
      <xs:element minOccurs="0" name="cancellation_time" nillable="true" type="xs:string">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ReceiptCancelRequest" nillable="true" type="tns:ReceiptCancelRequest" />
</xs:schema>

Additional request Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>

The following is the response Xml Schema:

<xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://api.rivhit.co.il" elementFormDefault="qualified" targetNamespace="http://api.rivhit.co.il" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
  <xs:complexType name="ReceiptCancelResponse">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:Response">
        <xs:sequence>
          <xs:element minOccurs="0" name="data" nillable="true" type="tns:ReceiptCancelData" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="ReceiptCancelResponse" nillable="true" type="tns:ReceiptCancelResponse" />
  <xs:complexType name="Response">
    <xs:sequence>
      <xs:element minOccurs="0" name="error_code" type="xs:int" />
      <xs:element minOccurs="0" name="client_message" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="debug_message" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Response" nillable="true" type="tns:Response" />
  <xs:complexType name="ReceiptCancelData">
    <xs:sequence>
      <xs:element minOccurs="0" name="status" type="xs:int" />
      <xs:element minOccurs="0" name="cancel_receipt_type" type="xs:int" />
      <xs:element minOccurs="0" name="cancel_receipt_number" type="xs:int" />
      <xs:element minOccurs="0" name="cancel_receipt_identity" type="ser:guid" />
      <xs:element minOccurs="0" name="cancel_receipt_link" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ReceiptCancelData" nillable="true" type="tns:ReceiptCancelData" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>