Get a Vehicle Finance
get
/crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances/{AccountNumber}
Request
Path Parameters
-
AccountNumber: string
Identifier to Vehicle Finances
-
VehicleIdentificationNumber: string
Identifier to Vehicles
Query Parameters
-
dependency: string
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
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : autoVehicles-VehicleFinances-item
Type:
Show Source
object-
AccountMaturityDate(optional):
string(date)
Title:
Account MaturityThe date when the account matures. -
AccountNumber(optional):
string
Title:
Account NumberMaximum Length:30The public unique identifier of the record. -
ArrPercent(optional):
number
Title:
Average Rate of ReturnThe return percentage of the loan. -
AttributeCategory(optional):
string
Title:
Attribute CategoryMaximum Length:30A system-generated read-only attribute used by the application framework. -
BasePaymentAmount(optional):
number
Title:
Base PaymentThe base payment amount for the vehicle. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code of the record. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the record was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate TypeMaximum Length:30The currency conversion rate type associated with the record. -
CurrencyCode(optional):
string
Title:
Currency CodeMaximum Length:15The currency code associated with the record like USD or EUR. -
CustomerId(optional):
integer(int64)
Title:
Customer IDThe unique identifier of the customer. -
DealerId(optional):
integer(int64)
Title:
Dealer IDThe unique identifier of the dealer. -
DeliquentTitle(optional):
string
Title:
Delinquent TitleMaximum Length:100Indicates whether the loan is marked delinquent. -
FinancedAmount(optional):
number
Title:
Financed AmountThe financed amount of the loan. -
FinanceStatus(optional):
string
Title:
StatusMaximum Length:30The status of the finance. -
FinanceTerms(optional):
string
Title:
TermsMaximum Length:30The terms of the finance. -
InspectionCompanyName(optional):
string
Title:
Inspection CompanyMaximum Length:100The name of the company that conducted the inspection. -
InspectionDate(optional):
string(date)
Title:
Inspection DateThe date when the inspection was conducted. -
InspectionType(optional):
string
Title:
Inspection TypeMaximum Length:30The type of the inspection. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update DateThe date and time when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the record. -
LastUpdateLogin(optional):
string
Title:
Last Update LoginMaximum Length:32The login of the user who last updated the record. -
links(optional):
array Items
Title:
ItemsLink Relations -
MoveDate(optional):
string(date)
Title:
Move DateThe date when the vehicle was moved. -
NextPaymentDueDate(optional):
string(date)
Title:
Next Due DateThe due date for the next payment. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version NumberA system-generated read-only attribute used by the application framework. -
OpenAmount(optional):
number
Title:
Open AmountThe opening amount paid for the vehicle loan. -
OrgId(optional):
integer(int64)
Title:
Business UnitThe associated business unit information. -
OriginSystem(optional):
string
Title:
Origin SystemMaximum Length:400The application from where the order originated. -
OriginSystemReference(optional):
string
Title:
Origin System ReferenceMaximum Length:400The unique identifier of the record in the source application. -
OtherPaymentAmount(optional):
number
Title:
Other AmountThe other payment amount associated with the loan. -
ReasonForMove(optional):
string
Title:
ReasonMaximum Length:400The reason for moving the vehicle from one location to other. -
SalesTax(optional):
number
Title:
Sales TaxThe sales tax associated with the loan. -
TitleNumber(optional):
string
Title:
TitleMaximum Length:100The unique 8 digit number issued by the state for title. -
TitleState(optional):
string
Title:
StateMaximum Length:100The state in which the title was issued. -
TitleStatus(optional):
string
Title:
StatusMaximum Length:30The title status of the vehicle. -
TotalPaymentAmount(optional):
number
Title:
Total AmountThe total payment amount. -
VehicleFinanceId(optional):
integer(int64)
Title:
Finance IDThe unique identifier of finance record. -
VehicleId(optional):
integer(int64)
Title:
Vehicle IDThe unique identifier of the vehicle.
- FinanceStatus LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups - FinanceTerms LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups - InspectionType LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups - TitleStatus LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.