Jump to

• Request
• Response
• Examples

Get all tax registrations

get

/fscmRestApi/resources/11.13.18.05/taxRegistrations

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ManageTaxRegistrationsRF: Finds all tax registrations that match the specified party number, party name, party type code, and country.
    Finder Variables:
    • country; string; The tax registration country of the resource.
    • partyName; string; The tax registration party name of the resource.
    • partyNumber; string; The tax registration party number of the resource.
    • partyTypeCode; string; The tax registration party type code of the resource.
  • PrimaryKey: Finds all tax registrations that match the specified registration identifier.
    Finder Variables:
    • RegistrationId; integer; The unique identifier of the tax registration.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BankAccountNumber; string; The bank account number associated with a tax registration.
  • BankBranchId; integer; The unique identifier for the bank branch associated with a tax registration.
  • BankId; integer; The unique identifier for the bank associated with a tax registration.
  • CollTaxAuthorityId; integer; The unique identifier for the collecting tax authority.
  • Country; string; The name of the country where tax is registered.
  • CountryCode; string; The country code used to validate the tax registration number for a party tax profile.
  • DefaultRegistrationFlag; boolean; Indicates whether a tax registration is set as default registration. The default value is FALSE.
  • EffectiveFrom; string; The date when the tax registration for a period starts being effective.
  • EffectiveTo; string; The date when the tax registration for a period stops being effective.
  • InclusiveTaxFlag; boolean; Indicates whether a tax registration is tax inclusive. The default value is FALSE.
  • IssuingTaxAuthority; string; The issuing tax authority for a tax registration.
  • LegalLocationId; integer; The unique identifier of the legal location for a tax registration.
  • LegalRegistrationAddress; string; The address of the legal tax registration that is defined.
  • PartyCountryCode; string; The country of the party for which a tax registration is defined.
  • PartyName; string; The name of the party for which the party tax profile is defined.
  • PartyNumber; string; The party number for which the party tax profile is defined.
  • PartySiteNumber; string; The party site number for which the party tax profile is defined.
  • PartyTaxAllowOffsetTaxFlag; boolean; Indicates whether the party tax profile is set up to allow offset tax. The default value is FALSE.
  • PartyTaxClassificationCode; string; The tax classification code for the party tax profile associated with a tax registration.
  • PartyTaxInclusiveTaxFlag; boolean; Indicates whether a party tax profile supports inclusive taxes. The default value is FALSE.
  • PartyTaxProcessForApplicabilityFlag; boolean; Indicates whether the party tax profile is applied during the tax determination process.
  • PartyTaxProfileId; integer; The unique identifier for the party tax profile.
  • PartyTaxRoundingLevelCode; string; The rounding level code defined for a tax registration associated with a party tax profile.
  • PartyTaxRoundingRuleCode; string; The rounding rule code for the party tax profile associated with a tax registration.
  • PartyTypeCode; string; The party type code of the party tax profile.
  • RegistrationId; integer; The unique identifier of the system-generated primary key column.
  • RegistrationNumber; string; The company tax registration number assigned by a tax authority.
  • RegistrationReasonCode; string; The registration reason code for tax registrations.
  • RegistrationSourceCode; string; The registration source code for tax registrations.
  • RegistrationStatusCode; string; The registration status code for tax registrations.
  • RegistrationTypeCode; string; The tax registration type represents the legal type of tax for which a tax registration is issued, such as VAT.
  • RepresentativePartyTaxName; string; The name of the reporting party for tax registrations.
  • RoundingLevelCode; string; The value that specifies the rounding to apply to tax amounts on a transaction. The valid values are HEADER and LINE.
  • RoundingRuleCode; string; The rule that defines how the rounding must be performed on a value involved in a taxable transaction. Possible values range from the next highest value to the next lowest or nearest value.
  • Tax; string; The tax code associated with a tax registration.
  • TaxAuthorityId; integer; The unique identifier of the tax authority associated with an existing tax registration.
  • TaxClassificationCode; string; The tax classification code associated with a tax registration.
  • TaxJurisdictionCode; string; The location for which a tax registration is defined.
  • TaxPointBasis; string; The point in the receipt transaction process where taxes are accounted and reported to the tax authorities. Tax points can be classified into delivery-based and invoice-based categories.
  • TaxRegimeCode; string; The tax regime code associated with a tax registration.
  • UniquenessValidationLevel; string; The types of parties to be checked for duplicate tax registration numbers entered on a tax registration record.
  • ValidationLevel; string; The level at which validation for duplicate registration numbers are raised to users. Possible values are ERROR and WARNING.
  • ValidationRule; string; The code for the validation that is to be applied to tax registration numbers for a tax regime.
  • ValidationType; string; The validation type for tax registrations.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

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 : taxRegistrations

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/taxRegistrations-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object taxRegistrations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/taxRegistrations-item-response"
    }
}

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 : taxRegistrations-item-response

