Jump to

• Request
• Response

Update an invoice line charge reference

patch

/fscmRestApi/resources/11.13.18.05/invoiceLineChargeReferences/{InvoiceChargeReferenceId}

Request

Path Parameters

• InvoiceChargeReferenceId(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChargeReferenceTypeId: integer (int64)
  Value that uniquely identifies the reference type associated with the charge line.
• InvoiceChargeReferenceId: integer (int64)
  Unique identifier for the charge references.
• InvoiceId: integer (int64)
  Identifier for the invoice line.
• InvoiceLineNumber: integer (int64)
  Line number of the invoice line.
• Name: string
  Maximum Length: 100

  Name of the charge reference type.
• PredefinedFlag: boolean
  Maximum Length: 6

  Default Value: false

  Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the procurement business unit.
• ReferenceTypeNumber: number
  Number type reference value associated with the invoice line.
• ReferenceTypeTimestamp: string (date-time)
  Date type reference value associated with the invoice line.
• ReferenceTypeVarchar: string
  Maximum Length: 64

  String type reference value associated with the invoice line.
• UserComment: string
  Maximum Length: 240

  Comments added by the user.

{
    "type":"object",
    "properties":{
        "ChargeReferenceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference type associated with the charge line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            }
        },
        "InvoiceChargeReferenceId":{
            "type":"integer",
            "description":"Unique identifier for the charge references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Identifier for the invoice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceLineNumber":{
            "type":"integer",
            "description":"Line number of the invoice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the charge reference type.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PredefinedFlag":{
            "maxLength":6,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false.",
            "nullable":true,
            "default":false
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReferenceTypeNumber":{
            "type":"number",
            "description":"Number type reference value associated with the invoice line.",
            "nullable":true
        },
        "ReferenceTypeTimestamp":{
            "type":"string",
            "description":"Date type reference value associated with the invoice line.",
            "format":"date-time",
            "nullable":true
        },
        "ReferenceTypeVarchar":{
            "maxLength":64,
            "type":"string",
            "description":"String type reference value associated with the invoice line.",
            "nullable":true
        },
        "UserComment":{
            "maxLength":240,
            "type":"string",
            "description":"Comments added by the user.",
            "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 : invoiceLineChargeReferences-item-response

Type: object

Show Source

• ChargeReferenceTypeDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the reference type associated with the charge line.
• ChargeReferenceTypeId: integer (int64)
  Value that uniquely identifies the reference type associated with the charge line.
• ChargeReferenceValueDataType: string
  Read Only: true

  Maximum Length: 30

  Reference data type associated with the charge line.
• InvoiceChargeReferenceId: integer (int64)
  Unique identifier for the charge references.
• InvoiceId: integer (int64)
  Identifier for the invoice line.
• InvoiceLineNumber: integer (int64)
  Line number of the invoice line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 100

  Name of the charge reference type.
• PredefinedFlag: boolean
  Maximum Length: 6

  Default Value: false

  Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the procurement business unit.
• ReferenceTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the charge reference type.
• ReferenceTypeNumber: number
  Number type reference value associated with the invoice line.
• ReferenceTypeTimestamp: string (date-time)
  Date type reference value associated with the invoice line.
• ReferenceTypeVarchar: string
  Maximum Length: 64

  String type reference value associated with the invoice line.
• SetId: integer (int64)
  Read Only: true

  Value that uniquely identifies the set that charge reference belongs to.
• SupplierId: integer
  Value that uniquely identifies the supplier rendering the service.
• SupplierSiteId: integer
  Value that uniquely identifies the supplier site rendering the service.
• UserComment: string
  Maximum Length: 240

  Comments added by the user.

{
    "type":"object",
    "properties":{
        "ChargeReferenceTypeDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the reference type associated with the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeReferenceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference type associated with the charge line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            },
            "x-queryable":true
        },
        "ChargeReferenceValueDataType":{
            "maxLength":30,
            "type":"string",
            "description":"Reference data type associated with the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceChargeReferenceId":{
            "type":"integer",
            "description":"Unique identifier for the charge references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Identifier for the invoice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLineNumber":{
            "type":"integer",
            "description":"Line number of the invoice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the charge reference type.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PredefinedFlag":{
            "maxLength":6,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReferenceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the charge reference type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceTypeNumber":{
            "type":"number",
            "description":"Number type reference value associated with the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceTypeTimestamp":{
            "type":"string",
            "description":"Date type reference value associated with the invoice line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceTypeVarchar":{
            "maxLength":64,
            "type":"string",
            "description":"String type reference value associated with the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the set that charge reference belongs to.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier rendering the service.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site rendering the service.",
            "nullable":true,
            "x-queryable":false
        },
        "UserComment":{
            "maxLength":240,
            "type":"string",
            "description":"Comments added by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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