請求書参照

/api/v1.0/bill/search

請求書の参照処理を実行します。

アウトライン

リクエスト

Parameters

名前 概要 桁数 種別 必須
user_id ユーザーID（管理画面へのログインID） 100 メール形式 必須
access_key アクセスキー 100 半角英数 必須
limit_count 請求書取得件数
※0〜200の数値を設定する。省略した場合、20が設定される		 3 数値  
page_count 請求書取得開始インデックス
※0〜99,999の数値を設定する。省略した場合、0が設定される		 5 数値  
sort 検索順序に属するパラメータ
※省略時は請求書ID の昇順で返却する		   object  
bill 請求書に属するパラメータ   object  

sort (request)

下記のような項目のオブジェクト

名前 概要 桁数 種別 必須 一致
key キー名
※以下の項目からのみ有効、複数選択可(カンマ区切り)
※左の項目から優先的にソート順序が指定される
bill_id: 請求書 ID,
regist_date: 登録日時,
update_date: 更新日時		 31 文字列    
order ソート順
0: 昇順
1: 降順		 1 数値    

bill (request)

下記のような項目のオブジェクト

名前                               概要                               桁数 種別 必須 一致
number 請求書番号 100 半角英数 + 記号   完全一致
billing_code 請求先コード 20 半角英数 + 記号 (請求先部署番号指定時)
(請求先部署コード指定時)		 完全一致
billing_individual_number 請求先部署番号 18 数値   完全一致
billing_individual_code 請求先部署コード 20 半角英数 + 記号   完全一致
issue_date_from 発行日の検索開始日 10 日付    
issue_date_to 発行日の検索終了日 10 日付    
deadline_date_from 決済期限の検索開始日 10 日付    
deadline_date_to 決済期限の検索終了日 10 日付    
payment_method 決済手段 2 数値    
clearing_status 消込ステータス
0:未処理
1:完了
2:確認済み
3:未収
4:貸倒
5:手数料
6:現金
7:長期滞留債権
8:破産更生債権
9:売上取消
10:繰越
11:まるなげ		 2 数値    
marunage_clearing_status まるなげ消込ステータス
0:未処理
1:完了
2:確認済み
3:未収
4:貸倒
5:手数料
6:現金
7:長期滞留債権
8:破産更生債権
9:売上取消
10:繰越		 2 数値    
bs_residence_code 請求元差出人コード
20 半角英数 + 記号   完全一致
bs_department_code 請求元部署コード
40 半角英数 + 記号   完全一致
bs_owner_code 請求元担当者コード
20 半角英数 + 記号   完全一致
attachment_planned_flg ファイル添付予定フラグ
0:ファイル添付予定なし
1:ファイル添付予定あり
※ファイル添付機能利用中のみ利用可能		 1 数値    
attachment_flg 添付ファイルフラグ
0:添付ファイルなし
1:添付ファイルあり
※ファイル添付機能利用中のみ利用可能		 1 数値    
carryover_status 繰越ステータス
0:対象外
1:繰越待ち
2:繰越完了		 1 数値    
carryover_transit_bill_number 繰越先請求書番号 100 半角英数 + 記号   完全一致
regist_date_from 登録日時(開始日)
※時刻省略時 00:00:00 で検索します		 19 日時    
regist_date_to 登録日時(終了日)
※時刻省略時 23:59:59 で検索します		 19 日時    
update_date_from 更新日時(開始日)
※時刻省略時 00:00:00 で検索します		 19 日時    
update_date_to 更新日時(終了日)
※時刻省略時 23:59:59 で検索します		 19 日時    
valid_flg 状態
0:無効
1:有効		 1 数値    

レスポンス

Fields

名前 概要 型
user_id ユーザーID string
limit_count 請求書取得件数
※最大件数は、リクエストで指定された「請求書取得件数」に依存		 int
page_count 請求書取得開始インデックス
※取得した請求書の開始インデックスを返却する		 int
total_page_count 請求書取得開始インデックス合計
※指定された検索条件によって取得可能な請求書の全件数／請求書取得件数によって、算出される値を返却する		 int
sort 検索順序に属するパラメータ object
bill 請求書に属するパラメータ array
count_update_date 更新日時に属するパラメータ array

