基本契約を編集する

Description

入力情報をもとに基本契約情報の登録、変更、削除を行います。基本契約情報を登録することにより、サービス契約を集約する契約グループ情報と請求先情報が登録されます。１つの契約グループ情報に対し、請求先情報は１つとなります。
なお、基本契約情報の変更を行う場合は、未設定の項目をnullで更新するため、編集を行わない項目も設定する必要があります。
また変更、削除を行う場合は、本API実行前に「基本契約を検索する」にて対象の基本契約マスタ情報を検索し、「バージョン情報」を取得する必要があります。

Method

POST

Request Header

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

Argument

なし

URI

/API/v2/api/basiccontract

Parameters in request body

共通仕様はこちらを参照してください。
下記の例には一部項目を記載しています。全項目の詳細は表を参照してください。

Example

▼ Exampleを展開

{
    "entry_id":"O00000000000001",
    "administration_number":"1",
    "group_id":"12345678",
    "classification_of_contract":"1",
    "customer_id":"123456789012345",
    "apply_start_date":"20170912",
    "apply_end_date":"20200912",
    "free_item":
        {
            "free1":"100",
            "free2":"テスト",
            "free3":"ABC"
        },
    "free_item1":"任意項目１",
    "free_item2":"任意項目２",
    "free_item3":"任意項目３"
}

Parameters

▼ Request Bodyを展開

Name	Type	Required	Length （Long/Decimalの場合はValue）	Description
entry_id	String	Yes	1 ～ 15	登録者ＩＤ 登録の処理を行ったユーザーのID
administration_number	Long	Yes	1 ～ 999	管理番号
bill_to_version_info	Long		1 ～ 999999999	請求先バージョン情報 変更、削除時必須 共通仕様はこちらを参照
group_id	String		8	グループＩＤ グループを一意に識別するＩＤ
classification_of_contract	String		1	契約種別 登録、変更時必須
customer_id	String		15	顧客ＩＤ 顧客を一意に識別するＩＤ
apply_start_date	String		8	適用開始年月日 顧客の適用を開始する年月日（当日を含む） 登録、変更時必須 yyyyMMdd形式
apply_end_date	String		8	適用終了年月日 顧客の適用を終了する年月日（当日を含む） yyyyMMdd形式
bill_to_id	String		15	請求先ＩＤ 請求先を一意に識別するＩＤ 変更、削除時必須
bill_to_name	String		1 ～ 128	請求先名称
zip_code	String		1 ～ 7	郵便番号
address1	String		1 ～ 30	住所１
address2	String		1 ～ 30	住所２
address3	String		1 ～ 30	住所３
address4	String		1 ～ 30	住所４
phone_number1	String		1 ～ 30	電話番号１
phone_number2	String		1 ～ 30	電話番号２
email_address1	String		1 ～ 256	メールアドレス１ メールアドレス形式
email_address2	String		1 ～ 256	メールアドレス２ メールアドレス形式
free_item	String		1 ～ 30000	フリー項目
free_item1	String		1 ～ 1000	フリー項目１
free_item2	String		1 ～ 1000	フリー項目２
free_item3	String		1 ～ 1000	フリー項目３
free_item4	String		1 ～ 1000	フリー項目４
free_item5	String		1 ～ 1000	フリー項目５
free_item6	String		1 ～ 1000	フリー項目６
free_item7	String		1 ～ 1000	フリー項目７
free_item8	String		1 ～ 1000	フリー項目８
free_item9	String		1 ～ 1000	フリー項目９
free_item10	String		1 ～ 1000	フリー項目１０
deletion_targeted_flag	String		1	削除対象フラグ 削除時必須

Return Codes

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

Response Header

なし

Response Parameter

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

• レスポンス（正常）

Example

▼ Exampleを展開

{
    "basic_contract_id":"000000000000001",
    "bill_to_id":"000000000000001",
    "result_information":{
        "result":"OK"
    }
}

Parameters

▼ Responseを展開

Name		Type	Required	Length （Long/Decimalの場合はValue）	Description
basic_contract_id		String		15	基本契約ＩＤ 契約グループを一意に識別するＩＤ
bill_to_id		String		15	請求先ＩＤ 請求先を一意に識別するＩＤ
result_information		list		Single	結果情報
	result	String		2	結果 OKまたはNGを返却
	detailed_result	String		1 ～ 256	結果詳細 NGの場合、エラー内容を返却

• レスポンス（異常）
  共通エラー情報を参照してください。

Top