Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Company.SummaryReport
Get Company Summary Documents report
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Company.SummaryReport
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:
<CompanySummaryReportRequest xmlns="http://api.rivhit.co.il"> <api_token>String content</api_token> <year>2147483647</year> <month>2147483647</month> <day>2147483647</day> <project_id>2147483647</project_id> </CompanySummaryReportRequest>
The following is an example request Json body:
{
"api_token":"String content",
"year":2147483647,
"month":2147483647,
"day":2147483647,
"project_id":2147483647
}
The following is an example response Xml body:
<CompanySummaryReportResponse xmlns="http://api.rivhit.co.il">
<error_code>2147483647</error_code>
<client_message>String content</client_message>
<debug_message>String content</debug_message>
<data>
<Documents xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<DocumentRow>
<DocCount>2147483647</DocCount>
<DocType>2147483647</DocType>
<DocTypeName>String content</DocTypeName>
<TotalDiscount>12678967.543233</TotalDiscount>
<TotalVat>12678967.543233</TotalVat>
<TotalWithVat>12678967.543233</TotalWithVat>
<TotalWithoutVat>12678967.543233</TotalWithoutVat>
</DocumentRow>
<DocumentRow>
<DocCount>2147483647</DocCount>
<DocType>2147483647</DocType>
<DocTypeName>String content</DocTypeName>
<TotalDiscount>12678967.543233</TotalDiscount>
<TotalVat>12678967.543233</TotalVat>
<TotalWithVat>12678967.543233</TotalWithVat>
<TotalWithoutVat>12678967.543233</TotalWithoutVat>
</DocumentRow>
</Documents>
<PayCodes xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<PaycodeRow>
<Count>2147483647</Count>
<PayCodeType>2147483647</PayCodeType>
<PayCodeTypeName>String content</PayCodeTypeName>
<TotalAmount>12678967.543233</TotalAmount>
</PaycodeRow>
<PaycodeRow>
<Count>2147483647</Count>
<PayCodeType>2147483647</PayCodeType>
<PayCodeTypeName>String content</PayCodeTypeName>
<TotalAmount>12678967.543233</TotalAmount>
</PaycodeRow>
</PayCodes>
<Receipts xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<ReceiptRow>
<ReceiptCount>2147483647</ReceiptCount>
<ReceiptType>2147483647</ReceiptType>
<ReceiptTypeName>String content</ReceiptTypeName>
<TotalAmount>12678967.543233</TotalAmount>
</ReceiptRow>
<ReceiptRow>
<ReceiptCount>2147483647</ReceiptCount>
<ReceiptType>2147483647</ReceiptType>
<ReceiptTypeName>String content</ReceiptTypeName>
<TotalAmount>12678967.543233</TotalAmount>
</ReceiptRow>
</Receipts>
</data>
</CompanySummaryReportResponse>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"Documents":[{
"DocCount":2147483647,
"DocType":2147483647,
"DocTypeName":"String content",
"TotalDiscount":12678967.543233,
"TotalVat":12678967.543233,
"TotalWithVat":12678967.543233,
"TotalWithoutVat":12678967.543233
}],
"PayCodes":[{
"Count":2147483647,
"PayCodeType":2147483647,
"PayCodeTypeName":"String content",
"TotalAmount":12678967.543233
}],
"Receipts":[{
"ReceiptCount":2147483647,
"ReceiptType":2147483647,
"ReceiptTypeName":"String content",
"TotalAmount":12678967.543233
}]
}
}
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="CompanySummaryReportRequest">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element name="year" type="xs:int" />
<xs:element name="month" type="xs:int" />
<xs:element minOccurs="0" name="day" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="project_id" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="CompanySummaryReportRequest" nillable="true" type="tns:CompanySummaryReportRequest" />
</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:import namespace="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" />
<xs:complexType name="CompanySummaryReportResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" type="q1:CompanySummaryReportData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CompanySummaryReportResponse" nillable="true" type="tns:CompanySummaryReportResponse" />
<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: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 xmlns:tns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="CompanySummaryReportData">
<xs:sequence>
<xs:element minOccurs="0" name="Documents" nillable="true" type="tns:ArrayOfDocumentRow" />
<xs:element minOccurs="0" name="PayCodes" nillable="true" type="tns:ArrayOfPaycodeRow" />
<xs:element minOccurs="0" name="Receipts" nillable="true" type="tns:ArrayOfReceiptRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="CompanySummaryReportData" nillable="true" type="tns:CompanySummaryReportData" />
<xs:complexType name="ArrayOfDocumentRow">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DocumentRow" nillable="true" type="tns:DocumentRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDocumentRow" nillable="true" type="tns:ArrayOfDocumentRow" />
<xs:complexType name="DocumentRow">
<xs:sequence>
<xs:element minOccurs="0" name="DocCount" type="xs:int" />
<xs:element minOccurs="0" name="DocType" type="xs:int" />
<xs:element minOccurs="0" name="DocTypeName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TotalDiscount" type="xs:decimal" />
<xs:element minOccurs="0" name="TotalVat" type="xs:decimal" />
<xs:element minOccurs="0" name="TotalWithVat" type="xs:decimal" />
<xs:element minOccurs="0" name="TotalWithoutVat" type="xs:decimal" />
</xs:sequence>
</xs:complexType>
<xs:element name="DocumentRow" nillable="true" type="tns:DocumentRow" />
<xs:complexType name="ArrayOfPaycodeRow">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="PaycodeRow" nillable="true" type="tns:PaycodeRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfPaycodeRow" nillable="true" type="tns:ArrayOfPaycodeRow" />
<xs:complexType name="PaycodeRow">
<xs:sequence>
<xs:element minOccurs="0" name="Count" type="xs:int" />
<xs:element minOccurs="0" name="PayCodeType" type="xs:int" />
<xs:element minOccurs="0" name="PayCodeTypeName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TotalAmount" type="xs:decimal" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaycodeRow" nillable="true" type="tns:PaycodeRow" />
<xs:complexType name="ArrayOfReceiptRow">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ReceiptRow" nillable="true" type="tns:ReceiptRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfReceiptRow" nillable="true" type="tns:ArrayOfReceiptRow" />
<xs:complexType name="ReceiptRow">
<xs:sequence>
<xs:element minOccurs="0" name="ReceiptCount" type="xs:int" />
<xs:element minOccurs="0" name="ReceiptType" type="xs:int" />
<xs:element minOccurs="0" name="ReceiptTypeName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TotalAmount" type="xs:decimal" />
</xs:sequence>
</xs:complexType>
<xs:element name="ReceiptRow" nillable="true" type="tns:ReceiptRow" />
</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>