Jump to

• Request
• Response
• Examples

Get all channel customer checkbook balances

get

/fscmRestApi/cjmRest/channelCustomerCheckbookBalances

Request

Query Parameters

• AccrueToAccountId: number
  Value that uniquely identifies the accrue-to customer account.
• AccrueToAccountNumber: string
  Number of the accrue-to customer account.
• AccrueToCustomerFilter: string
  Filter for the accrue-to customer(Start with).
• BusinessUnit: string
  Name of the business unit.
• BusinessUnitId(required): number
  Value that uniquely identifies the business unit.
• DataFor: string
  Value that indicates whether the customer balances, program balances, or total balances are retrieved.
• DataForCode(required): string
  Abbreviation that indicates whether the customer balances, program balances, or total balances are retrieved. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CHKBK_TYPE.
• GLCalendarYear: number
  Value that indicates the 4-digit calendar year.
• MyProgramFlag: boolean
  Contains one of the following values: true or false. If true, then the query is filtered based on the program owner. If false, then the query isn't filtered by the program owner. If not specified, it defaults to true.
• 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 Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : channelCustomerCheckbookBalances

Match All

Show Source

• object CollectionProperties
• object channelCustomerCheckbookBalances-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CollectionProperties"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "title":"Items",
                    "type":"array",
                    "description":"The items in the collection.",
                    "items":{
                        "$ref":"#/components/schemas/channelCustomerCheckbookBalances-item-response"
                    }
                }
            }
        }
    ],
    "x-hints":{
        "group":"SCM",
        "subgroup":"OrderManagement",
        "usage":"BusinessObject"
    }
}

Nested Schema : CollectionProperties

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : channelCustomerCheckbookBalances-allOf[1]

Type: object

Show Source

• items: array Items
  Title: Items

  The items in the collection.

{
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerCheckbookBalances-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: channelCustomerCheckbookBalances-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerCheckbookBalances-item-response"
    }
}

Nested Schema : channelCustomerCheckbookBalances-item-response

Match All

Show Source

• object channelCustomerCheckbookBalances-item
• object channelCustomerCheckbookBalances-item-response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/channelCustomerCheckbookBalances-item"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : channelCustomerCheckbookBalances-item

Type: object

Show Source

• 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.
• BalanceAmountInFunctionalCurrency: number
  Read Only: true

  Balance amount in the functional currency.
• BalanceAmountInProgramCurrency: number
  Read Only: true

  Balance amount in the program currency.
• BusinessUnit: string
  Read Only: true

  Name of the business unit.
• BusinessUnitId: number
  Read Only: true

  Value that uniquely identifies the business unit.
• DataFor: string
  Read Only: true

  Value that indicates whether the customer balances, program balances, or total balances are retrieved.
• DataForCode: string
  Read Only: true

  Abbreviation that indicates whether the customer balances, program balances, or total balances are retrieved. A list of accepted values is defined in the lookup type ORA_CJM_CUST_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.
• GLCalendarYear: number
  Read Only: true

  Value that indicates the 4-digit calendar year.
• 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.
• ProgramType: string
  Read Only: true

  Type of program on which the customer program is based.
• ProgramTypeId: integer
  Read Only: true

  Value that uniquely identifies the type of program on which the customer program is based.
• PromotionCode: string
  Read Only: true

  Abbreviation that uniquely identifies the customer program.