sort (response)

下記のような項目のオブジェクト

名前 概要 型
key キー名 string
order ソート順
0: 昇順
1: 降順		 int

bill (response)

下記のような項目のオブジェクトを持つリスト

名前 概要 型 備考
error_code エラーコード
※正常時はnull		 int  
error_message エラーメッセージ
※正常時はnull		 string  
number 請求書番号 string  
billing_code 請求先コード string  
billing_name 請求先名 string 発行時の情報を返却します
billing_individual_number 請求先部署番号 int  
billing_individual_code 請求先部署コード string  
billing_individual_name 請求先部署名 string 発行時の情報を返却します
billing_individual_address1 請求先部署宛名1 string 発行時の情報を返却します
billing_individual_address2 請求先部署宛名2 string 発行時の情報を返却します
billing_individual_address3 請求先部署宛名3 string 発行時の情報を返却します
billing_individual_zip_code 請求先部署郵便番号 string 発行時の情報を返却します
billing_individual_pref 請求先部署都道府県名 string 発行時の情報を返却します
billing_individual_city_address 請求先部署市区町村番地 string 発行時の情報を返却します
billing_individual_building_name 請求先部署建物名 string 発行時の情報を返却します
billing_individual_tel 請求先部署電話番号 string 発行時の情報を返却します
bill_detail_count 請求書明細件数 int  
subtotal_amount_billed 請求金額小計 int  
consumption_tax_amount 消費税額 int  
total_amount_billed 請求金額合計 int  
consumption_tax_items 消費税内訳 array 税率がない（対象外、非課税）場合はnullを返却
unclearing_amount 未消込金額 int  
message_column 通信欄 string  
billing_method 請求方法
0:請求無し
1:自動メール
2:手動メール
3:自動郵送
4:手動郵送
5:自動メール＋自動郵送
6:手動メール＋手動郵送
7:自動マイページ配信
8:手動マイページ配信配信		 int  
issue_date 請求書発行日 date  
make_date 請求書作成日 date  
sending_scheduled_date 請求書送付予定日 date  
sending_date 請求書送付日 date  
confirm_date 請求書確認日 date  
mail_send_flg メールステータス
0:未送信
1:送信済み		 int  
post_send_flg 郵送ステータス
0:未送信
1:送信済み		 int  
marunage_mail_status まるなげメールステータス
0:未送信
1:送信済み		 int  
marunage_post_status まるなげ郵送ステータス
0:注文済
1:発送済
2:完了
3:注文失敗
4:注文取り消し
5:注文差止
6:未送信　　　 　 　		 int  
payment_method 決済手段 int  
payment_method_number 決済情報番号 int  
payment_method_code 決済情報コード string  
settlement_result 決済連携ステータス
0:申請中
1:送信失敗
2:決済成功
3:決済失敗		 int  
settlement_linkage_status 決済データ連携ステータス
0:未連携
1:連携失敗
2:決済成功
3:決済失敗
4:連携なし
5:連携済み
6:再連携待ち		 int  
transfer_deadline 決済期限 date  
slip_deadline 払込票有効期限 date  
transfer_date 決済日 date  
gid 決済ID string  
ec 決済エラーコード string  
clearing_status 消込ステータス
0:未処理
1:完了
2:確認済み
3:未収
4:貸倒
5:手数料
6:現金
7:長期滞留債権
8:破産更生債権
9:売上取消
10:繰越
11:まるなげ		 int  
marunage_clearing_status まるなげ消込ステータス
0:未処理
1:完了
2:確認済み
3:未収
4:貸倒
5:手数料
6:現金
7:長期滞留債権
8:破産更生債権
9:売上取消
10:繰越		 int  
memo メモ string  
template_code 請求書テンプレート string  
bs_residence_code 請求元差出人コード string  
bs_residence_name 請求元差出人名 string  
bs_invoice_supplier_code 適格請求書発行事業者 登録番号 string 発行時の情報を返却します
bs_residence_zip_code 請求元差出人郵便番号 string 発行時の情報を返却します
bs_residence_pref 請求元差出人都道府県 string 発行時の情報を返却します
bs_residence_address 請求元差出人市区町村番地 string 発行時の情報を返却します
bs_residence_building_name 請求元差出人建物名 string 発行時の情報を返却します
bs_residence_phone_number 請求元差出人電話番号 string 発行時の情報を返却します
bs_department_code 請求元部署コード string  
bs_department_name 請求元部署名 string  
bs_owner_code 請求元担当者コード string  
bs_owner_name 請求元担当者名 string  
bs_owner_post_name 請求元担当者役職名 string  
carryover_status 繰越ステータス
0:対象外
1:繰越待ち
2:繰越完了		 int  
carryover_transit_bill_number 繰越先請求書番号 string  
carryover_total_amount 繰越金額 int  
attachment_planned_flg ファイル添付予定フラグ
0:ファイル添付予定なし
1:ファイル添付予定あり		 int  
attachment_flg 添付ファイルフラグ
0:添付ファイルなし
1:添付ファイルあり		 int  
download_url 請求書ダウンロードURL string  
bill_group_key 請求書合算キー string  
regist_date 登録日時 datetime  
update_date 更新日時 datetime  
valid_flg 有効フラグ
0:無効
1:有効		 int  

