Scalebase ペイメント API (1.0.0-alpha1)

Download OpenAPI specification:

Scalebase ペイメントへ接続するAPIのリファレンスです

Scalebaseペイメントヘルプ

Scalebase ペイメントの製品・概念説明、基本操作方法などについてはこちらをご確認ください

サービスエンドポイント

https://api.payment.scalebase.com

APIキー

発行されたAPIキーを X-API-Key ヘッダーに設定することでリクエスト可能です。

入金

入金の一括作成

Request Body schema: application/json

required

Array of objects (controllers.v1.DepositController.BulkCreate.Request.Item)

Responses

Request samples

Payload

Content type

application/json

{"deposits": [{"amount": 0,
"bankAccountName": "string",
"date": "2019-08-24",
"interofficeMemo": "string",
"partnerId": "string",
"recipientBankAccountText": "string"
}
]
}

Response samples

200
422

Content type

application/json

{"ids": ["string"
]
}

入金の作成

bankAccountName に使用できる文字は半角数字 (0-9), 半角英大文字 (A-Z), 半角カタカナ (ｱ-ﾝ), 濁点・半濁点 (ﾞﾟ), 長音 (ｰ), 記号 (. , - ( )), 空白のみです (1〜255 文字)。

Request Body schema: application/json

amount required	integer <int64>
bankAccountName	string or null
date required	string <date>
interofficeMemo	string or null
partnerId	string or null
recipientBankAccountText	string or null

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"bankAccountName": "string",
"date": "2019-08-24",
"interofficeMemo": "string",
"partnerId": "string",
"recipientBankAccountText": "string"
}

Response samples

200
422

Content type

application/json

{"id": "string"
}

入金の取得

指定した ID の入金を 1 件返します。

Request Body schema: application/json

depositId

required

string

Responses

Request samples

Payload

Content type

application/json

{"depositId": "string"
}

Response samples

200

Content type

application/json

{"bankAccountName": "string",
"depositAmount": 0,
"depositDate": "2019-08-24",
"depositId": "string",
"interofficeMemo": "string",
"isArchived": true,
"partner": {"code": "string",
"id": "string",
"name": "string"
},
"recipientBankAccountText": "string",
"unreconciledBalance": 0
}

入金の検索

page は 0 始まりのページ番号です。

Request Body schema: application/json

amountFrom	integer or null <int64>
amountTo	integer or null <int64>
bankAccountName	string or null
createdAtFrom	string or null <date>
createdAtTo	string or null <date>
depositDateFrom	string or null <date>
depositDateTo	string or null <date>
excludeZeroBalance	boolean or null
interofficeMemo	string or null
isArchivedSet	Array of booleans or null unique
page required	integer <int32>
partnerCode	string or null
partnerName	string or null
rowsPerPage required	integer <int32>
	Array of objects or null (com.scalebase.payment.accounting.SearchDepositsUseCase.SortCriteria.Column)
unreconciledBalanceFrom	integer or null <int64>
unreconciledBalanceTo	integer or null <int64>

Responses

Request samples

Payload

Content type

application/json

{"amountFrom": 0,
"amountTo": 0,
"bankAccountName": "string",
"createdAtFrom": "2019-08-24",
"createdAtTo": "2019-08-24",
"depositDateFrom": "2019-08-24",
"depositDateTo": "2019-08-24",
"excludeZeroBalance": true,
"interofficeMemo": "string",
"isArchivedSet": [true
],
"page": 0,
"partnerCode": "string",
"partnerName": "string",
"rowsPerPage": 0,
"sortBy": [{"direction": "Asc",
"field": "BankAccountName"
}
],
"unreconciledBalanceFrom": 0,
"unreconciledBalanceTo": 0
}

Response samples

200

Content type

application/json

