billing-robo-apispec

概要

API一覧

API Method Path
請求先登録更新 POST /api/v1.0/billing/bulk_upsert
請求先停止削除 POST /api/v1.0/billing/bulk_stop
口座振替依頼書発行 POST /api/v1.0/billing/bulk_download_pdf
請求先部署参照 POST /api/v1.0/billing_individual/search
クレジットカード登録(トークン方式) POST /api/v1.0/billing_payment_method/credit_card_token
決済情報参照 POST /api/v1.0/billing_payment_method/search
請求情報登録更新 POST /api/v1.0/demand/bulk_upsert
請求情報停止削除 POST /api/v1.0/demand/bulk_stop
売上消込結果参照 POST /api/v1.0/demand/search
請求情報参照 POST /api/v1.0/demand/search2
請求書発行 POST /api/v1.0/demand/bulk_issue_bill_select
即時決済 請求書合算 POST /api/demand/bulk_register
請求書送付メール POST /api/v1.0/bill/send_bill_by_email
請求書送付郵送 POST /api/v1.0/bill/send_bill_by_mail
繰越予約 POST /api/v1.0/bill/update_carryover
請求書参照 POST /api/v1.0/bill/search
請求書更新 POST /api/v1.0/bill/update
請求書無効 POST /api/v1.0/bill/stop
請求書明細参照 POST /api/v1.0/bill_detail/search
入金登録更新 POST /api/v1.0/payment/bulk_upsert
入金無効削除 POST /api/v1.0/payment/bulk_stop
入金参照 POST /api/v1.0/payment/search
消込 POST /api/v1.0/clearing/exec
消込結果参照 POST /api/v1.0/clearing/search
消込取消 POST /api/v1.0/clearing/bulk_cancel
消込結果明細参照 POST /api/v1.0/clearing_detail/search
商品登録更新2 POST /api/v1.0/goods/bulk_upsert2
商品停止削除 POST /api/v1.0/goods/bulk_stop
商品参照 POST /api/v1.0/goods/search
カスタム項目登録更新 POST /api/v1.0/custom_field/bulk_upsert
カスタム項目削除 POST /api/v1.0/custom_field/bulk_stop
カスタム項目参照 POST /api/v1.0/custom_field/search
請求元銀行口座登録更新 POST /api/v1.0/bs_bank_transfer/bulk_upsert
請求元銀行口座停止削除 POST /api/v1.0/bs_bank_transfer/bulk_stop
請求元銀行口座パターン登録更新 POST /api/v1.0/bs_bank_transfer_pattern/bulk_upsert
請求元銀行口座パターン停止削除 POST /api/v1.0/bs_bank_transfer_pattern/bulk_stop
請求元部署登録更新 POST /api/v1.0/bs_department/bulk_upsert
請求元部署停止削除 POST /api/v1.0/bs_department/bulk_stop
請求元担当者登録更新 POST /api/v1.0/bs_owner/bulk_upsert
請求元担当者停止削除 POST /api/v1.0/bs_owner/bulk_stop


Webhook一覧

注釈

APIアクセス制限

2021/11/17(水)よりAPIの利用に下記の制限を設けます。下記の制限を予防する実装例をこちらで公開しています。

リクエスト数の制限

リクエストサイズの制限

種別

種別 入力可能値
メール形式 正規表現 : /^([a-z0-9\+_\-]+)(\.[a-z0-9\+_\-]+)*@([a-z0-9\-]+\.)+[a-z]+$/ix
(例) robot_payment@example.com
アルファベット ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
半角英数 ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
半角英数 + 記号 ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
口座名義 半角英数 + 半角カタカナ + ,.()\/「」-
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789ヲァィゥェォャュョッ-アイウエオカキクケコサシスセソタチツテトナニヌネノハヒツヘホマミムメモヤユヨラリルレロワンガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポ,. )(\/「」-
口座名義(RP口座振替) 半角英数 + 半角カタカナ + ().-/
(RP口座振替)口座名義使用可能文字について
銀行名等 半角英数(半角英小文字除く) + 半角カタカナ
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ヲァィゥェォャュョッ-アイウエオカキクケコサシスセソタチツテトナニヌネノハヒツヘホマミムメモヤユヨラリルレロワンガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポ
日付形式 正規表現 : @^([0-9]{4}(-|/)(0?[1-9]|1[012])(-|/)(0?[1-9]|[12][0-9]|3[01]))$@
(例) 2020-01-01 または 2020/01/01 など

決済手段

数値 決済手段名
0 銀行振込
1 クレジットカード
2 バンクチェック
3 RP口座振替
4 RL口座振替
5 その他口座振替
6 コンビニ払込票(A4)
7 コンビニ払込票(ハガキ)
8 その他コンビニ払込票
9 バーチャル口座
10 その他決済1
11 その他決済2
12 その他決済3
13 その他決済4
14 その他決済5
15 まるなげ口座振替
16 まるなげバンクチェック

消込手段

数値 消込手段名
0 銀行振込
1 クレジットカード
2 バンクチェック
3 RP口座振替
4 RL口座振替
5 その他口座振替
6 コンビニ払込票(A4)
7 コンビニ払込票(ハガキ)
8 その他コンビニ払込票
9 バーチャル口座
10 その他決済手段1
11 その他決済手段2
12 その他決済手段3
13 その他決済手段4
14 その他決済手段5
15 まるなげ口座振替
16 まるなげバンクチェック
98 相殺
101 貸倒
102 確認済み
103 手数料
104 請求書明細相殺
106 現金
107 長期滞留債権
108 破産更生等債権
109 売上取消
110 繰越
201 入金確認済み

必須

種別 説明
必須 全てのリクエストに対して必要
(追加時) 登録・更新両方ができるAPIに存在し、追加時のリクエストに対して必要
(更新時) 登録・更新両方ができるAPIに存在し、更新時のリクエストに対して必要
({条件})^n {条件}時に、同じnの必須条件があるパラメータのなかでいずれかが必要

共通エラー

APIによる操作が失敗した場合、サーバは可能な限りエラーについての情報を application/json 形式でレスポンスします。その際、HTTPステータスは 400 Bad Request が使われます。ログインIDやアクセスキー、接続IPに不正があった場合は、HTTPステータスは、 401 Unauthorized が使われます。メンテナンス中の場合は、HTTPステータスは、 503 Service Unavailable で返却します。一定時間に大量のリクエストを検知した場合は 429 Too Many Requests を返却します。リクエストサイズが上限値を超えた場合 413 Request Entity Too Large を返却します。

エラー情報のレスポンスができないケースの例

エラーコード

エラーコード 内容
1 内部エラー
10 不明なURI
11 ログインIDが不正
12 アクセスキーが不正
13 接続IPが不正
14 店舗IDが不正
16 ログイン失敗
17 権限が不正
18 利用企業が不正
19 メンテナンス中
20 リクエスト数が不正

レスポンス例

{
    "error": {
        "code": 11,
        "message": "Invalid 'user_id'."
    }
}

決済システムエラーコード

決済システムエラーコード一覧

その他の特殊なエラーコード

エラーコード 内容
51 まるなげ請求書編集不可
52 まるなげオプション利用不可

推奨SSL/TLSバージョン

請求管理ロボAPIを、正常かつ快適にご利用いただくために、以下を推奨しております。

TLS 1.2

SSL/TLSバージョンをご確認いただき、推奨バージョンでのご利用をお願いいたします。


改訂履歴