{
    "type":"object",
    "properties":{
        "DataFor":{
            "type":"string",
            "description":"Value that indicates whether the customer balances, program balances, or total balances are retrieved.",
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "DataForCode":{
            "type":"string",
            "description":"Abbreviation that indicates whether the customer balances, program balances, or total balances are retrieved. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CHKBK_TYPE.",
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Name of the business unit.",
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "BusinessUnitId":{
            "type":"number",
            "description":"Value that uniquely identifies the business unit.",
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "GLCalendarYear":{
            "type":"number",
            "description":"Value that indicates the 4-digit calendar year.",
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "FunctionalCurrency":{
            "type":"string",
            "readOnly":true,
            "description":"Value that indicates the functional currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "FunctionalCurrencyCode":{
            "type":"string",
            "readOnly":true,
            "description":"Abbreviation that identifies the functional currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "AccrueToCustomer":{
            "type":"string",
            "readOnly":true,
            "description":"Name of the accrue-to customer.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "AccrueToAccountNumber":{
            "type":"string",
            "readOnly":true,
            "description":"Number of the accrue-to customer account",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "AccrueToAccountId":{
            "type":"integer",
            "readOnly":true,
            "description":"Value that uniquely identifies the accrue-to customer account.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "ProgramName":{
            "type":"string",
            "readOnly":true,
            "description":"Name of the customer program.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "ProgramId":{
            "type":"integer",
            "readOnly":true,
            "description":"Value that uniquely identifies the customer program.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "PromotionCode":{
            "type":"string",
            "readOnly":true,
            "description":"Abbreviation that uniquely identifies the customer program.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "ProgramType":{
            "type":"string",
            "readOnly":true,
            "description":"Type of program on which the customer program is based.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "ProgramTypeId":{
            "type":"integer",
            "readOnly":true,
            "description":"Value that uniquely identifies the type of program on which the customer program is based.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "ProgramCurrency":{
            "type":"string",
            "readOnly":true,
            "description":"Value that indicates the program currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "ProgramCurrencyCode":{
            "type":"string",
            "readOnly":true,
            "description":"Abbreviation that identifies the program currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "EarnedAmountInProgramCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"Earned amount in the program currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "InProgressAmountInProgramCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"In-progress amount in the program currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "PaidAmountInProgramCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"Paid amount in the program currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "BalanceAmountInProgramCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"Balance amount in the program currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "EarnedAmountInFunctionalCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"Earned amount in the functional currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "InProgressAmountInFunctionalCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"In-progress amount in the functional currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "PaidAmountInFunctionalCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"Paid amount in the functional currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        },
        "BalanceAmountInFunctionalCurrency":{
            "type":"number",
            "readOnly":true,
            "description":"Balance amount in the functional currency.",
            "x-queryable":false,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Nested Schema : channelCustomerCheckbookBalances-item-response-allOf[1]

Type: object

Back to Top

Examples

These examples describe how to get all channel customer 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/cjmRest/channelCustomerCheckbookBalances"

Example 1

This example describes how to get all channel customer checkbook balances for each customer.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/cjmRest/channelCustomerCheckbookBalances?DataForCode=ORA_CUSTOMER_BAL&BusinessUnit=Vision Operations&GLCalendarYear=2022&MyProgramFlag=true"

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "Big Computers",
            "AccrueToAccountNumber": "10022",
            "AccrueToAccountId": 6832,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 157290,
            "InProgressAmountInFunctionalCurrency": 3412,
            "PaidAmountInFunctionalCurrency": 151292,
            "BalanceAmountInFunctionalCurrency": 2586
        },
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "Blue Semiconductor",
            "AccrueToAccountNumber": "10045",
            "AccrueToAccountId": 6860,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 143200,
            "InProgressAmountInFunctionalCurrency": 630,
            "PaidAmountInFunctionalCurrency": 139293,
            "BalanceAmountInFunctionalCurrency": 3277
        },
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "Fantastic Laptops",
            "AccrueToAccountNumber": "10072",
            "AccrueToAccountId": 4564,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 140293,
            "InProgressAmountInFunctionalCurrency": 790,
            "PaidAmountInFunctionalCurrency": 138290,
            "BalanceAmountInFunctionalCurrency": 1213
        },
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "First Software",
            "AccrueToAccountNumber": "20920",
            "AccrueToAccountId": 4567,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 139239,
            "InProgressAmountInFunctionalCurrency": 1482,
            "PaidAmountInFunctionalCurrency": 130290,
            "BalanceAmountInFunctionalCurrency": 7467
        },
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "Green Corp.",
            "AccrueToAccountNumber": "21392",
            "AccrueToAccountId": 2580,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 130400,
            "InProgressAmountInFunctionalCurrency": 0,
            "PaidAmountInFunctionalCurrency": 130400,
            "BalanceAmountInFunctionalCurrency": 0
        },
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "Large and Associates",
            "AccrueToAccountNumber": "20272",
            "AccrueToAccountId": 6764,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 128190,
            "InProgressAmountInFunctionalCurrency": 4903,
            "PaidAmountInFunctionalCurrency": 113452,
            "BalanceAmountInFunctionalCurrency": 9835
        },
        {
            "DataFor": "Customer Balances",
            "DataForCode": "ORA_CUSTOMER_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "Seven Corporation",
            "AccrueToAccountNumber": "21494",
            "AccrueToAccountId": 3347,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 119223,
            "InProgressAmountInFunctionalCurrency": 5589,
            "PaidAmountInFunctionalCurrency": 110094,
            "BalanceAmountInFunctionalCurrency": 3540
        }
    ],
    "count": 7,
    "hasMore": false,
    "limit": 25,
    "offset": 0
}

Example 2

This example describes how to get the total channel customer checkbook balances.

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/cjmRest/channelCustomerCheckbookBalances?DataForCode=ORA_TOTAL_BAL&BusinessUnitId=204&GLCalendarYear=2022"

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "DataFor": "Total Balances",
            "DataForCode": "ORA_TOTAL_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": null,
            "AccrueToAccountNumber": null,
            "AccrueToAccountId": null,
            "ProgramName": null,
            "ProgramId": null,
            "PromotionCode": null,
            "ProgramType": null,
            "ProgramTypeId": null,
            "ProgramCurrency": null,
            "ProgramCurrencyCode": null,
            "EarnedAmountInProgramCurrency": null,
            "InProgressAmountInProgramCurrency": null,
            "PaidAmountInProgramCurrency": null,
            "BalanceAmountInProgramCurrency": null,
            "EarnedAmountInFunctionalCurrency": 957835,
            "InProgressAmountInFunctionalCurrency": 16806,
            "PaidAmountInFunctionalCurrency": 913111,
            "BalanceAmountInFunctionalCurrency": 27918
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0
}

