Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Payment.Report
Get payment report
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Payment.Report
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:
<PaymentReportRequest xmlns="http://api.rivhit.co.il"> <api_token>String content</api_token> <pay_code>2147483647</pay_code> <from_production_date>String content</from_production_date> <to_production_date>String content</to_production_date> <from_value_date>String content</from_value_date> <to_value_date>String content</to_value_date> <crmUserId>2147483647</crmUserId> <projectId>2147483647</projectId> </PaymentReportRequest>
The following is an example request Json body:
{
"api_token":"String content",
"pay_code":2147483647,
"from_production_date":"String content",
"to_production_date":"String content",
"from_value_date":"String content",
"to_value_date":"String content",
"crmUserId":2147483647,
"projectId":2147483647
}
The following is an example response Xml body:
<PaymentReportResponse 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>
<PaymentReportRow>
<amount>12678967.543233</amount>
<bank_account_number>String content</bank_account_number>
<bank_code>2147483647</bank_code>
<branch_number>2147483647</branch_number>
<check_number>2147483647</check_number>
<customer_first_name>String content</customer_first_name>
<customer_id>2147483647</customer_id>
<customer_last_name>String content</customer_last_name>
<due_date>String content</due_date>
<payment_type>2147483647</payment_type>
<project_id>2147483647</project_id>
<receipt_date>String content</receipt_date>
<receipt_link>String content</receipt_link>
<receipt_number>2147483647</receipt_number>
<receipt_type>2147483647</receipt_type>
</PaymentReportRow>
<PaymentReportRow>
<amount>12678967.543233</amount>
<bank_account_number>String content</bank_account_number>
<bank_code>2147483647</bank_code>
<branch_number>2147483647</branch_number>
<check_number>2147483647</check_number>
<customer_first_name>String content</customer_first_name>
<customer_id>2147483647</customer_id>
<customer_last_name>String content</customer_last_name>
<due_date>String content</due_date>
<payment_type>2147483647</payment_type>
<project_id>2147483647</project_id>
<receipt_date>String content</receipt_date>
<receipt_link>String content</receipt_link>
<receipt_number>2147483647</receipt_number>
<receipt_type>2147483647</receipt_type>
</PaymentReportRow>
</payments>
</data>
</PaymentReportResponse>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"payments":[{
"amount":12678967.543233,
"bank_account_number":"String content",
"bank_code":2147483647,
"branch_number":2147483647,
"check_number":2147483647,
"customer_first_name":"String content",
"customer_id":2147483647,
"customer_last_name":"String content",
"due_date":"String content",
"payment_type":2147483647,
"project_id":2147483647,
"receipt_date":"String content",
"receipt_link":"String content",
"receipt_number":2147483647,
"receipt_type":2147483647
}]
}
}
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="PaymentReportRequest">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="pay_code" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="from_production_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="to_production_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="from_value_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="to_value_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="crmUserId" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="projectId" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaymentReportRequest" nillable="true" type="tns:PaymentReportRequest" />
</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="PaymentReportResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" type="tns:PaymentReportData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PaymentReportResponse" nillable="true" type="tns:PaymentReportResponse" />
<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="PaymentReportData">
<xs:sequence>
<xs:element minOccurs="0" name="payments" nillable="true" type="tns:ArrayOfPaymentReportRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaymentReportData" nillable="true" type="tns:PaymentReportData" />
<xs:complexType name="ArrayOfPaymentReportRow">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="PaymentReportRow" nillable="true" type="tns:PaymentReportRow" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfPaymentReportRow" nillable="true" type="tns:ArrayOfPaymentReportRow" />
<xs:complexType name="PaymentReportRow">
<xs:sequence>
<xs:element minOccurs="0" name="amount" type="xs:decimal" />
<xs:element minOccurs="0" name="bank_account_number" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="bank_code" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="branch_number" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="check_number" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="customer_first_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="customer_id" type="xs:int" />
<xs:element minOccurs="0" name="customer_last_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="due_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="payment_type" type="xs:int" />
<xs:element minOccurs="0" name="project_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="receipt_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="receipt_link" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="receipt_number" type="xs:int" />
<xs:element minOccurs="0" name="receipt_type" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="PaymentReportRow" nillable="true" type="tns:PaymentReportRow" />
</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>