1. Aggregator Guide
  2. Aggregator Service
  3. Implementation Details of Individual Service
  4. SCF Implementation

1.2.1 SCF Implementation

Case 1

We want the list of top programs between the logged in party and specified associated party for both roles of logged in party - buyer and supplier. To achieve this we fire the list of Invoices with below specified query parameters and then group them by program code (grouping invoices of same program) and finally calculate the sum of invoice amount for each group.

Prop_id: invoices.Amount.Program

URL: /digx-scf/v1/aggregator/invoices

Request Parameters:

data: Amount

grouping: Program

q:

  1. Role of the logged in party that is used to get list of invoices(B or S) .
  2. Invoice status - ACCEPTED, RAISED, FINANCED, PARTIAL_FINANCED to get outstanding invoices.
  3. Payment status – UNPAID, PART_PAID, OVERDUE to get outstanding invoices.
  4. Associated party id – To get list of invoices only linked between logged in party id and associated party id specified.

sortBy: We want only top programs so we sort the groups by total amount. Thus we send amount and DESC(Descending).

maxRecords: We want only top 5 programs and thus we send 5.

Response: 

{    
        "aggregatedData": {        
            "resource":"invoices",
            "groups": [{            
                "id": "HPRF Program~HP Reverse Factoring~A~B",
                  "intervals":[{
                    "amount":{
                    "currency":"GBP",
                    "amount":62739.98688000                
                        },     
                        "count": 4            
                        }]        
                            }, {            
                            "id":"HPPRGFIN1~HPPRGFIN1~A~B",
                            "intervals":
                              [{"amount":{ 
                               "currency":"GBP",
                               "amount":8760.63785888
                                },                
                              "count":8            
                             }]        
                          }]    
                        }
}

Here, “groups” is the array which contains list of data after grouping. i.e. different groups. Inside group, “id” represents the unique Id of that group. In the response of this API, “id” will always be combination of program code, program name, relation of logged in party in that program (A or CP) and role of logged in party in that program (B or S), all tilde(~) separated.

Intervals contains the actual data (in this case, the total amount for each program) at various intervals. Here since no interval is specified there will always be one element in intervals array.

Case 2

We want the list of programs currency wise between the logged in party and specified associated party for both roles of logged in party - buyer and supplier. To achieve this we fire the list of Invoices with below specified query parameters and then group them by program code (grouping invoices of same program), then group them by currency(grouping invoices of same currency for every program) and finally calculate the sum of invoice amount for each group.

Prop_id: invoices.Amount.Currency,Program or invoices.Amount.Program,Currency

URL: /digx-scf/v1/aggregator/invoices

Request Parameters:

data: Amount

grouping: Currency,Program or Program,Currency

q:

  1. Role of the logged in party that is used to get list of invoices(B or S) .
  2. Invoice status - ACCEPTED, RAISED, FINANCED, PARTIAL_FINANCED to get outstanding invoices.
  3. Payment status – UNPAID, PART_PAID, OVERDUE to get outstanding invoices.
  4. Associated party id – To get list of invoices only linked between logged in party id and associated party id specified.

Response: 

{           
        "aggregatedData": {            
        "resource": "invoices",            
        "groups": [{ 
        "identifiers": ["GBP", "HPFactoringWRec~HP Factoring WRec~A~S"],
        "intervals":[{
          "amount":
           {"currency":"GBP",
            "amount":7426.00 
            },                
            "count":37            
            }]        
                }, 
                { "identifiers": ["USD","HPFactoringWRec~HP Factoring WRec~A~S"],
                    "intervals":
                    [{ "amount":
                        { "currency":"USD",
                           "amount":39840.00 },                
                            "count":295            
                            }]        
                        }]    
                }
              }

Here, “groups” is the array which contains list of data after grouping. i.e. different groups. Inside group, “identifiers” represents the unique Id of that group. Since, multiple grouping is done, id is the list containing 2 elements. First is Currency and second Is the combination of program code, program name, relation of logged in party in that program (A or CP) and role of logged in party in that program (B or S), all tilde(~) separated.

Intervals contains the actual data (in this case, the total amount for each program, currency wise) at various intervals. Here since no interval is specified there will always be one element in intervals array.