{"deposits": [{"bankAccountName": "string",
"depositAmount": 0,
"depositDate": "2019-08-24",
"depositId": "string",
"interofficeMemo": "string",
"isArchived": true,
"partner": {"code": "string",
"id": "string",
"name": "string"
},
"recipientBankAccountText": "string",
"unreconciledBalance": 0
}
],
"total": 0
}

入金の更新

指定したフィールドのみ更新します。省略したフィールドは変更されません。partnerId / interofficeMemo に null を指定するとクリア (取引先は紐付け解除) します。partnerId と interofficeMemo の少なくとも一方の指定が必須です。

Request Body schema: application/json

depositId required	string
interofficeMemo	string or null
partnerId	string or null

Responses

Request samples

Payload

Content type

application/json

{"depositId": "string",
"interofficeMemo": "string",
"partnerId": "string"
}

Response samples

200
422

Content type

application/json

{"id": "string"
}

事業者

事業者情報の取得

API キーに紐づく事業者の情報を返します。

Responses

Response samples

200
404

Content type

application/json

{"displayName": "string",
"ownerId": "string"
}

取引先

取引先の作成

Request Body schema: application/json

code	string or null
interofficeMemo	string or null
name required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"interofficeMemo": "string",
"name": "string"
}

Response samples

200
409
422

Content type

application/json

{"partnerId": "string"
}

取引先の取得

指定した ID の取引先を 1 件返します。アーカイブ済みの取引先も返します (isArchived で判別できます)。

Request Body schema: application/json

id

required

string

Responses

Request samples

Payload

Content type

application/json

{"id": "string"
}

Response samples

200
404

Content type

application/json

{"code": "string",
"id": "string",
"interofficeMemo": "string",
"isArchived": true,
"name": "string"
}

取引先の検索

Request Body schema: application/json

page required	integer <int32>
partnerCode	string or null
partnerName	string or null
rowsPerPage required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"page": 0,
"partnerCode": "string",
"partnerName": "string",
"rowsPerPage": 0
}

Response samples

200

Content type

application/json

{"partners": [{"code": "string",
"id": "string",
"name": "string"
}
],
"total": 0
}

取引先の更新

指定したフィールドのみ更新します。省略したフィールドは変更されません。code / interofficeMemo に null を指定するとクリアします。name は必須項目のため null を指定できません。name / code / interofficeMemo の少なくとも一方の指定が必須です。

Request Body schema: application/json

code	string or null
id required	string
interofficeMemo	string or null
name	string or null

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"id": "string",
"interofficeMemo": "string",
"name": "string"
}

Response samples

200
404
409

Content type

application/json

{"id": "string"
}

商品

商品の作成

code に使用できる文字は半角英数・ハイフン・アンダースコアのみです (255 文字以内)。quantity は 1 以上の整数です。

Request Body schema: application/json

code	string or null
name required	string
quantity	integer or null <int64>
revenueRecognitionRuleId	string or null
scalebaseCatalogChargeItemId	string or null

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"quantity": 0,
"revenueRecognitionRuleId": "string",
"scalebaseCatalogChargeItemId": "string"
}

Response samples

200
409
422

Content type

application/json

{"id": "string"
}

商品の取得

指定した ID の商品を 1 件返します。アーカイブ済みの商品も返します。

Request Body schema: application/json

id

required

string

Responses

Request samples

Payload

Content type

application/json

{"id": "string"
}

Response samples

200
404

Content type

application/json

{"code": "string",
"id": "string",
"isArchived": true,
"name": "string",
"quantity": 0,
"revenueRecognitionRuleId": "string",
"scalebaseCatalogChargeItemId": "string"
}

商品の検索

page は 0 始まりのページ番号です。アーカイブ済みの商品は返しません。

Request Body schema: application/json

page required	integer <int32>
productCode	string or null
productName	string or null
rowsPerPage required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"page": 0,
"productCode": "string",
"productName": "string",
"rowsPerPage": 0
}

Response samples

200

Content type

application/json

{"products": [{"code": "string",
"id": "string",
"name": "string",
"quantity": 0
}
],
"total": 0
}

