Wiki source code of 04. BillJournal
                      Last modified by Fredrik Nilsson on 2023/01/20 10:22
                  
            |                              | 
      2.1 | 1 | (% class="jumbotron" %) | 
| 2 | ((( | ||
| 3 | (% class="container" %) | ||
| 4 | ((( | ||
|                              | 
      30.1 | 5 | This is a technical overview of one of the response files (**Bill Journal**) you retrieve from PayEx. | 
|        | 
      2.1 | 6 | ))) | 
| 7 | ))) | ||
| 8 | |||
| 9 | {{warning}} | ||
| 10 | Please note that your Response files might only utilize and/or contain a subset of all elements described below. See the XSD version for your response files to learn more. | ||
| 11 | {{/warning}} | ||
| 12 | |||
| 13 | == Overview == | ||
| 14 | |||
|        | 
      9.1 | 15 | |
| 16 | The Bill Journal displays changes in invoice status that relates to contracted services. | ||
| 17 | |||
|        | 
      2.1 | 18 | Entries in the Bill Journal could stem from events such as: | 
| 19 | |||
|        | 
      28.1 | 20 | * An invoice has been closed or backordered in accounts receivable (including invoice substatus if applicable) | 
|        | 
      2.1 | 21 | * A reminder, interest claim or debt claim has been sent | 
| 22 | * An invoice has been transfered to debt collection | ||
| 23 | * An invoice claim has been received | ||
| 24 | * An invoice claim has been registered as settled | ||
|        | 
      27.1 | 25 | * A respite has been registered | 
| 26 | * A respite has been removed | ||
|        | 
      28.1 | 27 | * A notification has been created | 
|                              | 
      62.1 | 28 | * A failed direct debit has occurred | 
|        | 
      2.1 | 29 | |
|        | 
      63.1 | 30 | (% class="box warningmessage" %) | 
| 31 | ((( | ||
| 32 | The file can contain up to 300,000 events, if there are more events to be exported via BillJournal, it will be split into several files | ||
| 33 | ))) | ||
| 34 | |||
|        | 
      28.1 | 35 | //Below diagram shows the structure of BillJournal in current version// | 
|        | 
      2.1 | 36 | |
|        | 
      63.1 | 37 | [[image:1655717195862-707.png||height="813" width="422"]] | 
|        | 
      53.1 | 38 | |
|        | 
      2.1 | 39 | (% id="HRecordDescription" %) | 
| 40 | == Name Convention == | ||
| 41 | |||
| 42 | ##BILLJOURNAL_<CompanyNumber>_<DatumTime>_<SerialNumber>.xml## | ||
| 43 | |||
| 44 | (% class="table-bordered table-striped" %) | ||
|                              | 
      51.1 | 45 | |=Name components|=Description | 
|        | 
      2.1 | 46 | |CompanyNumber|The company number in our ledger system | 
|                              | 
      33.1 | 47 | |DateTime|The date and time that the file was created. Uses ISO 8601 format, ##YYYYMMDDhhmmdd## | 
|        | 
      50.1 | 48 | |SerialNumber|Should follow an uninterrupted number series, 1, 2, 3 and so on. | 
|        | 
      2.1 | 49 | |
| 50 | Example filename: ##BILLJOURNAL_9999_20080923124422_1.xml## | ||
| 51 | |||
| 52 | (% id="HXMLschemadefinitionfile" %) | ||
| 53 | == Current XML schema description == | ||
| 54 | |||
|        | 
      49.1 | 55 | A detailed description of the elements in the current version of the XML schema definition file (XSD) can be found [[here>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.BillJournal.XML Schema specification.WebHome]] | 
|        | 
      2.1 | 56 | |
|        | 
      9.1 | 57 | == Download XML schema file == | 
|        | 
      2.1 | 58 | |
