Jump to

• Request
• Response

Get a receivables adjustment

get

/fscmRestApi/resources/11.13.18.05/receivablesAdjustments/{AdjustmentId}

Request

Path Parameters

• AdjustmentId(required): integer(int64)
  The unique identifier of the adjustment.

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

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 : receivablesAdjustments-item-response

Type: object

Show Source

• AccountCombination: string
  Title: Account Code Combination

  Read Only: true

  The account code combination of the adjustment distribution.
• AccountedAmount: number
  The accounted amount of the adjustment.
• AccountingDate: string (date)
  The accounting date assigned to the adjustment.
• AdjustmentAmount: number
  The amount of the transaction or part of the transaction that was adjusted.
• AdjustmentDate: string (date)
  The date when the adjustment was made.
• AdjustmentId: integer (int64)
  Title: Adjustment ID

  The unique identifier of the adjustment.
• AdjustmentNumber: string
  Maximum Length: 20

  The number assigned to the adjustment.
• AdjustmentReason: string
  Maximum Length: 80

  The user-defined reason the transaction was adjusted.
• AdjustmentType: string
  Maximum Length: 80

  The attribute that determines which part of the transaction is adjusted. Valid values are: Charges, Freight, Invoice (transaction header), Line, Tax.
• ApprovedBy: string
  Read Only: true

  Maximum Length: 240

  The user who approved the adjustment.
• BillToSiteUseId: integer (int64)
  Title: Bill-to Site Use ID

  Read Only: true

  The unique identifier of the bill-to site business purpose associated with an adjustment.
• BusinessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The business unit under which the adjusted transaction is created. A business unit is a unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy.
• Comments: string
  Title: Comments

  Read Only: true

  Maximum Length: 2000

  The user-defined comments about the adjustment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• Currency: string
  Read Only: true

  Maximum Length: 15

  The code that identifies the entered currency of the adjusted transaction.
• CustomerTransactionId: integer (int64)
  Read Only: true

  The unique identifier of the adjusted transaction.
• InstallmentBalance: number
  Title: Payment Schedule Balance Due Amount

  Read Only: true

  The outstanding balance on the installment.
• InstallmentNumber: integer (int64)
  Read Only: true

  The number that identifies the installment of the transaction that is adjusted and the due date of the installment.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  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.
• ReceivablesActivity: string
  Title: Receivables Activity Name

  Read Only: true

  Maximum Length: 50

  The attribute that determines the transaction distribution account to use for the expense or revenue generated by the adjustment.
• receivablesAdjustmentDFF: array Receivables Adjustments Descriptive Flexfields
  Title: Receivables Adjustments Descriptive Flexfields

  The receivables adjustments descriptive flexfields resource is used to get the descriptive flexfield values associated with an invoice adjustment.
• Status: string
  Maximum Length: 80

  The status of the adjustment. Valid values are: Pending Approval, Approved, Rejected, More Research.
• TransactionClass: string
  Maximum Length: 80

  The transaction class of the adjusted transaction. Valid values are: Invoice, Debit Memo, Credit Memo.
• TransactionNumber: string
  Title: Payment Schedule Transaction Number

  Read Only: true

  Maximum Length: 30

  The transaction number assigned to the adjusted transaction.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransactionNumber":{
            "title":"Payment Schedule Transaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The transaction number assigned to the adjusted transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountingDate":{
            "type":"string",
            "description":"The accounting date assigned to the adjustment.",
            "format":"date",
            "nullable":false,
            "x-queryable":false
        },
        "AccountedAmount":{
            "type":"number",
            "description":"The accounted amount of the adjustment.",
            "nullable":false,
            "x-queryable":false
        },
        "AdjustmentNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The number assigned to the adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "InstallmentNumber":{
            "type":"integer",
            "description":"The number that identifies the installment of the transaction that is adjusted and the due date of the installment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InstallmentBalance":{
            "title":"Payment Schedule Balance Due Amount",
            "type":"number",
            "description":"The outstanding balance on the installment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AdjustmentId":{
            "title":"Adjustment ID",
            "type":"integer",
            "description":"The unique identifier of the adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"The code that identifies the entered currency of the adjusted transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransactionClass":{
            "maxLength":"80",
            "type":"string",
            "description":"The transaction class of the adjusted transaction. Valid values are: Invoice, Debit Memo, Credit Memo.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"The amount of the transaction or part of the transaction that was adjusted.",
            "nullable":false,
            "x-queryable":false
        },
        "AdjustmentReason":{
            "maxLength":"80",
            "type":"string",
            "description":"The user-defined reason the transaction was adjusted.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentDate":{
            "type":"string",
            "description":"The date when the adjustment was made.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the adjustment. Valid values are: Pending Approval, Approved, Rejected, More Research.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToSiteUseId":{
            "title":"Bill-to Site Use ID",
            "type":"integer",
            "description":"The unique identifier of the bill-to site business purpose associated with an adjustment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-defined comments about the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the adjusted transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountCombination":{
            "title":"Account Code Combination",
            "type":"string",
            "description":"The account code combination of the adjustment distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChartOfAccountsId",
                    "CodeCombinationId"
                ]
            }
        },
        "AdjustmentType":{
            "maxLength":"80",
            "type":"string",
            "description":"The attribute that determines which part of the transaction is adjusted. Valid values are: Charges, Freight, Invoice (transaction header), Line, Tax.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The business unit under which the adjusted transaction is created. A business unit is a unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ApprovedBy":{
            "maxLength":"240",
            "type":"string",
            "description":"The user who approved the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "receivablesAdjustmentDFF":{
            "title":"Receivables Adjustments Descriptive Flexfields",
            "type":"array",
            "description":"The receivables adjustments descriptive flexfields resource is used to get the descriptive flexfield values associated with an invoice adjustment.",
            "items":{
                "$ref":"#/components/schemas/receivablesAdjustments-receivablesAdjustmentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ReceivablesActivity":{
            "title":"Receivables Activity Name",
            "maxLength":"50",
            "type":"string",
            "description":"The attribute that determines the transaction distribution account to use for the expense\nor revenue generated by the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Receivables Adjustments Descriptive Flexfields

Type: array

Title: Receivables Adjustments Descriptive Flexfields

The receivables adjustments descriptive flexfields resource is used to get the descriptive flexfield values associated with an invoice adjustment.

Show Source

• Array of: object receivablesAdjustments-receivablesAdjustmentDFF-item-response

{
    "title":"Receivables Adjustments Descriptive Flexfields",
    "type":"array",
    "description":"The receivables adjustments descriptive flexfields resource is used to get the descriptive flexfield values associated with an invoice adjustment.",
    "items":{
        "$ref":"#/components/schemas/receivablesAdjustments-receivablesAdjustmentDFF-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : receivablesAdjustments-receivablesAdjustmentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  The context of the descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The display value of the descriptive flexfield context.
• AdjustmentId: integer (int64)
  The unique identifier of the receivables adjustment associated to the descriptive flexfield.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the receivables adjustment associated to the descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The display value of the descriptive flexfield context.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"The context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

receivablesAdjustmentDFF

Operation: /fscmRestApi/resources/11.13.18.05/receivablesAdjustments/{AdjustmentId}/child/receivablesAdjustmentDFF

Parameters:

• AdjustmentId: $request.path.AdjustmentId

The receivables adjustments descriptive flexfields resource is used to get the descriptive flexfield values associated with an invoice adjustment.

Back to Top