Spendia Open API

法人カード(請求データ)追加

OpenAPI説明

当該OpenAPIはクレカデータ情報を追加する際に利用します。

リクエストURI

/api/openapi/import/user/credit-cards/tx-data

リクエスト形式

POST

リクエスト例

{
  "companyCode": "123456",
  "importDate": "2010/10/10",
  "orderSequence": "12345",
  "legalPersonCode": "",
  "dedicatedDepartmentCode": "", 
  "dedicatedDepartmentName": "", 
  "employeeDepartmentCode": "",
  "employeeDepartmentName": "",
  "creditCardUserId": "",
  "employeeName": "",
  "billingDate": "2010/10/10",
  "transactionDate": "2010/10/10",
  "saleCategory": "",
  "orderItemSeq": 10001,
  "storeNo": "",
  "storeName": "",
  "storeFPName": "",
  "storeCHName": "",
  "storePhone": "",
  "storeENLocation": "",
  "amount": 2001,
  "taxAmount": "",
  "overseasSales": "",
  "currencyRate": "",
  "currencyRateDate": "2010/10/10",
  "region": "",
  "industryCode": "",
  "saleEndDate": "",
  "dataCreationDate": "",
  "localCurrency": "",
  "customText1": "1",
  "customText2": "2",
  "customText3": "3",
  "customText4": "4",
  "customText5": "5",
  "customText6": "6",
  "customText7": "7",
  "customText8": "8",
  "customText9": "9",
  "customText10": "10",
  "customNum1": 1,
  "customNum2": 2,
  "customNum3": 3,
  "customNum4": 4,
  "customNum5": 5,
  "customNum6": 6,
  "customNum7": 7,
  "customNum8": 8,
  "customNum9": 9,
  "customNum10": 10
}

リクエスト項目

項目名 タイプ 必須 キー 規則 説明
companyCode String ○ ○ 最大36文字 会社コード
importDate LocalDate 日付フォーマット： yyyy/MM/dd 取込年月日
orderSequence String 最大5文字 請求データ取込連番
legalPersonCode String ○ ○ 固定2文字 クレカ会社コード
MS:三井住友カード
JC:JCB
DI:三井住友トラフトクラブ（ダイナース）
AM:AMEX
NI:三菱UFJニコス
CS:クレディセゾン
TF:トヨタファイナンス
UC:UCカード
HC:三菱HCキャピタル
dedicatedDepartmentCode String 最大36文字 集計部署コード
dedicatedDepartmentName String 最大50文字 集計部署名称
employeeDepartmentCode String 最大36文字 利用者部署コード
employeeDepartmentName String 最大50文字 利用者部署名
creditCardUserId String ○ ○ 最大20文字 利用者ユーザID
employeeName String 最大40文字 利用者社員名
billingDate LocalDate ○ 日付フォーマット： yyyy/MM/dd 請求年月(決済日)
transactionDate LocalDate ○ 日付フォーマット： yyyy/MM/dd 利用日
saleCategory String 最大5文字 売上区分
orderItemSeq Long 最大10文字 明細連番
storeNo String ○ 最大20文字 加盟店番号
storeName String 最大100文字 加盟店名称
storeFPName String 最大25文字 加盟店名称カナ
storeCHName String 最大100文字 加盟店漢字住所
storePhone String 最大16文字 加盟店電話番号
storeENLocation String 最大25文字 海外加盟店所在地英名
amount Long ○ 最大9文字 利用金額
taxAmount Long 最大9文字 利用金額消費税金額
overseasSales String 最大10文字（整数部7,小数部2位） 海外売上金額
currencyRate String 最大13文字（整数部9位,小数部3位） 為替相場金額
currencyRateDate LocalDate 日付フォーマット： yyyy/MM/dd 為替レート適用年月日
region String 最大1文字 海外区分
industryCode String 最大3文字 (新)業種コード
saleEndDate String 最大10文字 売上締年月日
dataCreationDate String 最大10文字 データ作成年月日
localCurrency String 最大3文字 現地通貨略称
customText1 String 最大100文字 予備項目（文字列）1
customText2 String 最大100文字 予備項目（文字列）2
customText3 String 最大100文字 予備項目（文字列）3
customText4 String 最大100文字 予備項目（文字列）4
customText5 String 最大100文字 予備項目（文字列）5
customText6 String 最大100文字 予備項目（文字列）6
customText7 String 最大100文字 予備項目（文字列）7
customText8 String 最大100文字 予備項目（文字列）8
customText9 String 最大100文字 予備項目（文字列）9
customText10 String 最大100文字 予備項目（文字列）10
customNum1 String 最大20文字 予備項目（数字）1
customNum2 String 最大20文字 予備項目（数字）2
customNum3 String 最大20文字 予備項目（数字）3
customNum4 String 最大20文字 予備項目（数字）4
customNum5 String 最大20文字 予備項目（数字）5
customNum6 String 最大20文字 予備項目（数字）6
customNum7 String 最大20文字 予備項目（数字）7
customNum8 String 最大20文字 予備項目（数字）8
customNum9 String 最大20文字 予備項目（数字）9
customNum10 String 最大20文字 予備項目（数字）10

OpenAPIリターン例

成功例

{
    "message": "success",
    "key": "xxx123456"
}

失敗例

{
    "message": "パラメータ:companyCodeは指定必須の項目です",
    "errorCode": "120003"
}

項目説明

項目名 タイプ 説明
message String メッセージを返す
key String クレカユーザID
errorCode String エラーコードを返す

エラーコード説明

errorCode message 説明
0013 パラメータ:{0}は{1}文字以内で指定してください
120003 パラメータ:{0}は指定必須の項目です
120005 パラメータ送信フォーマット異常{0}、正しいフォーマット{1}
120112 部門は存在しない{0}
6013027 無効な会社コード
6013029 利用者ユーザーIDは存在しません:{0}