Centrepay Bulk Upload Service (XML) User Guide

advertisement
USER GUIDE
CENTREPAY BULK UPLOAD
SERVICE
XML File Format
Version date: 18 March 2015
Page 1 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Table of Contents
Introduction ..................................................................................................................................... 3
Introduction to the Centrepay Bulk Upload Service............................................................................ 3
Centrelink Deduction reports .......................................................................................................... 3
Getting started ................................................................................................................................. 4
Accessing Centrelink Business Online Services .................................................................................. 5
Option to link your digital credential ................................................................................................ 5
Using Centrelink Business Online Services ........................................................................................... 6
Entry Page .................................................................................................................................... 6
Business Online Services Announcements ........................................................................................ 6
How to access the Centrepay Bulk Upload Service ............................................................................. 7
Inbox – Centrepay Bulk Upload Service ........................................................................................ 8
Compose New Message to Centrelink (and attach file) ................................................................... 9
Sent messages......................................................................................................................... 10
System Diagram of File Submission under Centrepay Bulk Upload Service ........................................... 11
Validation of files and deduction instruction data .............................................................................. 12
Level 1 – File validation ................................................................................................................ 12
Level 2 – Data validation............................................................................................................... 12
CSV file validation .................................................................................................................... 13
XML file validation ................................................................................................................... 13
Level 3 – Input validation.............................................................................................................. 13
Request File – XML format ............................................................................................................ 15
Centrepay Bulk Upload Service – EXAMPLE XML REQUEST FILE ......................................................... 20
Rejection File – XML format .......................................................................................................... 24
Response File – XML format .......................................................................................................... 25
Centrepay Bulk Upload Service - EXAMPLE XML RESPONSE FILE ........................................................ 32
Access levels ............................................................................................................................... 34
Centrelink Payment Types and Benefit Groups ................................................................................ 35
Guide to changing existing deductions ........................................................................................... 36
Error Messages – Centrepay Bulk Upload Service (CBUS).................................................................. 37
Need help? ..................................................................................................................................... 42
Centrepay Helpdesk ..................................................................................................................... 42
Page 2 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Introduction
The Department of Human Services is responsible for the development of service delivery policy
and provides access to social, health and other payments and services through Medicare,
Centrelink and Child Support. Centrelink Business Online Services can be located on the Business
page on the Department of Human Services website at humanservices.gov.au/business
INTRODUCTION TO THE CENTREPAY BULK UPLOAD SERVICE
The Centrepay Bulk Upload Service (CBUS) is an online service that allows approved Centrepay
business providers to submit a file of requests to update customer records. Depending on your
organisation’s access, this function allows you to start, vary (increase or decrease), and stop
customer Centrepay deductions.
The range of functions available to each organisation using the Centrepay Bulk Upload Service
depends upon the type of services you deliver to customers, and the level of access granted by the
department.
The file must be submitted through the Organisation Online Mail (OOM) system where deduction
reports for the majority of Centrepay organisations are currently received. The file will be
validated to make sure it meets specification and then the department will apply the individual
deduction instructions to customer records.
A response file detailing the outcomes of deduction instruction processing will be sent to your
organisation at end of day after processing has completed.
Note: you must get customer consent (for example, Centrepay SA325 deduction form or any other
consent method approved by the department) before establishing a new Centrepay deduction,
increasing an existing Centrepay deduction or increasing the target amount for an existing
Centrepay deduction arrangement, as per the conditions of your Contract. You should not send
the completed SA325 form to the department if you process the deduction through the Centrepay
Bulk Upload Service. The completed consent authority form must be securely stored by your
business for five years after the deduction arrangement has stopped.
CENTRELINK DEDUCTION REPORTS
If you have selected to receive the PYI510 – Deduction Instruction Update Notification, any
deductions processed through CBUS will be identified in your Centrelink Deduction report with the
following codes:
 ENI – External New Instruction
 EVI – External Varied Instruction, and
 ETI – External Terminated Instruction.
It is important that you make sure your system has the ability to accept these codes.
Note: Existing codes (INI, IVI, ITI, ITB) will still be used for transactions not undertaken by the bulk
upload and single input facilities.
Page 3 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Getting started
You need to be registered to use Centrelink Business Online Services, which is located on the
Business page on the Human Services website at humanservices.gov.au/business
Once registered, you will receive a user ID and password to be used exclusively by you, enabling
you to logon and access the service.
Note: when requesting a new user ID or cancelling or updating existing user ID’s visit
humanservices.gov.au/businessforms for a ‘Business Online Services – User Detail’ form (SA445).
Page 4 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
ACCESSING CENTRELINK BUSINESS ONLINE SERVICES
To start using Centrelink Business Online Services, navigate to the Business section of the website
and click on the Logon button.
Enter your user ID and click on Continue, you will then be required to enter your password and
click Continue.
OPTION TO LINK YOUR DIGITAL CREDENTIAL
An online security pass called AUSkey has been introduced by the Australian Government to
standardise and streamline access to business online services. If you have an AUSkey you will be
able to register faster, access more functions and access Centrelink Business Online Services
without having to maintain a separate password.
To find out more about AUSkey or to register online, visit the AUSkey website auskey.abr.gov.au
If you already have an AUSkey, click on the green Link your AUSkey or ATO Digital Certificate
button to link your credential.
Page 5 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Using Centrelink Business Online Services
ENTRY PAGE
The entry page is the first page you see after you logon to Centrelink Business Online Services.
The page contains links to a range of services that you have been given access to.
BUSINESS ONLINE SERVICES ANNOUNCEMENTS
The entry page will display important news and alerts regarding system interruptions (for
example, scheduled maintenance).
These announcements will advise:
 information about new services
 advance notice of any changes to your services, and
 any problems that we know about with your services.
A restricted number of announcements will display on the ‘Centrelink Business Online Services’
entry page. Select View all news to display all available announcements. Click on more to read the
relevant news.
Page 6 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
HOW TO ACCESS THE CENTREPAY BULK UPLOAD SERVICE
To access this online service, click Centrepay Bulk Upload Service under the Organisational Online
Mail System. Also shown in the link title is the number of unread emails (with attached files) you
have from the department, in the folder relating to the Centrepay Bulk Upload Service.
Page 7 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Inbox – Centrepay Bulk Upload Service
About this page
This page allows you to view messages and files sent to you by the department. Make sure you
are working within the Centrepay Bulk Upload Service folder from the menu on the left.
Click on the Inbox tab to search for ‘Response and Rejection’ file messages relating to your
organisation’s usage of the Centrepay Bulk Upload Service. You can enter date parameters to
refine your search.
Note: ‘Response and Rejection’ file messages will be culled after 180 days, therefore the
department recommends saving all files in a local file directory before they are culled. We
recommend you do not delete them.
When a file is deleted from the inbox it will be available from the deleted tab for a further 45 days.
To submit a file to the Centrepay Bulk Upload Service, you need to compose a new message within
your Organisational Online Mailbox and attach a file to that message. Make sure you are working
within the Centrepay Bulk Upload Service folder from the menu on the left.
Page 8 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Compose New Message to Centrelink (and attach file)
About this page
This page allows you to create a new message and attach a file to be sent to the department.
Make sure you are working within the Centrepay Bulk Upload Service folder from the menu on
the left.
Click Compose New to start the file attachment process.
Click Browse to search your local system drives and servers for the file you wish to attach and
submit to the department for processing.
To minimise data loads, we only accept electronic data files that have been zipped. Your file must
be zipped before you attach the zip file. Other rules detailing the requirements for files submitted
to the department are contained further on in this document.
Click Submit File to send the attached zip file to the department for processing. You will then
receive a message with a reference ID advising that your document submitted successfully. Please
take note of the reference ID as this can be useful if you need to contact the helpdesk for
assistance after submitting the file.
If there are any deduction instructions within the submitted file that fail our validation process,
you will receive a notification message shortly after you submit the file. A ‘Rejection’ file will be
sent to your online mailbox identifying the deduction instructions that failed the validation
process.
Page 9 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Sent messages
About this page
This page shows a recent history of the messages and files you have sent to the department using
this secure mail system.
You can search for historical messages by using the search functions on the page.
Page 10 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
System Diagram of File Submission under Centrepay Bulk Upload Service
Page 11 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Validation of files and deduction instruction data
The Centrepay Bulk Upload Service will enable you to submit a zip file containing deduction
instruction data in one of the following formats:


Comma Separated Value (CSV), and
Extensible Markup Language (XML).
All submitted files will be subject to three levels of validation:
 Level 1 — File validation
 Level 2 — Data validation (each individual line), and
 Level 3 — Input validation (when deduction instructions are applied to customer records).
When records are successfully validated at levels 1 and 2, they are passed to the department’s
payment system and the customer deduction updates will be processed. These updates may fail
when being applied to the customer record for a number of reasons.
LEVEL 1 – FILE VALIDATION
All files must be zipped into a file with a .zip extension. Each zipped file that is submitted will be
validated to make sure it meets specification.
 If accepted — file will go to level 2 validation
 If rejected — make sure the file meets the below zip requirements and try again, and
No customer deduction updates will be applied or reported.
The zip file you upload to the department must meet the following specifications:







Zip file must only contain one file in XML format
Zip file must comply with Zip 2.0 standard (see pkware.com)
Zip files must not contain any subfolders
Zip files must not be password protected or encrypted
Zip files must be no larger than 20 MB
Receipt numbers in file names may be up to 15 characters long, and
File name conventions for the zip file are as follows:
– can be mixed case
– can be alpha or numeric or a combination of both
– maximum of 20 characters
You will receive an error message on screen immediately if your submitted file fails validation.
LEVEL 2 – DATA VALIDATION
Each deduction instruction within the file is validated for correct format:
 If accepted — each deduction instruction that passes level 2 validation will go to level 3
validation.
 If rejected — details of each deduction instruction that failed level 2 validation will be identified
in a Rejection file sent to you, accompanied by a Comment Record which explains the reason
for rejection of that instruction. This enables you to read the comment, then correct the data
and resubmit it.
Page 12 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
CSV file validation
Data validation rules relating to Centrepay deduction instructions provided in CSV format are
contained in a separate User Guide.
XML file validation
The zipped XML file you upload to the department (and data within it) must meet the following
specifications:

XML files submitted are to meet the XML Schema relating to this system

File name conventions for the XML file are as follows:
– can be mixed case
– can be alpha or numeric or a combination of both
– maximum of 20 characters

The file should contain a well formed xml document containing a top level XML declaration
string (supporting encoding UTF-8)


The XML document should contain a single root-level node named "File"
The <cbus.req:File> tag marks the start of the file and </cbus.req:File> tag marks the end of
the file. Between the <cbus.req:File> and </cbus.req:File> tags there may be one or many
Deduction Instruction Request blocks
Contain a context "header" block
Where an XML tag (or node) is defined as optional that tag in general should be omitted
from the XML document rather than including an empty node, and
The XML file should not contain any binary or other special non printing character values.
XML fields (or node values) should not include tab, line feed or carriage return control
characters within. These characters can exist within the XML document itself for
readability or ease of generation purposes (providing the document remains valid XML).



Special XML characters
Certain characters parsed as simple text will cause the XML to fail validation. There are 4
characters that must be encoded using either CDATA tags, or entity replacement characters if they
exist in the data item. The following table gives the entity replacement characters in question.
Character
&
<
>
‘
Entity Replacement Characters
&
<
>
'
XML data validation rules relating to Centrepay deduction instructions are contained further into
this document.
LEVEL 3 – INPUT VALIDATION
Each deduction instruction will be passed to the individual customer records in our payment
system for update of Centrepay deduction details. If the deduction instruction is:
 Applied — the instruction is reported as successful
 Not applied — the instruction is rejected and will be returned to the organisation within the
‘Response’ file with error messages.
Page 13 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Once a CBUS file submission has been fully processed, you will receive a ‘Response’ report
outlining the results of deduction instruction processing. Each instruction in the ‘Response’ report
will identify whether the update has been successful or not. See example below (this is only a
small section of the report).
Response
Unsuccessful
Successful
Successful
Unsuccessful
Unsuccessful
Unsuccessful
Successful
Successful
Unsuccessful
Successful
Code
E480PI
Description
Request is ADD but current instruction exists.
E709PI
E709PI
E709PI
Customer not matched
Customer not matched
Customer not matched
E721PI
There is no current deduction for this type
Note: If multiple files are sent to us in the one day the system will collate all the instructions
processed on that day into one response file. Response files are usually available after 8 pm AEST
each night.
Page 14 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
REQUEST FILE – XML FORMAT
Overview
The XML file you submit to DHS must conform to XML 1.0 standards and include the standard XML file declarations.
The XML tags <cbus.req:File> and </cbus.req:File> will be used to indicate the start and end of the file being provided by your organisation.
Within this, the file structure can be broken into two main XML components:

Header block – contains summary information relevant to the file. The header node structure is a common structure that is used to make sure
the correct routing and processing of the file.

Deduction Instruction request block – contains the deduction instruction data, including data that assists to identify the correct customer
record.
<cbus.req:File>
<Header>
... header block details
</Header>
<Deduction.Instruction.Request>
... Deduction.Instruction Request details
</Deduction.Instruction.Request>
<Deduction.Instruction.Request>
... Deduction.Instruction Request details
</Deduction.Instruction.Request>
</cbus.req:File>
Note: The header block and the deduction request blocks must appear in the order shown above. One header block permitted per file.
Page 15 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
The cardinality of the “header” is “one to one” [1..1]. The cardinality of the “Deduction.Instruction.Request” is “one to many” [1..*].
Standard XML Declarations
The first line of the incoming XML file must contain the standard XML declarations, namely:

xml version: currently the only valid value for this attribute is “1.0”

