REST Auth API: TaxRates

A TaxRate resource represents an available tax rate for use with OrderLines and CreditNoteLines.

TaxRate instance resource

Resource URI

/api/2012-02-01/auth/resources/taxrates/{TaxRateID}/

Resource properties

Property	Description
TaxRateID	A integer value that uniquely identifies this resource within the platform.
Name	A string representing the descriptive name for this tax, up to 64 characters long.
RatePercent	The percentage rate of the tax.

HTTP GET

Returns a representation of a TaxRate, including the properties above.

Example

GET /api/2012-02-01/auth/resources/taxrates/1/

<TaxRate>
  <TaxRateID>1</TaxRateID>
  <Name>GST (15%)</Name>
  <RatePercent>15.00</RatePercent>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/1/"/>
</TaxRate>

TaxRate collection resource

The TaxRate collection resource represents the set of all TaxRates available on the platform.

Resource URI

/api/2012-02-01/auth/resources/taxrates/

Returns a representation of the collection as a set of Link elements which can be followed to access individual TaxRate resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.
filter	A filter expression to apply to the collection. See collection filters. The following properties (and link titles) may be used in filter expressions: `TaxRateID` `Name`
orderby	A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions: `TaxRateID` `Name`
skip	Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The `skip` and `top` parameters are generally used for collection paging.
top	Returns a subset of records from the collection, starting at index 0 or index `skip`, and returns the first N records. The `skip` and `top` parameters are generally used for collection paging.

Example 1

Retrieve a collection of TaxRate links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/taxrates/

<TaxRates>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/1/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/2/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/3/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/4/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/"/>
</TaxRates>

Example 2

Retrieve a collection of TaxRate links with the default parameters, with TaxRate link expansion.

GET /api/2012-02-01/auth/resources/taxrates/?expand=TaxRate

<TaxRates>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/1/">
    <TaxRate>
      <TaxRateID>1</TaxRateID>
      <Name>GST (15%)</Name>
      <RatePercent>15.00</RatePercent>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/1/"/>
    </TaxRate>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/2/">
    <TaxRate>
      <TaxRateID>2</TaxRateID>
      <Name>GST (10%)</Name>
      <RatePercent>10.00</RatePercent>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/2/"/>
    </TaxRate>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/?expand=TaxRate&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/?expand=TaxRate"/>
</TaxRates>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.