Skip to content

割引契約の件数を取得する#

Description#

リクエストパラメータ「顧客ID」「基本契約ID」「請求先ID」「割引契約ID」「(割引対象の)サービス契約ID」「サービスコード」「ステータス」、各フリー項目を設定し、該当する割引契約情報の件数を取得します。

Method#

GET

Request Header#

共通リクエストヘッダーを参照してください。

Argument#

Name Type Required Length
(Long/Decimalの場合はValue)
URI Query String Description
service_application_date_from String 8 - サービス申込年月日From
入力値のサービス申込年月日以降を検索
yyyyMMdd形式
service_application_date_to String 8 - サービス申込年月日To
入力値のサービス申込年月日以前を検索
yyyyMMdd形式
service_end_application_date_from String 8 - サービス終了申込年月日From
入力値のサービス終了申込年月日以降を検索
yyyyMMdd形式
service_end_application_date_to String 8 - サービス終了申込年月日To
入力値のサービス終了申込年月日以前を検索
yyyyMMdd形式
service_code String 1

10
- サービスコード
商品IDとして使用
半角英数字またはハイフン、アンダーバーのみ入力可能
customer_id String 15 - 顧客ID
顧客を一意に識別するID
basic_contract_id String 15 - 基本契約ID
契約グループを一意に識別するID
bill_to_id String 15 - 請求先ID
請求先を一意に識別するID
order_number String 15 - 注文番号
contract_number String 15 - 契約番号
administration_number Long 1

999
- 管理番号
status String 1

59
- ステータス
ステータスを表す任意のコード値を設定可能
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定
例) 001:契約中、999:解約済
service_contract_id String 15 - サービス契約ID
割引の対象として登録されているサービス契約IDによる絞り込み検索を行う
free_item1 String 1

1000
- フリー項目1
free_item2 String 1

1000
- フリー項目2
free_item3 String 1

1000
- フリー項目3
free_item4 String 1

1000
- フリー項目4
free_item5 String 1

1000
- フリー項目5
free_item6 String 1

1000
- フリー項目6
free_item7 String 1

1000
- フリー項目7
free_item8 String 1

1000
- フリー項目8
free_item9 String 1

1000
- フリー項目9
free_item10 String 1

1000
- フリー項目10
discount_contract_id String 15 - 割引契約ID
割引契約を一意に識別するID
apply_start_month_from String 6 - 適用開始年月From
入力値の適用開始年月以降
yyyyMM形式
apply_start_month_to String 6 - 適用開始年月To
入力値の適用開始年月以前
yyyyMM形式
apply_end_month_from String 6 - 適用終了年月From
入力値の適用終了年月以降
yyyyMM形式
apply_end_month_to String 6 - 適用終了年月To
入力値の適用終了年月以前
yyyyMM形式

URI#

/API/v2/api/discountcontractslistcount

Sample request uri#

割引契約IDを指定しての検索

/API/v2/api/discountcontractslistcount?discount_contract_id=000000000000277

Parameters in request body#

なし

Return Codes#

Code Description
200 レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。
401 認証エラー。API認証時のエラー。
403 アクセス不可
404 対象なし。対象の情報が見つからない場合。
500 業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。

Response Header#

なし

Response Parameter#

共通仕様はこちらを参照してください。

  • レスポンス(正常)

Example#

Parameters#

Top