Jump to

• Request
• Response

Get a receivables invoice line tax line

get

/fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTaxLines/{CustomerTransactionLineId2}

Request

Path Parameters

• CustomerTransactionId(required): integer(int64)
  The unique identifier of the invoice.
• CustomerTransactionLineId(required): integer(int64)
  The unique identifier of an invoice line.
• CustomerTransactionLineId2(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=

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 : receivablesInvoices-receivablesInvoiceLines-receivablesInvoiceLineTaxLines-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CustomerTransactionLineId: integer (int64)
  Title: Transaction Line ID

  The unique identifier of each separate tax line of the invoice.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlaceOfSupply: integer
  Title: Place of Supply

  Read Only: true

  The location where the transaction on the invoice line is determined to take place for tax purposes.
• Tax: string
  Title: Tax

  Maximum Length: 80

  The code of the tax assigned to the tax line.
• TaxableAmount: number
  Title: Taxable Amount

  Read Only: true

  The amount on the invoice line eligible for taxation. The tax rate is applied to the taxable amount.
• TaxAmount: number
  Title: Tax Amount

  The tax amount on the invoice line in the entered currency.
• TaxInclusiveIndicator: string
  Title: Tax Inclusive Indicator

  Maximum Length: 255

  The option that indicates whether the invoice line amount is inclusive of tax.
• TaxJurisdictionCode: string
  Title: Tax Jurisdiction Code

  Maximum Length: 80

  The tax jurisdiction code assigned to the tax line.
• TaxLineNumber: integer
  Title: Tax Line Number

  Read Only: true

  The line number of the tax line of the invoice line.
• TaxPointBasis: string
  Title: Tax Point Basis

  Read Only: true

  Maximum Length: 30

  The transaction event that is the basis for tax on the invoice line.
• TaxPointDate: string (date)
  Title: Tax Point Date

  Read Only: true

  The date when the taxpayer becomes liable for paying the tax to the tax authority. Valid values are delivery date, invoice date, and pickup date.
• TaxRate: number
  Title: Tax Rate

  The tax rate assigned to the invoice line.
• TaxRateCode: string
  Title: Tax Rate Code

  Maximum Length: 80

  The tax rate code assigned to the invoice line.
• TaxRegimeCode: string
  Title: Tax Regime Code

  Maximum Length: 80

  The tax regime code assigned to the tax line.
• TaxStatusCode: string
  Title: Tax Status Code

  Maximum Length: 80

  The tax status code assigned to the tax line.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxInclusiveIndicator":{
            "title":"Tax Inclusive Indicator",
            "maxLength":255,
            "type":"string",
            "description":"The option that indicates whether the invoice line amount is inclusive of tax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Meaning"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxableAmount":{
            "title":"Taxable Amount",
            "type":"number",
            "description":"The amount on the invoice line eligible for taxation. The tax rate is applied to the taxable amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxRateCode":{
            "title":"Tax Rate Code",
            "maxLength":80,
            "type":"string",
            "description":"The tax rate code assigned to the invoice line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TaxLineId1"
                ]
            }
        },
        "Tax":{
            "title":"Tax",
            "maxLength":80,
            "type":"string",
            "description":"The code of the tax assigned to the tax line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TaxLineId1"
                ]
            }
        },
        "TaxPointBasis":{
            "title":"Tax Point Basis",
            "maxLength":30,
            "type":"string",
            "description":"The transaction event that is the basis for tax on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The tax amount on the invoice line in the entered currency.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxJurisdictionCode":{
            "title":"Tax Jurisdiction Code",
            "maxLength":80,
            "type":"string",
            "description":"The tax jurisdiction code assigned to the tax line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TaxLineId1"
                ]
            }
        },
        "CustomerTransactionLineId":{
            "title":"Transaction Line ID",
            "type":"integer",
            "description":"The unique identifier of each separate tax line of the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaxRate":{
            "title":"Tax Rate",
            "type":"number",
            "description":"The tax rate assigned to the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxPointDate":{
            "title":"Tax Point Date",
            "type":"string",
            "description":"The date when the taxpayer becomes liable for paying the tax to the tax authority. Valid values are delivery date, invoice date, and pickup date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaxRegimeCode":{
            "title":"Tax Regime Code",
            "maxLength":80,
            "type":"string",
            "description":"The tax regime code assigned to the tax line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TaxLineId1"
                ]
            }
        },
        "TaxLineNumber":{
            "title":"Tax Line Number",
            "type":"integer",
            "description":"The line number of the tax line of the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxStatusCode":{
            "title":"Tax Status Code",
            "maxLength":80,
            "type":"string",
            "description":"The tax status code assigned to the tax line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TaxLineId1"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PlaceOfSupply":{
            "title":"Place of Supply",
            "type":"integer",
            "description":"The location where the transaction on the invoice line is determined to take place for tax purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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