Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Document.List
Get documents list. by default returns last 6 months
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Document.List
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:
<DocumentListRequest xmlns="http://api.rivhit.co.il">
<api_token>String content</api_token>
<from_document_type>2147483647</from_document_type>
<to_document_type>2147483647</to_document_type>
<from_customer_id>2147483647</from_customer_id>
<to_customer_id>2147483647</to_customer_id>
<from_date>String content</from_date>
<to_date>String content</to_date>
<from_agent_id>2147483647</from_agent_id>
<to_agent_id>2147483647</to_agent_id>
<from_document_number>2147483647</from_document_number>
<to_document_number>2147483647</to_document_number>
<filter_fields>
<DynamicFilterFieldsDTO xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<filter_field>String content</filter_field>
<filter_value>String content</filter_value>
</DynamicFilterFieldsDTO>
<DynamicFilterFieldsDTO xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<filter_field>String content</filter_field>
<filter_value>String content</filter_value>
</DynamicFilterFieldsDTO>
</filter_fields>
</DocumentListRequest>
The following is an example request Json body:
{
"api_token":"String content",
"from_document_type":2147483647,
"to_document_type":2147483647,
"from_customer_id":2147483647,
"to_customer_id":2147483647,
"from_date":"String content",
"to_date":"String content",
"from_agent_id":2147483647,
"to_agent_id":2147483647,
"from_document_number":2147483647,
"to_document_number":2147483647,
"filter_fields":[{
"filter_field":"String content",
"filter_value":"String content"
}]
}
The following is an example response Xml body:
<DocumentListResponse xmlns="http://api.rivhit.co.il">
<error_code>2147483647</error_code>
<client_message>String content</client_message>
<debug_message>String content</debug_message>
<data>
<document_list>
<Document>
<document_type>2147483647</document_type>
<document_number>2147483647</document_number>
<document_date>String content</document_date>
<document_time>String content</document_time>
<amount>12678967.543233</amount>
<amount_exempt>12678967.543233</amount_exempt>
<customer_id>2147483647</customer_id>
<agent_id>2147483647</agent_id>
<is_cancelled>true</is_cancelled>
<customer_name>String content</customer_name>
<order>String content</order>
<sort_code>2147483647</sort_code>
<total_vat>12678967.543233</total_vat>
<document_type_name>String content</document_type_name>
<is_accounting>true</is_accounting>
<project_id>2147483647</project_id>
<reference>String content</reference>
<phone>String content</phone>
<document_link>String content</document_link>
<comments>String content</comments>
<customer_email>String content</customer_email>
<is_closed>true</is_closed>
<customer_firstname>String content</customer_firstname>
<customer_lastname>String content</customer_lastname>
<confirmation_number>2147483647</confirmation_number>
<due_date>String content</due_date>
</Document>
<Document>
<document_type>2147483647</document_type>
<document_number>2147483647</document_number>
<document_date>String content</document_date>
<document_time>String content</document_time>
<amount>12678967.543233</amount>
<amount_exempt>12678967.543233</amount_exempt>
<customer_id>2147483647</customer_id>
<agent_id>2147483647</agent_id>
<is_cancelled>true</is_cancelled>
<customer_name>String content</customer_name>
<order>String content</order>
<sort_code>2147483647</sort_code>
<total_vat>12678967.543233</total_vat>
<document_type_name>String content</document_type_name>
<is_accounting>true</is_accounting>
<project_id>2147483647</project_id>
<reference>String content</reference>
<phone>String content</phone>
<document_link>String content</document_link>
<comments>String content</comments>
<customer_email>String content</customer_email>
<is_closed>true</is_closed>
<customer_firstname>String content</customer_firstname>
<customer_lastname>String content</customer_lastname>
<confirmation_number>2147483647</confirmation_number>
<due_date>String content</due_date>
</Document>
</document_list>
</data>
</DocumentListResponse>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"document_list":[{
"document_type":2147483647,
"document_number":2147483647,
"document_date":"String content",
"document_time":"String content",
"amount":12678967.543233,
"amount_exempt":12678967.543233,
"customer_id":2147483647,
"agent_id":2147483647,
"is_cancelled":true,
"customer_name":"String content",
"order":"String content",
"sort_code":2147483647,
"total_vat":12678967.543233,
"document_type_name":"String content",
"is_accounting":true,
"project_id":2147483647,
"reference":"String content",
"phone":"String content",
"document_link":"String content",
"comments":"String content",
"customer_email":"String content",
"is_closed":true,
"customer_firstname":"String content",
"customer_lastname":"String content",
"confirmation_number":2147483647,
"due_date":"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:import namespace="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" />
<xs:complexType name="DocumentListRequest">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="from_document_type" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="to_document_type" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="from_customer_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="to_customer_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="from_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="to_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="from_agent_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="to_agent_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="from_document_number" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="to_document_number" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="filter_fields" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" type="q1:ArrayOfDynamicFilterFieldsDTO" />
</xs:sequence>
</xs:complexType>
<xs:element name="DocumentListRequest" nillable="true" type="tns:DocumentListRequest" />
</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 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="ArrayOfDynamicFilterFieldsDTO">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DynamicFilterFieldsDTO" nillable="true" type="tns:DynamicFilterFieldsDTO" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDynamicFilterFieldsDTO" nillable="true" type="tns:ArrayOfDynamicFilterFieldsDTO" />
<xs:complexType name="DynamicFilterFieldsDTO">
<xs:sequence>
<xs:element minOccurs="0" name="filter_field" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="filter_value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="DynamicFilterFieldsDTO" nillable="true" type="tns:DynamicFilterFieldsDTO" />
</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="DocumentListResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" type="tns:DocumentListData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DocumentListResponse" nillable="true" type="tns:DocumentListResponse" />
<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="DocumentListData">
<xs:sequence>
<xs:element minOccurs="0" name="document_list" nillable="true" type="tns:ArrayOfDocument" />
</xs:sequence>
</xs:complexType>
<xs:element name="DocumentListData" nillable="true" type="tns:DocumentListData" />
<xs:complexType name="ArrayOfDocument">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Document" nillable="true" type="tns:Document" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDocument" nillable="true" type="tns:ArrayOfDocument" />
<xs:complexType name="Document">
<xs:sequence>
<xs:element minOccurs="0" name="document_type" type="xs:int" />
<xs:element minOccurs="0" name="document_number" type="xs:int" />
<xs:element minOccurs="0" name="document_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="document_time" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="amount" type="xs:decimal" />
<xs:element minOccurs="0" name="amount_exempt" type="xs:decimal" />
<xs:element minOccurs="0" name="customer_id" type="xs:int" />
<xs:element minOccurs="0" name="agent_id" type="xs:int" />
<xs:element minOccurs="0" name="is_cancelled" type="xs:boolean" />
<xs:element minOccurs="0" name="customer_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="order" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="sort_code" type="xs:int" />
<xs:element minOccurs="0" name="total_vat" type="xs:decimal" />
<xs:element minOccurs="0" name="document_type_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="is_accounting" type="xs:boolean" />
<xs:element minOccurs="0" name="project_id" type="xs:int" />
<xs:element minOccurs="0" name="reference" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="phone" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="document_link" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="comments" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="customer_email" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="is_closed" type="xs:boolean" />
<xs:element minOccurs="0" name="customer_firstname" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="customer_lastname" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="confirmation_number" type="xs:int" />
<xs:element minOccurs="0" name="due_date" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Document" nillable="true" type="tns:Document" />
</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>