Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Payment.MonthlyReport
Get customer payments for each month by certain year
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Payment.MonthlyReport
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:
<PaymentMonthlyReportRequest xmlns="http://api.rivhit.co.il"> <api_token>String content</api_token> <year>2147483647</year> <customer_id>2147483647</customer_id> </PaymentMonthlyReportRequest>
The following is an example request Json body:
{
"api_token":"String content",
"year":2147483647,
"customer_id":2147483647
}
The following is an example response Xml body:
<PaymentMonthlyReportResponse xmlns="http://api.rivhit.co.il">
<error_code>2147483647</error_code>
<client_message>String content</client_message>
<debug_message>String content</debug_message>
<data>
<payments>
<PaymentMonthlyReportRow>
<cust_id>2147483647</cust_id>
<cust_name>String content</cust_name>
<january>12678967.543233</january>
<february>12678967.543233</february>
<march>12678967.543233</march>
<april>12678967.543233</april>
<may>12678967.543233</may>
<june>12678967.543233</june>
<july>12678967.543233</july>
<august>12678967.543233</august>
<september>12678967.543233</september>
<october>12678967.543233</october>
<november>12678967.543233</november>
<december>12678967.543233</december>
<total>12678967.543233</total>
</PaymentMonthlyReportRow>
<PaymentMonthlyReportRow>
<cust_id>2147483647</cust_id>
<cust_name>String content</cust_name>
<january>12678967.543233</january>
<february>12678967.543233</february>
<march>12678967.543233</march>
<april>12678967.543233</april>
<may>12678967.543233</may>
<june>12678967.543233</june>
<july>12678967.543233</july>
<august>12678967.543233</august>
<september>12678967.543233</september>
<october>12678967.543233</october>
<november>12678967.543233</november>
<december>12678967.543233</december>
<total>12678967.543233</total>
</PaymentMonthlyReportRow>
</payments>
</data>
</PaymentMonthlyReportResponse>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"payments":[{
"cust_id":2147483647,
"cust_name":"String content",
"january":12678967.543233,
"february":12678967.543233,
"march":12678967.543233,
"april":12678967.543233,
"may":12678967.543233,
"june":12678967.543233,
"july":12678967.543233,
"august":12678967.543233,
"september":12678967.543233,
"october":12678967.543233,
"november":12678967.543233,
"december":12678967.543233,
"total":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="PaymentMonthlyReportRequest">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="year" type="xs:int" />
<xs:element minOccurs="0" name="customer_id" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaymentMonthlyReportRequest" nillable="true" type="tns:PaymentMonthlyReportRequest" />
</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="PaymentMonthlyReportResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" type="tns:PaymentMonthlyReportData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PaymentMonthlyReportResponse" nillable="true" type="tns:PaymentMonthlyReportResponse" />
<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="PaymentMonthlyReportData">
<xs:sequence>
<xs:element minOccurs="0" name="payments" nillable="true" type="tns:ArrayOfPaymentMonthlyReportRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaymentMonthlyReportData" nillable="true" type="tns:PaymentMonthlyReportData" />
<xs:complexType name="ArrayOfPaymentMonthlyReportRow">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="PaymentMonthlyReportRow" nillable="true" type="tns:PaymentMonthlyReportRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfPaymentMonthlyReportRow" nillable="true" type="tns:ArrayOfPaymentMonthlyReportRow" />
<xs:complexType name="PaymentMonthlyReportRow">
<xs:sequence>
<xs:element minOccurs="0" name="cust_id" type="xs:int" />
<xs:element minOccurs="0" name="cust_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="january" type="xs:decimal" />
<xs:element minOccurs="0" name="february" type="xs:decimal" />
<xs:element minOccurs="0" name="march" type="xs:decimal" />
<xs:element minOccurs="0" name="april" type="xs:decimal" />
<xs:element minOccurs="0" name="may" type="xs:decimal" />
<xs:element minOccurs="0" name="june" type="xs:decimal" />
<xs:element minOccurs="0" name="july" type="xs:decimal" />
<xs:element minOccurs="0" name="august" type="xs:decimal" />
<xs:element minOccurs="0" name="september" type="xs:decimal" />
<xs:element minOccurs="0" name="october" type="xs:decimal" />
<xs:element minOccurs="0" name="november" type="xs:decimal" />
<xs:element minOccurs="0" name="december" type="xs:decimal" />
<xs:element minOccurs="0" name="total" type="xs:decimal" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaymentMonthlyReportRow" nillable="true" type="tns:PaymentMonthlyReportRow" />
</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>