POST/shorts.v1alpha1.StockService/GetCompanyTaxProfile

GetCompanyTaxProfile

Get an ASX-listed entity's annual corporate-tax profile (ATO transparency data).

Parameters

Connect-Protocol-VersionheaderRequired

number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader

number

Define the timeout, in ms

Request Body

application/json

object

Request for GetCompanyTaxProfile RPC

productCodestring

(proto string)

Responses

200Success

application/json

object

Response for GetCompanyTaxProfile RPC

abnstring

(proto string)

entityNamestring

(proto string)

sourceAttributionstring

(proto string)

yearsarray

(proto shorts.v1alpha1.CompanyTaxYear)

Array Items:

object

One income year of ATO corporate-tax transparency data for an entity. has_taxable_income / has_tax_payable distinguish a genuine zero from "not reported" (the ATO leaves these blank; blank is meaningful, not zero).

defaultError

application/json

object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:

object

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.StockService/GetCompanyTaxProfile" \
  -H "Content-Type: application/json" \
  -d '{
  "productCode": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.StockService/GetCompanyTaxProfile" \
  -H "Content-Type: application/json" \
  -d '{
  "productCode": "string"
}'