Jump to

• Request
• Response

Update a Vehicle Finance

patch

/crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances/{AccountNumber}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• AccountNumber: string
  Identifier to Vehicle Finances
• VehicleIdentificationNumber: string
  Identifier to Vehicles

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : autoVehicles-VehicleFinances-item

Type: object

Show Source

• AccountMaturityDate(optional): string(date)
  Title: Account Maturity

  The date when the account matures.
• AccountNumber(optional): string
  Title: Account Number

  Maximum Length: 30

  The public unique identifier of the record.
• ArrPercent(optional): number
  Title: Average Rate of Return

  The return percentage of the loan.
• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• BasePaymentAmount(optional): number
  Title: Base Payment

  The base payment amount for the vehicle.
• CorpCurrencyCode(optional): string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time when the record was created.
• CurcyConvRateType(optional): string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the record.
• CurrencyCode(optional): string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the record like USD or EUR.
• CustomerId(optional): integer(int64)
  Title: Customer ID

  The unique identifier of the customer.
• DealerId(optional): integer(int64)
  Title: Dealer ID

  The unique identifier of the dealer.
• DeliquentTitle(optional): string
  Title: Delinquent Title

  Maximum Length: 100

  Indicates whether the loan is marked delinquent.
• FinancedAmount(optional): number
  Title: Financed Amount

  The financed amount of the loan.
• FinanceStatus(optional): string
  Title: Status

  Maximum Length: 30

  The status of the finance.
• FinanceTerms(optional): string
  Title: Terms

  Maximum Length: 30

  The terms of the finance.
• InspectionCompanyName(optional): string
  Title: Inspection Company

  Maximum Length: 100

  The name of the company that conducted the inspection.
• InspectionDate(optional): string(date)
  Title: Inspection Date

  The date when the inspection was conducted.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 30

  The type of the inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

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

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin(optional): string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the record.
• links(optional): array Items
  Title: Items

  Link Relations
• MoveDate(optional): string(date)
  Title: Move Date

  The date when the vehicle was moved.
• NextPaymentDueDate(optional): string(date)
  Title: Next Due Date

  The due date for the next payment.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  A system-generated read-only attribute used by the application framework.
• OpenAmount(optional): number
  Title: Open Amount

  The opening amount paid for the vehicle loan.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The associated business unit information.
• OriginSystem(optional): string
  Title: Origin System

  Maximum Length: 400

  The application from where the order originated.
• OriginSystemReference(optional): string
  Title: Origin System Reference

  Maximum Length: 400

  The unique identifier of the record in the source application.
• OtherPaymentAmount(optional): number
  Title: Other Amount

  The other payment amount associated with the loan.
• ReasonForMove(optional): string
  Title: Reason

  Maximum Length: 400

  The reason for moving the vehicle from one location to other.
• SalesTax(optional): number
  Title: Sales Tax

  The sales tax associated with the loan.
• TitleNumber(optional): string
  Title: Title

  Maximum Length: 100

  The unique 8 digit number issued by the state for title.
• TitleState(optional): string
  Title: State

  Maximum Length: 100

  The state in which the title was issued.
• TitleStatus(optional): string
  Title: Status

  Maximum Length: 30

  The title status of the vehicle.
• TotalPaymentAmount(optional): number
  Title: Total Amount

  The total payment amount.
• VehicleFinanceId(optional): integer(int64)
  Title: Finance ID

  The unique identifier of finance record.
• VehicleId(optional): integer(int64)
  Title: Vehicle ID

  The unique identifier of the vehicle.