encoding: this attribute is optional and if omitted, defaults to “UTF-8”
<?xml version=”1.0” encoding=”UTF-8”?>
The File Block
The file block is identified within the XML by the <cbus.req:File> </cbus.req:File> tags and is used to identify the start and end of the data being
provided to Department of Human Services.
<cbus.req:File>
…Header block
…1:many Deduction.Instruction.Request blocks
</cbus.req:File>
The Header Block
This header block contains summary information relevant to the file being provided to Department of Human Services.
Only one header block permitted per file.
<Header>
<BatchFile.Identifier>YOURID123456</BatchFile.Identifier>
</Header>
Page 16 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Element Definitions
Tag Name
Condition
Validation Level
Description
Data Type
Valid Values
Cardinality
<Header>
BatchFile.Identifier
Mandatory
Mandatory
Primary
Secondary
Contains summary level info
Your reference number for this file
submission, generated by you.
XML tag only
xs:integer
Max 20 chars
1.. m
1.. 1
The Deduction Instruction Request Block
The incoming request file will contain one or more Deduction.Instruction.Request blocks. Each request block contains Department of Human Services
customer details for each request for information.
The example below is requesting to add a new $25 fortnightly deduction for Electricity, ending once $1000 has been paid:
<Deduction.Instruction.Request>
<Type.Code>CBS</Type.Code>
<Customer.Query>
<CustomerReference.Identifier>123456789K</CustomerReference.Identifier>
<PersonNameDetails>
<UsageType.Code>LGL</UsageType.Code>
<FamilyName.Text>CITIZEN</FamilyName.Text>
<GivenName.Text>JOHN</GivenName.Text>
<OtherGivenName.Text></ OtherGivenName.Text>
</PersonNameDetails>
<PersonDemographicDetails>
<Birth.Date>1988-12-25</ Birth.Date>
</PersonDemographicDetails>
<DeductionActionType.Code>ADD</DeductionActionType.Code>
Page 17 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
<ServiceReasonType.Code>ELE</ServiceReasonType.Code>
<AccountReference.Identifier>YOURID12345</ AccountReference.Identifier>
<BillingNumber.Identifier></BillingNumber.Identifier>
<BenefitGroupType.Code>PEN</ BenefitGroupType.Code>
<Start.Date>2014-01-13</ Start.Date>
<End.Date></End.Date>
<Deduction.Amount>25.00</Deduction.Amount>
<Target.Amount>1000.00</Target.Amount>
</Customer.Query>
</Deduction.Instruction.Request>
Element Definitions
Tag Name
Condition
Validation Level
Description
Data Type
<Deduction.Instruction.Request>
Mandatory
Primary
XML tag only
<Type.Code>
Mandatory
Primary
Delineates the Deduction Instruction
Request data structure.
Indicates the type of request file.
<Customer.Query>
<CustomerReference.Identifier>
Mandatory
Mandatory
Primary
Primary
<PersonNameDetails>
Mandatory
Primary
<UsageType.Code>
<FamilyName.Text>
Mandatory
Mandatory
Primary
Primary
<GivenName.Text>
Optional
Delineates the Customer Query data.
The DHS Customer Reference Number of the
queried customer. 9 consecutive numeric
characters followed by an alpha character.
Delineates the Person Name Details data
structure.
Name usage type.
The person’s last name or surname. The
name by which a family group is identified.
The person’s first given name by which the
person is uniquely socially identified. For
customers known by a single name, e.g.,
‘Madonna’, the name should be populated in
the <FamilyName.Text> element.
Valid Values
1.. m
xs: string
max 8 chars
XML tag only
xs :String 10 Chars
CBS
XML tag only
Refer to CSV validation
rules.
LGL
Refer to CSV validation
rules.
Refer to CSV validation
rules.
xs: string max 3 chars
xs : string max 30 chars
xs : string max 30 chars
Cardinality
1.. 1
1.. 1
1.. 1
1.. 1
1…1
1…1
0.. 1
Page 18 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Tag Name
Condition
Validation Level
Description
Data Type
Valid Values
Cardinality
<OtherGivenName.Text>
Optional
Primary
xs : string max 30 chars
Refer to CSV validation
rules.
0.. 1
<PersonDemographicDetails>
Mandatory
Primary
<Birth.Date>
<DeductionActionType.Code>
Mandatory
Mandatory
Primary
Primary
The middle given name which complements
that person’s identifying name. For
customers known by a single name, e.g.,
‘Madonna’, the name should be populated in
the <FamilyName.Text> element.
Delineates the Person Demographic Details
data structure.
Date of birth for customer.
A code defining the action being undertaken.
<ServiceReasonType.Code>
Mandatory
Primary
<AccountReference.Identifier>
Optional
Primary
<BillingNumber.Identifier>
Optional
Primary
<BenefitGroupType.Code>
Optional
Primary
<Start.Date>
Optional
<End.Date>
<Deduction.Amount>
XML tag only
1.. 1
xs :date
xs: string
Max 3 chars
xs: string
Max 3 chars
xs: string
Max 20 chars
CCYY-MM-DD
Refer to CSV validation
rules.
Refer to CSV validation
rules.
Refer to CSV validation
rules.
1…1
1.. 1
xs: string
10 numeric
xs: string
Max 3 chars
Refer to CSV validation
rules.
Refer to CSV validation
rules.
0…1
Start date of the new or varied deduction
instruction.
xs: date
0…1
Optional
The date the last deduction is to be delivered
to your organisation.
xs: date
CCYY-MM-DD
Refer to CSV validation
rules.
CCYY-MM-DD
Refer to CSV validation
rules.
Optional
The deduction amount of the payment
instruction.
xs: decimal
6 numerics
nnn.nn
0…1
The service reason associated with the new,
changed or cancelled deduction instruction.
The reference ID that your organisation uses
to uniquely identify an individual customer
or account.
The billing number for a specific Telstra
customer.
The Payment System that has facilitated the
deduction and relates to the major payment
categories delivered by the Dept of Human
Services.
1.. 1
0.. 1
0.. 1
0…1
<Deduction.Amount> is
mandatory if
<DeductionActionType
Code> = ADD
Else Optional
<Deduction.Amount>
cannot be greater than
$999.99
Page 19 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Tag Name
Condition
<Target.Amount>
Optional
Validation Level
Description
Data Type
Valid Values
Cardinality
The instruction for the total amount of
deductions to be deducted before
terminating the instruction.
xs: decimal
7 numerics
nnnn.nn
0…1
<Target.Amount> cannot
be less than
<Deduction.Amount>
<Target.Amount> cannot be
greater than $999999.99
Only one of
<Target.Amount> or
<End.Date> is required.
CENTREPAY BULK UPLOAD SERVICE – EXAMPLE XML REQUEST FILE
The sample XML below contains deduction instructions notifying DHS to:
1. Add a new deduction for Electricity, $25/fortnight until the Target Amount of $2500 is reached.
2. Cancel an existing deduction for Gas.
3. Change an existing deduction for Gas, to collect $25/fortnight until Target Amount of $2500 is reached.
<?xml version=”1.0” encoding=”utf-8”?>
<cbus.req:File>
<Header>
<BatchFile.Identifier>EDXCBS14</BatchFile.Identifier>
</Header>
<Deduction.Instruction.Request>
<Type.Code>CBS</Type.Code>
<Customer.Query>
Page 20 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
<CustomerReference.Identifier>123456987K</CustomerReference.Identifier>
<PersonNameDetails>
<UsageType.Code>LGL</UsageType.Code>
<FamilyName.Text>Smith</FamilyName.Text>
<GivenName.Text>Freda</GivenName.Text>
<OtherGivenName.Text>Anne</ OtherGivenName.Text>
</PersonNameDetails>
<PersonDemographicDetails>
<Birth.Date>1988-10-22</ Birth.Date>
</PersonDemographicDetails>
<DeductionActionType.Code>ADD</DeductionActionType.Code>
<ServiceReasonType.Code>ELE</ServiceReasonType.Code>
<AccountReference.Identifier>GUUGf1234</ AccountReference.Identifier>
<BillingNumber.Identifier>9876543210</BillingNumber.Identifier>
<BenefitGroupType.Code>PEN</BenefitGroupType.Code>
<Start.Date>2016-09-13</Start.Date>
<Deduction.Amount>25.00</Deduction.Amount>
<Target.Amount>2500.00</Target.Amount>
</Customer.Query>
</Deduction.Instruction.Request>
<Deduction.Instruction.Request>
<Type.Code>CBS</Type.Code>
Page 21 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
<Customer.Query>
<CustomerReference.Identifier>123456789A</CustomerReference.Identifier>
<PersonNameDetails>
<UsageType.Code>LGL</UsageType.Code>
<FamilyName.Text>Brown</FamilyName.Text>
<GivenName.Text>Susie</GivenName.Text>
</PersonNameDetails>
<PersonDemographicDetails>
<Birth.Date>1946-10-22</ Birth.Date>
</PersonDemographicDetails>
<DeductionActionType.Code>CAN</DeductionActionType.Code>
<ServiceReasonType.Code>GAS</ServiceReasonType.Code>
<AccountReference.Identifier>ABDF12345</ AccountReference.Identifier>
<BenefitGroupType.Code>PEN</BenefitGroupType.Code>
<End.Date>2016-09-28</End.Date>
</Customer.Query>
</Deduction.Instruction.Request>
<Deduction.Instruction.Request>
<Type.Code>CBS</Type.Code>
<Customer.Query>
<CustomerReference.Identifier>123456789C</CustomerReference.Identifier>
<PersonNameDetails>
Page 22 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
<UsageType.Code>LGL</UsageType.Code>
<FamilyName.Text>Hughes</FamilyName.Text>
<GivenName.Text>Howard</GivenName.Text>
<OtherGivenName.Text>Barry</ OtherGivenName.Text>
</PersonNameDetails>
<PersonDemographicDetails>
<Birth.Date>1950-10-22</ Birth.Date>
</PersonDemographicDetails>
<DeductionActionType.Code>CHG</DeductionActionType.Code>
<ServiceReasonType.Code>GAS</ServiceReasonType.Code>
<AccountReference.Identifier>12DF12345</ AccountReference.Identifier>
<BenefitGroupType.Code>PEN</BenefitGroupType.Code>
<Start.Date>2016-09-13</Start.Date>
<Deduction.Amount>55.00</Deduction.Amount>
<Target.Amount>2500.00</Target.Amount>
</Customer.Query>
</Deduction.Instruction.Request>
</cbus.req:File>
Page 23 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
REJECTION FILE – XML FORMAT
If an XML deduction instruction you submit fails validation, you will be sent a ‘Rejection’ file identifying the reason why the instruction failed
validation.
The deduction instruction request you submitted to us will be sent back, with a ‘Message Event’ block within it that identifies the reason for the
failure.
Rejected records should be corrected, and resubmitted to DHS for processing.
The Message Event Block
Contained within the response Deduction.Instruction.Request block. This block contains data that will assist you to identify the reason why the
deduction instruction failed to be applied to the customer record within our payment system.
<MessageEvent>
<Type.Code>Validation</Type.Code>
<Description.Text>User generated exception, [ Only one of Target Amount or End Date is required ], [ 250.00 ]</Description.Text>
</MessageEvent>
Element Definitions
Tag Name
Condition
Validation Level
Description
Data Type
Valid Values
Cardinality
<MessageEvent>
<Type.Code>
<Description.Text>
Mandatory
Mandatory
Mandatory
Primary
Primary
Primary
Delineates the error message data structure.
The type of validation error.
Explanation of the validation error.
XML tag only
xs: string
xs: string
Validation
1.. 1
1.. 1
1.. 1
Page 24 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
RESPONSE FILE – XML FORMAT
Overview
The XML Response file we send you will conform to XML standards and include the standard XML file declarations.
The XML tags <cbus.resp:File> and </cbus.resp:File> will be used to indicate the start and end of the file being provided to your organisation. URLs for
data definitions are included.
Within this, <Deduction.Instruction.Response> and </Deduction.Instruction.Response> will be used to indicate the start and end of the response data.
Within this, the file structure is broken into three main XML components:

Header block – contains summary information relevant to the file.

Type Code block – the type of response file. Always CBS.

Customer Query block – contains the deduction instruction data, including the outcome of the deduction instruction update on the customer
record.
<cbus.resp:File xsi:schemaLocation="http://xml.gov.au/dhs/reports/common/DeductionInstruction.Response.01.01
DeductionInstruction.Response.01.01.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:cbus.resp="http://xml.gov.au/dhs/reports/common/DeductionInstruction.Response.01.01">
<Deduction.Instruction.Response>
<Header>
... header block details
</Header>
<Type.Code>CBS</Type.Code>
<Customer.Query>
... deduction instruction details, and outcome of application to customer record in DHS payment system
Page 25 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
</Customer.Query>
</Deduction.Instruction.Response>
</cbus.resp:File>
Standard XML Declarations
The first line of the outgoing XML file sent to you will contain the standard XML declaratives, namely:

xml version: currently the only valid value for this attribute is “1.0”

encoding: this attribute is optional and if omitted, defaults to “UTF-8”
<?xml version=”1.0” encoding=”UTF-8”?>
The File Block
The file block is identified within the XML by the <cbus.req:File> </cbus.req:File> tags and is used to identify the start and end of the data provided.
<cbus.resp:File xsi:schemaLocation="http://xml.gov.au/dhs/reports/common/DeductionInstruction.Response.01.01
DeductionInstruction.Response.01.01.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:cbus.resp="http://xml.gov.au/dhs/reports/common/DeductionInstruction.Response.01.01">
…1:1 Deduction.Instruction.Response block
</cbus.resp:File>
The Deduction Instruction Response Block
This block contains summary information relevant to the file being provided to your organisation. Only one header block permitted per file.
<Deduction.Instruction.Response>
<Header>
... header block details
Page 26 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
</Header>
<Type.Code>CBS</Type.Code>
<Customer.Query>
... deduction instruction details, and outcome of application to customer record in DHS payment system
</Customer.Query>
</Deduction.Instruction.Response>
Element Definitions
Tag Name
Condition
Validation Level
Description
Data Type
Valid Values
Cardinality
<Header>
<Type.Code>
<Customer.Query>
Mandatory
Mandatory
Mandatory
Primary
Primary
Primary
Contains summary level info
The type of response file.
Delineates customer deduction instruction
response file data.
XML tag only
xs: string
XML tag only
CBUS
1.. 1
1.. 1
1.. m
The Header Block
This header block contains summary information relevant to deduction instruction response file being sent to your organisation.
Only one header block permitted per Deduction.Instruction.Response.
<Header>
<BatchFile.Identifier>YOURID123456</BatchFile.Identifier>
<Receipt.Number>807050604</Receipt.Number>
<Request.Count>25</Request.Count>
<Request.Number>1</Request.Number>
</Header>
Page 27 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Element Definitions
Tag Name
Condition
<BatchFile.Identifier>
Optional
<Receipt.Number>
Mandatory
<Request.Count>
Mandatory
<Request.Number>
Mandatory
Validation Level
Description
Data Type
An agency generated unique identifier for
the batch file as per the request file.
The receipt number issued on submission of
the associated request file.
The total number of instructions in the
corresponding request file which have been
processed.
The request number of the iteration in the
corresponding request file.
xs:string
max 8 chars
xs:string
max 20
xs:string
max 6
Valid Values
Cardinality
0.. 1
xs:string
max 6
1.. 1
1.. 1
1.. 1
The Customer Query Block
The ‘Response file’ will contain one or more Customer.Query blocks. Each block contains the deduction instruction request data that was provided to
the Department of Human Services in the ‘Request’ file sent previously, as well as the results of the application of that data to the customer record
within our payment system:
<Customer.Query>
<CustomerReference.Identifier>123456789K</CustomerReference.Identifier>
<PersonNameDetails>
<UsageType.Code>LGL</UsageType.Code>
<FamilyName.Text>CITIZEN</FamilyName.Text>
<GivenName.Text>JOHN</GivenName.Text>
<OtherGivenName.Text></ OtherGivenName.Text>
</PersonNameDetails>
<PersonDemographicDetails>
<Birth.Date>1988-12-25</ Birth.Date>
Page 28 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
</PersonDemographicDetails>
<DeductionActionType.Code>ADD</DeductionActionType.Code>
<ServiceReasonType.Code>ELE</ServiceReasonType.Code>
<AccountReference.Identifier>YOURID12345</ AccountReference.Identifier>
<BillingNumber.Identifier></BillingNumber.Identifier>
<BenefitGroupType.Code>PEN</ BenefitGroupType.Code>
<Start.Date>2014-01-13</ Start.Date>
<End.Date></End.Date>
<Deduction.Amount>25.00</Deduction.Amount>
<Target.Amount>1000.00</Target.Amount>
<MessageEvent>
<Type.Code>Unsuccessful</Type.Code>
<EventType_Code>E814PI</EventType_Code>
<Description.Text>Unable to complete updates</Description.Text>
</MessageEvent>
</Customer.Query>
Element Definitions
Tag Name
Condition
Validation Level
Description
Data Type
<Customer.Query>
<CustomerReference.Identifier>
Mandatory
Mandatory
Primary
Primary
XML tag only
xs :String 10 Chars
<PersonNameDetails>
Mandatory
Primary
Delineates the Customer Query data.
The DHS Customer Reference Number of the queried
customer. 9 consecutive numeric characters followed
by an alpha character.
Delineates the Person Name Details data structure.
XML tag only
Valid Values
Cardinality
1.. 1
1.. 1
Refer to CSV validation
rules.
1.. 1
Page 29 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Tag Name
Condition
Validation Level
Description
Data Type
Valid Values
Cardinality
<UsageType.Code>
Mandatory
Primary
Name usage type (eg Legal, Maiden, Previous etc. ).
Mandatory
Primary
<GivenName.Text>
Optional
The person’s last name or surname. The name by
which a family group is identified.
The person’s first given name by which the person is
uniquely socially identified. For customers known by a
single name, e.g., ‘Madonna’, the name should be
populated in the <FamilyName.Text> element.
Refer to CSV validation
rules.
Refer to CSV validation
rules.
Refer to CSV validation
rules.
1…1
<FamilyName.Text>
xs: string max 3
chars
xs : string max 30
chars
xs : string max 30
chars
<OtherGivenName.Text>
Optional
Primary
xs : string max 30
chars
Refer to CSV validation
rules.
0.. 1
<PersonDemographicDetails>
Mandatory
Primary
<Birth.Date>
<DeductionActionType.Code>
Mandatory
Mandatory
Primary
Primary
<ServiceReasonType.Code>
Mandatory
Primary
<AccountReference.Identifier>
Optional
Primary
<BillingNumber.Identifier>
Optional
Primary
<BenefitGroupType.Code>
Optional
Primary
<Start.Date>
Optional
<End.Date>
<Deduction.Amount>
The middle given name which complements that
person’s identifying name. For customers known by a
single name, e.g., ‘Madonna’, the name should be
populated in the <FamilyName.Text> element.
Delineates the Person Demographic Details data
structure.
Date of birth for customer.
A code defining the action being undertaken.
XML tag only
1…1
0.. 1
1.. 1
xs :date
xs: string
Max 3 chars
xs: string
Max 3 chars
xs: string
Max 20 chars
xs: string
10 numeric
xs: string
Max 3 chars
CCYY-MM-DD
Refer to CSV validation
rules.
Refer to CSV validation
rules.
Refer to CSV validation
rules.
Refer to CSV validation
rules.
Refer to CSV validation
rules.
1…1
1.. 1
Start date of the new or varied deduction instruction.
xs: date
0…1
Optional
The date the last deduction is to be delivered to your
organisation.
xs: date
CCYY-MM-DD
Refer to CSV validation
rules.
CCYY-MM-DD
Refer to CSV validation
rules.
Optional
The deduction amount of the payment instruction.
xs: decimal
6 numerics
nnn.nn
0…1
The service reason associated with the new, changed
or cancelled deduction instruction.
The reference ID that your organisation uses to
uniquely identify an individual customer or account.
The billing number for a specific Telstra customer.
The Payment System that has facilitated the deduction
and relates to the major payment categories delivered
by the Dept of Human Services.
1.. 1
0.. 1
0…1
0.. 1
0…1
<Deduction.Amount> is
mandatory if
<DeductionActionType
Code> = ADD
Page 30 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Tag Name
Condition
Validation Level
Description
Data Type
Valid Values
Cardinality
Else Optional
<Deduction.Amount>
cannot be greater than
$999.99
<Target.Amount>
Optional
The instruction for the total amount of deductions to
be deducted before terminating the instruction.
xs: decimal
7 numerics
nnnn.nn
0…1
<Target.Amount>
cannot be less than
<Deduction.Amount>
<Target.Amount>
cannot be greater than
$999999.99
Only one of
<Target.Amount> or
<End.Date> is required.
<MessageEvent>
<Type.Code>
Mandatory
Mandatory
Primary
Delineates the outcome message data structure.
<EventType.Code>
Conditionally
mandatory
XML tag only
xs: string max 11
chars
xs:string
max 8 chars
<Description.Text>
Conditionally
mandatory
xs:string
max 255 chars
Successful or
Unsuccessful
If <Type.Code> =
Unsuccessful
1.. 1
1.. 1
0.. 1
Then mandatory
If <Type.Code> =
Unsuccessful
0…1
Then mandatory
Page 31 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
CENTREPAY BULK UPLOAD SERVICE - EXAMPLE XML RESPONSE FILE
The sample XML response below contains an example of a failed deduction instruction, as notified
to you by DHS:
1. Attempt to add a new deduction for Electricity ($25/fortnight until the Target Amount of
$2500 is reached) has failed due to error “E488PI – Unable To Complete Updates At This
Time”.
<?xml version="1.0" encoding="UTF-8" ?>
<cbus.resp:File
xsi:schemaLocation="http://xml.gov.au/dhs/reports/common/DeductionInstruction.Response.01.01
DeductionInstruction.Response.01.01.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
xmlns:cbus.resp="http://xml.gov.au/dhs/reports/common/DeductionInstruction.Response.01.01 ">
<Deduction.Instruction.Response>
<Header>
<BatchFile.Identifier>EDXCBS14</BatchFile.Identifier>
<Receipt.Number>123456789</Receipt.Number>
<Request.Count>25</Request.Count>
<Request.Number>1</ Request.Number>
</Header>
<Type.Code>CBS</Type.Code>
<Request.Date>20161121</Request.Date>
<Customer.Query>
<CustomerReference.Identifier>123456789K</CustomerReference.Identifier>
<PersonNameDetails>
<UsageType.Code>LGL</UsageType.Code>
<FamilyName.Text>Smith</FamilyName.Text>
<GivenName.Text>Freda</GivenName.Text>
<OtherGivenName.Text>Anne</ OtherGivenName.Text>
</PersonNameDetails>
<PersonDemographicDetails>
<Birth.Date>1988-10-22</ Birth.Date>
</PersonDemographicDetails>
<DeductionActionType.Code>ADD</DeductionActionType.Code>
<ServiceReasonType.Code>ELE</ServiceReasonType.Code>
<AccountReference.Identifier>agdf12345</ AccountReference.Identifier>
Page 32 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
<BillingNumber.Identifier>9876543210</BillingNumber.Identifier>
<BenefitGroupType.Code>PEN</BenefitGroupType.Code>
<Start.Date>2016-09-13</Start.Date>
<End.Date>2016-11-14</End.Date>
<Deduction.Amount>25.00</Deduction.Amount>
<Target.Amount>2500.00</Target.Amount>
<MessageEvent>
<Type.Code>Unsuccessful</Type.Code>
<EventType.Code>E488PI</EventType.Code>
<Description.Text>Unable to complete updates at this
time</Description.Text>
</MessageEvent>
</Customer.Query>
</Deduction.Instruction.Response>
</cbus.resp:File>
Page 33 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
ACCESS LEVELS
This table identifies the authorised access levels for each individual Service Reason. Access levels
may sometimes differ from this table.
CODE DESCRIPTION
ADD
DEDUCTION
INCREASE
DEDN AMT
INCREASE
TARGET AMT
DECREASE
DEDN AMT
DECREASE
TARGET AMT
CANCEL
DEDUCTION
AMB AMBULANCE
Y
Y
Y
Y
Y
Y
BDH
N
N
N
Y
Y
Y
CFW BASIC H OUSEHOLD I TEMS
N
N
N
Y
Y
Y
CGR
COMMUNITY GROUP L OAN R EPAYMENT
Y
Y
Y
Y
Y
Y
CHC
CHILD CARE S ERVICES
Y
Y
Y
Y
Y
Y
CPF
CARAVAN PARK F EES
Y
N
N
Y
Y
Y
CRT
COURT FINES
Y
Y
Y
Y
Y
Y
CTI
COURT I NFRINGEMENTS
Y
Y
Y
Y
Y
Y
DIH
INDIGENOUS C OMMUNITY H OUSING
Y
Y
Y
Y
Y
Y
EAG
R EAL E STATE AGENTS
N
N
N
Y
Y
Y
EDF
E DUCATION FEES
Y
Y
Y
Y
Y
Y
BOARDING H OUSES
ELE
E LECTRICITY
Y
Y
Y
Y
Y
Y
FBF
FUNERAL BENEFIT FUND
N
N
N
Y
Y
Y
FIL
NO I NTEREST L OANS
Y
Y
Y
Y
Y
Y
FPR
FOOD PROVISION
Y
N
N
Y
Y
Y
GAS
GAS
Y
Y
Y
Y
Y
Y
GCH
GENERAL C OMMUNITY H OUSING
Y
Y
Y
Y
Y
Y
GCL
GENERAL C OMMUNITY H OUSING L OAN
Y
Y
Y
Y
Y
Y
HCS
H OME CARE S ERVICES
Y
N
N
Y
Y
Y
IHL
INDIGENOUS H OUSING L OAN
Y
Y
Y
Y
Y
Y
ISH
INDIGENOUS SHORT T ERM H OUSING
Y
N
N
Y
Y
Y
ISR
INSURANCE S ERVICES
Y
Y
Y
Y
Y
Y
LAF
PROFESSIONAL S ERVICES
Y
N
N
Y
Y
Y
LCS
L OCAL C OUNCIL C OMMUNITY SERVICES
Y
Y
Y
Y
Y
Y
LRD
COUNCIL S ERVICES
Y
Y
Y
Y
Y
Y
MEX MEDICAL S ERVICES & E QUIPMENT
Y
Y
Y
Y
Y
Y
MVR MOTOR V EHICLE R EGISTRATION
Y
Y
Y
Y
Y
Y
PMG PROPERTY MANAGEMENT
N
N
N
Y
Y
Y
PRD
PRIVATE L ANDLORDS
N
N
N
Y
Y
Y
RVF
R ETIREMENT AND N URSING H OME F EES
Y
Y
Y
Y
Y
Y
SIL
SPECIAL I NTEREST L OANS
Y
N
N
Y
Y
Y
SNP
NUTRITION PROGRAM
Y
Y
Y
Y
Y
Y
SOR
SOCIAL & R ECREATIONAL
Y
N
N
Y
Y
Y
STA
SHORT T ERM ACCOMMODATION
Y
N
N
Y
Y
Y
SWG SEWERAGE
Y
Y
Y
Y
Y
Y
TEL
T ELECOMMUNICATIONS
Y
Y
Y
Y
Y
Y
TOT
T OOLS OF T RADE
Y
N
N
Y
Y
Y
TVL
T RAVEL A ND T RANSPORT
Y
N
N
Y
Y
Y
Y
Y
Y
Y
Y
Y
WCF WORK U NIFORM C LOTHING F OOTWEAR
Y
N
N
Y
Y
Y
WGS H OUSEHOLD G OODS
N
N
N
Y
Y
Y
WAT WATER
Page 34 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
CENTRELINK PAYMENT TYPES AND BENEFIT GROUPS
This table identifies the Centrelink payments that customers can receive from the Department of
Human Services, and the Benefit Group they belong to. If you want to deduct funds from a
specific Centrelink payment type, you can send us a deduction instruction with the Benefit Group
identified, otherwise we will deduct funds from the customer’s primary (income support)
Centrelink payment type.
Benefit Group
PPL
PGA
PEN
PEN
PEN
PEN
PEN
PEN
PEN
NSS
NSS
NSS
NSS
NSS
NSS
NSS
NSS
NSS
NSS
NSS
NSS
MOB
FTB
DRA
DOP
CDA
BBY
ABY
Centrelink Payment Type
Paid parental Leave
Parenting Payment - Partnered
Age Pension
Wife’s Pension - Age
Disability Support Pension
Wife’s Pension - Disability
Parenting Payment - Single
Widow’s Pension
Carer Payment
Newstart Allowance
Austudy ( Students)
Youth Allowance
Partner Allowance
Sickness Allowance
Widow Allowance
Special Benefit
Special Benefit - Newstart
Special Benefit - Sickness Allowance
Special Benefit - Youth Allowance
Exceptional Circumstance Payment
Newstart Mature Age Allowance
Mobility Allowance
Family Tax Benefit
Disaster Recovery Allowance
Double Orphans Pension
Carer Allowance
Baby Bonus Payment
Abstudy
Page 35 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
GUIDE TO CHANGING EXISTING DEDUCTIONS
 If you need to make two changes to a deduction instruction (for example, CAN the existing
deduction and ADD a new one) the instruction will be processed in the order that you submit
them within the CSV or XML file.
 If the customer has a deduction starting with a future date or a future change to a current