consumption_tax_items (response)

下記のような項目のオブジェクトを持つリスト

名前 概要 型 備考
taxable_amount 課税基準額 int 税抜額
tax_amount 消費税額 int  
tax_rate 税率 int  

count_update_date (response)

下記のような項目のオブジェクトを持つリスト

名前 概要 型
update_date 更新日時 datetime
update_count 更新日時毎の件数 int

使用例

リクエスト例

{
    "user_id": "sample@robotpayment.co.jp",
    "access_key": "xxxxxxxxxxxxxxxx",
    "limit_count": 20,
    "page_count": 1,
    "sort": {
        "key": "update_date,bill_id",
        "order": 0
    },
    "bill": {
        "number": "202001-sample-1",
        "billing_code": "sample",
        "billing_individual_number": 1,
        "billing_individual_code": "sample",
        "issue_date_from": "2020/06/01",
        "issue_date_to": "2020/07/30",
        "deadline_date_from": "2020/06/01",
        "deadline_date_to": "2020/07/30",
        "payment_method": 0,
        "clearing_status": 1,
        "marunage_clearing_status": "",
        "bs_residence_code": "bs_residence001",
        "bs_department_code": "bs_department001",
        "bs_owner_code": "bs_owner001",
        "attachment_planned_flg": 0,
        "attachment_flg": 0,
        "carryover_status": 0,
        "carryover_transit_bill_number": "",
        "regist_date_from": "2020/07/01 10:00:00",
        "regist_date_to": "2020/07/31 10:00:00",
        "update_date_from": "2020/07/01 10:00:00",
        "update_date_to": "2020/07/30 10:00:00",
        "valid_flg": 1
    }
}

レスポンス例

Status: 200 OK

