Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Payroll Event

ClickSuper LabelATO Label NameATO Business DefinitionATO Business GuidanceATO Report Guidance
Reporting PartyRpNot availableNot availableNot available
BMS IdentifierSoftwareInformationBusinessManagementSystemIdThis identifies the Business Management System software used by the employer.Not availableThis is allocated to each instance of a payroll solution and allows multiple payroll reports submitted separately to be allocated to the same payee.  It must be unique within an ABN/branch.  The recommended value is a GUID generated using RFC4122.  Once established for that payroll instance, it should not be changed without reference to the STP Business Implementation Guide.
Payer Australian Business NumberAustralianBusinessNumberIdA unique public identifier issued to all entities registered in the Australian Business Register (ABR), to be used in their dealings with government. Companies registered under the Corporations Law and business entities carrying on an enterprise in Australia are entitled to an ABN.The Withholder Payer Number reported must belong to the payer named in this record.Identifies the Payer who is responsible for the PAYGW reporting obligations and enables the ATO to record the payroll event against the correct record.  It must be the WPN issued by the ATO.  Either the ABN or WPN of the Payer must be reported.
Payer Withholding Payer NumberWithholdingPayerNumberIdThe Withholding Payer Number (WPN) is allocated to clients who have withholding obligations under Pay As You Go (PAYG) withholding but who do not have an Australian Business Number (ABN). Its primary purpose is for quotation on payment summaries issued to their employees. For example, private individuals not carrying on an enterprise employing a nanny or housekeeper, would be allocated a WPN.Not availableIdentifies the Payer who is responsible for the PAYGW reporting obligations and enables the ATO to record the payroll event against the correct record.  It must be the WPN issued by the ATO.  Either the ABN or WPN of the Payer must be reported.
Payer Branch CodeOrganisationDetailsOrganisationBranchCThe branch number of an organisation. Branch Numbers are issued to organisations that wish to sub-divide their activities in dealing with their tax obligations.Not availableThis is used to identify the correct branch of an organisation for the PAYGW obligation.  If the Payer does not have a branch number, this must be set to 1.
Payer NameOrganisationNameNot availableNot availableNot available
Payer Organisation NameDetailsOrganisationalNameTThe full name by which an organisation is known.Not availableFor an ABN, use the legal name of the Payer as per Australian Business Register.  For a WPN, use the Payer name registered with the ATO.
Payer Contact NamePersonUnstructuredNameFullNameTThe name of a person represented in a free format text. It may contain a complete name (first, family and other given names) or parts of it. This representation of a person's name is commonly used where the name is not used for proof of identity matching hence it is not required to be strongly validated. Examples of its use are: The name of the person who is used as a contact on behalf of an Organisation or the name of the recipient of a correspondence.Not availableName of the person to be contacted on behalf of a Payer.  All questions regarding the payroll will be directed to this contact.
Payer Electronic ContactElectronicContactNot availableNot availableNot available
Payer E-mail AddressElectronicMailAddressTDenotes the address of an electronic mail service.Not availableE-mail for the nominated contact person. This will be used for certain processing enquiries and general correspondence.
Payer Business Hours Phone NumberTelephoneMinimalNThe number that is associated to a unique provision of telephone service.Not availableThe telephone number for the nominated contact person for the Payer.  Include area code.  If outside Australia, include country code.  1800, 13 numbers and mobile numbers are allowed.
Payer Postal AddressAddressDetailsPostalNot availableNot availableNot available
Payer Address Line 1Line1TFirst line utilising free format, that is used to create a semi structured address.Not availableThis is the postal address of the Payer.  It may be used to send correspondence for TFN declarations. Unit/apartment and street address must be provided in the 1st and 2nd address lines. It may not be necessary to use both lines. The suburb/town/city, state/territory and postcode must be supplied in the separate fields as specified and must not be included in the first or second address line fields.
Payer Address Line 2Line2TSecond line utilising free format, that is used to create a semi structured address.Not availableAddress line 2 is used to complete the postal street address of the Payer.  It may be used to send correspondence for TFN declarations.
Payer Suburb/TownLocalityNameTA word or combination of words, by which a geographic locality/suburb is designated or known.Not availableThis is the suburb, town or locality for the postal address of the Payer.  It may be used to send correspondence for TFN declarations.
Payer State/TerritoryStateOrTerritoryCThe code that is assigned to each Australian State or TerritoryNot available

