Table of Contents

Activity Statements

Supported Endpoints and Methods 

The endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/activitystatements

Methods supported:   GET

The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401 

Activity Statements is available for AU books only.

Reckon One Module

Endpoint

Additional Parameter(s)

HTTP Method

Description

API Portal

Countries

Core

Activity Statements

 

GET

Retrieve a list of activity statements

Portal

AU

Core

Activity Statements

/gstReportId

GET

Allows you to retrieve detailed information from a single activity statement by sending its ID to the API endpoint

Portal

AU

 

Sample 

 

Get Activity Statement List

Endpoint:  https://api.reckon.com/R1/{BOOKID}/activitystatements

Method: GET  

 

[
{
"GSTReportID":"17444bf7-9aab-4dfe-967e-d5ac2dac9ea9",
"CashbookID":"00000000-0000-0000-0000-000000000000",
"DocumentID":null,
"Description":"Annual report 2013/2014 with all options (PAYG1) nnnnn",
"ReceiptNumber":null,
"DueDate":null,
"LodgeDate":null,
"StartDate":"2013-07-01T00:00:00+12:00",
"EndDate":"2014-06-30T00:00:00+12:00",
"GSTReportTemplateID":"00000000-0000-0000-0000-000000000000",
"IsAmendment":false,
"Status":1,
"PeriodInDays":0
}
]

 

Details of each object 

Data Field

Description

Data Type

GSTReportID

The GUID of the GST Report

GUID

DocumentID

If a document ID has been assigned to the report it will list here

Text

Description

The description of the report

Text

ReceiptNumber

If a receipt number has been entered against the report it will appear here

Alphanumeric

DueDate

The date date of the BAS report

Date/Time

LodgeDate

The date the report was lodged

Date/Time

StartDate

The start date of the period for the BAS report

Date/Time

EndDate

The end date of the period for the BAS report

Date/Time

GSTReportTemplateID

The template that has been applied to the GST report

GUID

IsAmendment

Whether this BAS report has been marked as amended

Boolean (True/False)

Status

Not used yet

N/A

 

Get Activity Statement List by ID

Endpoint:  https://api.reckon.com/R1/{BOOKID}/activitystatements/{gstreportid}

Method: GET  

{
   "BASPreferences": {
     "AmountTaxstatus": 2,
     "CashbookID": "00000000-0000-0000-0000-000000000000",
     "IncludeFBT": false,
     "IncludeFTC": false,
     "IncludeLCT": false,
     "IncludePAYGIOption1": true,
     "IncludePAYGIOption2": false,
     "IncludePAYGW": false,
     "IncludeWET": true,
     "ReportingPeriodType": "54041267-bc3a-4aef-8cb9-2b36f8be1d03"
   },
   "CashbookId": "e17417ac-fc79-4d4d-9ee8-1780b3bc326f",
   "CompanyName": "ABC Building",
   "Data": [
     {
       "Error": null,
       "Label": "9a",
       "Value": null,
       "Xbrl": null
     },
     {
       "Error": null,
       "Label": "8B",
       "Value": null,
       "Xbrl": null
     },
     {
       "Error": null,
       "Label": "8A",
       "Value": null,
       "Xbrl": null
     },
     {
       "Error": null,
       "Label": "9",
       "Value": "0",
       "Xbrl": null
     },
     {
       "Error": null,
       "Label": "9b",
       "Value": null,
       "Xbrl": null
     }
   ],
   "GSTReportId": "44713e4e-1f7a-40b8-b51d-9a5c3fc671af",
   "LegalName": "ABC Building Pty Ltd",
   "Lodgement": {
     "CashbookId": "e17417ac-fc79-4d4d-9ee8-1780b3bc326f",
     "Description": null,
     "DocumentId": null,
     "DueDate": null,
     "EndDate": "2017-03-31T00:00:00",
     "GSTReportId": "44713e4e-1f7a-40b8-b51d-9a5c3fc671af",
     "IsAmendment": false,
     "LodgeDate": null,
     "LodgementStatus": 1,
     "LodgementType": 0,
     "PeriodInDays": 0,
     "ReceiptNumber": null,
     "StartDate": "2017-01-01T00:00:00"
   },
   "ReportType": 1,
   "TemplateId": "79a11efe-dec4-43d1-a9e3-715dc26c2220",
   "Total": 0.0
 }

Details of each object 

Data Field

Description

Data Type

AmountTaxStatus

Whether the amounts in the bas are gst inclusive or not

Fixed numbers

1 - Non Taxed

2 - Inclusive

3 - Exclusive

CashBookID

Always a zero GUID. The CashBook ID can be found further into the response payload.

GUID

IncludeFBT

Whether the BAS includes FBT amounts or not

boolean true/false

IncludeFTC

Whether the BAS includes FTC amounts or not

boolean true/false

IncludeLTC

Whether the BAS includes LTC amounts or not

boolean true/false

IncludePAYGIOption1

Whether the BAS is set to PAYGI option 1 or not

boolean true/false

IncludePAYGIOption2

Whether the BAS is set to PAYGI option 2 or not

boolean true/false

IncludePAYGW

Whether the BAS is set to include PAYG WItholding or not

boolean true/false

IncludeWET

Whether the BAS includes WET tax amounts or not

boolean true/false

ReportingPeriodType

Can be ignored. Internal use only

GUID

CashBookID

The ID of the CashBook the BAS is from.

GUID

CompanyName

The name of the company the BAS is for

Text

Data

The array of the BAS data.

Array

Error

Whether a error was detected with this field on the bas. Remains the same definition for every field

Text. Will appear as null if no error.

XBRL

Not used. Future development. Remains the same definition for every field

Always Null

Label

The label from the BAS for the data eg 8A. Remains the same definition for every field

Numeric

GSTReportID

The unique GUID of the BAS from the book

GUID

LegalName

The legal name of the company stored in the book

Alphanumeric

Lodgement

Data related to the lodgement of the BAS

 

CashBookID

The id of the book

GUID

Description

Any description that has been typed in with the BAS return

Alphanumeric

DocumentID

Any document id that has been typed in with the BAS reutrn

Alphanumeric

DueDate

The due date for the BAS

Date/Time

EndDate

The end date for the BAS period

Date/Time

StartDate

The start date for the BAS period

Date/Time

IsAmendment

Whether this has been marked as a amended BAS for lodgement

Boolean true/false

LodgeDate

The date recorded for any lodgement of the BAS

Date/Time

LodgementStatus

Whether the BAS is marked lodged or not

Fixed numbers

1 - Draft

2 - Lodged

LodgementType

The way the BAS was lodged. Please note at the current time this will always respond 0 or 1.

Fixed numbers

0 - None

1 - Manual

2 - Electronic

ReceiptNumber

Any receipt number entered against a lodged BAS

Alphanumeric

ReportType

Where the report was lodged. This will always return 1 at the current time.

Fixed number

0 - None

1 - AU

TemplateID

Internal use only

N/A

Total

The total of the BAS refund/bill

Numeric

 


Need more help?

Ask the Reckon Community at: https://community.reckon.com/categories/reckonapi

How did we do?

Expenses API v1

Reports

Related Articles

BAS W1 Prefill on the ATO Business Portal displays the incorrect balance of Total Gross with Salary Sacrifice
Have not received confirmation that BAS was processed through GovConnect
Error: "BAS form format is unknown. The file will not be saved or exported" when saving the Instalment Activity Statement
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)