Taxes Endpoint Reference

Sage Accounting API v3 - Taxes (v1.2.0)

Download OpenAPI specification: Download

Contact: Sage One API Team sageoneapi@sage.com

Documentation of the Sage One Accounts API.

tax_offices

Operations about tax_offices

Returns all Tax Offices.

Returns all Tax Offices.

Parameters
query Parameters ?
show_legacy_id
boolean

Display the legacy_id for the Tax Offices.

items_per_page
integer <int32> [ 1 .. 200 ]
20

Returns the given number of Tax Offices per request.

page
integer <int32>
1

Go to specific page of Tax Offices

attributes
string

Specify the attributes that you want to expose for the Tax Offices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

Responses

200 Returns all Tax Offices.
Response Schema
get
/tax_offices

Server URL

/tax_offices

Response samples

  • 200 Returns all Tax Offices.

Copy Expand all Collapse all 
[
  • {
    }
]

Returns a single Tax Office.

Returns a single Tax Office.

Parameters
path Parameters ?
key
string Required

The Tax Office Key.

query Parameters ?
show_legacy_id
boolean

Display the legacy_id for the Tax Office.

attributes
string

Specify the attributes that you want to expose for the Tax Office (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

Responses

200 Returns a single Tax Office.
Response Schema
get
/tax_offices/{key}

Server URL

/tax_offices/{key}

Response samples

  • 200 Returns a single Tax Office.

Copy Expand all Collapse all 
{
  • "legacy_id": 0,
  • "id": "string",
  • "displayed_as": "string",
  • "$path": "string",
  • "office_number": "string",
  • "name": "string"
}

tax_profiles

Operations about tax_profiles

Returns all Tax Profiles.

Returns all Tax Profiles.

Parameters
query Parameters ?
updated_or_created_since
string <date-time>

Use this to limit the response to Tax Profiles changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.

show_legacy_id
boolean

Display the legacy_id for the Tax Profiles.

items_per_page
integer <int32> [ 1 .. 200 ]
20

Returns the given number of Tax Profiles per request.

page
integer <int32>
1

Go to specific page of Tax Profiles

attributes
string

Specify the attributes that you want to expose for the Tax Profiles (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

Responses

200 Returns all Tax Profiles.
Response Schema
get
/tax_profiles

Server URL

/tax_profiles

Response samples

  • 200 Returns all Tax Profiles.

Copy Expand all Collapse all 
[
  • {
    }
]

Returns a single Tax Profile.

Returns a single Tax Profile.

Parameters
path Parameters ?
key
string Required

The Tax Profile Key.

query Parameters ?
show_legacy_id
boolean

Display the legacy_id for the Tax Profile.

attributes
string

Specify the attributes that you want to expose for the Tax Profile (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

Responses

200 Returns a single Tax Profile.
Response Schema
get
/tax_profiles/{key}

Server URL

/tax_profiles/{key}

Response samples

  • 200 Returns a single Tax Profile.

Copy Expand all Collapse all 
{
  • "legacy_id": 0,
  • "id": "string",
  • "displayed_as": "string",
  • "$path": "string",
  • "transaction": 
    {
    },
  • "transaction_type": 
    {
    },
  • "created_at": "2025-05-09T14:55:27Z",
  • "updated_at": "2025-05-09T14:55:27Z",
  • "tax_type": 
    {
    },
  • "tax_number": "string",
  • "tax_number_suffix": "string",
  • "collect_tax": true,
  • "tax_return_frequency": 
    {
    }
}

Returns a single Tax Profile that has been updated.

Returns a single Tax Profile that has been updated.

Parameters
path Parameters ?
key
string Required

The Tax Profile Key.

Request Body

tax_profile
tax_profile
transaction_id
string

The ID of the Transaction.
transaction_type_id
string

The ID of the Transaction Type.
tax_type_id
string

The ID of the Tax Type.
tax_number
string

The tax number
tax_number_suffix
string

The tax number suffix
collect_tax
boolean

Indicates whether tax is collected for this tax type
tax_return_frequency_id
string

The ID of the Tax Return Frequency.

Responses

200 Returns a single Tax Profile that has been updated.
Response Schema
put
/tax_profiles/{key}

Server URL

/tax_profiles/{key}
Request samples
Copy Expand all Collapse all 
{
  • "tax_profile": 
    {
    }
}

Response samples

  • 200 Returns a single Tax Profile that has been updated.

Copy Expand all Collapse all 
{
  • "legacy_id": 0,
  • "id": "string",
  • "displayed_as": "string",
  • "$path": "string",
  • "transaction": 
    {
    },
  • "transaction_type": 
    {
    },
  • "created_at": "2025-05-09T14:55:27Z",
  • "updated_at": "2025-05-09T14:55:27Z",
  • "tax_type": 
    {
    },
  • "tax_number": "string",
  • "tax_number_suffix": "string",
  • "collect_tax": true,
  • "tax_return_frequency": 
    {
    }
}

tax_rates

Operations about tax_rates

tax_return_frequencies

Operations about tax_return_frequencies

tax_schemes

Operations about tax_schemes

tax_types

Operations about tax_types