This is the state/territory of the residential address of the payer.  This field is required if the country is not provided or Australia.

AAT| ACT| NSW| NT| QLD| SA| TAS| VIC| WA

Payer PostcodePostcodeTThe Australian descriptor for a postal delivery area, aligned with locality, suburb or placeNot availableThis is the postcode of the postal address of the Payer. It may be used to send correspondence for TFN declarations. This is mandatory if the Payee's country code is either not supplied or Australia (AU).
Payer Country CodeCountryCThis represents the Country Code as prescribed by AS4590 and inherited from ISO 3166Not available

The country code for the postal address of the Payer. It does not need to be supplied if country is AU.

ad| ae| af| ag| ai| al| am| ao| aq| ar| as| at| au| aw| ax| az| ba| bb| bd| be| bf| bg| bh| bi| bj| bl| bm| bn| bo| bq| br| bs| bt| bv| bw| by| bz| ca| cc| cd| cf| cg| ch| ci| ck| cl| cm| cn| co| cr| cu| cv| cw| cx| cy| cz| de| dj| dk| dm| do| dz| ec| ee| eg| eh| er| es| et| fi| fj| fk| fm| fo| fr| ga| gb| gd| ge| gf| gg| gh| gi| gl| gm| gn| gp| gq| gr| gs| gt| gu| gw| gy| hk| hm| hn| hr| ht| hu| id| ie| il| im| in| io| iq| ir| is| it| je| jm| jo| jp| ke| kg| kh| ki| km| kn| kp| kr| kw| ky| kz| la| lb| lc| li| lk| lr| ls| lt| lu| lv| ly| ma| mc| md| me| mf| mg| mh| mk| ml| mm| mn| mo| mp| mq| mr| ms| mt| mu| mv| mw| mx| my| mz| na| nc| ne| nf| ng| ni| nl| no| np| nr| nu| nz| om| pa| pe| pf| pg| ph| pk| pl| pm| pn| pr| ps| pt| pw| py| qa| re| ro| rs| ru| rw| sa| sb| sc| sd| se| sg| sh| si| sj| sk| sl| sm| sn| so| sr| ss| st| sv| sx| sy| sz| tc| td| tf| tg| th| tj| tk| tl| tm| tn| to| tr| tt| tv| tw| tz| ua| ug| um| us| uy| uz| va| vc| ve| vg| vi| vn| vu| wf| ws| ye| yt| za| zm| zw

PayrollPayrollNot availableNot availableNot available
Pay/Update DatePaymentRecordTransactionDDate on which a payment has been made by an entity.Not available

For Submit event, this is the date on which the PAYG withholding for the Payroll Submit Event occurred. It is used to determine what PAYGW period the Payer Gross and PAYGW amounts are to be applied.
For Update Event this is the As At date. It must be any date within the financial year that is being updated.

Payee Record CountInteractionRecordCtThe number of records included in an interaction.Not availableDefines the number of child or PAYEVNTEMP records associated with this PAYEVNT record.
Run Date/Time StampMessageTimestampGenerationDtThe generation date and time (ISO 8601 - UTC) of a Business Signal.Not availableThe timestamp of when the payroll or update data was run. It is used to identify the most recent information for a payee.
Submission IDInteractionTransactionIdThis is a unique identifier to identify a transaction.Not availableIt must be unique across your ABN, Branch ID and BMS identifier.  If requesting a full file replacement, use the submission ID of the initial payevent submit message being replaced.
Full File Replacement IndicatorAmendmentIIndicator to identify whether the report contains original or amended data.

A choice of TRUE/FALSE values.
true = The report contains amended data
false = The report does not contain amended data

This is used to indicate when this submission is a full file replacement.
TRUE indicates the data provided in this transaction replaces data previously reported under the provided submission ID. It cannot be TRUE for Update events.
FALSE indicates this is the original submission or an Update event.

Payer Period TotalsIncomeTaxAndRemuneration   
Payer Total PAYGW AmountPayAsYouGoWithholdingTaxWithheldAThis is the value, during the relevant period, for the amount withheld under the Pay As You Go (PAYG) arrangement. 

