Jump to

• Request
• Response

Get a tax regime

get

/fscmRestApi/resources/11.13.18.05/taxRegimesLOV/{TaxRegimeId}

Request

Path Parameters

• TaxRegimeId(required): integer(int64)
  The unique identifier of a tax regime.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : taxRegimesLOV-item-response

Type: object

Show Source

• CountryCode: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The country for which the tax regime is defined.
• CountryName: string
  Read Only: true

  Maximum Length: 255

  The country for which the tax regime is defined.
• EffectiveFrom: string (date)
  Read Only: true

  The date when a tax regime becomes effective.
• EffectiveTo: string (date)
  Title: End Date

  Read Only: true

  The date when a tax regimes stops being effective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RegnNumberSameAsLeFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the tax registration for the tax regime must be the same as the legal entity registration number.
• TaxRegimeCode: string
  Title: Tax Regime Code

  Read Only: true

  Maximum Length: 30

  The tax regime code associated with a country or group of countries.
• TaxRegimeId: integer (int64)
  Read Only: true

  The unique identifier of a tax regime.
• TaxRegimeName: string
  Title: Tax Regime Name

  Read Only: true

  Maximum Length: 80

  The tax regime name associated with a country or group of countries.
• UniquenessValidationLevel: string
  Read Only: true

  Maximum Length: 30

  The duplicate validation level for the tax registration number for this tax regime.
• UseTaxReportConfigFlag: boolean
  Title: Use tax reporting configuration

  Read Only: true

  Maximum Length: 1

  Indicates whether the tax registrations for the tax regime include additional tax reporting configuration.
• ValidationLevel: string
  Read Only: true

  Maximum Length: 30

  The outcome of any validation issues that will be applied to tax registration numbers entered on a tax registration record. If values aren't defined at the tax regime, tax or tax jurisdiction levels of the tax registration, then the value defined on the tax reporting type will be used.
• ValidationType: string
  Read Only: true

  Maximum Length: 30

  The reporting type defined for the registration number validation.

{
    "type":"object",
    "properties":{
        "CountryCode":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country for which the tax regime is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "maxLength":255,
            "type":"string",
            "description":"The country for which the tax regime is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveFrom":{
            "type":"string",
            "description":"The date when a tax regime becomes effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a tax regimes stops being effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RegnNumberSameAsLeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax registration for the tax regime must be the same as the legal entity registration number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxRegimeCode":{
            "title":"Tax Regime Code",
            "maxLength":30,
            "type":"string",
            "description":"The tax regime code associated with a country or group of countries.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaxRegimeId":{
            "type":"integer",
            "description":"The unique identifier of a tax regime.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaxRegimeName":{
            "title":"Tax Regime Name",
            "maxLength":80,
            "type":"string",
            "description":"The tax regime name associated with a country or group of countries.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniquenessValidationLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The duplicate validation level for the tax registration number for this tax regime.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseTaxReportConfigFlag":{
            "title":"Use tax reporting configuration",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the tax registrations for the tax regime include additional tax reporting configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The outcome of any validation issues that will be applied to tax registration numbers entered on a tax registration record. If values aren't defined at the tax regime, tax or tax jurisdiction levels of the tax registration, then the value defined on the tax reporting type will be used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationType":{
            "maxLength":30,
            "type":"string",
            "description":"The reporting type defined for the registration number validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top