Type: object

Show Source

• BankAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The bank account number associated with a tax registration.
• BankBranchId: integer (int64)
  The unique identifier for the bank branch associated with a tax registration.
• BankId: integer (int64)
  The unique identifier for the bank associated with a tax registration.
• CollTaxAuthorityId: integer (int64)
  The unique identifier for the collecting tax authority.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 255

  The name of the country where tax is registered.
• CountryCode: string
  Title: Country Code

  The country code used to validate the tax registration number for a party tax profile.
• DefaultRegistrationFlag: boolean
  Title: Set as default registration

  Maximum Length: 1

  Default Value: false

  Indicates whether a tax registration is set as default registration. The default value is FALSE.
• EffectiveFrom: string (date)
  Title: Start Date

  The date when the tax registration for a period starts being effective.
• EffectiveTo: string (date)
  Title: End Date

  The date when the tax registration for a period stops being effective.
• InclusiveTaxFlag: boolean
  Title: Set Invoice Values as Tax Inclusive

  Maximum Length: 1

  Default Value: false

  Indicates whether a tax registration is tax inclusive. The default value is FALSE.
• IssuingTaxAuthority: string
  Title: Issuing Tax Authority

  The issuing tax authority for a tax registration.
• LegalLocationId: integer (int64)
  The unique identifier of the legal location for a tax registration.
• LegalRegistrationAddress: string
  Title: Legal Registration Address

  The address of the legal tax registration that is defined.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyCountryCode: string
  Title: Country Code

  Read Only: true

  Maximum Length: 255

  The country of the party for which a tax registration is defined.
• PartyName: string
  Title: Party Name

  Maximum Length: 255

  The name of the party for which the party tax profile is defined.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 255

  The party number for which the party tax profile is defined.
• PartySiteNumber: string
  Title: Party Site Number

  Maximum Length: 255

  The party site number for which the party tax profile is defined.
• PartyTaxAllowOffsetTaxFlag: boolean
  Title: Allow offset tax calculation

  Indicates whether the party tax profile is set up to allow offset tax. The default value is FALSE.
• PartyTaxClassificationCode: string
  Title: Tax Classification Code

  The tax classification code for the party tax profile associated with a tax registration.
• PartyTaxInclusiveTaxFlag: boolean
  Title: Set Invoice Values as Tax Inclusive

  Indicates whether a party tax profile supports inclusive taxes. The default value is FALSE.
• PartyTaxProcessForApplicabilityFlag: boolean
  Title: Tax Applicability

  Indicates whether the party tax profile is applied during the tax determination process.
• PartyTaxProfileId: integer (int64)
  The unique identifier for the party tax profile.
• PartyTaxRoundingLevelCode: string
  Title: Rounding Level

  The rounding level code defined for a tax registration associated with a party tax profile.
• PartyTaxRoundingRuleCode: string
  Title: Rounding Rule

  The rounding rule code for the party tax profile associated with a tax registration.
