Payments
Subcategories: Attachments, Notes
The payment resource is used to create, view, update, or delete payments.
|
Resource Plural Label |
Payments |
|
Resource Name |
__ORACO__PaymentDSD_c |
Get All Payments
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PaymentDSD_c
Request Path Parameters
There are no elements in the request body for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a payment with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Payment
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PaymentDSD_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Payment
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PaymentDSD_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the route check-in history. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Payment
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PaymentDSD_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the shipment. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Payment
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PaymentDSD_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the payment. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Payment
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PaymentDSD_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the payment. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
FK_LOVVA_For___ORACO__Account_c |
OrganizationProfileId |
__ORACO__Account_Id_c |
|
LOVVA_For___ORACO__Account_c |
OrganizationName |
__ORACO__Account_c |
|
LOVVA_For___ORACO__ProcessStatus_c |
LookupCode |
__ORACO__ProcessStatus_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the payment. UI Label: Record ID |
|
RowType |
string |
The type of the payment. The value will always be __ORACO__PaymentDSD_c. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the payment. Properties: The maximum length is 80. UI Label: Payment Number |
|
CreatedBy |
string |
The user who created the record. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the record was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the record. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the record was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time when the record was last updated from a mobile. |
|
CurrencyCode |
string |
The currency code associated with the record. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the record. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
SourceType |
string |
The type of the source object such as Opportunities or Partners as defined in the object metadata. Properties: The maximum length is 0. |
|
__ORACO__Account_Id_c |
integer |
The unique identifier of the account associated with order. UI Label: Account |
|
__ORACO__Account_c |
string |
The name of account associated with the order. Properties: The maximum length is 1500. UI Label: Account |
|
__ORACO__Amount_c |
number |
The total amount of the payment. UI Label: Amount |
|
__ORACO__Note_c |
string |
The note that captures additional information regarding the payment. Properties: The maximum length is 80. UI Label: Note |
|
__ORACO__PaymentDate_c |
date |
The date and time when the payment was done. UI Label: Payment Date |
|
__ORACO__ProcessStatus_c |
string |
The status indicating whether the record is ready to be processed or was processed by the downstream application. The list of values is defined in the lookup ORA_ACO_PROCESS_STATUS. The creating system moves the process status to 'Ready to Process' when it is ready to be read by the ERP. The reading system (ERP) will move the status to 'Processed' once the payment is processed. Properties: The maximum length is 1500. UI Label: Process Status |
|
__ORACO__Currency_c |
string |
The currency used to make the payment. Properties: The maximum length is 80. UI Label: Currency |
|
__ORACO__PaymentSS_c |
string |
The application where the payment record originated from. Properties: The maximum length is 80. UI Label: Source System |
|
__ORACO__PaymentSSN_c |
integer |
The unique identifier of the record in the source application. UI Label: Source System Number |
|
__ORACO__CreatedOn_c |
integer |
The date when the record was created. UI Label: Created On |
|
__ORACO__AuxiliaryAttribute01_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 01 |
|
__ORACO__AuxiliaryAttribute02_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 02 |
|
__ORACO__AuxiliaryAttribute03_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 03 |
|
__ORACO__AuxiliaryAttribute04_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 04 |
|
__ORACO__AuxiliaryAttribute05_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 05 |
|
__ORACO__AuxiliaryAttribute06_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 06 |
|
__ORACO__AuxiliaryAttribute07_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 07 |
|
__ORACO__AuxiliaryAttribute08_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 08 |
|
__ORACO__AuxiliaryAttribute09_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 09 |
|
__ORACO__AuxiliaryAttribute10_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 10 |
|
__ORACO__AuxiliaryAttribute11_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 11 |
|
__ORACO__AuxiliaryAttribute12_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 12 |
|
__ORACO__AuxiliaryAttribute13_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 13 |
|
__ORACO__AuxiliaryAttribute14_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 14 |