Tax returns

You can submit a tax return through Sage Regulatory Reporting for Australia, Canada, South Africa, and the United Kingdom. Multi-entity companies typically submit taxes from the top level. You can submit taxes for an individual entity only if the entity has a unique tax ID. For more information, see Submit taxes.

List tax returns

get/objects/tax/tax-return

Returns a collection with a key, ID, and link for each tax return. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionTaxes
Regional availabilityAustralia, Canada, France, South Africa, United Kingdom
User typeBusiness
PermissionsList Tax Returns
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/tax/tax-return/9"
      },
    • {
      • "key": "54",
      • "id": "54",
      • "href": "/objects/tax/tax-return/54"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a tax return
post/objects/tax/tax-return
Creates a new tax return.



Permissions and other requirements



SubscriptionTaxes


Regional availabilityAustralia, Canada, France, South Africa, United Kingdom


User typeBusiness


PermissionsAdd Tax Returns







SecurityOAuth2 
Request 
Request Body schema: application/json
Tax return to be created


name
required
string
Name for the tax return.


 
 Example:  "VAT Return Q1 2023"
taxId
required
string
Tax ID such as VAT registration number (VRN) or Australian Business Number (ABN) for the tax filing company or entity.


 
 Example:  "4490232727"
recipientEmail
required
string
The email address of the recipient for the tax return.


 
 Example:  "[email protected]"
required
object
The tax solution used for this tax return.


 
key
string
System-assigned unique key for the tax solution.


 
 Example:  "1"
id
string
Unique identifier for the tax solution.


 
 Example:  "United Kingdom - VAT"
id
string
System-assigned identifier for the tax return. The value is the same as the key for this object.


 
 Example:  "61"
submissionDate
string <date> 
The date the tax return was submitted.


 
 Example:  "2021-01-23"
submittersEmail
string
The email address of the person who submitted the tax return.


 
 Example:  "[email protected]"
setEmailAddressAsDefault
boolean
 Default:  true
Specifies whether the recipient's email should be used for the next submission for this tax ID.


 
 Example:  true
isAdjustingCompleted
boolean
 Default:  false
Specifies whether the entry in the adjusting journal is completed in Sage Intacct for the tax return.


 
 Example:  true
adjustmentNotes
string
Notes about an adjustment for the tax return.


 
 Example:  "VAT return notes"
object
The entity that the tax return is filed under.


 
key
string
System-assigned unique key for the reporting entity.


 
 Example:  "3"
id
string
Unique identifier for the reporting entity.


 
 Example:  "LOC-USA-0778"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "VAT_Sub",
  • "taxSolution": {
    • "key": "1"
    },
  • "taxId": "445025391",
  • "recipientEmail": "[email protected]"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "626",
    • "key": "626",
    • "href": "/objects/tax/tax-return/626"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a tax return
get/objects/tax/tax-return/{key}
Returns detailed information for a specified tax return.



Permissions and other requirements



SubscriptionTaxes


Regional availabilityAustralia, Canada, France, South Africa, United Kingdom


User typeBusiness


PermissionsView Tax Returns







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the tax return.


 
 Example:  105
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "9",
    • "key": "9",
    • "name": "Tax return ABCompany Q3",
    • "taxId": "30 616 935 623",
    • "recipientEmail": "[email protected]",
    • "submissionPeriodStartDate": "2019-06-01",
    • "submissionPeriodEndDate": "2020-02-29",
    • "submissionDate": "2020-03-03",
    • "submittersEmail": "[email protected]",
    • "legalCountryCode": "au",
    • "setEmailAddressAsDefault": true,
    • "currentStepStage": "submitToGovernment",
    • "currentStepStatus": "completed",
    • "adjustmentNotes": "Verified using tax solution",
    • "bundleNumber": "891204442498",
    • "receiptId": "4c907ee0-a76f-42a7-b582-1a3fb78ae4b8",
    • "reportingEntity": {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/entity/1"
      },
    • "taxSolution": {
      • "id": "Australia - GST",
      • "key": "2",
      • "href": "/objects/tax/tax-solution/2"
      },
    • "submissionType": null,
    • "taxProcessingSteps": [
      • {
        },
      • {
        },
      • {
        },
      • {
        },
      • {
        }
      ],
    • "relatedFiles": [
      • {
        },
      • {
        },
      • {
        },
      • {
        },
      • {
        },
      • {
        },
      • {
        },
      • {
        }
      ],
    • "href": "/objects/tax/tax-return/9"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a tax return
patch/objects/tax/tax-return/{key}
Updates an existing tax return by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionTaxes


Regional availabilityAustralia, Canada, France, South Africa, United Kingdom


User typeBusiness


PermissionsEdit Tax Returns







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the tax return.


 
 Example:  105
Request Body schema: application/json
name
string
Name for the tax return.


 
 Example:  "VAT Return Q1 2023"
taxId
string
Tax ID such as VAT registration number (VRN) or Australian Business Number (ABN) for the tax filing company or entity.


 
 Example:  "4490232727"
recipientEmail
string
The email address of the recipient for the tax return.


 
 Example:  "[email protected]"
submissionDate
string <date> 
The date the tax return was submitted.


 
 Example:  "2021-01-23"
submittersEmail
string
The email address of the person who submitted the tax return.


 
 Example:  "[email protected]"
setEmailAddressAsDefault
boolean
 Default:  true
Specifies whether the recipient's email should be used for the next submission for this tax ID.


 
 Example:  true
isAdjustingCompleted
boolean
 Default:  false
Specifies whether the entry in the adjusting journal is completed in Sage Intacct for the tax return.


 
 Example:  true
adjustmentNotes
string
Notes about an adjustment for the tax return.


 
 Example:  "VAT return notes"
object
The entity that the tax return is filed under.


 
key
string
System-assigned unique key for the reporting entity.


 
 Example:  "3"
id
string
Unique identifier for the reporting entity.


 
 Example:  "LOC-USA-0778"
object
The tax solution used for this tax return.


 
key
string
System-assigned unique key for the tax solution.


 
 Example:  "1"
id
string
Unique identifier for the tax solution.


 
 Example:  "United Kingdom - VAT"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "adjustmentNotes": "Tax Submission notes"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "105",
    • "id": "105",
    • "href": "/objects/tax/tax-return/105"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a tax return
delete/objects/tax/tax-return/{key}
Deletes a tax return.



Permissions and other requirements



SubscriptionTaxes


Regional availabilityAustralia, Canada, France, South Africa, United Kingdom


User typeBusiness


PermissionsDelete Tax Returns







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the tax return.


 
 Example:  105
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query tax returns
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "tax/tax-return"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "tax/tax-return",
  • "fields": [
    • "name",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "name": "id1690974955",
      • "href": "/objects/tax/tax-return/8"
      },
    • {
      • "name": "id1693165140",
      • "href": "/objects/tax/tax-return/15"
      },
    • {
      • "name": "id1693212346",
      • "href": "/objects/tax/tax-return/16"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}