{
    "properties":{
        "AccountMaturityDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the account matures.",
            "title":"Account Maturity"
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the record.",
            "title":"Account Number"
        },
        "ArrPercent":{
            "type":"number",
            "description":"The return percentage of the loan.",
            "title":"Average Rate of Return"
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "BasePaymentAmount":{
            "type":"number",
            "description":"The base payment amount for the vehicle.",
            "title":"Base Payment"
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the record.",
            "title":"Corporate Currency Code"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the record.",
            "title":"Conversion Rate Type"
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the record like USD or EUR.",
            "title":"Currency Code"
        },
        "CustomerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the customer.",
            "title":"Customer ID"
        },
        "DealerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the dealer.",
            "title":"Dealer ID"
        },
        "DeliquentTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates whether the loan is marked delinquent.",
            "title":"Delinquent Title"
        },
        "FinanceStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the finance.",
            "title":"Status"
        },
        "FinanceTerms":{
            "maxLength":30,
            "type":"string",
            "description":"The terms of the finance.",
            "title":"Terms"
        },
        "FinancedAmount":{
            "type":"number",
            "description":"The financed amount of the loan.",
            "title":"Financed Amount"
        },
        "InspectionCompanyName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the company that conducted the inspection.",
            "title":"Inspection Company"
        },
        "InspectionDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the inspection was conducted.",
            "title":"Inspection Date"
        },
        "InspectionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the inspection.",
            "title":"Inspection Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "title":"Last Update Login"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "MoveDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the vehicle was moved.",
            "title":"Move Date"
        },
        "NextPaymentDueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date for the next payment.",
            "title":"Next Due Date"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Object Version Number"
        },
        "OpenAmount":{
            "type":"number",
            "description":"The opening amount paid for the vehicle loan.",
            "title":"Open Amount"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The associated business unit information.",
            "title":"Business Unit"
        },
        "OriginSystem":{
            "maxLength":400,
            "type":"string",
            "description":"The application from where the order originated.",
            "title":"Origin System"
        },
        "OriginSystemReference":{
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the record in the source application.",
            "title":"Origin System Reference"
        },
        "OtherPaymentAmount":{
            "type":"number",
            "description":"The other payment amount associated with the loan.",
            "title":"Other Amount"
        },
        "ReasonForMove":{
            "maxLength":400,
            "type":"string",
            "description":"The reason for moving the vehicle from one location to other.",
            "title":"Reason"
        },
        "SalesTax":{
            "type":"number",
            "description":"The sales tax associated with the loan.",
            "title":"Sales Tax"
        },
        "TitleNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The unique 8 digit number issued by the state for title.",
            "title":"Title"
        },
        "TitleState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in which the title was issued.",
            "title":"State"
        },
        "TitleStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The title status of the vehicle.",
            "title":"Status"
        },
        "TotalPaymentAmount":{
            "type":"number",
            "description":"The total payment amount.",
            "title":"Total Amount"
        },
        "VehicleFinanceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of finance record.",
            "title":"Finance ID"
        },
        "VehicleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the vehicle.",
            "title":"Vehicle ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "x-links":[
        {
            "rel":"lov",
            "title":"FinanceStatus LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: FinanceStatus; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_VHCLE_FINANCE_STATUS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        },
        {
            "rel":"lov",
            "title":"FinanceTerms LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: FinanceTerms; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_VHCLE_FINANCE_TERMS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        },
        {
            "rel":"lov",
            "title":"TitleStatus LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: TitleStatus; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_FNCE_TITLE_STATUS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        },
        {
            "rel":"lov",
            "title":"InspectionType LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: InspectionType; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_VHCLE_INSPECTION_TYPE",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        }
    ],
    "type":"object"
}

Relationships

FinanceStatus LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

FinanceTerms LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

InspectionType LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

TitleStatus LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : autoVehicles-VehicleFinances-item

Type: object

Show Source

• AccountMaturityDate(optional): string(date)
  Title: Account Maturity

  The date when the account matures.
• AccountNumber(optional): string
  Title: Account Number

  Maximum Length: 30

  The public unique identifier of the record.
• ArrPercent(optional): number
  Title: Average Rate of Return

  The return percentage of the loan.
• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• BasePaymentAmount(optional): number
  Title: Base Payment

  The base payment amount for the vehicle.
• CorpCurrencyCode(optional): string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time when the record was created.
• CurcyConvRateType(optional): string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the record.
• CurrencyCode(optional): string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the record like USD or EUR.
• CustomerId(optional): integer(int64)
  Title: Customer ID

  The unique identifier of the customer.
• DealerId(optional): integer(int64)
  Title: Dealer ID

  The unique identifier of the dealer.
• DeliquentTitle(optional): string
  Title: Delinquent Title

  Maximum Length: 100

  Indicates whether the loan is marked delinquent.
• FinancedAmount(optional): number
  Title: Financed Amount

  The financed amount of the loan.
• FinanceStatus(optional): string
  Title: Status

  Maximum Length: 30

  The status of the finance.
• FinanceTerms(optional): string
  Title: Terms

  Maximum Length: 30

  The terms of the finance.
• InspectionCompanyName(optional): string
  Title: Inspection Company

  Maximum Length: 100

  The name of the company that conducted the inspection.
• InspectionDate(optional): string(date)
  Title: Inspection Date

  The date when the inspection was conducted.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 30

  The type of the inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

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

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin(optional): string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the record.
• links(optional): array Items
  Title: Items

  Link Relations
• MoveDate(optional): string(date)
  Title: Move Date

  The date when the vehicle was moved.
• NextPaymentDueDate(optional): string(date)
  Title: Next Due Date

  The due date for the next payment.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  A system-generated read-only attribute used by the application framework.
• OpenAmount(optional): number
  Title: Open Amount

  The opening amount paid for the vehicle loan.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The associated business unit information.
• OriginSystem(optional): string
  Title: Origin System

  Maximum Length: 400

  The application from where the order originated.
• OriginSystemReference(optional): string
  Title: Origin System Reference

  Maximum Length: 400

  The unique identifier of the record in the source application.
• OtherPaymentAmount(optional): number
  Title: Other Amount

  The other payment amount associated with the loan.
• ReasonForMove(optional): string
  Title: Reason

  Maximum Length: 400

  The reason for moving the vehicle from one location to other.
• SalesTax(optional): number
  Title: Sales Tax

  The sales tax associated with the loan.
• TitleNumber(optional): string
  Title: Title

  Maximum Length: 100

  The unique 8 digit number issued by the state for title.
• TitleState(optional): string
  Title: State

  Maximum Length: 100

  The state in which the title was issued.
• TitleStatus(optional): string
  Title: Status

  Maximum Length: 30

  The title status of the vehicle.
• TotalPaymentAmount(optional): number
  Title: Total Amount

  The total payment amount.
• VehicleFinanceId(optional): integer(int64)
  Title: Finance ID

  The unique identifier of finance record.
• VehicleId(optional): integer(int64)
  Title: Vehicle ID

  The unique identifier of the vehicle.

{
    "properties":{
        "AccountMaturityDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the account matures.",
            "title":"Account Maturity"
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the record.",
            "title":"Account Number"
        },
        "ArrPercent":{
            "type":"number",
            "description":"The return percentage of the loan.",
            "title":"Average Rate of Return"
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "BasePaymentAmount":{
            "type":"number",
            "description":"The base payment amount for the vehicle.",
            "title":"Base Payment"
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the record.",
            "title":"Corporate Currency Code"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the record.",
            "title":"Conversion Rate Type"
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the record like USD or EUR.",
            "title":"Currency Code"
        },
        "CustomerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the customer.",
            "title":"Customer ID"
        },
        "DealerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the dealer.",
            "title":"Dealer ID"
        },
        "DeliquentTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates whether the loan is marked delinquent.",
            "title":"Delinquent Title"
        },
        "FinanceStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the finance.",
            "title":"Status"
        },
        "FinanceTerms":{
            "maxLength":30,
            "type":"string",
            "description":"The terms of the finance.",
            "title":"Terms"
        },
        "FinancedAmount":{
            "type":"number",
            "description":"The financed amount of the loan.",
            "title":"Financed Amount"
        },
        "InspectionCompanyName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the company that conducted the inspection.",
            "title":"Inspection Company"
        },
        "InspectionDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the inspection was conducted.",
            "title":"Inspection Date"
        },
        "InspectionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the inspection.",
            "title":"Inspection Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "title":"Last Update Login"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "MoveDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the vehicle was moved.",
            "title":"Move Date"
        },
        "NextPaymentDueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date for the next payment.",
            "title":"Next Due Date"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Object Version Number"
        },
        "OpenAmount":{
            "type":"number",
            "description":"The opening amount paid for the vehicle loan.",
            "title":"Open Amount"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The associated business unit information.",
            "title":"Business Unit"
        },
        "OriginSystem":{
            "maxLength":400,
            "type":"string",
            "description":"The application from where the order originated.",
            "title":"Origin System"
        },
        "OriginSystemReference":{
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the record in the source application.",
            "title":"Origin System Reference"
        },
        "OtherPaymentAmount":{
            "type":"number",
            "description":"The other payment amount associated with the loan.",
            "title":"Other Amount"
        },
        "ReasonForMove":{
            "maxLength":400,
            "type":"string",
            "description":"The reason for moving the vehicle from one location to other.",
            "title":"Reason"
        },
        "SalesTax":{
            "type":"number",
            "description":"The sales tax associated with the loan.",
            "title":"Sales Tax"
        },
        "TitleNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The unique 8 digit number issued by the state for title.",
            "title":"Title"
        },
        "TitleState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in which the title was issued.",
            "title":"State"
        },
        "TitleStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The title status of the vehicle.",
            "title":"Status"
        },
        "TotalPaymentAmount":{
            "type":"number",
            "description":"The total payment amount.",
            "title":"Total Amount"
        },
        "VehicleFinanceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of finance record.",
            "title":"Finance ID"
        },
        "VehicleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the vehicle.",
            "title":"Vehicle ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "x-links":[
        {
            "rel":"lov",
            "title":"FinanceStatus LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: FinanceStatus; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_VHCLE_FINANCE_STATUS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        },
        {
            "rel":"lov",
            "title":"FinanceTerms LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: FinanceTerms; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_VHCLE_FINANCE_TERMS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        },
        {
            "rel":"lov",
            "title":"TitleStatus LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: TitleStatus; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_FNCE_TITLE_STATUS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        },
        {
            "rel":"lov",
            "title":"InspectionType LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: InspectionType; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_VHCLE_INSPECTION_TYPE",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        }
    ],
    "type":"object"
}

Relationships

FinanceStatus LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

FinanceTerms LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

InspectionType LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

TitleStatus LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top