deduction, any CHG you send through will replace all existing instructions and delete any future
changes that may have been on the record.
 If you want to remove (from a current deduction instruction) the Account Reference ID, Target Amount,
or End Date, you cannot do this through CHG action. You will need to send a CAN for the current
instruction and then an ADD for a new instruction with the new values that are needed.
 If you want to end a current deduction on a future date, you can do this by sending us a CHG
update with an End Date in the future.
 If you want to end a current deduction immediately, you can do this by sending us a CAN
instruction with no End date or Deduction Amount.
 If a deduction requires suspension for a temporary period, you will need to either instruct the
customer to organise this with the department or cancel the deduction and restart at a later
date.
Customers can:
- suspend their deduction (ie. apply $0 for period of time, then revert back to original amount);
and/or
- have a specified change period (ie. apply a different Deduction Amount for period of time
then revert back to original amount).
During these periods, the only update you can make is to cancel the deduction through CAN
action.
 If you vary an existing Target Amount using this service, the new Target Amount you enter will
be stored by the system, however the Target Balance Remaining will recalculate taking into
consideration all instalments paid towards the Target Amount since the arrangement
commenced.
For example, Existing Target Balance is $500, and Total Amount Paid Towards Target is
currently $200, so the current Target Balance Remaining is $300.
Decrease - If you change the Target Amount to $300, the Total Amount Paid Towards Target is still
$200, but the new Target Balance Remaining would then be $100.
Increase - If you change the Target Amount to $1000, the Total Amount Paid Towards Target is still
$200, but the new Target Balance Remaining would then be $800.
Error - If you change the Target Amount to $100, the Total Amount Paid Towards Target is still
$200, an error will be returned as a Target Amount can’t be changed to an amount less that the
Total Amount Paid Towards Target.
Page 36 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
ERROR MESSAGES – CENTREPAY BULK UPLOAD SERVICE (CBUS)
Error in CBUS Response file
Code
Workaround for users
Zero cannot be entered unless an
instruction of the same type exists.
E001PI
If you want the deduction amount to be $0, cancel the deduction.
The format of the amount entered is
incorrect.
E002PI
Ensure the Deduction Amount is in the correct format (e.g. 50.00)
Requested deduction cannot exceed
$99999.99.
E003PI
Ensure Deduction Amount is less than the maximum amount.
No customer found with this SSOR.
E008ET
The CRN you supplied is valid, however it has not been assigned to a
customer. You may need to contact the customer to confirm the correct
CRN.
#### cannot be changed.
E008PI
If you want to change the Start Date or the Deduction Amount, cancel
the current instruction and code the correct details.
Customer not current on #### and does
not have new claim pending.
E009PI
The Centrelink Benefit Group is not valid. The customer may not be
receiving a payment from us for the Benefit Group you have selected.
Entry required.
E012ZZ
Ensure all mandatory fields have been completed.
Start Date or End Date cannot be in the
past.
E016PI
Ensure Start Date or End Date is not in the past. If you leave the Start
Date blank, we will use today’s date.
Entry contains invalid characters.
E017ZZ
Ensure the Account Reference ID is valid (rules may differ for each
organisation).
Payee reference number entered is invalid.
E023PI
Ensure the Account Reference ID is valid (rules may differ for each
organisation).
Deduction limit exceeded. Only 19 current
deductions allowed.
E076PI
No workaround – Request customer to make changes via Online
Services, Call Centre or alternatively submit an SA325 form to the
department for processing.
####
E097AX
No workaround – Request customer to make changes via Online
Services, Call Centre or alternatively submit an SA325 to the department
for processing.
Requested deduction cannot be less than
####.
E101PI
Ensure the Deduction Amount is more than the minimum deduction
amount accepted by your organisation (usually $10.00).
Not a valid DSS obj ref (SSR).
E105ET
Ensure the Centrelink Reference Number is correct. You may need to
contact the customer to confirm the correct CRN.
For new deductions, amount must be >
0.00.
E113PI
Ensure the Deduction Amount is more than the minimum deduction
amount accepted by your organisation.
MULTIPLE DEDUCTION DETAILS RECS exist
on DEDN0; contact SYSTEMS.
E114PI
No workaround - Customer record may contain corrupt data. Request
customer to make changes via Online Services, Call Centre or
alternatively submit an SA325 form to the department for processing.
Target Amount cannot be less than $10.00.
E120PI
Ensure Target Amount is greater than $10.00.
The requested Target Amount is less than
the Instruction Amt P.F.
E122PI
Ensure the Target Amount is equal to or greater than the Deduction
Amount.
System code must equal benefit group.
E154PI
The Centrelink Benefit Group is not valid. The customer may not be
receiving a payment from us for the Benefit Group you have selected.
Benefit status must be current to setup
Centrepay deductions.
E159PI
The Centrelink Benefit Group is not valid. The customer may not be
receiving a payment from us for the Benefit Group you have selected.
End date must be greater than Start Date.
E185PI
Ensure the End Date is after the Start Date. Neither of these dates can
be prior to today’s date.
No overlapping instruction dates
permitted.
E186PI
Deduction instruction has a change in the future (preventing updates) –
if you want to change the current or future deduction, cancel the current
instruction and code the correct details.
Only one future SUS/SPC/CAF/SFD are
allowed per benefit, dedn type & org.
E188PI
Deduction instruction has a change in the future (preventing updates) –
if you want to change the current or future deduction, cancel the current
instruction and code the correct details.
Target Amt may not be added/changed on
SUS/SPC/CAF except cur SPC.
E190PI
Deduction instruction has a change in the future (preventing updates) –
if you want to change the current or future deduction, cancel the current
instruction and code the correct details.
Page 37 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Error in CBUS Response file
Code
Workaround for users
Org Cust Ref may not be added/chng on
SUS/CAF/SPC except cur SPC.
E191PI
Deduction instruction has a change in the future (preventing updates) –
if you want to change the current or future deduction, cancel the current
instruction and code the correct details.
Start Date must not exceed 8 weeks in the
future for SFD instruction.
E192PI
Ensure Start Date is within 8 weeks of today’s date. An SFD deduction is
one that ‘Starts on a Future Date’.
End Date is not permitted when
terminating the instruction.
E193PI
If you want to change the End Date, cancel the current instruction and
code the correct details.
SPC immediately following SUS or SUS
action following SPC not permitted.
E195PI
Deduction instruction has a change in the future (preventing updates) –
if you want to change the current or future deduction, cancel the current
instruction and code the correct details.
Start Date is invalid for the Change Reason
code.
E199PI
Start Date is invalid for this update action. Choose a date at least 14 days
in future, or contact the Helpdesk if unable to resolve.
Start Date must be within 52 weeks from
today’s date.
E230PI
Ensure Start Date is within 52 weeks of today’s date. If you leave the
Start Date blank, we will use today’s date.
End Date cannot be more than 52 weeks
after the Start Date.
E231PI
Ensure End Date is within 52 weeks of the Start Date.
End Date cannot be more than 13 weeks
after the Start Date.
E232PI
Ensure End date is within 13 weeks of the Start Date.
Derived End Date may not be removed.
E233PI
If you want the deduction amount to be $0, cancel the deduction.
Org Cust Acct Ref and Target Amount may
not be updated when terminating.
E238PI
If you want to cancel the deduction, you cannot update other data as
part of that cancellation.
Only End Date, Org Cust Acct Ref & Target
may change.
E240PI
Deduction instruction has a change in the future. Updates can only be
made to End Date or Account Reference ID.
Start date cannot be changed to End date +
1.
E243PI
Start Date is too close to the existing End date. Cancel the current
instruction and code the correct details.
A current instruction already exists for this
benefit / organisation.
E245PI
Check current deduction instruction, as one already exists.
#### is mandatory for this organisation.
E253PI
Ensure the Account Reference ID is not blank, and is valid (rules may
differ for each organisation). This error can also be invoked if you have
not included a Target Amount if it is mandatory for your organisation.
Requested #### amount cannot be less
than ####.
E254PI
Ensure the Target Amount is greater than the minimum target amount
accepted by your organisation.
Requested #### amount cannot be greater
than ####.
E255PI
Ensure the Target Amount is less than the maximum target amount
accepted by your organisation.
Org account reference valid format: #####
E256PI
The Account Reference ID must be provided in the correct format, as per
validation rules requested by your organisation. You may have asked us
to accept Account Reference IDs in a number of formats.
e.g. ######; ########
= must have either 6 or 8 digits.
e.g. T#####
= must have ‘T’ as first character, followed by 5 digits.
Cannot enter both a deduction amount
and a percentage.
E259PI
No workaround – Please contact Helpdesk and request customer to
make changes via Online Services, Call Centre or alternatively submit an
SA325 form to the department for processing.
Task locking conflict. Deduction Service
update failed.
E263PI
There is a pending piece of work on the customer record that blocks this
update. Try again in a day or two.
No access. Your #### is not in the allowed
#### list.
E277PI
No workaround – Please contact Helpdesk and request customer to
make changes via Online Services, Call Centre or alternatively submit an
SA325 form to the department for processing.
Invalid date: Date of birth.
E303PI
The date of birth you have supplied is not in a valid format. Please check
the User Guide to ensure you are using the correct date format.
Invalid date: Start Date
E303PI
The Start Date you have supplied is not in a valid format. Please check
the User Guide to ensure you are using the correct date format.
Invalid date: End Date
E303PI
The End Date you have supplied is not in a valid format. Please check the
User Guide to ensure you are using the correct date format.
Page 38 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Error in CBUS Response file
Code
Workaround for users
Updates cannot be made on a terminated
organisation.
E326PI
No workaround – Please contact Helpdesk and request customer to
make changes via Online Services, Call Centre or alternatively submit an
SA325 form to the department for processing.
Organisation ineligible to ADD deductions.
E471PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Service reason not eligible for action ADD.
E472PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Service reason ineligible for action CAN.
E473PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Organisation ineligible to CAN deductions.
E474PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Organisation ineligible to make any
updates to deductions.
E475PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Service reason not eligible for amount
increase.
E476PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Service reason not eligible for downward
variation of amount.
E477PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
You cannot increase the target amount for
this service reason.
E478PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
You cannot decrease the target amount for
this service reason.
E479PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Request is ADD but current instruction
already exists.
E480PI
A current deduction already exists. Please make any required changes to
the current deduction.
Service reason not eligible for action CHG.
E481PI
Your organisation has not been approved to undertake this action. If you
believe the system is not operating correctly, please contact the
Helpdesk.
Deduction action failed
E482PI
You have submitted a CAN request with too much data – no need to also
send Start Date or End Date or Deduction Amount or Target Amount.
Submitting a CAN request will cancel the existing deduction and any
future changes to that deduction. Check the User Guide for guidance on
what data is required to successfully submit a CAN request.
Can only have End Date or Target Amount,
not both.
E483PI
A Target Amount or End Date already exists on the current deduction
instruction.
You cannot add an End Date or a Target Amount to this deduction –
either wait til Target Amount (or End Date) has been reached, or cancel
the deduction and add a new one with the correct details.
Error prevented updates being applied at
this time.
E488PI
Your organisation has not been approved to make this type of update. If
you believe the system is not operating correctly, please contact the
Helpdesk.
This deduction type is not valid for
Centrepay.
E514PI
Service Reason entered is not valid.
Not a valid instruction for this service
reason
E529PI
Deduction cannot be set up on customer receiving Paid Parental Leave
via their employer.
Request Action Code is invalid.
E700PI
The Deduction Action Code can only be one of the following: ADD, CHG,
CAN. Ensure you are submitting a valid code.
CLK Benefit group is invalid.
E702PI
The Centrelink Benefit Group you have supplied is not in a valid format.
Please check the User Guide to ensure you are using a valid code. If you
leave the Centrelink Benefit Group blank, we will apply the deduction to
the customer’s primary payment type.
Page 39 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Error in CBUS Response file
Code
Workaround for users
For deductions from Family Tax Benefit payments, you must use code
FTB in all cases.
Customer not matched.
E709PI
The customer details you have supplied either don’t match our records,
or there is a reason why we cannot confirm the customer’s identity to
you (e.g. Customer is deceased, or a protected witness, etc).
Customer not current on requested
system.
E713PI
No matching deduction found. The customer may not be receiving a
payment from us for the Benefit Group you have selected.
No current deduction for this type.
E721PI
No matching deduction found. The customer may not be receiving a
payment from us for the Benefit Group you have selected.
Benefit type invalid for deduction.
E736PI
No workaround - Please contact Helpdesk and request customer to make
changes via Online Services, Call Centre or alternatively submit an SA325
form to the department for processing.
Unable to update deduction instruction at
this time.
E787PI
This is a default error message when we are unable to allow updates to
this customer record. The underlying cause could be a number of
reasons.
If you repeatedly receive this error for the same customer, please
contact the Helpdesk.
New Target Amount is less than total
deductions to date.
E837PI
Ensure the Target Amount is equal to or greater than the total of
repayments made to date (ie. Target Balance Remaining). If you don’t
know the amount already repaid, you can cancel the current deduction
and start a new one with the Target Amount you wish to recover from
today onward.
CBUS Troubleshooting Guide
Q. Preceding zeroes from the dates, and the decimal places from the deduction/target amounts,
are removed when I create the CBUS file using Excel (or other spreadsheet application)?
A. Format the cells in your spreadsheet as ‘text’ to retain preceding zeroes and decimal places.
Q. I’ve formatted my spreadsheet cells as ‘text’ and saved the file as a CSV document, but when I
review the file the preceding zeroes from the dates, and decimal places from the deduction/target
amounts have disappeared?
A. Review your data using a text editor application such as Notepad. Preceding zeroes and decimal
places will not display when opening a CSV file in a spreadsheet application (such as Excel).
Q. How do I minimise the return of ‘Customer Not Matched’ responses in my Response file?
A. Ask your customer to provide you with their name and date of birth to exactly match what they
have recorded with the Department of Human Services – Centrelink.
Provide only the minimum information required to match the customer: Centrelink Reference
Number (CRN), Surname (Family name) and Date of Birth.
Q. We receive a lot of ‘request is ADD but deduction is already in place’ responses. How do we
minimise these?
A. Confirm with the customer at the time of getting their consent whether a deduction is already
in place or not. If receiving instruction data with your Centrelink Deduction reports, use this
information to update your records with the status of your customer’s Centrepay deductions.
Page 40 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Utilise the Deductions And Payments Application (DAPA) to verify existing deduction
arrangements.
Q. I receive the response ‘there is no current deduction for this type’ when attempting to vary or
cancel a deduction, but I’m certain the deduction is in place?
A. If the deduction is from ABY, CDA, DRA, FTB or MOB benefit group, this benefit group type must
be included in the Centrelink Benefit Group section of your file to allow the update to be
processed.
Q. Why did I receive a response file for only some of the deduction requests in the file submitted?
A. Incorrectly formatted transaction lines will be returned in a separate ‘Rejection’ file. Response
file will return a response for all correctly formatted deduction requests.
If spaces are included with any of your data, it is possible those spaces may contain hidden
characters which can cause rejection of the file at the point where the hidden characters are
encountered when the file is processed. We recommend reviewing your file before submission to
make sure spaces are not included, and avoiding cutting and pasting data from other sources as
you may inadvertently include hidden characters that are either outside the allowable printable
range, or are unprintable characters.
Q. I have successfully submitted my CBUS file, but haven’t received an immediate response?
A. Response files are generally available after 8 pm on the same day the file is submitted. Where
multiple files are submitted on the same day, the system will collate all instructions provided on
that day into one response file.
Q. It takes time to format the requests I receive into the format required for a CBUS file?
A. You could provide a template or guide to your house staff to make sure all necessary
information is collected, and it is in the order it will be entered into the CBUS file.
Page 41 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Need help?
CENTREPAY HELPDESK
If you experience technical difficulties while using the Centrepay Bulk Upload Service or require
more information, you can contact the following helpdesk for assistance. Alternatively, visit our
website humanservices.gov.au/business
Email
centrelink.business.support@humanservices.gov.au
FreeCall™
1800 044 063
Please make sure you have the following information ready when contacting us:




your organisation’s name
your organisation’s Centrelink Reference Number
contact phone number or email address, and
description of the problem you are experiencing.
Note: Calls to ‘1800’ phone numbers from a fixed phone line are free. Calls from public phones and mobile
phones may be timed and charged at a higher rate.
If you need assistance with a file submission or response file, you can find the ‘File Receipt
Number’ within the ‘Sent’ and ‘Inbox’ folders in your online mailbox. This reference number will
help us provide assistance to you regarding any file submissions.
Page 42 of 42
User Guide – Centrepay Bulk Upload Service (CBUS)
Version 18.03.2015
Download