This is reported as the Payer's PAYGW obligation for the payroll period ending in the pay date. The Payer Total PAYGW amount includes the total value for the payroll period being reported and represents the difference between the last reported YTD and the current report. Refer to STP Business Implementation Guide on what is to be included in this element.
This field must not be supplied in the Update Event.

Payer Total Gross PaymentsTotalGrossPaymentsWithholdingAThe total of salary, wages and other payments paid during the reporting period from which an amount must be withheld. 

This is reported as the Payer's Total Gross payments for the payroll period ending in the pay date. It includes the total value for the payroll period being reported and represents the difference between the last reported YTD and the current report. Refer to STP Business Implementation Guide on what is to be included in this element.
This field must not be supplied in the Update Event.

Reporting Party DeclarationDeclaration   
Payer Declarer IdentifierSignatoryIdentifierTIdentifier defined and used by the ABR device credential holder to identify a user. The user identifier must allow the ABR credential owner or an external auditor to uniquely identify the individual that made the declaration. The name of the individual that made the declaration for the Payer.
Payer Declaration DateSignatureDThis is the date on which the declaration is signed by the reporting entity. This is the date the individual signed and accepted the terms of the declaration on behalf of the Payer.
Payer Declaration Acceptance IndicatorStatementAcceptedIIndicates that the terms stated in the Declaration Text have been accepted or declined. This indicates the Payer's acceptance of the declaration statement.
IntermediaryInt   
Intermediary ABNAustralianBusinessNumberIdA unique public identifier issued to all entities registered in the Australian Business Register (ABR), to be used in their dealings with government. Companies registered under the Corporations Law and business entities carrying on an enterprise in Australia are entitled to an ABN. The ABN of the Registered Agent or Intermediary supplying the data.
Registered Agent NumberTaxAgentNumberIdAn external identifier issued by the ATO on behalf of the Tax Agent's Board.  It is used to uniquely identify an individual who has been registered by the Board as a Tax Agent. The Registered Agent Number issued by TPB that is associated with Intermediary ABN.  This is not mandatory.
Intermediary Contact NamePersonUnstructuredNameFullNameTThe name of a person represented in a free format text. It may contain a complete name (first, family and other given names) or parts of it. This representation of a person's name is commonly used where the name is not used for proof of identity matching hence it is not required to be strongly validated. Examples of its use are: The name of the person who is used as a contact on behalf of an Organisation or the name of the recipient of a correspondence. This is the authorised nominated contact person for the intermediary.
Intermediary Electronic ContactElectronicContact   
Intermediary E-mail AddressElectronicMailAddressTDenotes the address of an electronic mail service. The email address of the nominated contact person for the intermediary.
Intermediary Business Hours Phone NumberTelephoneMinimalNThe number that is associated to a unique provision of telephone service. The telephone number for the nominated contact person for the Intermediary.  Include area code.  If outside Australia, include country code.  1800, 13 numbers and mobile numbers are allowed.
Intermediary Declaration    
Intermediary Declarer Identifier Identifier defined and used by the ABR device credential holder to identify a user. The user identifier must allow the ABR credential owner or an external auditor to uniquely identify the individual that made the declaration.The identifier used can be specified by the ABR credential owner providing it allows identification as above. Examples of suitable identifiers include a user login, a full name or an E-mail address.The name of the individual that made the declaration on behalf of the intermediary.
Intermediary Declaration Date This is the date on which the declaration is signed by the reporting entity.The actual date on which the declaration is signed by the reporting entity, not the date on which the relationship commenced or any 'default' or 'dummy' date.This is the date the individual signed and accepted the terms of the Declaration on behalf of the intermediary.
Intermediary Declaration Acceptance Indicator Indicates that the terms stated in the Declaration Text have been accepted or declined.

A choice of TRUE/FALSE values.
true = Indicates that the terms stated in the Declaration Text have been accepted.
false = Indicates that the terms stated in the Declaration Text have been declined.

This indicates the Payers acceptance of the declaration statement on behalf of the intermediary.

 

Payroll Event Payee

