Get all channel customer available accruals

get

/fscmRestApi/cjm/channelCustomerAvailableAccruals

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : channelCustomerAvailableAccruals
Match All
Show Source
Nested Schema : CollectionProperties
Type: object
Show Source
Nested Schema : channelCustomerAvailableAccruals-allOf[1]
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
Items in the collection.
Show Source
Nested Schema : channelCustomerAvailableAccruals-item-response
Match All
Show Source
Nested Schema : channelCustomerAvailableAccruals-item
Type: object
Show Source
Nested Schema : channelCustomerAvailableAccruals-item-response-allOf[1]
Type: object
Back to Top

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
}
Back to Top