Operacja getPurchaseDocumentList zwraca listę dokumentów spełniających zadane kryteria.
Przykładowe zapytanie SOAP:
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns="ns1"> <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <ns:getPurchaseDocumentList> <searchCriteria> <cashierName>imie</cashierName> <startDate>2018-07-17 13:49:57</startDate> <endDate>2018-07-18 13:49:57</endDate> <invoiceNum>1</invoiceNum> <fromAmount> <amount>1000</amount> <currency>PLN</currency> <colour>0</colour> </fromAmount> <toAmount> <amount>100000</amount> <currency>PLN</currency> <colour>0</colour> </toAmount> </searchCriteria> </ns:getPurchaseDocumentList> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykładowa odpowiedź SOAP:
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns="ns1"> <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <ns:getPurchaseDocumentListResponse> <return> <documents> <item> <uniqueTransferId></uniqueTransferId> <purchaseDocument></purchaseDocument> </item></documents> <requestStatus>SUCCESS</requestStatus> <requestStatusDescription>Request succeeded.</requestStatusDescription> </return> </ns:getPurchaseDocumentListResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Parametry zapytania:
parametr | typ | opis | wymagane? |
---|---|---|---|
searchCriteria | documentSearchCriteria | kryteria wyszukiwania | nie |
Parametry odpowiedzi:
nazwa | typ | opis |
---|---|---|
documents | vuiGetPurchaseDocumentList | lista opisów płatności |
requestStatus | string | status wykonania zapytania |
requestStatusDescription | string | opis statusu |