Jump to

• Request
• Response

Update a third-party site tax reporting code association

patch

/fscmRestApi/resources/11.13.18.05/thirdPartySiteTaxReportingCodeAssociations/{ReportingCodeAssocId}

Request

Path Parameters

• ReportingCodeAssocId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• EffectiveTo: string (date)
  The effective end date for the association between the third-party site and the reporting code.
• PartyNumber: string
  Maximum Length: 255

  The identifying number of the third party.
• PartySiteNumber: string
  Maximum Length: 255

  The identifying number of the third-party site.
• TaxReportingTypeCode: string
  Maximum Length: 255

  The reporting type code.

{
    "type":"object",
    "properties":{
        "PartySiteNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The identifying number of the third-party site.",
            "nullable":true
        },
        "PartyNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The identifying number of the third party.",
            "nullable":true
        },
        "TaxReportingTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The reporting type code.",
            "nullable":true
        },
        "EffectiveTo":{
            "type":"string",
            "description":"The effective end date for the association between the third-party site and the reporting code.",
            "format":"date",
            "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:
  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 : thirdPartySiteTaxReportingCodeAssociations-item-response

Type: object

Show Source

• EffectiveFrom: string (date)
  The effective start date for the association between the third-party site and the reporting code.
• EffectiveTo: string (date)
  The effective end date for the association between the third-party site and the reporting code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the third party.
• PartyNumber: string
  Maximum Length: 255

  The identifying number of the third party.
• PartySiteName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  The name of the third-party site.
• PartySiteNumber: string
  Maximum Length: 255

  The identifying number of the third-party site.
• PartyTaxProfileId: integer (int64)
  Read Only: true

  The unique identifier of the party site tax profile.
• ReportingCodeAssocId: integer (int64)
  The unique identifier of the association between the third-party site and the reporting code.
• ReportingCodeCharValue: string
  Maximum Length: 60

  Alphanumeric value of the reporting code.
• ReportingCodeDateValue: string (date)
  Date value of the reporting code.
• ReportingCodeNumericValue: integer (int64)
  Numeric value of the reporting code.
• TaxReportingTypeCode: string
  Maximum Length: 255

  The reporting type code.

{
    "type":"object",
    "properties":{
        "ReportingCodeNumericValue":{
            "type":"integer",
            "description":"Numeric value of the reporting code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxReportingTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The reporting type code.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the third party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The identifying number of the third-party site.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportingCodeDateValue":{
            "type":"string",
            "description":"Date value of the reporting code.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The identifying number of the third party.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportingCodeCharValue":{
            "maxLength":"60",
            "type":"string",
            "description":"Alphanumeric value of the reporting code.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the third-party site.",
            "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"
            }
        },
        "EffectiveFrom":{
            "type":"string",
            "description":"The effective start date for the association between the third-party site and the reporting code.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ReportingCodeAssocId":{
            "type":"integer",
            "description":"The unique identifier of the association between the third-party site and the reporting code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyTaxProfileId":{
            "type":"integer",
            "description":"The unique identifier of the party site tax profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EffectiveTo":{
            "type":"string",
            "description":"The effective end date for the association between the third-party site and the reporting code.",
            "format":"date",
            "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