Create a tax partner for tax calculation integration
post
/fscmRestApi/resources/11.13.18.05/taxPartnerRegistrations
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ConnectionPassword: string
Title:
Connection Password
The password of the tax partner calculation application, which is used for determining transaction tax. -
ConnectionUserName: string
Title:
Connection User Name
The user name of the tax partner calculation application, which is used for determining transaction tax. -
DocumentId: string
Title:
Document ID
The unique identifier of the file that is passed to the Import Tax Lines operation. -
EndpointURL: string
Title:
Endpoint URL
The URL for the tax partner's tax calculation application, which is used for determining transaction tax. -
OperationName: string
Title:
Operation Name
Maximum Length:255
The name of the tax partner service operation that is invoked. -
ReqstId: string
Title:
Request ID
The unique identifier of the scheduled process job request that is used to register the tax partner. -
TaxPartnerName: string
Title:
Tax Partner Name
The tax partner name that identifies the tax partner's tax calculation application used for determining transaction tax.
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.
Root Schema : taxPartnerRegistrations-item-response
Type:
Show Source
object
-
ConnectionPassword: string
Title:
Connection Password
The password of the tax partner calculation application, which is used for determining transaction tax. -
ConnectionUserName: string
Title:
Connection User Name
The user name of the tax partner calculation application, which is used for determining transaction tax. -
DocumentId: string
Title:
Document ID
The unique identifier of the file that is passed to the Import Tax Lines operation. -
EndpointURL: string
Title:
Endpoint URL
The URL for the tax partner's tax calculation application, which is used for determining transaction tax. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Operation Name
Maximum Length:255
The name of the tax partner service operation that is invoked. -
ReqstId: string
Title:
Request ID
The unique identifier of the scheduled process job request that is used to register the tax partner. -
Status: string
Title:
Status
Read Only:true
The code corresponding to the current status of the Register Tax Partner operation. -
TaxPartnerName: string
Title:
Tax Partner Name
The tax partner name that identifies the tax partner's tax calculation application used for determining transaction tax.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.