商品の部分更新

指定したフィールドのみ更新します。省略したフィールドは変更されません。code / quantity / scalebaseCatalogChargeItemId / revenueRecognitionRuleId に null を指定するとクリアします。name に null は指定できません。

Request Body schema: application/json

code	string or null
id required	string
name	string or null
quantity	integer or null <int64>
revenueRecognitionRuleId	string or null
scalebaseCatalogChargeItemId	string or null

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"id": "string",
"name": "string",
"quantity": 0,
"revenueRecognitionRuleId": "string",
"scalebaseCatalogChargeItemId": "string"
}

Response samples

200
404
422

Content type

application/json

{"id": "string"
}

債権

債権の取得

指定した ID の債権を 1 件返します。アーカイブ済みの債権も返します (isArchived で判別できます)。

Request Body schema: application/json

receivableId

required

string

Responses

Request samples

Payload

Content type

application/json

{"receivableId": "string"
}

Response samples

200

Content type

application/json

{"billingDate": "2019-08-24",
"endDate": "2019-08-24",
"invoiceId": "string",
"invoiceName": "string",
"invoiceNumber": "string",
"isArchived": true,
"itemCode": "string",
"partnerCode": "string",
"partnerId": "string",
"partnerName": "string",
"paymentDueDate": "2019-08-24",
"paymentMethodDisplayName": "string",
"paymentMethodId": "string",
"productCode": "string",
"productId": "string",
"productName": "string",
"receivableAmount": 0,
"receivableId": "string",
"receivableName": "string",
"startDate": "2019-08-24",
"taxClass": "string",
"unpaidBalance": 0
}

債権の検索

page は 0 始まりのページ番号です。

Request Body schema: application/json

amountFrom	integer or null <int64>
amountTo	integer or null <int64>
billingDateFrom	string or null <date>
billingDateTo	string or null <date>
invoiceNumber	string or null
page required	integer <int32>
partnerCode	string or null
partnerName	string or null
paymentDueDateFrom	string or null <date>
paymentDueDateTo	string or null <date>
rowsPerPage required	integer <int32>
unpaidBalanceFrom	integer or null <int64>
unpaidBalanceTo	integer or null <int64>

Responses

Request samples

Payload

Content type

application/json

{"amountFrom": 0,
"amountTo": 0,
"billingDateFrom": "2019-08-24",
"billingDateTo": "2019-08-24",
"invoiceNumber": "string",
"page": 0,
"partnerCode": "string",
"partnerName": "string",
"paymentDueDateFrom": "2019-08-24",
"paymentDueDateTo": "2019-08-24",
"rowsPerPage": 0,
"unpaidBalanceFrom": 0,
"unpaidBalanceTo": 0
}

Response samples

200

Content type

application/json

{"receivables": [{"billingDate": "2019-08-24",
"invoiceNumber": "string",
"partnerCode": "string",
"partnerId": "string",
"partnerName": "string",
"paymentDueDate": "2019-08-24",
"receivableAmount": 0,
"receivableId": "string",
"receivableName": "string",
"unpaidBalance": 0
}
],
"total": 0
}

消込

消込の取消

Request Body schema: application/json

reconciliationProcessIds

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"reconciliationProcessIds": ["string"
]
}

Response samples

200

Content type

application/json

{"failures": [{"messages": ["string"
],
"reconciliationProcessId": "string"
}
],
"successes": ["string"
]
}

消込の取得

指定した ID の消込処理を 1 件返します。diff は「債権 - 入金」の差額です。

Request Body schema: application/json

reconciliationProcessId

required

string

Responses

Request samples

Payload

Content type

application/json

{"reconciliationProcessId": "string"
}

Response samples

200

Content type

application/json

