Input index Input details Output index Output details

PCM_OP_BILL_MAKE_BILL_NOW

Component financial
Visibility public
Transaction required


Description

This opcode is used to produce Bill Now for the specified billinfo object, for account, or for the list of pending items.


Input field index

0 poid POID
0 poid BILLINFO_OBJ
0 poid ACCOUNT_OBJ
0 string PROGRAM_NAME
0 timestamp END_T
0 int FLAGS
0 poid SERVICE_OBJ
0 array ITEMS
1 poid      ITEM_OBJ
0 substruct CONTEXT_INFO
1 string      CORRELATION_ID
1 string      EXTERNAL_USER


Output field index

0 poid POID
0 array RESULTS
1 poid      BILLINFO_OBJ
1 poid      LAST_BILL_OBJ
1 decimal      PENDING_RECV
0 substruct CONTEXT_INFO
1 string      CORRELATION_ID
1 string      EXTERNAL_USER


Input details

0 poid    POID
Use required
Class /account


0 poid    BILLINFO_OBJ
Use optional
Class /billinfo

Poid of billinfo for which Bill Now is produced. If it is not presented then Bill Now will be produced for each billinfo for the given account

0 poid    ACCOUNT_OBJ
Use optional
Class /account

Account for which bill now is produced.

0 string    PROGRAM_NAME
Use required
Max length 60

Program name - identifies calling program

0 timestamp    END_T
Use optional

Time of producing Bill Now. If it is not presented, then the current time is used.

0 int    FLAGS
Use optional

This field may contain two flags (bits): 1. PIN_BILL_FLG_APPLY_FOLDS (value is 0x10). This flag indicates to apply folds for Bill Now. 2. PIN_BILL_FLG_APPLY_DISCOUNTS (value is 0x20). This indicates to apply billing time discounts for Bill Now.

0 poid    SERVICE_OBJ
Use optional
Class /service

This poid specifies the subscription. If the account_poid for this service is the same as poid from the input flist, then the Bill_Now will be produced for this subscription. Otherwise, the Bill_Now will be produced for the sponsor which is defined by poid, but it will include charges only from this subscription.

0 array    ITEMS
Use optional
ElemID mode ignored
Iteration undefined
Min number of Elements 0

List of pending items to be included into the Bill_Now

1 poid    ITEM_OBJ
Use required
Parent in.ITEMS
Class /item

Item poid from the ITEMS array

0 substruct    CONTEXT_INFO
Use optional

Substruct to pass information from external clients.

1 string    CORRELATION_ID
Use optional
Parent in.CONTEXT_INFO
Max length 128

Correlation id passed by an external system to BRM.

1 string    EXTERNAL_USER
Use optional
Parent in.CONTEXT_INFO
Max length 128

User of an external system connecting to BRM.


Output details

0 poid    POID
Use required
Class /account

Account object passed into call.

0 array    RESULTS
Use required
ElemID mode ignored
Iteration undefined
Min number of Elements 1

Results array contains info for each produced Bill Now object.

1 poid    BILLINFO_OBJ
Use required
Parent out.RESULTS
Class /billinfo

Poid of billinfo for which Bill Now is produced.

1 poid    LAST_BILL_OBJ
Use required
Parent out.RESULTS
Class /bill

Poid of the created bill object (which is Bill Now)

1 decimal    PENDING_RECV
Use required
Parent out.RESULTS

Value of Bill Now totals.

0 substruct    CONTEXT_INFO
Use optional

Substruct to pass information from external clients.

1 string    CORRELATION_ID
Use optional
Parent out.CONTEXT_INFO
Max length 128

Correlation id passed by an external system to BRM.

1 string    EXTERNAL_USER
Use optional
Parent out.CONTEXT_INFO
Max length 128

User of an external system connecting to BRM.


Input index Input details Output index Output details