• PartyTypeCode: string
  Title: Party Type

  Maximum Length: 255

  The party type code of the party tax profile.
• RegistrationId: integer (int64)
  The unique identifier of the system-generated primary key column.
• RegistrationNumber: string
  Title: Registration Number

  Maximum Length: 50

  The company tax registration number assigned by a tax authority.
• RegistrationReasonCode: string
  Title: Tax Registration Reason

  Maximum Length: 30

  The registration reason code for tax registrations.
• RegistrationSourceCode: string
  Title: Source

  Maximum Length: 30

  The registration source code for tax registrations.
• RegistrationStatusCode: string
  Title: Tax Registration Status

  Maximum Length: 30

  The registration status code for tax registrations.
• RegistrationTypeCode: string
  Title: Tax Registration Type

  Maximum Length: 30

  The tax registration type represents the legal type of tax for which a tax registration is issued, such as VAT.
• RepresentativePartyTaxName: string
  Title: Reporting Party Tax Name

  Maximum Length: 80

  The name of the reporting party for tax registrations.
• RoundingLevelCode: string
  Title: Rounding Level

  Maximum Length: 30

  The value that specifies the rounding to apply to tax amounts on a transaction. The valid values are HEADER and LINE.
• RoundingRuleCode: string
  Title: Rounding Rule

  Maximum Length: 30

  The rule that defines how the rounding must be performed on a value involved in a taxable transaction. Possible values range from the next highest value to the next lowest or nearest value.
• Tax: string
  Title: Tax

  Maximum Length: 30

  The tax code associated with a tax registration.
• TaxAuthorityId: integer (int64)
  The unique identifier of the tax authority associated with an existing tax registration.
• TaxClassificationCode: string
  Title: Tax Classification Code

  Maximum Length: 30

  The tax classification code associated with a tax registration.
• TaxJurisdictionCode: string
  Title: Tax Jurisdiction Code

  Maximum Length: 30

  The location for which a tax registration is defined.
• TaxPointBasis: string
  Title: Tax Point Basis

  Maximum Length: 30

  The point in the receipt transaction process where taxes are accounted and reported to the tax authorities. Tax points can be classified into delivery-based and invoice-based categories.
• TaxRegimeCode: string
  Title: Tax Regime Code

  Maximum Length: 30

  The tax regime code associated with a tax registration.
• UniquenessValidationLevel: string
  Title: Duplicate Validation Level

  Maximum Length: 30

  The types of parties to be checked for duplicate tax registration numbers entered on a tax registration record.
• ValidationLevel: string
  Title: Validation Level

  Maximum Length: 30

  The level at which validation for duplicate registration numbers are raised to users. Possible values are ERROR and WARNING.
• ValidationRule: string
  Title: Validation Level

  Maximum Length: 30

  The code for the validation that is to be applied to tax registration numbers for a tax regime.
• ValidationType: string
  Title: Validation Type

  Maximum Length: 30

  The validation type for tax registrations.