Case 3

We want the list of top associated parties linked with logged in party in a particular program. To achieve this we fire the list of Invoices with below specified query parameters and then group them by associated party Id (grouping invoices of same associated party) and finally calculate the sum of invoice amount for each group.

Prop_id: invoices.Amount.AssociatedParty

URL: /digx-scf/v1/aggregator/invoices

Request Parameters:

data: Amount

grouping: AssociatedParty

q:

  1. Role of the logged in party that is used to get list of invoices(B or S) .
  2. Invoice status - ACCEPTED, RAISED, FINANCED, PARTIAL_FINANCED to get outstanding invoices.
  3. Payment status – UNPAID, PART_PAID, OVERDUE to get outstanding invoices.
  4. program code – To get list of invoices only linked between logged in party id and associated party id in the specified program.

sortBy: We want only top associated parties so we sort the groups by total amount. Thus we send amount and DESC(Descending).

maxRecords: We want only top 10 associated parties and thus we send 10.

Response: 

{           
        "aggregatedData": {            
        "resource": "invoices",            
        "groups": [{             
        "id":" E4228ED58341003545623EDC7319024990E5C38ACB60 ~***728 ~TURBO TEXTILES ",
        "intervals":[{                
        "amount": {                    
        "currency":"GBP",
        "amount":7426.00 },
        "count":37      
        }]        
        }, 
        { "id": " E4228ED58341003545623EDC7319024990E5C38ACB90~*****C001 ~TestCP02 "],
          "intervals":
            [{ "amount":{                    
                "currency":"USD", 
                "amount":39840.00 },
                "count":295            
              }]        
           }]    
        }
}

Here, “groups” is the array which contains list of data after grouping. i.e. different groups. Inside group, “id” represents the unique Id of that group. In the response of this API, “id” will always be combination of associated party id (hashed value), associated party id (display value), all tilde(~) separated.

Intervals contains the actual data (in this case, the total amount for each associated party) at various intervals. Here since no interval is specified there will always be one element in intervals array.

Case 4

We want the list of associated parties currency wise linked with logged in party in a particular program. To achieve this we fire the list of with below specified query parameters and then group them by associated party id (grouping invoices of same associated party), then group them by currency(grouping invoices of same currency for every associated party) and finally calculate the sum of invoice amount for each group.

Prop_id: invoices.Amount.AssociatedParty,Currency or invoices.Amount.Currency,AssociatedParty

URL:/digx-scf/v1/aggregator/invoices

Request Parameters:

data: Amount

grouping: AssociatedParty,Currency or Currency,AssociatedParty

q:

  1. Role of the logged in party that is used to get list of invoices(B or S) .
  2. Invoice status - ACCEPTED, RAISED, FINANCED, PARTIAL_FINANCED to get outstanding invoices.
  3. Payment status – UNPAID, PART_PAID, OVERDUE to get outstanding invoices.
  4. program code – To get list of invoices only linked between logged in party id and associated party id in the specified program.

Response: 

{           
        "aggregatedData": {            
        "resource": "invoices",            
        "groups": 
        [{"identifiers": 
            ["GBP", " E4228ED58341003545623EDC7319024990E5C38ACB60 ~***728  ~TURBO TEXTILES "],
             "intervals": [{ "amount":
             {"currency":"GBP",
              "amount":7426.00 },
              "count":37            
              }]        
              }, 
              {"identifiers": ["USD", " E4228ED58341003545623EDC7319024990E5C38ACB60 ~***728  ~TURBO TEXTILES "],
               "intervals":
                [{ "amount":{                      
                    "currency":"USD",
                     "amount":39840.00 },
                     "count":295            
                }]        
              }]    
            }
}

Here, “groups” is the array which contains list of data after grouping. i.e. different groups. Inside group, “identifiers” represents the unique Id of that group. Since, multiple grouping is done, id is the list containing 2 elements. First is Currency and second Is the combination of associated party id (hashed value), associated party id (display value), all tilde(~) separated.

Intervals contains the actual data (in this case, the total amount for each associated party, currency wise) at various intervals. Here since no interval is specified there will always be one element in intervals array.

Parent topic: Implementation Details of Individual Service