ClickSuper LabelATO Label NameATO Business DefinitionATO Business GuidanceATO Report Guidance
PayeePayeeNot availableNot availableNot available
Payee IdentifiersIdentifiersNot availableNot availableNot available
Payee TFNTaxFileNumberIdA unique number issued by the Tax Office to individuals and organisations to identify their tax records. It increases the efficiency in administering tax and other Australian Government systems such as income support payments. It is also used as the identifier for clients' income tax roles. A Tax File Number (TFN) can be used externally only for communication with the Tax Office, either directly by the client, or by an external organisation that is required to collect and quote the client's TFN to the Tax Office. 

This is to identify an individual within the ATO. If a TFN exemption is being sought, valid TFNs to use are:
000000000 – Where the payee has not completed a TFN declaration, the payee has completed a TFN declaration and chooses not to quote a TFN, the payee has indicated that they applied or enquired about a TFN with the ATO and failed to provide a TFN within 28 days.
111111111 - Where the payee has not provided a TFN but they indicate on the TFN declaration that they have applied or enquired about a TFN with the ATO.
333333333 - Where the payee is under the age of eighteen and earns $350 or less weekly, earns $700 or less fortnightly or earns $1517 or less monthly.
444444444 - Where the payee is a recipient of a social security or service pension or benefit (other than Newstart, sickness allowance, special benefits or partner allowance) an exemption from quoting a TFN may be claimed.
987654321 - Where a payee has quoted a TFN with alpha characters the code 987654321 must be used in place of the quoted TFN. This code must also be used where the TFN quoted cannot be contained in the TFN field.
For employment termination payments, in the event the payment is due to the death of an employee, show either the TFN of the trustee for the deceased estate or the TFN of the dependant or non dependant of the deceased employee, whichever is applicable.

Contractor ABNAustralianBusinessNumberIdA unique public identifier issued to all entities registered in the Australian Business Register (ABR), to be used in their dealings with government. Companies registered under the Corporations Law and business entities carrying on an enterprise in Australia are entitled to an ABN. This is used to allow a Payer to report a voluntary agreement, labour hire or other specific payments. This must be supplied if voluntary agreement income is to be included during the financial year.
Payee Payroll IDEmploymentPayrollNumberIdNumber allocated by the payer payroll system to identify a payee. This identifier will be quoted on any correspondence regarding the payee's declaration to assist correct identification of the payee. This is used to help identify the payee if they have more than one instance in a payroll system, e.g. payee paid on two separate awards.  Used in combination with ABN, Branch, BMS ID and Payee TFN/ABN to identify a unique pay record.  A Payevnt message can only contain a single child record per employee per Payee Payroll ID.
Payee Name DetailsPersonNameDetails   
Payee Family NameFamilyNameTThe person's last name or surname. The name by which a family group is identified. This is the payee's family name. Where the payee has a legal single name only, this field must be completed.  If a beneficiary receives payment upon a person's death, use either the name of the trustee for the deceased estate or the beneficiary of the deceased person, whichever is applicable.
Payee First NameGivenNameTThe name given to a person which is that person's identifying name within the family group or the name by which the person is uniquely socially identified; the name borne by an individual, often assigned by his or her parents shortly after birth, as opposed to the inherited surname. This should be provided unless the payee has a legal single name.  For non-individual trustees, split the legal name over name fields.
Payee Other NameOtherGivenNameTThe middle name given to a person which complements that person's identifying name within the family group or the name by which the person is uniquely socially identified.  
Payee Demographic DetailsPersonDemographicDetails   
Payee Day of BirthBirthDmThe date of the day in the month in which an individual was born If year of birth is not known, do not provide.
Payee Month of BirthBirthMThe month in which an individual was born If year of birth is not known, do not provide.
Payee Year of BirthBirthYThe year in which an individual was born If unknown, do not provide.
Address DetailsAddressDetails   
Payee Address Line 1Line1TFirst line utilising free format, that is used to create a semi structured address. This is the residential address of the Payee. Unit/apartment and street address must be provided in the 1st and 2nd address lines. It may not be necessary to use both lines. The suburb/town/city, state/territory and postcode must be supplied in the separate fields as specified and must not be included in the first or second address line fields.
Payee Address Line 2Line2TSecond line utilising free format, that is used to create a semi structured address. Address line 2 is used to complete the residential street address of the payee.  This is an optional field and does not need to be populated.
Payee Suburb/TownLocalityNameTA word or combination of words, by which a geographic locality/suburb is designated or known. This is the suburb, town or locality for the residential address of the payee.
Payee State/TerritoryStateOrTerritoryCThe code that is assigned to each Australian State or Territory. 

