Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Customer.ClosedDocuments
Get the customer closed documents report
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Customer.ClosedDocuments
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:
<CustomerClosedDocumentsRequestDTO xmlns="http://api.rivhit.co.il"> <api_token>String content</api_token> <customer_id>2147483647</customer_id> <document_type>2147483647</document_type> <until_date>String content</until_date> <by_produce_date>true</by_produce_date> <accounting_only>true</accounting_only> <no_accounting>true</no_accounting> <agent_id>2147483647</agent_id> <from_date>String content</from_date> <cartis_code>2147483647</cartis_code> </CustomerClosedDocumentsRequestDTO>
The following is an example request Json body:
{
"api_token":"String content",
"customer_id":2147483647,
"document_type":2147483647,
"until_date":"String content",
"by_produce_date":true,
"accounting_only":true,
"no_accounting":true,
"agent_id":2147483647,
"from_date":"String content",
"cartis_code":2147483647
}
The following is an example response Xml body:
<CustomerClosedDocumentsResponseDTO xmlns="http://api.rivhit.co.il">
<error_code>2147483647</error_code>
<client_message>String content</client_message>
<debug_message>String content</debug_message>
<data>
<closed_documents>
<CustomerClosedDocument>
<balance>12678967.543233</balance>
<closing_list>
<CustomerClosedDocumentsClosingListData>
<amount>12678967.543233</amount>
<close_date>String content</close_date>
<close_type>String content</close_type>
<sub_num>2147483647</sub_num>
<sub_type>2147483647</sub_type>
</CustomerClosedDocumentsClosingListData>
<CustomerClosedDocumentsClosingListData>
<amount>12678967.543233</amount>
<close_date>String content</close_date>
<close_type>String content</close_type>
<sub_num>2147483647</sub_num>
<sub_type>2147483647</sub_type>
</CustomerClosedDocumentsClosingListData>
</closing_list>
<currency_id>2147483647</currency_id>
<customer_id>2147483647</customer_id>
<customer_name>String content</customer_name>
<document_number>2147483647</document_number>
<document_type>2147483647</document_type>
<due_date>String content</due_date>
<is_receipt>true</is_receipt>
<issue_date>String content</issue_date>
<paid_amount>12678967.543233</paid_amount>
<reference>String content</reference>
<total_amount>12678967.543233</total_amount>
<total_amount_mtc>12678967.543233</total_amount_mtc>
</CustomerClosedDocument>
<CustomerClosedDocument>
<balance>12678967.543233</balance>
<closing_list>
<CustomerClosedDocumentsClosingListData>
<amount>12678967.543233</amount>
<close_date>String content</close_date>
<close_type>String content</close_type>
<sub_num>2147483647</sub_num>
<sub_type>2147483647</sub_type>
</CustomerClosedDocumentsClosingListData>
<CustomerClosedDocumentsClosingListData>
<amount>12678967.543233</amount>
<close_date>String content</close_date>
<close_type>String content</close_type>
<sub_num>2147483647</sub_num>
<sub_type>2147483647</sub_type>
</CustomerClosedDocumentsClosingListData>
</closing_list>
<currency_id>2147483647</currency_id>
<customer_id>2147483647</customer_id>
<customer_name>String content</customer_name>
<document_number>2147483647</document_number>
<document_type>2147483647</document_type>
<due_date>String content</due_date>
<is_receipt>true</is_receipt>
<issue_date>String content</issue_date>
<paid_amount>12678967.543233</paid_amount>
<reference>String content</reference>
<total_amount>12678967.543233</total_amount>
<total_amount_mtc>12678967.543233</total_amount_mtc>
</CustomerClosedDocument>
</closed_documents>
</data>
</CustomerClosedDocumentsResponseDTO>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"closed_documents":[{
"balance":12678967.543233,
"closing_list":[{
"amount":12678967.543233,
"close_date":"String content",
"close_type":"String content",
"sub_num":2147483647,
"sub_type":2147483647
}],
"currency_id":2147483647,
"customer_id":2147483647,
"customer_name":"String content",
"document_number":2147483647,
"document_type":2147483647,
"due_date":"String content",
"is_receipt":true,
"issue_date":"String content",
"paid_amount":12678967.543233,
"reference":"String content",
"total_amount":12678967.543233,
"total_amount_mtc":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="CustomerClosedDocumentsRequestDTO">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="customer_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="document_type" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="until_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="by_produce_date" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="accounting_only" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="no_accounting" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="agent_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="from_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="cartis_code" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomerClosedDocumentsRequestDTO" nillable="true" type="tns:CustomerClosedDocumentsRequestDTO" />
</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="CustomerClosedDocumentsResponseDTO">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" type="tns:CustomerClosedDocumentsData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CustomerClosedDocumentsResponseDTO" nillable="true" type="tns:CustomerClosedDocumentsResponseDTO" />
<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="CustomerClosedDocumentsData">
<xs:sequence>
<xs:element minOccurs="0" name="closed_documents" nillable="true" type="tns:ArrayOfCustomerClosedDocument" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomerClosedDocumentsData" nillable="true" type="tns:CustomerClosedDocumentsData" />
<xs:complexType name="ArrayOfCustomerClosedDocument">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CustomerClosedDocument" nillable="true" type="tns:CustomerClosedDocument" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomerClosedDocument" nillable="true" type="tns:ArrayOfCustomerClosedDocument" />
<xs:complexType name="CustomerClosedDocument">
<xs:sequence>
<xs:element minOccurs="0" name="balance" type="xs:decimal" />
<xs:element minOccurs="0" name="closing_list" nillable="true" type="tns:ArrayOfCustomerClosedDocumentsClosingListData" />
<xs:element minOccurs="0" name="currency_id" type="xs:int" />
<xs:element minOccurs="0" name="customer_id" type="xs:int" />
<xs:element minOccurs="0" name="customer_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="document_number" type="xs:int" />
<xs:element minOccurs="0" name="document_type" type="xs:int" />
<xs:element minOccurs="0" name="due_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="is_receipt" type="xs:boolean" />
<xs:element minOccurs="0" name="issue_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="paid_amount" type="xs:decimal" />
<xs:element minOccurs="0" name="reference" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="total_amount" type="xs:decimal" />
<xs:element minOccurs="0" name="total_amount_mtc" type="xs:decimal" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomerClosedDocument" nillable="true" type="tns:CustomerClosedDocument" />
<xs:complexType name="ArrayOfCustomerClosedDocumentsClosingListData">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CustomerClosedDocumentsClosingListData" nillable="true" type="tns:CustomerClosedDocumentsClosingListData" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomerClosedDocumentsClosingListData" nillable="true" type="tns:ArrayOfCustomerClosedDocumentsClosingListData" />
<xs:complexType name="CustomerClosedDocumentsClosingListData">
<xs:sequence>
<xs:element minOccurs="0" name="amount" type="xs:decimal" />
<xs:element minOccurs="0" name="close_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="close_type" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="sub_num" type="xs:int" />
<xs:element minOccurs="0" name="sub_type" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomerClosedDocumentsClosingListData" nillable="true" type="tns:CustomerClosedDocumentsClosingListData" />
</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>