Query Settlemet

query_settlement

Request Parameter

Parameter	Type	Meaning
account	Account	Account
range	string	Query range, currently valid values are "0d" (today) and "3d".

Result Response

Parameter	Type	Meaning
is_success	bool	Interface result
data	SettlementData	Settlement is returned
message	string	is_success = False error description is returned

SettlementData Parameter

Return type : Object

Parameter	Type	Meaning
> account	list	Object
>> branch_no	string	Branch Number
>> account	string	Account
> details	list	Object
>> date	string	Query Date
>> settlement_date	string (Optional)	Settlement Date (If no data will return None )
>> buy_value	int (Optional)	Buying Value (If no data will return None )
>> buy_fee	int (Optional)	Buying Fee (If no data will return None )
>> buy_settlement	int (Optional)	Buying Payable / Receivable Amount (If no data will return None )
>> buy_tax	int (Optional)	Buying Tax (If no data will return None )
>> sell_value	int (Optional)	Selling Value (If no data will return None )
>> sell_fee	int (Optional)	Selling Fee (If no data will return None )
>> sell_settlement	int (Optional)	Selling Payable / Receivable Amount (If no data will return None )
>> sell_tax	int (Optional)	Selling Tax (If no data will return None )
>> total_bs_value	int (Optional)	Total Buying & Selling Value (If no data will return None )
>> total_fee	int (Optional)	Total Fee (If no data will return None )
>> total_tax	int (Optional)	Total Tax (If no data will return None )
>> total_settlement_amount	int (Optional)	Total Payable & Receivable Amount (If no data will return None )
>> currency	string (Optional)	Currency (If no data will return None )

Request Example

sdk.accounting.query_settlement(account,"3d")

Response Example

Result {
    is_success: True,
    message: None,
    data :
      SettlementData{
        account: AccountRes {
          branch_no: "6460",    # Branch Number (string)
          account: "26"         # Account (string)
        },
        details: [
          Settlement{
            date: "2023/10/16",   # Query Date (string)
            settlement_date: "2023/10/18",  # Settlement Date  (string)
            buy_value: 12,              # Buying Value (int)
            buy_fee: 12,                # Buying Fee (int)
            buy_settlement: 0,          # Buying Payable / Receivable Amount (int)
            buy_tax: 0,                 # Buying Tax (int)
            sell_value: 4,              # Selling Value (int)
            sell_fee: 4,                # Selling Fee (int)
            sell_settlement: 0,         # Selling Payable / Receivable Amount (int)
            sell_tax: 4,                # Selling Tax (int)
            total_bs_value: 16,         # Total Buying & Selling Value (int)
            total_fee: 16,              # Total Fee (int)
            total_tax: 4,               # Total Tax (int)
            total_settlement_amount: 0, # Total Payable & Receivable Amount (int)
            currency: TWD,              # Currency (string)
          },
          Settlement{
            date: "2023/10/17",                # Query Date (string)
            settlement_date: "2023/10/19",     # Settlement Date (string)
            buy_value: 735500,                 # Buying Value (int)
            buy_fee: 313,                      # Buying Fee (int)
            buy_settlement: -1429513,          # Buying Payable / Receivable Amount (int)
            buy_tax: 0,                        # Buying Tax (int)
            sell_value: 770500,                # Selling Value (int)
            sell_fee: 320,                     # Selling Fee (int)
            sell_settlement: 0,                # Selling Payable / Receivable Amount (int)
            sell_tax: 2309,                    # Selling Tax (int)
            total_bs_value: 1506000,           # Total Buying & Selling Value (int)
            total_fee: 633,                    # Total Fee (int)
            total_tax: 2309,                   # Total Tax (int)
            total_settlement_amount: -1429513, # Total Payable & Receivable Amount (int)
            currency: "TWD",                   # Currency (string)
          },
          Settlement{
            date: "2023/10/18",   # Query Date (string)
            settlement_date: None,  # Settlement Date (string)
            buy_value: None,              # Buying Value (int)
            buy_fee: None,                # Buying Fee (int)
            buy_settlement: None,          # Buying Payable / Receivable Amount (int)
            buy_tax: None,                 # Buying Tax (int)
            sell_value: None,              # Selling Value (int)
            sell_fee: None,                # Selling Fee (int)
            sell_settlement: None,         # Selling Payable / Receivable Amount (int)
            sell_tax: None,                # Selling Tax (int)
            total_bs_value: None,         # Total Buying & Selling Value (int)
            total_fee: None,              # Total Fee (int)
            total_tax: None,               # Total Tax (int)
            total_settlement_amount: None, # Total Payable & Receivable Amount (int)
            currency: None,              # Currency (string)
          }
        ]
      }
}