| 59 | (% class="row" %) | ||
| 60 | ((( | ||
| 61 | (% class="col-xs-12" %) | ||
| 62 | ((( | ||
| 63 | (% border="0" style="width:900px" %) | ||
| 64 | |=(% style="width: 208px; background-color: rgb(237, 237, 237);" %)Fileversion|=(% style="width: 213px; background-color: rgb(237, 237, 237);" %)Version|=(% style="width: 288px; background-color: rgb(237, 237, 237);" %)Releasedate|=(% style="width: 585px; background-color: rgb(237, 237, 237);" %)Comment | ||
|                              | 
      60.1 | 65 | |(% style="width:208px" %)[[BillJournal[1.X].xsd>>attach:BillJournal_[1.X].xsd]]|(% style="width:213px" %)1.3|(% style="width:288px" %)2022-04-26|(% style="width:585px" %)Added support for new eCurrencyTypes USD and GBP | 
|                              | 
      45.1 | 66 | |(% style="width:208px" %)[[BillJournal[1.2].xsd>>attach:BillJournal[1.2].xsd]]|(% style="width:213px" %)1.2|(% style="width:288px" %)2020-03-10|(% style="width:585px" %)Added PaymentOrderEvents | 
|        | 
      60.1 | 67 | |(% style="width:208px" %)[[BillJournal[1.1].xsd>>attach:BillJournal_[1.1].xsd]]|(% style="width:213px" %)1.1|(% style="width:288px" %)2019-10-08|(% style="width:585px" %)((( | 
|        | 
      27.1 | 68 | Added InvoiceNotificationEvents | 
|        | 
      9.1 | 69 | Added optional InvoiceSubStatus | 
| 70 | ))) | ||
|        | 
      34.1 | 71 | |(% style="width:208px" %)[[BillJournal_[1.0].xsd>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@BillJournal_[1.0].xsd]]|(% style="width:213px" %)1.0|(% style="width:288px" %)2016|(% style="width:585px" %)Deprecated | 
|        | 
      9.1 | 72 | |
|        | 
      30.1 | 73 | == Change Log == | 
|        | 
      2.1 | 74 | |
|        | 
      36.1 | 75 | |
|        | 
      2.1 | 76 | (% id="HVersion1.1" %) | 
|        | 
      60.1 | 77 | ==== **Version 1.3** ==== | 
|        | 
      55.1 | 78 | |
| 79 | (% id="HJanuary2C2016" %) | ||
| 80 | ===== April, 2022 ===== | ||
| 81 | |||
|        | 
      60.1 | 82 | [[BillJournal[1.X].xsd>>attach:BillJournal_[1.X].xsd]] | 
|        | 
      55.1 | 83 | |
| 84 | (% class="box" %) | ||
| 85 | ((( | ||
| 86 | Added support for new eCurrencyTypes USD and GBP | ||
| 87 | ))) | ||
| 88 | |||
| 89 | (% id="HVersion1.1" %) | ||
|        | 
      36.1 | 90 | ==== **Version 1.2** ==== | 
| 91 | |||
| 92 | (% id="HJanuary2C2016" %) | ||
| 93 | ===== Mars, 2020 ===== | ||
| 94 | |||
|        | 
      46.1 | 95 | [[BillJournal[1.2].xsd>>attach:BillJournal[1.2].xsd]] | 
|        | 
      36.1 | 96 | |
| 97 | (% class="box" %) | ||
| 98 | ((( | ||
| 99 | Added PaymentOrderEvents | ||
| 100 | ))) | ||
| 101 | |||
| 102 | (% id="HVersion1.1" %) | ||
|        | 
      9.1 | 103 | ==== **Version 1.1{{id name="3"/}}** ==== | 
|        | 
      2.1 | 104 | |
| 105 | (% id="HJanuary2C2016" %) | ||
|        | 
      9.1 | 106 | ===== Oktober, 2019 ===== | 
|        | 
      2.1 | 107 | |
|        | 
      60.1 | 108 | [[BillJournal[1.1].xsd>>attach:BillJournal_[1.1].xsd]] | 
|        | 
      2.1 | 109 | |
| 110 | (% class="box" %) | ||
| 111 | ((( | ||
|        | 
      9.1 | 112 | Added information notifications before and after due date and before reminder date. | 
| 113 | |||
| 114 | Added optional InvoiceSubStatus under InvoiceStatusEvent | ||
|        | 
      2.1 | 115 | ))) | 
| 116 | |||
| 117 | ---- | ||
| 118 | |||
|        | 
      9.1 | 119 | (% id="HVersion1.1" %) | 
| 120 | ==== **Version 1.0{{id name="3"/}}** ==== | ||
| 121 | |||
| 122 | (% id="HJanuary2C2016" %) | ||
| 123 | ===== September, 2016 ===== | ||
| 124 | |||
|        | 
      12.1 | 125 | [[BillJournal_[1.0].xsd>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@BillJournal_[1.0].xsd]] | 
|        | 
      9.1 | 126 | |
| 127 | (% class="box" %) | ||
| 128 | ((( | ||
| 129 | Initial version (latest documented version) | ||
|        | 
      2.1 | 130 | ))) | 
|        | 
      30.1 | 131 | |
| 132 | == Download sample file == | ||
| 133 | |||
|        | 
      47.1 | 134 | [[BillJournal_367_20191030142104_439>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@BillJournal_367_20191030142104_439.XML]] | 
|        | 
      2.1 | 135 | ))) | 
|        | 
      9.1 | 136 | ))) |