Example 3

This example describes how to get program 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/cjmRest/channelCustomerCheckbookBalances?DataForCode=ORA_PROGRAM_BAL&BusinessUnit=Vision Operations&GLCalendarYear=2022&AccrueToCustomerFilter=First Software"

Example 3 Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "DataFor": "Program Balances",
            "DataForCode": "ORA_PROGRAM_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "First Software",
            "AccrueToAccountNumber": "20920",
            "AccrueToAccountId": 4567,
            "ProgramName": "Program 1",
            "ProgramId": 300100562692478,
            "PromotionCode": "CR14024",
            "ProgramType": "Customer Rebate",
            "ProgramTypeId": 300100562725304,
            "ProgramCurrency": "US Dollar",
            "ProgramCurrencyCode": "USD",
            "EarnedAmountInProgramCurrency": 28109,
            "InProgressAmountInProgramCurrency": 401,
            "PaidAmountInProgramCurrency": 27708,
            "BalanceAmountInProgramCurrency": 0,
            "EarnedAmountInFunctionalCurrency": 28109,
            "InProgressAmountInFunctionalCurrency": 401,
            "PaidAmountInFunctionalCurrency": 27708,
            "BalanceAmountInFunctionalCurrency": 0
        },
        {
            "DataFor": "Program Balances",
            "DataForCode": "ORA_PROGRAM_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "First Software",
            "AccrueToAccountNumber": "20920",
            "AccrueToAccountId": 4567,
            "ProgramName": "Program 2",
            "ProgramId": 300100562648337,
            "PromotionCode": "CR15021",
            "ProgramType": "Customer Rebate",
            "ProgramTypeId": 300100562725304,
            "ProgramCurrency": "US Dollar",
            "ProgramCurrencyCode": "USD",
            "EarnedAmountInProgramCurrency": 20433,
            "InProgressAmountInProgramCurrency": 0,
            "PaidAmountInProgramCurrency": 18607,
            "BalanceAmountInProgramCurrency": 1826,
            "EarnedAmountInFunctionalCurrency": 20433,
            "InProgressAmountInFunctionalCurrency": 0,
            "PaidAmountInFunctionalCurrency": 18607,
            "BalanceAmountInFunctionalCurrency": 1826
        },
        {
            "DataFor": "Program Balances",
            "DataForCode": "ORA_PROGRAM_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "First Software",
            "AccrueToAccountNumber": "20920",
            "AccrueToAccountId": 4567,
            "ProgramName": "Program 3",
            "ProgramId": 300100562648481,
            "PromotionCode": "CR15082",
            "ProgramType": "Customer Rebate",
            "ProgramTypeId": 300100562725304,
            "ProgramCurrency": "US Dollar",
            "ProgramCurrencyCode": "USD",
            "EarnedAmountInProgramCurrency": 41032,
            "InProgressAmountInProgramCurrency": 580,
            "PaidAmountInProgramCurrency": 35644,
            "BalanceAmountInProgramCurrency": 4808,
            "EarnedAmountInFunctionalCurrency": 41032,
            "InProgressAmountInFunctionalCurrency": 580,
            "PaidAmountInFunctionalCurrency": 35644,
            "BalanceAmountInFunctionalCurrency": 4808
        },
        {
            "DataFor": "Program Balances",
            "DataForCode": "ORA_PROGRAM_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "First Software",
            "AccrueToAccountNumber": "20920",
            "AccrueToAccountId": 4567,
            "ProgramName": "Program 4",
            "ProgramId": 300100562648417,
            "PromotionCode": "CR15060",
            "ProgramType": "Customer Rebate",
            "ProgramTypeId": 300100562725304,
            "ProgramCurrency": "US Dollar",
            "ProgramCurrencyCode": "USD",
            "EarnedAmountInProgramCurrency": 19234,
            "InProgressAmountInProgramCurrency": 501,
            "PaidAmountInProgramCurrency": 18382,
            "BalanceAmountInProgramCurrency": 351,
            "EarnedAmountInFunctionalCurrency": 19234,
            "InProgressAmountInFunctionalCurrency": 501,
            "PaidAmountInFunctionalCurrency": 18382,
            "BalanceAmountInFunctionalCurrency": 351
        },
        {
            "DataFor": "Program Balances",
            "DataForCode": "ORA_PROGRAM_BAL",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "GLCalendarYear": 2022,
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "AccrueToCustomer": "First Software",
            "AccrueToAccountNumber": "20920",
            "AccrueToAccountId": 4567,
            "ProgramName": "Program 5",
            "ProgramId": 300100562606570,
            "PromotionCode": "CR15010",
            "ProgramType": "Customer Rebate",
            "ProgramTypeId": 300100562725304,
            "ProgramCurrency": "US Dollar",
            "ProgramCurrencyCode": "USD",
            "EarnedAmountInProgramCurrency": 30431,
            "InProgressAmountInProgramCurrency": 0,
            "PaidAmountInProgramCurrency": 29949,
            "BalanceAmountInProgramCurrency": 482,
            "EarnedAmountInFunctionalCurrency": 30431,
            "InProgressAmountInFunctionalCurrency": 0,
            "PaidAmountInFunctionalCurrency": 29949,
            "BalanceAmountInFunctionalCurrency": 482
        },

    ],
    "count": 5,
    "hasMore": false,
    "limit": 25,
    "offset": 0
}

Back to Top