Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/OpenFormat.ZIP
Create an open format files zip
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/OpenFormat.ZIP
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:
<OpenFormatRequest xmlns="http://api.rivhit.co.il"> <api_token>String content</api_token> <year>2147483647</year> <request_reference>String content</request_reference> </OpenFormatRequest>
The following is an example request Json body:
{
"api_token":"String content",
"year":2147483647,
"request_reference":"String content"
}
The following is an example response Xml body:
<OpenFormatResponse xmlns="http://api.rivhit.co.il">
<error_code>2147483647</error_code>
<client_message>String content</client_message>
<debug_message>String content</debug_message>
<data>
<company_id>2147483647</company_id>
<company_name>String content</company_name>
<document_list>
<OpenFormatSummary>
<count>2147483647</count>
<sum>12678967.543233</sum>
<type_code>2147483647</type_code>
</OpenFormatSummary>
<OpenFormatSummary>
<count>2147483647</count>
<sum>12678967.543233</sum>
<type_code>2147483647</type_code>
</OpenFormatSummary>
</document_list>
<production_date>String content</production_date>
<production_time>String content</production_time>
<receipt_list>
<OpenFormatSummary>
<count>2147483647</count>
<sum>12678967.543233</sum>
<type_code>2147483647</type_code>
</OpenFormatSummary>
<OpenFormatSummary>
<count>2147483647</count>
<sum>12678967.543233</sum>
<type_code>2147483647</type_code>
</OpenFormatSummary>
</receipt_list>
<record_list>
<OpenFormatRecord>
<code>String content</code>
<count>2147483647</count>
</OpenFormatRecord>
<OpenFormatRecord>
<code>String content</code>
<count>2147483647</count>
</OpenFormatRecord>
</record_list>
<year>2147483647</year>
<link>String content</link>
</data>
</OpenFormatResponse>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"company_id":2147483647,
"company_name":"String content",
"document_list":[{
"count":2147483647,
"sum":12678967.543233,
"type_code":2147483647
}],
"production_date":"String content",
"production_time":"String content",
"receipt_list":[{
"count":2147483647,
"sum":12678967.543233,
"type_code":2147483647
}],
"record_list":[{
"code":"String content",
"count":2147483647
}],
"year":2147483647,
"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="OpenFormatRequest">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element name="year" type="xs:int" />
<xs:element minOccurs="0" name="request_reference" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="OpenFormatRequest" nillable="true" type="tns:OpenFormatRequest" />
</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: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="OpenFormatResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" type="tns:OpenFormatData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="OpenFormatResponse" nillable="true" type="tns:OpenFormatResponse" />
<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="OpenFormatData">
<xs:sequence>
<xs:element minOccurs="0" name="company_id" type="xs:int" />
<xs:element minOccurs="0" name="company_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="document_list" nillable="true" type="tns:ArrayOfOpenFormatSummary" />
<xs:element minOccurs="0" name="production_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="production_time" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="receipt_list" nillable="true" type="tns:ArrayOfOpenFormatSummary" />
<xs:element minOccurs="0" name="record_list" nillable="true" type="tns:ArrayOfOpenFormatRecord" />
<xs:element minOccurs="0" name="year" type="xs:int" />
<xs:element minOccurs="0" name="link" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="OpenFormatData" nillable="true" type="tns:OpenFormatData" />
<xs:complexType name="ArrayOfOpenFormatSummary">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="OpenFormatSummary" nillable="true" type="tns:OpenFormatSummary" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfOpenFormatSummary" nillable="true" type="tns:ArrayOfOpenFormatSummary" />
<xs:complexType name="OpenFormatSummary">
<xs:sequence>
<xs:element minOccurs="0" name="count" type="xs:int" />
<xs:element minOccurs="0" name="sum" type="xs:decimal" />
<xs:element minOccurs="0" name="type_code" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="OpenFormatSummary" nillable="true" type="tns:OpenFormatSummary" />
<xs:complexType name="ArrayOfOpenFormatRecord">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="OpenFormatRecord" nillable="true" type="tns:OpenFormatRecord" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfOpenFormatRecord" nillable="true" type="tns:ArrayOfOpenFormatRecord" />
<xs:complexType name="OpenFormatRecord">
<xs:sequence>
<xs:element minOccurs="0" name="code" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="count" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="OpenFormatRecord" nillable="true" type="tns:OpenFormatRecord" />
</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>