{
    "user_id": "sample@robotpayment.co.jp",
    "limit_count": 20,
    "page_count": 0,
    "total_page_count": 1,
    "sort": {
        "key": "update_date,bill_id",
        "order": 0
    },
    "bill": [
        {
            "error_code": null,
            "error_message": null,
            "number": "202001-sample-1",
            "billing_code": "sample",
            "billing_name": "株式会社sample",
            "billing_individual_number": 1,
            "billing_individual_code": "sample",
            "billing_individual_name": "株式会社sample経理部",
            "billing_individual_address1": "株式会社sample",
            "billing_individual_address2": "経理部",
            "billing_individual_address3": "代表取締役　サンプル　様",
            "billing_individual_zip_code": "0000000",
            "billing_individual_pref": "東京都",
            "billing_individual_city_address": "渋谷区1-1-1",
            "billing_individual_building_name": "渋谷ビル3階",
            "billing_individual_tel": "00000000000",
            "bill_detail_count": 1,
            "subtotal_amount_billed": 10000,
            "consumption_tax_amount": 800,
            "total_amount_billed": 10800,
            "consumption_tax_items":[
              {
                "taxable_amount": 10000,
                "tax_amount": 800,
                "tax_rate": 8
              }
            ],
            "unclearing_amount": 0,
            "message_column": "message_column",
            "billing_method": 6,
            "issue_date": "2020/06/01",
            "make_date": "2020/06/01",
            "sending_scheduled_date": "2020/06/01",
            "sending_date": "2020/06/01",
            "confirm_date": "2020/06/01",
            "mail_send_flg": 1,
            "post_send_flg": 1,
            "marunage_mail_status": null,
            "marunage_post_status": null,
            "payment_method": 0,
            "payment_method_number": 1,
            "payment_method_code": "bank001",
            "settlement_result": 0,
            "settlement_linkage_status": 0,
            "transfer_deadline": "2020/07/30",
            "slip_deadline": null,
            "transfer_date": "2020/07/15",
            "gid": null,
            "ec": null,
            "clearing_status": 1,
            "marunage_clearing_status": null,
            "memo": "メモ",
            "template_code": "10010",
            "bs_residence_code": "bs_residence001",
            "bs_residence_name": "差出人1",
            "bs_invoice_supplier_code": "T1234567890123",
            "bs_residence_zip_code": "1234567",
            "bs_residence_pref": "北海道",
            "bs_residence_address": "札幌市1-1",
            "bs_residence_building_name": "札幌ビル1F",
            "bs_residence_phone_number": "08012345678",
            "bs_department_code": "bs_department001",
            "bs_department_name": "請求元財務部",
            "bs_owner_code": "bs_owner001",
            "bs_owner_name": "山田太郎",
            "bs_owner_post_name": "課長",
            "carryover_status": 0,
            "carryover_transit_bill_number": null,
            "carryover_total_amount": 0,
            "attachment_planned_flg": 0,
            "attachment_flg": 0,
            "download_url": "http:://",
            "bill_group_key": null,
            "regist_date": "2020/07/01 10:11:12",
            "update_date": "2020/07/01 16:17:18",
            "valid_flg": 1
        }
    ],
    "count_update_date": [
        {
            "update_date": "2020/07/01 16:17:18",
            "update_count": 1
        }
    ]
}

エラー

共通エラー

個別エラー

エラーコード 内容
4601 請求書番号が不正
4602 請求先コードが不正
4603 請求先部署番号が不正
4604 請求先部署コードが不正
4605 発行日の検索開始日が不正
4606 発行日の検索終了日が不正
4607 決済期限の検索開始日が不正
4608 決済期限の検索終了日が不正
4609 決済手段が不正
4610 消込ステータスが不正
4611 請求元部署コードが不正
4612 請求元担当者コードが不正
4613 繰越ステータスが不正
4614 繰越先請求書番号が不正
4615 登録日時の検索開始日が不正
4616 登録日時の検索終了日が不正
4617 更新日時の検索開始日が不正
4618 更新日時の検索終了日が不正
4619 状態が不正
4620 請求書取得件数が不正
4621 請求書取得開始インデックスが不正
4622 キー名が不正
4623 ソート順が不正
4624 請求書件数が100,000件に到達しました
4625 請求書参照に失敗しました
4626 まるなげ消込ステータスが不正
4627 請求元差出人コードが不正
4628 ファイル添付予定フラグが不正
4629 ファイル添付予定フラグ利用不可
4630 添付ファイルフラグが不正
4631 添付ファイルフラグ利用不可

TOPへ戻る