Handbuch ESR

More documents

Recommendations

Info

3. Specification The advantage of web services is that we will not have to worry about communications or the protocol on the client side or the server side. The various frameworks usually do this work for you. Thanks to the generated proxy classes the client can call up functionalities as if they were local classes. An explanation of the yellowbill web service functionalities follows. 3.1 Web service for biller 3.1.1 Upload Services The UploadInvoice web service is intended for billers and provides methods for uploading bill files. The following listed bill types are supported. The FileType determinate the file extension of the uploaded file. This is important for further processing. Bill Types FileType (File Extension) PDF bill detail for presentment "PDF" PDFOnly bill format "PDFOnly.PDF" ybInvoice or CreateBill format "XML" Custom XML bill format like SAPiDoc "EAI.XML" Custom EDIFACT bill format "EAI.EDI" 3.1.1.1 The UploadFiles method The interface of the UploadFiles method is as follows: NotProcessedInvoice[] UploadFiles( Invoice[] invoices, String BillerID ); The method expects an array of type Invoice (see below) and the BillerID of the biller to be passed. It returns an array of the type NotProcessedInvoice (see below). To avoiding timeout and peformance problems while uploading a greater amount of Invoices, we recommend to call the UploadFiles Methode for each Invoice rather than to upload them all together with one single call. The type Invoice is a self-declared data type representing a file. It is defined as follows: public class Invoice { public String FileType; public String TransactionID; public byte[] Data; } The FileType The TransactionID is the biller’s bill identification and must be identical to the one in the bill file. The Data field contains the file contents in the form of a binary stream. A byte array, however, cannot be simply transferred via http. The binary stream must be converted into a base64-encoded string and then converted back again on the other side. This conversion, however, is usually done automatically by the SOAP framework. The NotProcessedInvoice data type has the following structure: public class NotProcessedInvoice { public String FileType; public String TransactionID; } 4/19
A NotProcessedInvoice entry indicates that the file could not be uploaded. The biller can tell which invoice is concerned by checking the TransactionID. The biller receives more detailed information in a separate processing log delivered daily. To comply with the WS-Security specification, requests always have a username token and a timeout. Further details below. 3.1.1.2 The UploadFilesReport method The request for UploadFilesReport is similar to the method above. But in the response more detailed information about the transmission status of the files is given. The result is returned in the form of an array of type ProcessedInvoice with the following structure. public class ProcessedInvoice { public String FileType; public DateTime SubmitDate; public String TransactionID; public String ProcessingState; } This type of report entry corresponds to a daily report for each file type. The FileType may be one of the list above. The SubmitDate are date and time of the request and the TransactionID is the unique invoice ID supplied by the biller at upload. Processing contains the state of the submitted data. They may be "OK" or "NOK" by uploaded data. This information may be used for the download methods. 3.1.2 Download Services The Download web service provides the biller with eight bill management methods. A distinction is made between outstanding bills, protocols and registrations (never downloaded) and archived data (already downloaded). It can be controlled by ArchiveData (true / false). Data already collected remain available for 40 days after the first download. 3.1.2.1 GetInvoiceListWithIDs This method returns a report list of available bills with the most important details. It replaces the omitted method GetInvoiceList. The interfaces are as follows: InvoiceReportWithID[] GetInvoiceList( String BillerID, bool ArchiveData ); The method expect the BillerID and the ArchiveData flag as parameters to be passed. To list already downloaded bills, the ArchiveData flag must be set to true. The result will be returned in an array of type InvoiceReportWithID with the following structure. public class InvoiceReportWithID { public String BillerID; public String TransactionID; public DateTime DeliveryDate; public String FileType; } This type of report contains the follwing details for each bill. The TransactionID is the unique invoice ID and the DeliveryDate is the invoice date supplied by the biller when uploading it. The FileType may be "RGXMLSIG"or "EDIFACT". Bills which are embedded as an appendix in a ybInvoice like the SAPiDoc are also of the FileType "RGXMLSIG". All this information may be used for the download methods. 3.1.2.2 GetInvoiceByID This method allows to download a single signed invoice by its TransactionID. It replaces the omitted method GetInvoce. For obtaining the TransactionID, the GetInvoiceListWithID method has to be called first. DownloadFile GetInvoiceByID( String BillerID, string TransactionID ); 5/19
Page 1 and 2: E-bill Instruction for a client imp
Page 3: 1. Introduction Within the e-bill p
Page 7 and 8: public class ProtocolReport { publi
Page 9 and 10: 3.2.1.2 GetInvoiceByID This method
Page 11 and 12: 4. Implementation This section serv
Page 13 and 14: Because the web service is located
Page 15 and 16: There is another configuration file
Page 17 and 18: Next, there is a simple evaluation
Page 19: Annex A Links relating to the integ

Handbuch ESR

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?