Get all channel customer program checkbook balances
/fscmRestApi/cjmRest/channelCustomerProgramCheckbookBalances
Request
-
AccrueToAccountIdFilter: Integer
Filter for the accrue-to customer.
-
BillToSiteUseIdFilter: Integer
Filter for the bill-to site.
-
DataFor: string
Value that indicates whether the customer balances, bill-to balances, or total balances are retrieved.
-
DataForCode(required): string
Abbreviation that indicates whether the customer balances, bill-to balances, or total balances are retrieved. A list of accepted values is defined in the lookup type ORA_CJM_PGM_CHKBK_TYPE.
-
ProgramId(required): Integer
Value that uniquely identifies the customer program.
-
ProgramName: string
Name of the customer program.
-
PromotionCode: string
Abbreviation that uniquely identifies the customer program.
-
limit: integer
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: 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.
-
orderBy: string
List of attributes for sorting the data.
There's no request body for this operation.
Back to TopResponse
- application/json
- application/vnd.oracle.adf.resourcecollection+json
Default Response
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.
object
-
items: array
Items
Title:
Items
The items in the collection.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
AccrueToAccountId: Integer
Read Only:
true
Value that uniquely identifies the accrue-to customer account -
AccrueToAccountNumber: string
Read Only:
true
Number of the accrue-to customer account -
AccrueToCustomer: string
Read Only:
true
Name of the accrue-to customer account. -
BalanceAmountInFunctionalCurrency: number
Read Only:
true
Balance amount in the functional currency. -
BalanceAmountInProgramCurrency: number
Read Only:
true
Balance amount in the program 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. -
BillToSite: string
Read Only:
true
Name of the bill-to customer account site. -
BillToSiteAddress: string
Read Only:
true
Address of the bill-to customer account site. -
BillToSiteUseId: Integer
Read Only:
true
Value that uniquely identifies the bill-to customer account site. -
DataFor: string
Read Only:
true
Value that indicates whether the customer balances, bill-to balances, or total balances are retrieved. -
DataForCode: string
Read Only:
true
Abbreviation that indicates whether the customer balances, bill-to balances, or total balances are retrieved. A list of accepted values is defined in the lookup type ORA_CJM_PGM_CHKBK_TYPE. -
EarnedAmountInFunctionalCurrency: number
Read Only:
true
Earned amount in the functional currency. -
EarnedAmountInProgramCurrency: number
Read Only:
true
Earned amount in the program currency. -
FunctionalCurrency: string
Read Only:
true
Value that indicates the functional currency. -
FunctionalCurrencyCode: string
Read Only:
true
Abbreviation that identifies the functional currency. -
InProgressAmountInFunctionalCurrency: number
Read Only:
true
In-progress amount in the functional currency. -
InProgressAmountInProgramCurrency: number
Read Only:
true
In-progress amount in the program currency. -
PaidAmountInFunctionalCurrency: number
Read Only:
true
Paid amount in the functional currency. -
PaidAmountInProgramCurrency: number
Read Only:
true
Paid amount in the program currency. -
ProgramCurrency: string
Read Only:
true
Value that indicates the program currency -
ProgramCurrencyCode: string
Read Only:
true
Abbreviation that identifies the program currency -
ProgramId: Integer
Read Only:
true
Value that uniquely identifies the customer program. -
ProgramName: string
Read Only:
true
Name of the customer program. -
PromotionCode: string
Read Only:
true
Abbreviation that uniquely identifies the customer program.
object
Examples
This example describes how to get channel customer program checkbook balances.
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/cjmRest/channelCustomerProgramCheckbookBalances"
Example 1
This example describes how to get customer balances for a program.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjmRest/channelCustomerProgramCheckbookBalances?DataForCode=ORA_CUSTOMER_BAL&ProgramId=300100562606570"
Example 1 Response Body
{ "items": [ { "DataFor": "Customer Balances", "DataForCode": "ORA_CUSTOMER_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "Big Computers", "AccrueToAccountNumber": "10022", "AccrueToAccountId": 1001, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 28109, "InProgressAmountInProgramCurrency": 401, "PaidAmountInProgramCurrency": 27708, "BalanceAmountInProgramCurrency": 0, "EarnedAmountInFunctionalCurrency": 28109, "InProgressAmountInFunctionalCurrency": 401, "PaidAmountInFunctionalCurrency": 27708, "BalanceAmountInFunctionalCurrency": 0, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null }, { "DataFor": "Customer Balances", "DataForCode": "ORA_CUSTOMER_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "Blue Semiconductor", "AccrueToAccountNumber": "10045", "AccrueToAccountId": 1290, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 20433, "InProgressAmountInProgramCurrency": 0, "PaidAmountInProgramCurrency": 18607, "BalanceAmountInProgramCurrency": 1826, "EarnedAmountInFunctionalCurrency": 20433, "InProgressAmountInFunctionalCurrency": 0, "PaidAmountInFunctionalCurrency": 18607, "BalanceAmountInFunctionalCurrency": 1826, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null }, { "DataFor": "Customer Balances", "DataForCode": "ORA_CUSTOMER_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "Fantastic Laptops", "AccrueToAccountNumber": "10072", "AccrueToAccountId": 2580, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 41032, "InProgressAmountInProgramCurrency": 580, "PaidAmountInProgramCurrency": 35644, "BalanceAmountInProgramCurrency": 4808, "EarnedAmountInFunctionalCurrency": 41032, "InProgressAmountInFunctionalCurrency": 580, "PaidAmountInFunctionalCurrency": 35644, "BalanceAmountInFunctionalCurrency": 4808, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null }, { "DataFor": "Customer Balances", "DataForCode": "ORA_CUSTOMER_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "First Software", "AccrueToAccountNumber": "20920", "AccrueToAccountId": 3347, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 19234, "InProgressAmountInProgramCurrency": 501, "PaidAmountInProgramCurrency": 18382, "BalanceAmountInProgramCurrency": 351, "EarnedAmountInFunctionalCurrency": 19234, "InProgressAmountInFunctionalCurrency": 501, "PaidAmountInFunctionalCurrency": 18382, "BalanceAmountInFunctionalCurrency": 351, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null }, { "DataFor": "Customer Balances", "DataForCode": "ORA_CUSTOMER_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "Green Corp.", "AccrueToAccountNumber": "21392", "AccrueToAccountId": 6250, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 30431, "InProgressAmountInProgramCurrency": 0, "PaidAmountInProgramCurrency": 29949, "BalanceAmountInProgramCurrency": 482, "EarnedAmountInFunctionalCurrency": 30431, "InProgressAmountInFunctionalCurrency": 0, "PaidAmountInFunctionalCurrency": 29949, "BalanceAmountInFunctionalCurrency": 482, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null }, ], "count": 5, "hasMore": false, "limit": 25, "offset": 0 }
Example 2
This example describes how to get total balances for a program.
Example 2 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjmRest/channelCustomerProgramCheckbookBalances?DataForCode=ORA_TOTAL_BAL&ProgramId=300100562606570"
Example 2 Response Body
{ "items": [ { "DataFor": "Total Balances", "DataForCode": "ORA_TOTAL_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": null, "AccrueToAccountNumber": null, "AccrueToAccountId": null, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 139239, "InProgressAmountInProgramCurrency": 1482, "PaidAmountInProgramCurrency": 130290, "BalanceAmountInProgramCurrency": 7467, "EarnedAmountInFunctionalCurrency": 139239, "InProgressAmountInFunctionalCurrency": 1482, "PaidAmountInFunctionalCurrency": 130290, "BalanceAmountInFunctionalCurrency": 7467, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0 }
Example 3
This example describes how to get Bill-to balances for a customer.
Example 3 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjmRest/channelCustomerProgramCheckbookBalances?DataForCode=ORA_BILL_TO_BAL&ProgramId=300100562606570&AccrueToAccountIdFilter=1290"
Example 3 Response Body
{ "items": [ { "DataFor": "Bill-to Balances", "DataForCode": "ORA_BILL_TO_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "Blue Semiconductor", "AccrueToAccountNumber": "10045", "AccrueToAccountId": 1290, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 20433, "InProgressAmountInProgramCurrency": 0, "PaidAmountInProgramCurrency": 18607, "BalanceAmountInProgramCurrency": 1826, "EarnedAmountInFunctionalCurrency": 20433, "InProgressAmountInFunctionalCurrency": 0, "PaidAmountInFunctionalCurrency": 18607, "BalanceAmountInFunctionalCurrency": 1826, "BillToAccountNumber": "10045", "BillToCustomer": "Blue Semiconductor", "BillToAccountId": 1008, "BillToSite": "Foster City", "BillToSiteUseId": 1036, "BillToSiteAddress": "123 Rock Harbor Lane, Detroit, MI" } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0 }
Example 4
This example describes how to get customer balances for a program when the customer is using a promotion code.
Example 4 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/cjmRest/channelCustomerProgramCheckbookBalances?DataForCode=ORA_CUSTOMER_BAL&PromotionCode='CR15010'&AccrueToAccountIdFilter=1290"
Example 4 Response Body
{ "items": [ { "DataFor": "Customer Balances", "DataForCode": "ORA_CUSTOMER_BAL", "ProgramName": "Summer Special", "ProgramId": 300100562606570, "PromotionCode": "CR15010", "AccrueToCustomer": "Blue Semiconductor", "AccrueToAccountNumber": "10045", "AccrueToAccountId": 1290, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "ProgramCurrency": "US Dollar", "ProgramCurrencyCode": "USD", "EarnedAmountInProgramCurrency": 20433, "InProgressAmountInProgramCurrency": 0, "PaidAmountInProgramCurrency": 18607, "BalanceAmountInProgramCurrency": 1826, "EarnedAmountInFunctionalCurrency": 20433, "InProgressAmountInFunctionalCurrency": 0, "PaidAmountInFunctionalCurrency": 18607, "BalanceAmountInFunctionalCurrency": 1826, "BillToAccountNumber": null, "BillToCustomer": null, "BillToAccountId": null, "BillToSite": null, "BillToSiteUseId": null, "BillToSiteAddress": null } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0 }