This is the state/territory of the residential address of the payee.  This field is required if the country is not provided or Australia.

AAT| ACT| NSW| NT| QLD| SA| TAS| VIC| WA

Payee PostcodePostcodeTThe Australian descriptor for a postal delivery area, aligned with locality, suburb or place. This is the postcode of the contact address of the payee.  This is mandatory if the Payee's country code is either not supplied or Australia (AU).
Payee Country CodeCountryCThis represents the Country Code as prescribed by AS4590 and inherited from ISO 3166. 

The country code for the residential address of the Payee. It does not need to be supplied if country is AU.

ad| ae| af| ag| ai| al| am| ao| aq| ar| as| at| au| aw| ax| az| ba| bb| bd| be| bf| bg| bh| bi| bj| bl| bm| bn| bo| bq| br| bs| bt| bv| bw| by| bz| ca| cc| cd| cf| cg| ch| ci| ck| cl| cm| cn| co| cr| cu| cv| cw| cx| cy| cz| de| dj| dk| dm| do| dz| ec| ee| eg| eh| er| es| et| fi| fj| fk| fm| fo| fr| ga| gb| gd| ge| gf| gg| gh| gi| gl| gm| gn| gp| gq| gr| gs| gt| gu| gw| gy| hk| hm| hn| hr| ht| hu| id| ie| il| im| in| io| iq| ir| is| it| je| jm| jo| jp| ke| kg| kh| ki| km| kn| kp| kr| kw| ky| kz| la| lb| lc| li| lk| lr| ls| lt| lu| lv| ly| ma| mc| md| me| mf| mg| mh| mk| ml| mm| mn| mo| mp| mq| mr| ms| mt| mu| mv| mw| mx| my| mz| na| nc| ne| nf| ng| ni| nl| no| np| nr| nu| nz| om| pa| pe| pf| pg| ph| pk| pl| pm| pn| pr| ps| pt| pw| py| qa| re| ro| rs| ru| rw| sa| sb| sc| sd| se| sg| sh| si| sj| sk| sl| sm| sn| so| sr| ss| st| sv| sx| sy| sz| tc| td| tf| tg| th| tj| tk| tl| tm| tn| to| tr| tt| tv| tw| tz| ua| ug| um| us| uy| uz| va| vc| ve| vg| vi| vn| vu| wf| ws| ye| yt| za| zm| zw

Electronic ContactElectronicContact   
Payee E-mail AddressElectronicMailAddressTDenotes the address of an electronic mail service. The email address the payee wants TFN Declaration notifications sent to.
Payee Phone NumberTelephoneMinimalNThe number that is associated to a unique provision of telephone service. This is the contact phone number of the payee. Include country code and area code.  Mobile numbers are acceptable.
Employment ConditionsEmployerConditions   
Payee Commencement DateEmploymentStartDThe date when a person commenced paid employment. Refer to the STP Business Implementation Guide for guidance on when to populate this field.
Payee Cessation DateEmploymentEndDThe date when a person ceases paid employment. Refer to the STP Business Implementation Guide for guidance on when to populate this field.
Wage ItemRemunerationIncomeTaxPayAsYouGoWithholding   
Payroll RunPayrollPeriod   
Period Start DateStartDThe Period Start Date is the initial date of the period. 

For Submit, this is the start date of the pay period. The start and end dates can be the same.

For Update, if the message is for the current financial year, then this date must be the same as the pay/update date from the payevnt record. If it is to update a previous financial year, this date must be set to the last date of the relevant financial year.

Period End DateEndDThe Period End Date is the final date of the period. 

For Submit, this is the end date of the pay period.

For Update, the Period End Date must be the same as the Period Start Date.

Final Event IndicatorPayrollEventFinalI

This indicates whether the report is the employers final payroll for the current reporting period.

 

A choice of TRUE/FALSE values.
true = report is the employers final payroll data for the current reporting period.


false = report is not the employers final payroll data for the current reporting period.

The final event indicator allows a Payer to make a declaration to the ATO that they have provided all the information for each payee for a financial year. This declaration allows the ATO to make the payee information available for income tax return prefill for employees and extinguishes the payers liability to provide a payment summary for that payee.
     
     

 

 

 

  • No labels