Main.Invoicing.invoice-service.Implementation guide.Technical reference.BillJournal - 04. BillJournal

Page of - last modified by frn on 2023/01/20 10:22

04. BillJournal

frn

2023/01/20 10:22

Table of Contents

Overview

Name Convention

Current XML schema description

Download XML schema file

This is a technical overview of one of the response files (Bill Journal) you retrieve from PayEx.

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.

Overview

The Bill Journal displays changes in invoice status that relates to contracted services.

Entries in the Bill Journal could stem from events such as:

An invoice has been closed or backordered in accounts receivable (including invoice substatus if applicable)

A reminder, interest claim or debt claim has been sent

An invoice has been transfered to debt collection

An invoice claim has been received

An invoice claim has been registered as settled

A respite has been registered

A respite has been removed

A notification has been created

A failed direct debit has occurred

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

Below diagram shows the structure of BillJournal in current version

Name Convention

BILLJOURNAL_<CompanyNumber>_<DatumTime>_<SerialNumber>.xml

Name components	Description
CompanyNumber	The company number in our ledger system
DateTime	The date and time that the file was created. Uses ISO 8601 format, YYYYMMDDhhmmdd
SerialNumber	Should follow an uninterrupted number series, 1, 2, 3 and so on.

Example filename: BILLJOURNAL_9999_20080923124422_1.xml

Current XML schema description

A detailed description of the elements in the current version of the XML schema definition file (XSD) can be found here

Download XML schema file

Fileversion	Version	Releasedate	Comment
BillJournal[1.X].xsd	1.3	2022-04-26	Added support for new eCurrencyTypes USD and GBP
BillJournal[1.2].xsd	1.2	2020-03-10	Added PaymentOrderEvents
BillJournal[1.1].xsd	1.1	2019-10-08	Added InvoiceNotificationEvents Added optional InvoiceSubStatus
BillJournal_[1.0].xsd	1.0	2016	Deprecated

Change Log

Version 1.3

April, 2022

BillJournal[1.X].xsd

Added support for new eCurrencyTypes USD and GBP

Version 1.2

Mars, 2020

BillJournal[1.2].xsd

Added PaymentOrderEvents

Version 1.1

Oktober, 2019

BillJournal[1.1].xsd

Added information notifications before and after due date and before reminder date.

Added optional InvoiceSubStatus under InvoiceStatusEvent

Version 1.0

September, 2016

BillJournal_[1.0].xsd

Initial version (latest documented version)

Download sample file

BillJournal_367_20191030142104_439