請求書送付郵送
/api/v1.0/bill/send_bill_by_mail
請求書郵送をAPIで行う場合に利用します
アウトライン
リクエスト
- Path:
/api/v1.0/bill/send_bill_by_mail
- Preferred HTTP method:
POST
- Accepted content types:
application/json
- Encode:
UTF-8
Parameters
名前 | 概要 | 桁数 | 種別 | 必須 |
---|---|---|---|---|
user_id | ユーザーID(管理画面へのログインID) | 100 | メール形式 | 必須 |
access_key | アクセスキー | 100 | 半角英数 | 必須 |
bill | 請求書に属するパラメータ | array |
bill (request)
下記のような項目のオブジェクトを持つリスト
名前 | 概要 | 桁数 | 種別 | 必須 |
---|---|---|---|---|
number | 請求書番号 | 100 | 半角英数 + 記号 |
レスポンス
- Type:
application/json
- Encode:
UTF-8
Fields
名前 | 概要 | 型 |
---|---|---|
user_id | ユーザーID | string |
bill | 請求書に属するパラメータ | array |
bill (response)
下記のような項目のオブジェクトを持つリスト
名前 | 概要 | 型 |
---|---|---|
error_code | エラーコード ※正常時はnull |
int |
error_message | エラーメッセージ ※正常時はnull |
string |
number | 請求書番号 | string |
mail_order_number | 郵送受付番号 | int |
使用例
リクエスト例
{
"user_id": "sample@robotpayment.co.jp",
"access_key": "xxxxxxxxxxxxxxxx",
"bill": [
{
"number": "201705-billing-1"
}
]
}
レスポンス例
Status: 200 OK
{
"user_id": "sample@robotpayment.co.jp",
"bill": [
{
"error_code": null,
"error_message": null,
"number": "201705-billing-1",
"mail_order_number": 1
}
]
}
エラー
個別エラー
エラーコード | 内容 |
---|---|
2801 | 請求書郵送に失敗 |
2802 | 郵送済みの請求書は郵送できない |
2803 | 郵送機能が利用可能でない |
2804 | 請求書番号が不正 |
2805 | 無効の請求書は送信できない |
2806 | 請求書が承認依頼中 |
2807 | 請求先部署が承認依頼中 |
2808 | 枚数制限(6枚)オーバー |
2809 | 郵送不可の添付ファイルが含まれている |
2810 | 枚数制限(349枚)オーバー |