Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ConnectionUserName":{
            "title":"Connection User Name",
            "type":"string",
            "description":"The user name of the tax partner calculation application, which is used for determining transaction tax.",
            "nullable":true
        },
        "OperationName":{
            "title":"Operation Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the tax partner service operation that is invoked.",
            "nullable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"string",
            "description":"The unique identifier of the file that is passed to the Import Tax Lines operation.",
            "nullable":true
        },
        "TaxPartnerName":{
            "title":"Tax Partner Name",
            "type":"string",
            "description":"The tax partner name that identifies the tax partner's tax calculation application used for determining transaction tax.",
            "nullable":true
        },
        "EndpointURL":{
            "title":"Endpoint URL",
            "type":"string",
            "description":"The URL for the tax partner's tax calculation application, which is used for determining transaction tax.",
            "nullable":true
        },
        "ReqstId":{
            "title":"Request ID",
            "type":"string",
            "description":"The unique identifier of the scheduled process job request that is used to register the tax partner.",
            "nullable":true
        },
        "ConnectionPassword":{
            "title":"Connection Password",
            "type":"string",
            "description":"The password of the tax partner calculation application, which is used for determining transaction tax.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : taxPartnerRegistrations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"The code corresponding to the current status of the Register Tax Partner operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConnectionUserName":{
            "title":"Connection User Name",
            "type":"string",
            "description":"The user name of the tax partner calculation application, which is used for determining transaction tax.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Operation Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the tax partner service operation that is invoked.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"string",
            "description":"The unique identifier of the file that is passed to the Import Tax Lines operation.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxPartnerName":{
            "title":"Tax Partner Name",
            "type":"string",
            "description":"The tax partner name that identifies the tax partner's tax calculation application used for determining transaction tax.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndpointURL":{
            "title":"Endpoint URL",
            "type":"string",
            "description":"The URL for the tax partner's tax calculation application, which is used for determining transaction tax.",
            "nullable":true,
            "x-queryable":true
        },
        "ReqstId":{
            "title":"Request ID",
            "type":"string",
            "description":"The unique identifier of the scheduled process job request that is used to register the tax partner.",
            "nullable":true,
            "x-queryable":true
        },
        "ConnectionPassword":{
            "title":"Connection Password",
            "type":"string",
            "description":"The password of the tax partner calculation application, which is used for determining transaction tax.",
            "nullable":true,
            "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