{
    "type":"object",
    "properties":{
        "PartyTaxInclusiveTaxFlag":{
            "title":"Set Invoice Values as Tax Inclusive",
            "type":"boolean",
            "description":"Indicates whether a party tax profile supports inclusive taxes. The default value is FALSE.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the party for which the party tax profile is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "Tax":{
            "title":"Tax",
            "maxLength":"30",
            "type":"string",
            "description":"The tax code associated with a tax registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "PartyCountryCode":{
            "title":"Country Code",
            "maxLength":"255",
            "type":"string",
            "description":"The country of the party for which a tax registration is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteNumber":{
            "title":"Party Site Number",
            "maxLength":"255",
            "type":"string",
            "description":"The party site number for which the party tax profile is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxPointBasis":{
            "title":"Tax Point Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The point in the receipt transaction process where taxes are accounted and reported to the tax authorities. Tax points can be classified into delivery-based and invoice-based categories.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTypeCode":{
            "title":"Party Type",
            "maxLength":"255",
            "type":"string",
            "description":"The party type code of the party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistrationTypeCode":{
            "title":"Tax Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"The tax registration type represents the legal type of tax for which a tax registration is issued, such as VAT.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_REGISTRATION_TYPES"
            },
            "x-queryable":true
        },
        "PartyTaxRoundingLevelCode":{
            "title":"Rounding Level",
            "type":"string",
            "description":"The rounding level code defined for a tax registration associated with a party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxAuthorityId":{
            "type":"integer",
            "description":"The unique identifier of the tax authority associated with an existing tax registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegistrationStatusCode":{
            "title":"Tax Registration Status",
            "maxLength":"30",
            "type":"string",
            "description":"The registration status code for tax registrations.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_REGISTRATIONS_STATUS"
            },
            "x-queryable":true
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"50",
            "type":"string",
            "description":"The company tax registration number assigned by a tax authority.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "TaxRegimeCode":{
            "title":"Tax Regime Code",
            "maxLength":"30",
            "type":"string",
            "description":"The tax regime code associated with a tax registration.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyTaxAllowOffsetTaxFlag":{
            "title":"Allow offset tax calculation",
            "type":"boolean",
            "description":"Indicates whether the party tax profile is set up to allow offset tax. The default value is FALSE.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "type":"string",
            "description":"The country code used to validate the tax registration number for a party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the tax registration for a period stops being effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UniquenessValidationLevel":{
            "title":"Duplicate Validation Level",
            "maxLength":"30",
            "type":"string",
            "description":"The types of parties to be checked for duplicate tax registration numbers entered on a tax registration record.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTaxProcessForApplicabilityFlag":{
            "title":"Tax Applicability",
            "type":"boolean",
            "description":"Indicates whether the party tax profile is applied during the tax determination process.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTaxClassificationCode":{
            "title":"Tax Classification Code",
            "type":"string",
            "description":"The tax classification code for the party tax profile associated with a tax registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RegistrationReasonCode":{
            "title":"Tax Registration Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The registration reason code for tax registrations.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_REGISTRATIONS_REASON"
            },
            "x-queryable":true
        },
        "CollTaxAuthorityId":{
            "type":"integer",
            "description":"The unique identifier for the collecting tax authority.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RegistrationId":{
            "type":"integer",
            "description":"The unique identifier of the system-generated primary key column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValidationType":{
            "title":"Validation Type",
            "maxLength":"30",
            "type":"string",
            "description":"The validation type for tax registrations.",
            "nullable":true,
            "x-queryable":true
        },
        "InclusiveTaxFlag":{
            "title":"Set Invoice Values as Tax Inclusive",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a tax registration is tax inclusive. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_YES_NO"
            },
            "x-queryable":true
        },
        "BankBranchId":{
            "type":"integer",
            "description":"The unique identifier for the bank branch associated with a tax registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BankId"
                ]
            },
            "x-queryable":true
        },
        "ValidationRule":{
            "title":"Validation Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the validation that is to be applied to tax registration numbers for a tax regime.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingTaxAuthority":{
            "title":"Issuing Tax Authority",
            "type":"string",
            "description":"The issuing tax authority for a tax registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"255",
            "type":"string",
            "description":"The party number for which the party tax profile is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxJurisdictionCode":{
            "title":"Tax Jurisdiction Code",
            "maxLength":"30",
            "type":"string",
            "description":"The location for which a tax registration is defined.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Tax",
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "PartyTaxRoundingRuleCode":{
            "title":"Rounding Rule",
            "type":"string",
            "description":"The rounding rule code for the party tax profile associated with a tax registration.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalLocationId":{
            "type":"integer",
            "description":"The unique identifier of the legal location for a tax registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoundingLevelCode":{
            "title":"Rounding Level",
            "maxLength":"30",
            "type":"string",
            "description":"The value that specifies the rounding to apply to tax amounts on a transaction. The valid values are HEADER and LINE.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_ROUNDING_LEVEL"
            },
            "x-queryable":true
        },
        "LegalRegistrationAddress":{
            "title":"Legal Registration Address",
            "type":"string",
            "description":"The address of the legal tax registration that is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RepresentativePartyTaxName":{
            "title":"Reporting Party Tax Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the reporting party for tax registrations.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxClassificationCode":{
            "title":"Tax Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"The tax classification code associated with a tax registration.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the country where tax is registered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the tax registration for a period starts being effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ValidationLevel":{
            "title":"Validation Level",
            "maxLength":"30",
            "type":"string",
            "description":"The level at which validation for duplicate registration numbers are raised to users. Possible values are ERROR and WARNING.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistrationSourceCode":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"The registration source code for tax registrations.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_REGISTRATIONS_SOURCE"
            },
            "x-queryable":true
        },
        "DefaultRegistrationFlag":{
            "title":"Set as default registration",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a tax registration is set as default registration. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_YES_NO"
            },
            "x-queryable":true
        },
        "BankId":{
            "type":"integer",
            "description":"The unique identifier for the bank associated with a tax registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoundingRuleCode":{
            "title":"Rounding Rule",
            "maxLength":"30",
            "type":"string",
            "description":"The rule that defines how the rounding must be performed on a value involved in a taxable transaction. Possible values range from the next highest value to the next lowest or nearest value.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"ZX_ROUNDING_RULE"
            },
            "x-queryable":true
        },
        "BankAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The bank account number associated with a tax registration.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTaxProfileId":{
            "type":"integer",
            "description":"The unique identifier for the party tax profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

Examples

The following example shows how to retrieve all the tax registrations by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "PartyTypeCode": "THIRD_PARTY_SITE",
            "PartyName": "AT&T Universal Card",
            "PartyNumber": "1005",
            "PartySiteNumber": "4643",
            "TaxRegimeCode": "IT VAT",
            "Tax": "IT VAT",
            "TaxJurisdictionCode": null,
            "TaxPointBasis": null,
            "RegistrationTypeCode": "VAT",
            "RegistrationStatusCode": "REGISTERED",
            "RepresentativePartyTaxName": null,
            "RegistrationReasonCode": null,
            "EffectiveFrom": "1973-01-01",
            "EffectiveTo": null,
            "LegalRegistrationAddress": null,
            "ValidationType": null,
            "ValidationLevel": null,
            "ValidationRule": null,
            "RegistrationNumber": "01098766759",
            "RegistrationSourceCode": null,
            "IssuingTaxAuthority": null,
            "DefaultRegistrationFlag": false,
            "RoundingRuleCode": "NEAREST",
            "InclusiveTaxFlag": false,
            "BankAccountNumber": null,
            "TaxClassificationCode": null,
            "UniquenessValidationLevel": null,
            "Country": "Italy",
            "PartyCountryCode": "IT",
            "BankBranchId": null,
            "BankId": null,
            "CollTaxAuthorityId": null,
            "LegalLocationId": null,
            "PartyTaxProfileId": 847064,
            "RoundingLevelCode": null,
            "TaxAuthorityId": null,
            "RegistrationId": 100000011813021,
            "PartyTaxAllowOffsetTaxFlag": null,
            "PartyTaxRoundingLevelCode": null,
            "PartyTaxInclusiveTaxFlag": null,
            "PartyTaxClassificationCode": null,
            "PartyTaxRoundingRuleCode": null,
            "PartyTaxProcessForApplicabilityFlag": null,
            "CountryCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021",
                    "name": "taxRegistrations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021",
                    "name": "taxRegistrations",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/roundingRules",
                    "name": "roundingRules",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/taxClassifications",
                    "name": "taxClassifications",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/legalLocations",
                    "name": "legalLocations",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/taxAuthorityProfiles",
                    "name": "taxAuthorityProfiles",
                    "kind": "collection"
                }
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations",
            "name": "taxRegistrations",
            "kind": "collection"
        }
    ]
}

Back to Top