{"reconciliationProcess": {"accountingDate": "2019-08-24",
"cancelledAt": "2019-08-24T14:15:22Z",
"creditSideItems": [{"adjustmentAccountTitle": "string",
"adjustmentKind": "BankTransferFee",
"balanceAmount": 0,
"invoiceId": "string",
"invoiceNumber": "string",
"kind": "Receivable",
"originalAmount": 0,
"partner": {"code": "string",
"id": "string",
"name": "string"
},
"receivableId": "string",
"receivableName": "string",
"reconciledAmount": 0
}
],
"debitSideItems": [{"adjustmentAccountTitle": "string",
"adjustmentKind": "BankTransferFee",
"balanceAmount": 0,
"bankAccountName": "string",
"depositDate": "2019-08-24",
"depositId": "string",
"kind": "Deposit",
"originalAmount": 0,
"partner": {"code": "string",
"id": "string",
"name": "string"
},
"reconciledAmount": 0
}
],
"diff": 0,
"id": "string",
"interofficeMemo": "string",
"reconciledAmount": 0,
"reconciledAt": "2019-08-24T14:15:22Z"
}
}

消込の実行

receivableAdjustments / depositAdjustments は省略できません。調整金がない場合は空配列を指定してください。

Request Body schema: application/json

required	Array of objects (com.scalebase.payment.matching.reconciliationprocess.Adjustment.Input)
required	Array of objects (com.scalebase.payment.matching.reconciliationprocess.ReconciliationTarget.DepositItem.Input)
interofficeMemo	string or null
required	Array of objects (com.scalebase.payment.matching.reconciliationprocess.Adjustment.Input)
required	Array of objects (com.scalebase.payment.matching.reconciliationprocess.ReconciliationTarget.ReceivableItem.Input)

Responses

Request samples

Payload

Content type

application/json

{"depositAdjustments": [{"accountTitle": "string",
"amount": 0,
"kind": "string"
}
],
"depositItems": [{"depositId": "string",
"reconciliationAmount": 0
}
],
"interofficeMemo": "string",
"receivableAdjustments": [{"accountTitle": "string",
"amount": 0,
"kind": "string"
}
],
"receivableItems": [{"receivableId": "string",
"reconciliationAmount": 0
}
]
}

Response samples

200

Content type

application/json

{"reconciliationProcessId": "string"
}

消込の検索

page は 0 始まりのページ番号です。diff は「債権 - 入金」の差額です。

Request Body schema: application/json

accountingDateFrom	string or null <date>
accountingDateTo	string or null <date>
bankAccountName	string or null
cancellationDateFrom	string or null <date>
cancellationDateTo	string or null <date>
interofficeMemo	string or null
isCancelled	boolean or null
page required	integer <int32>
partnerCode	string or null
partnerName	string or null
reconciledAmountFrom	integer or null <int64>
reconciledAmountTo	integer or null <int64>
reconciliationDateFrom	string or null <date>
reconciliationDateTo	string or null <date>
rowsPerPage required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"accountingDateFrom": "2019-08-24",
"accountingDateTo": "2019-08-24",
"bankAccountName": "string",
"cancellationDateFrom": "2019-08-24",
"cancellationDateTo": "2019-08-24",
"interofficeMemo": "string",
"isCancelled": true,
"page": 0,
"partnerCode": "string",
"partnerName": "string",
"reconciledAmountFrom": 0,
"reconciledAmountTo": 0,
"reconciliationDateFrom": "2019-08-24",
"reconciliationDateTo": "2019-08-24",
"rowsPerPage": 0
}

Response samples

200

Content type

application/json

{"reconciliationProcesses": [{"accountingDate": "2019-08-24",
"bankAccountNames": ["string"
],
"cancellationDate": "2019-08-24",
"depositAdjustmentAmount": 0,
"diff": 0,
"id": "string",
"interofficeMemo": "string",
"partners": [{"code": "string",
"id": "string",
"name": "string"
}
],
"receivableAdjustmentAmount": 0,
"reconciledAmount": 0,
"reconciliationDate": "2019-08-24"
}
],
"total": 0
}