Get all channel customer available accruals
get
/fscmRestApi/cjm/channelCustomerAvailableAccruals
Request
Query Parameters
-
AccrualCurrency: string
Value that indicates the accrual currency.
-
AccrualCurrencyCode: string
Abbreviation that uniquely identifies the accrual currency.
-
AccrualsBeforeDate: string
Date used in conjunction with the year context to filter the accruals .
-
AssociationType: string
Name of the type of association.
-
AssociationTypeCode: string
Abbreviation that uniquely identifies the association type. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_ASSOC_TYPE.
-
BillToAccountId: number
Value that uniquely identifies the bill-to customer account.
-
BillToAccountNumber: string
Number of the bill-to customer account.
-
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: number
Value that uniquely identifies the business unit.
-
CalendarYear: string
Calendar year of the accrual based on the accounting date.
-
ExcludeZeroBalancesFlag: string
Contains one of the following values: true or false. If true, programs with zero available accruals won't be listed. If false, all the programs will be listed. The default value for this attribute is false.
-
InvoiceNumber: string
Number that indicates the invoice.
-
Item: string
Name of the item in the inventory.
-
ItemDescription: string
Description of the item.
-
ItemId: number
Value that uniquely identifies the item.
-
Program: string
Name of the customer program.
-
ProgramId: number
Value that uniquely identifies the customer program.
-
ProgramType: string
Name of the program type.
-
ProgramTypeId: number
Value that uniquely identifies the program type.
-
PromotionCode: string
Abbreviation that uniquely identifies the customer program.
-
RelatedCustomerAccountId: number
Value that uniquely identifies the related customer account.
-
RelatedCustomerAccountNumber: string
Account number of the related customer.
-
ShowActiveProgramsFlag: string
Contains one of the following values: true or false. If true, then only programs that can still accrue funds or have a balance will be listed. If false, all the programs will be listed. The default value for this attribute is true.
-
limit: integer
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: integer
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Nested Schema : CollectionProperties
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : channelCustomerAvailableAccruals-allOf[1]
Type:
Show Source
object
-
items: array
Items
Title:
Items
Items in the collection.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : channelCustomerAvailableAccruals-item
Type:
Show Source
object
-
AccrualCurrency: string
Read Only:
true
Value that indicates the accrual currency. -
AccrualCurrencyCode: string
Read Only:
true
Abbreviation that uniquely identifies the accrual currency. -
AccrueToLevel: string
Read Only:
true
Level of accrual required. -
AccrueToLevelCode: string
Read Only:
true
Abbreviation that uniquely identifies the level of accrual. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLM_ACCRUE_TO_LVL. -
AssociationType: string
Read Only:
true
Name of the type of association. -
AssociationTypeCode: string
Read Only:
true
Abbreviation that uniquely identifies the association type. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_ASSOC_TYPE. -
AvailableAmountInTransactionCurrency: number
Read Only:
true
Available amount in the transaction currency. -
BillToAccountId: integer
Read Only:
true
Value that uniquely identifies the bill-to customer account. -
BillToAccountNumber: string
Read Only:
true
Number of the bill-to customer account. -
BillToCustomer: string
Read Only:
true
Name of the bill-to customer. -
CalendarYear: string
Read Only:
true
Calendar year of the accrual based on the accounting date. -
EarnedAmountInTransactionCurrency: number
Read Only:
true
Earned amount in the transaction currency. -
InvoiceNumber: string
Read Only:
true
Number that indicates the invoice. -
Item: string
Read Only:
true
Name of the item in the inventory. -
ItemDescription: string
Read Only:
true
Description of the item. -
ItemId: number
Read Only:
true
Value that uniquely identifies the item. -
Program: string
Read Only:
true
Name of the customer program. -
ProgramId: integer
Read Only:
true
Value that uniquely identifies the customer program. -
ProgramType: string
Read Only:
true
Name of the program type. -
ProgramTypeId: integer
Read Only:
true
Value that uniquely identifies the program type. -
ProgramUOM: string
Read Only:
true
Unit of measure of the item in the program. -
PromotionCode: string
Read Only:
true
Abbreviation that uniquely identifies the customer program. -
Quantity: number
Read Only:
true
Transaction quantity in program UOM.
Nested Schema : channelCustomerAvailableAccruals-item-response-allOf[1]
Type:
object
Examples
This example describes how to get all channel customer available accruals.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjm/channelCustomerAvailableAccruals"
Example 1 cURL Command
This example is for finding available accruals for a particular customer and program combination.
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjm/channelCustomerAvailableAccruals?BusinessUnitId=204&BillToAccountId=1006&AssociationTypeCode=ORA_PROGRAM&AccrualCurrencyCode=USD&ProgramId=300100570704421"
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570360793, "ProgramId": 300100570704421, "ProgramType": "CRAUTO_NAME8921", "Program": "WinterSales", "PromotionCode": "CR19010", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 1275, "AvailableAmountInTransactionCurrency": 1275, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0 }
Example 2 cURL Command
This example is for finding available accruals for a particular customer across all programs.
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjm/channelCustomerAvailableAccruals?BusinessUnitId=204&BillToAccountId=1006&AssociationTypeCode=ORA_PROGRAM&AccrualCurrencyCode=USD"
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570360793, "ProgramId": 300100570704472, "ProgramType": "CRAUTO_NAME8921", "Program": "Customer Promotion 2023", "PromotionCode": "CR19011", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 430.5, "AvailableAmountInTransactionCurrency": 430.5, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100571136403, "ProgramId": 300100571171737, "ProgramType": "CRTP2", "Program": "Customer Promotion", "PromotionCode": "CR24012", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 300, "AvailableAmountInTransactionCurrency": 300, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100571136403, "ProgramId": 300100571171749, "ProgramType": "CRTP2", "Program": "Customer Promotion", "PromotionCode": "CR24013", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 300, "AvailableAmountInTransactionCurrency": 300, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100571136403, "ProgramId": 300100572672185, "ProgramType": "CRTP2", "Program": "Customer Promotion Q2", "PromotionCode": "CR30000", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 80, "AvailableAmountInTransactionCurrency": 80, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570360793, "ProgramId": 300100571378560, "ProgramType": "CRAUTO_NAME8921", "Program": "Customer Promotion Q3", "PromotionCode": "CR27000", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 33, "AvailableAmountInTransactionCurrency": 33, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570360793, "ProgramId": 300100572840952, "ProgramType": "CRAUTO_NAME8921", "Program": "Customer Promotion 2023", "PromotionCode": "CR32001", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 33, "AvailableAmountInTransactionCurrency": 33, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570713159, "ProgramId": 300100570713171, "ProgramType": "CRAUTO_NAME1067", "Program": "CRAUTO_NAME1067", "PromotionCode": "CR19014", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 1800, "AvailableAmountInTransactionCurrency": 1800, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570360793, "ProgramId": 300100570704421, "ProgramType": "CRAUTO_NAME8921", "Program": "CR_WinterSales2", "PromotionCode": "CR19010", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 1275, "AvailableAmountInTransactionCurrency": 1275, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570737387, "ProgramId": 300100570737399, "ProgramType": "CRAUTO_NAME2964", "Program": "{ProgramTypeName}", "PromotionCode": "CR20001", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 1500, "AvailableAmountInTransactionCurrency": 1500, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, { "BillToCustomer": "Seven Corporation", "BillToAccountNumber": "1006", "BillToAccountId": 1006, "ProgramTypeId": 300100570713159, "ProgramId": 300100571180564, "ProgramType": "CRAUTO_NAME1067", "Program": "cbktest1301", "PromotionCode": "CR25000", "AccrualCurrencyCode": "USD", "EarnedAmountInTransactionCurrency": 10, "AvailableAmountInTransactionCurrency": 10, "AccrualCurrency": "US Dollar", "Item": null, "ItemId": null, "ItemDescription": null, "InvoiceNumber": null, "CalendarYear": null, "AssociationType": "Program", "AssociationTypeCode": "ORA_PROGRAM", "ClaimedAmount": "0", "Quantity": null, "ProgramUOM": null }, ], "count": 10, "hasMore": true, "limit": 10, "offset": 0 }