File Format Document
Generic Invoice (.INV)
Transporter to System User
Copyright Xoserve 2014©, all rights reserved.
No part of this publication may be reproduced in any material form (including photocopying and restoring in any medium or electronic means and whether or not transiently or incidentally) without the written permission of Xoserve except in accordance with the provisions of the Copyright, Designs and Patents Act 1998.
Author: / XoserveOwner: / Xoserve
Version: / 1.6 A
Status: / Approved
Date: / 10-Sept-2015
Version Control
Version / COR / Issue Date / Implementation Date / Summary of Change0.1FA / 1154 / 20-Aug-2014 / 01-Oct-2015 / Preliminary file issued for representation
Description rationalisation
Record type H00
GENERATION_NUMBER mandatory
Record type I56
SHIPPER_SHORT_CODE renamed to ORGANISATION_SHORT_CODE
INVOICE_BILLING_PERIOD_YEAR renamed to BILLING_YEAR
INVOICE_BILLING_PERIOD_MONTH renamed to BILING_MONTH
ISH_BANK_SORT_CODE length 8
New field:
FILE_NAME
Record type I59
INVOICE_ITEM-NUMBER renamed to INVOICE_NUMBER length 12
INVOICE_ITEM_REFERENCE_NUMBER new field
INVOICE_ITEM_VAT_RATE length 10
1FA / 1154 / 30-Sep-2014 / 01-Oct-2015 / File issued for representation
1.1FA / 1154 / 07-Oct-2014 / 01-Oct-2015 / File issued for representation. Record Length corrected.
1.1A / 1154 / 08/01/2015 / 01-Oct-2015 / Approved
1.2FA / 1154 / 22-Dec-2014 / 01-Oct-2015 / Further changes identified. Represented with track change.
1.3FA / 1154 / 09-Jun-2015 / TBC /
- Implementation Date amended to TBC
- Issue date amended to 09/06/2015
- Removed extra space after DEFINITIONS in description of BILLING_MONTH under I56 record type
- Modified ‘value’ to ‘category’ in the description of INVOICE_ITEM_VAT_CATEGORY record name under I59 record type
1.4FA / 1154 / 03-Jul-2015 / TBC /
- Updated the I57 record name in record hierarchy table
- Amended the Issue Date to 03/07/2015
1.5FA / 1154 / 20-July-2015 / TBC /
- Updated the I57 level from 2 to 3 and reordered accordingly.
1.5A / 1154 / 27-July-2015 / Project Nexus Implementation Date / Approved
1.6FA / 1154 / 21-Aug-2015 / Project Nexus Implementation Date /
- In I57 record, the definition for Quantity field amended to show that the field can accept negative values as well.
- In I57 record, the definition for Rate field amended to show that the field can accept negative values as well
- In I57 record, the length and decimal for Quantity field amended
1.6A / 1154 / 10-Sept-2015 / Project Nexus Implementation Date / Approved
Generic_Invoice (.INV)Page 1 of 15Issue Date: 10/09/2015
Version 1.6 A Implementation Date: Project NexusImplementation Date
Contains 8 different Record TypesLevel / Record Name / Occurrence / Optionality
1 / HD_A00_STANDARD_HEADER / 1 / M
1 / RT_I56_INVOICE_DETAIL / 1 / M
2 / RT_I59_INVOICE_ITEM_DETAIL / Up to 99 / M
3 / RT_I57_ANCILLARY_INV_SUPP_INFO / Up to 1000 / O
2 / RT_I05_INVOICE_CLAUSE / Up to 20 / M
2 / RT_I58_INVOICE_REMITTANCE / 1 / OM
3 / RT_I60_INVOICE_REMIT_DETAIL / Up to 99 / OM
1 / TR_Z99_STANDARD_TRAILER / 1 / M
Note 1
OPT - Optional/Mandatory (O - Optional, M - Mandatory)
DOM - Domain (T - text, N - Numeric, D - Date (YYYYMMDD), M - Timestamp)
LNG - Number of characters
DEC - Number of decimal places
Note 2
All text fields will be enclosed in double quotes ("")
Generic_Invoice (.INV)Page 1 of 15Issue Date: 10/09/2015
Version 1.6 A Implementation Date: Project NexusImplementation Date
Record Type Definition
AI_O_GENERIC_INVOICE
HD_A00_STANDARD_HEADER
RECORD/FIELD_NAME*Occurs Max 1* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents.
VALUE:A00
ORGANISATION_ID / M / N / 10 / 0 / DEFINITION: A reference which uniquely identifies a User/Organisation.
FILE_TYPE / M / T / 3 / 0 / DEFINITION: An application specific code used to identify the structure and the usage of the file.
VALUE:INV
CREATION_DATE / M / D / 8 / 0 / DEFINITION: The date on which the file was generated.
FORMAT: YYYYMMDD
CREATION_TIME / M / M / 6 / 0 / DEFINITION: The time at which the file was generated (within the Creation Date).
FORMAT: HHMMSS
GENERATION_NUMBER / OM / N / 6 / 0 / A sequence number which represents an issue of
a file from the organization (indicated by the
organisation id), and, of the file type (indicated
by file type) e.g. The first Nominations file from
an Organisation will have the number 1, the
second, number 2 etc. Each file sent to an
Organisation within one file type must have
consecutive numbers.
DEFINITION: A unique sequence number which represents an issue of an INV invoice file to a System User.
Total / 36
AI_O_GENERIC_INVOICE
RT_I56_INVOICE_DETAIL
RECORD/FIELD_NAME*Occurs Max 1* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents
VALUE:I56
ISH_ORGANISATION_ID
ORGANISATION_SHORT_CODE / M / NT / 103 / 0 / A unique number identifying a
shipper.
DEFINITION: This field identifies the three character unique organisation short code.
INV_NUMBERINVOICE_NUMBER / M / N / 126 / 0 / DEFINITION: Holds the unique number by which an Invoice is known.
ITP_CODEINVOICE_TYPE_CODE / M / T / 3 / 0 / DEFINITION: A three character code used to identify the Invoice Type.
VALUE: Any applicable invoice type code, please refer theInvoice to the charge type mapping rule spreadsheet.
BILLING_YEAR / M / N / 4 / 0 / DEFINITION: This attribute holds the year to which the invoice relates. Combined with BILLING MONTH will give billing period which the invoice covers. FORMAT:YYYY
BILLING_MONTH / M / N / 2 / 0 / DEFINITION: This attribute holds the month to which the invoice relates. Combined with BILLING YEAR will give billing period which the invoice covers
The month of the billing period for which the Invoice relates e.g. 1 – 9 = January – September and 10 – 12 = October - December
FORMAT:MM
INV_AMOUNT_DUEINVOICE_AMOUNT / M / N / 1411 / 2 / Holds sum of debit amount due for
all debit invoice items on the
invoice. (VAT exclusive) Unit –
Pounds.DEFINITION: Holds sum of net value of credit and debit amount due for all invoice items on the invoice. (VAT exclusive) Negative values will have a prefix (-).
VALUE: Monetary values from -99999999999.99 to 99999999999.99
INV_VAT_AMOUNT_DUEINVOICE_VAT_AMOUNT / M / N / 1410 / 2 / Holds sum of all VAT amounts due
for all debit invoice items on the
invoice. Unit –PoundsDEFINITION: Holds sum of all VAT amounts due for all credit and debit invoice items on the invoice. Negative values will have a prefix (-).
VALUE:Monetary values from
-99999999999.99 to 99999999999.99
INV_GROSS_TOTALINVOICE_GROSS_TOTAL / M / N / 1412 / 2 / Holds sum of
INV_AMOUNT_DUE and
INV_VAT_AMOUNT_DUE for
all debit invoice items on the
invoice. (VAT inclusive) Unit –
Pounds DEFINITION: Holds sum of INVOICE_AMOUNT and INVOICE_VAT_AMOUNT for all invoice items on the invoice. (VAT inclusive). Negative values will have a prefix (-).
VALUE:Monetary values from
-99999999999.99 to 99999999999.99
CREDIT_AMOUNT_DUE / M / N / 11 / 2 / Holds the sum net amount of all the
credit invoice items. Unit – Pounds.
For clarity, non zero amounts will
be prefixed by a minus sign.
CREDIT_VAT_AMOUNT_DUE / M / N / 10 / 2 / Holds the sum of VAT for all credit
invoice items. Unit – Pounds. For
clarity, non zero amounts will be
prefixed by a minus sign.
CREDIT_GROSS_TOTAL / M / N / 12 / 2 / Holds the sum of
CREDIT_AMOUNT_ DUE and
CREDIT_VAT_AMOUNT_DUE
for all the credit invoice items. Unit
– Pounds. For clarity, non zero
amounts will be prefixed by a
minus sign.
PAYMENT_DUE_DATE / M / D / 8 / 0 / DEFINITION: Date by when payment is due. FORMAT:YYYYMMDD
VAT_CHARGED_TO_NWO / M / N / 1410 / 2 / Holds the sum of the Invoice Item VAT amounts charged to NWO. DEFINITION: Holds the sum of the Invoice Item VAT amounts charged to a Network Operator.
VALUE:Monetary values from
-99999999999.99 to 09999999999.99
VAT_CHARGED_TO_SHIPPER / M / N / 1410 / 2 / Holds the sum of the Invoice Item
VAT amounts charged to a ShipperDEFINITION: Holds the sum of the Invoice Item VAT amounts payable charged to a Shipper
VALUE: Monetary values from
0 to -99999999999.99 to 99999999999.99
INVINVOICE_TAX_POINT_DATE / M / D / 8 / 0 / DEFINITION: Holds the Invoice Tax Point date. FORMAT:YYYYMMDD
NODNWO_VAT_ REGISTRATION_NUMBER / M / T / 20 / 0 / DEFINITION: The VAT number used on the Invoice. This will be Network Operator’s VAT registration number.
NODNWO_BANK_SORT_CODE / M / T / 8 / 0 / DEFINITION: Holds details of Network Operator’s sort code
NODNWO_BANK_ACCOUNT_NUMBER / M / T / 9 / 0 / DEFINITION: This is the Bank account number for NWO
NODNWO_BANK_ACCOUNT_NAME / M / T / 30 / 0 / The Account Number via which
financial transactions are routedDEFINITION: This is NWO’s bank account name.
ISH_VAT_REGISTRATION_NUMBER / M / T / 20 / 0 / DEFINITION:
The VAT registration number for the party to whom the invoice is issued.
ISH_BANK_ACCOUNT_NUMBER / M / T / 98 / 0 / The Account Number via which
financial transactions are routedDEFINITION: The Account Number via which financial transactions are routed.
ISH_BANK_SORT_CODE / M / T / 86 / 0 / The sort code of the Bank holding
the customer's account. DEFINITION: The sort code of the Bank holding the customer's account.
NODNWO_SHORT_CODE / M / T / 3 / 0 / A code identifying the Distribution
Network Operator to whom this
invoice is payable. DEFINITION: A unique three character code used to identify a Network Operator.
NODNWO_VAT_REGISTRATION_NAME / M / T / 30 / 0 / DEFINITION: The VAT Registration Name for the Network OperatorNWO.
NODNWO_ADDRESS_LINE_1 / M / T / 4035 / 0 / DEFINITION: The address of the relevant party on whose behalf the invoice is being issued.
NODNWO_ADDRESS_LINE_2 / M / T / 4035 / 0 / DEFINITION: The address of the relevant party on whose behalf the invoice is being issued.
NODNWO_ADDRESS_LINE_3 / M / T / 4035 / 0 / DEFINITION: The address of the relevant party on whose behalf the invoice is being issued.
NODNWO_ADDRESS_LINE_4 / M / T / 4035 / 0 / DEFINITION: The address of the relevant party on whose behalf the invoice is being issued.
FILE_NAME / O / T / 18 / 0 / The name of the corresponding supporting information file. CONTEXT: This field is mandatory for Core Invoice files.
Total / 428427390
AI_O_ GENERIC_INVOICE
RT_I59_INVOICE_ITEM_DETAIL
RECORD/FIELD_NAME*Occurs Max 99* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents
VALUE:I59
INVINVOICE_NUMBER / M / N / 12 / 0 / DEFINITION: Holds the unique number by which an Invoice is known.
IIT_NUMBER
INVOICE_ITEM_REFERENCE_NUMBER / M / N / 316 / 0 / Identifies the line number of an
invoice item within a particular
invoice.
DEFINITION:A unique reference number used to identify the invoice item associated to the invoice
CTP_CODE
CHARGE_TYPE_CODE / M / T / 3 / 0 / Identifies the charge type
DEFINITION: A unique three character code used to identify the charge type/s.
VALUE:Any applicable charge type code.
IIT_AMOUNT_DUE
INVOICE_ITEM_AMOUNT / M / N / 14 / 2 / Holds the sum of the charges of a
particular charge type calculated
during the Billing Period. Nett of
VAT. PERMITTED VALUES :
Monetary values -999999999.99 to
999999999.99
DEFINITION: Invoice line item amount; Holds the sum of the charges of a particular charge type calculated during the Billing Period. Net of VAT Negative values will have a prefix (-).
VALUE: Monetary values from -99999999999.99 to 99999999999.99
VRT_RATE
INVOICE_ITEM_VAT_RATE / M / N / 610 / 4 / DEFINITION: Holds the VAT rate for a specific code.
INVOICE_ITEM_VAT_CATEGORY / M / T / 2 / 0 / DEFINITION: Holds the VAT valuecategory per charge type.
VALUE:VZ (VAT rate is zero)
VA (VAT Applicable)
VE (VAT Exempt)
IIT_VAT_AMOUNT_DUE
INVOICE_ITEM_VAT_AMOUNT / M / N / 1014 / 2 / Holds the sum of the VAT to be
applied to the invoice line amount
DEFINITION: The VAT value to be applied to the invoice line amount Negative values will have a prefix (-).
VALUE: Monetary values from -99999999999.99 to 99999999999.99
IITINVOICE_ITEM_TOTAL_AMOUNT / M / N / 142 / 2 / DEFINITION: The invoice item amount plus the VAT to be applied to that line amount. Negative values will have a prefix (-).
VALUE: Monetary values from
-99999999999.99 to 99999999999.99
INVOICE_ITEM_VAT_CODE / M / T / 3 / 0 / DEFINITION: A code identifying the type of VAT being used
Total / 618891
AI_O_ GENERIC_INVOICE
RT_I57_ANCILLARY _INV_SUPP_INFO
RECORD/FIELD NAMEOCCURS MAX 1000 * / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request this record represents.
VALUE: I57
INVOICE_ITEM_REFERENCE_NUMBER / M / N / 16 / 0 / DEFINITION:A unique reference number used to identify the invoice item associated to the invoice
INCURRED_DATE / O / D / 8 / 0 / DEFINITION: The date on which the Ancillary charge item is incurred by the Shipper.
CHARGE TYPE CODE / M / T / 3 / 0 / DEFINITION: A code to identify the type of charge.
QUANTITY / O / N / 31 / 15 / DEFINITION: The quantity in volumetric terms of the incurred Ancillary charge item. This value will be set to zero if UNIT_TYPE is not provided. Negative values will have a prefix (-)
UNIT_TYPE / O / T / 10 / 0 / DEFINITION: Identifies the unit which applies to the quantity. e.g. Hours, Therms
RATE / O / N / 10 / 4 / DEFINITION: The rate in pence per day which is used to calculate the charge. Negative values will have a prefix (-)
INVOICE_ITEM_AMOUNT / M / N / 14 / 2 / DEFINITION: The value in monetary terms of the
incurred charge item. Unit – pounds.
VALUE: Monetary values from -99999999999.99 to 99999999999.99
ANCILLARY_INVOICE_COMMENTS / O / T / 200 / 0 / DEFINITION: Any comments to help validate the resulting supporting information
____
277
Generic_Invoice (.INV)Page 1 of 15Issue Date: 10/09/2015
Version 1.6 A Implementation Date: Project NexusImplementation Date
AI_O_GENERIC_INVOICE
RT_I05_INVOICE_CLAUSE
RECORD/FIELD_NAME*Occurs Max 20* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents
VALUE:I05
ISC_LINE_1_TEXT / M / T / 200 / 0 / DEFINITION: The first 200 characters of the Textual statement which appears within an invoice.
ISC_LINE_2_TEXT / O / T / 200 / 0 / DEFINITION: 201st-400th characters of the Textual statement which appears within an invoice.
Total / 403
AI_O_ GENERIC_INVOICE
RT_I58_INVOICE_REMITTANCE
RECORD/FIELD_NAME*Occurs Max 1* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents
VALUE:I58
ISH_ORGANISATION_ID / M / N / 10 / 0 / A unique number identifying a
shipper.
DEFINITION: A reference, which uniquely identifies a User/ Organisation
INVINVOICE_NUMBER / M / N / 612 / 0 / DEFINITION: Holds the unique number by which an Invoice is known.
INVOICE_FORECAST_PAYMENT_DATE / O / TD / 8 / 0 / DEFINITION: Remittance Advice Forecast Date. This is the date that the Shipper intends to transfer the monetary value, detailed on the remittance advice, to the NWO bank account. It shows the shippers intention of the payment date for an invoice.
FORMAT:YYYYMMDD
INV_INVOICE_RECEIVED_AMOUNT / O / N / 1214 / 2 / DEFINITION: Remittance Advice Received Amount. This is the monetary value, inclusive of VAT, detailed on the remittance advice, which will settle an invoice. It shows the Shippers intention of the payment amount for an invoice. Negative values will have a prefix (-)
VALUE: Monetary values from -99999999999.99 to 99999999999.99
Total / 47
AI_O_ GENERIC_INVOICE
RT_I60_INVOICE_REMIT_DETAIL
RECORD/FIELD_NAME*Occurs Max 99* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents
VALUE:I60
IIT_INVOICE_ITEM_REFERENCE_NUMBER / M / N / 316 / 0 / Identifies the line number of an
invoice item within a particular
invoice.
DEFINTION DEFINITION:A unique reference number used to identify the invoice item associated to the invoice
CTP_CODE
CHARGE_TYPE_CODE / M / T / 3 / 0 / Identifies the charge type.
DEFINITION: A unique three character code used to identify the charge type/s.
VALUE: Any applicable charge type codes
IIT_INVOICE_ITEM_TOTAL_AMOUNT / M / N / 1214 / 2 / DEFINITION: Holds the sum of the invoice line amount plus the VAT to be applied to that line amount. Negative values will have a prefix (-).
VALUE: Monetary values from -99999999999.99 to 99999999999.99
IIT_INVOICE_ITEM_AMOUNT_PAID / O / N / 1214 / 2 / The total amount paid against this
item to date.
DEFINITION: The total amount paid against this item to date. Negative values will have a prefix (-).
VALUE: Monetary values from -99999999999.99 to 99999999999.99
GENERIC_INVOICE_COMMENTS REASON_DESCRIPTION / O / T / 200 / 0 / DEFINITION: This contains reason for part payment or non-payment of this invoice item. To include details of invoice number, invoice item number and charge item number which is being queried
Total / 237250
AI_O_ GENERIC_INVOICE
TR_Z99_STANDARD_TRAILER
RECORD/FIELD_NAME*Occurs Max 1* / OPT / DOM / LNG / DEC / DESCRIPTION
TRANSACTION_TYPE / M / T / 3 / 0 / DEFINITION: A code identifying the type of request that this record represents.
VALUE:Z99
RECORD_COUNT / M / N / 10 / 0 / DEFINITION: The number of detail records contained within the file. This should not include the Standard Header (A00) and Standard Trailer (Z99) but should include any file specific Headers and Trailers specified for this file type.
Total / 13
Total Length: 1224 1545
Generic_Invoice (.INV)Page 1 of 15Issue Date: 10/09/2015
Version 1.6 A Implementation Date: Project NexusImplementation Date