Spendia Open API

ワークフローコールバック

OpenAPI説明

当該APIはSpendiaからワークフロー経由で外部システムにデータを同期します。

リクエストURI

外部提供

リクエスト形式

POST

リクエストパラメータ例

外部提供

リクエスト例

{
  "entityKey": "aweFdwsxzBsadV132",
  "workflowCode": "6101",
  "processStatus": 1001,
  "lastApprovalDate": "2023-03-01 11:55:23",
  "lastApproverCode": "2109990",
  "lastApproverMail": "spendia@spendia.jp",
  "processCode": "WK000000001",
  "entityFields": [
    {
      "fieldCode": "47",
      "fieldType": "BANK_ACCOUNT",
      "inputType": "spot",
      "details": {
        "country": "JP",
        "bankCode": "0000",
        "bankName": "日本銀行",
        "branchCode": "567",
        "branchName": "秋田支店",
        "accountCategory": "2",
        "bankAccount": "4",
        "accountName": "4",
        "accountNameKana": "4"
      }
    },
    {
      "fieldCode": "field199",
      "fieldType": "text",
      "value": "テキスト１",
      "name": ""
    },
    {
      "fieldCode": "field299",
      "fieldType": "date",
      "value": "2020-10-01",
      "name": ""
    },
    {
      "fieldCode": "field399",
      "fieldType": "ValueList",
      "value": "1",
      "name": "男"
    },
    {
      "fieldCode": "field3",
      "fieldType": "AMOUNT",
      "amountValue": {
        "amount":2000,
        "currencyCode":"CNY",
        "rate":"5",
        "baseCurrencyAmount":10000,
        "baseCurrency":"JPY",
        "companyCurrencyRate":"4.8"
      }
    },
    {
      "fieldCode": "Control_Amount",
      "fieldType": "AMOUNT",
      "amountValue": {
        "amount": 10000,
        "currencyCode": "JPY",
        "rate": "1",
        "baseCurrencyAmount": 10000,
        "baseCurrency": "JPY",
        "companyCurrencyRate": "1"
      }
    },
    {
      "fieldCode": "Control_VAT",
      "fieldType": "TAX_CATEGORY",
      "value": "1001",
      "name": "10%"
    },
    {
      "fieldCode": "Consumption_Tax",
      "fieldType": "TAX_CATEGORY_AMOUNT",
      "amountValue": {
        "excludingTaxAmount": 9091,
        "includingTaxAmount": 10000,
        "taxAmount": 909,
        "exemptedExcludingTaxAmount": 10000,
        "exemptedTaxAmount": 0
      }
    },
    {
      "fieldCode": "field1",
      "fieldType": "COMPANY",
      "value":"YM01",
      "name":"テスト会社"
    },
    {
      "fieldCode": "field2",
      "fieldType": "DEPARTMENT",
      "value":"Sales01",
      "name":"セールス"
    },
    {
      "fieldCode": "field3",
      "fieldType": "ACCOUNT",
      "account": {
        "accountCode":"1001001",
        "accountName":"現金",
        "auxiliaryAccountCode":"A001",
        "auxiliaryAccountName":"会議費用",
        "accountTypeCode":"123",
        "accountType":"費用"
      }
    },
    {
      "fieldCode": "field999",
      "fieldType": "COSTCENTER",
      "name":"関東事業",
      "value":"A001"
    },
    {
      "fieldCode": "field4",
      "fieldType": "TAXCATEGORY",
      "name":"消費税10%",
      "value": "J0010"
    },
    {
      "fieldCode": "field333",
      "fieldType": "TRADING_DESTINATION",
      "partner": {
        "modeType": "supplier",
        "paymentType": "pre_defined",
        "supplier": {
          "customFormValues": [],
          "vendorCode": "1",
          "vendorName": "供应商名称12345678901234567890123456789012345678901供应商名",
          "vendorSemiangleName": null,
          "postalCode": "123-456",
          "address": "名古屋市天白区",
          "businessRegistrationNumber": null,
          "businessCategory": null,
          "businessRegistrationDate": null,
          "legalRepresentative": null,
          "taxId": null,
          "checkNetNo": null,
          "contact": "かかいとう",
          "contactPhone": null,
          "contactMail": null,
          "fax": null,
          "semiangleAddress": null,
          "remark": null,
          "description": null,
          "paymentTerms": null
        },
        "client": null
      }
    },
    {
      "fieldCode": "field5",
      "fieldType": "EMPLOYEE",
      "value":"A001,A002",
      "name":"厳英明,田中正義"
    },
    {
      "fieldCode": "field6",
      "fieldType": "DATE",
      "value": "2023-11-27"
    },
    {
      "fieldCode": "field7",
      "fieldType": "MONTH",
      "value": "2023-11"
    },
    {
      "fieldCode": "field6",
      "fieldType": "VALUELIST",
      "name": "男",
      "value": "1"
    },
    {
      "fieldCode": "field8",
      "fieldType": "NUMBER",
      "value": "9999.22"
    },
    {
      "fieldCode": "field8",
      "fieldType": "TEXT",
      "value": "わかりました"
    },
    {
      "fieldCode": "field9",
      "fieldType": "REFERENCE",
      "referenceEntity": [
        {
          "fieldCode": "field8",
          "fieldType": "NUMBER",
          "value": "9999.22"
        },
        {
          "fieldCode": "field8",
          "fieldType": "TEXT",
          "value": "わかりました"
        }
      ]
    },
    {
      "fieldCode": "link1",
      "fieldType": "Attachment",
      "attachments": [{
        "linkName": "リンク1",
        "linkValue": "https://service.spendia.jp/"
      },
        {
          "linkName": "リンク2",
          "linkValue": "https://service.spendia.jp/"
        }]
    },
    {
      "fieldCode": "file1",
      "fieldType": "Attachment",
      "attachments": [{
        "fileName": "添付ファイルのfile1.pdf",
        "fileUrl": "https://spendia-dynamic-stage.s3.ap-northeast-1.amazonaws.com/29ad55e2-702d-43be-b525-1b7a173c452b/invoices/5bfc11df-5436-4920-8632-ee1ba74a3bea-%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231127T014901Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIAJYC4KIDBXXJMJSNQ%2F20231127%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Signature=8c3324b7496df5df48a1eeb486fd89106c60e8d6836a51723f59a9db865d0bd7"
      },
        {
          "fileName": "添付ファイルのfile2.pdf",
          "fileUrl": "https://spendia-dynamic-stage.s3.ap-northeast-1.amazonaws.com/29ad55e2-702d-43be-b525-1b7a173c452b/invoices/5bfc11df-5436-4920-8632-ee1ba74a3bea-%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231127T014901Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIAJYC4KIDBXXJMJSNQ%2F20231127%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Signature=8c3324b7496df5df48a1eeb486fd89106c60e8d6836a51723f59a9db865d0bd7"
        }]
    },
    {
      "fieldCode": "table1",
      "fieldType": "Table",
      "tableData": [
        [
          {
            "fieldCode": "field6",
            "fieldType": "text",
            "value": "テキスト6",
            "name": ""
          },
          {
            "fieldCode": "field7",
            "fieldType": "date",
            "value": "2020-10-01",
            "name": ""
          },
          {
            "fieldCode": "field8",
            "fieldType": "ValueList",
            "value": "1",
            "name": "男"
          },
          {
            "fieldCode": "field9",
            "fieldType": "Amt.",
            "amountValue": {
              "amount": 100.22,
              "currencyCode": "CNY"
            }
          }
        ],
        [
          {
            "fieldCode": "field6",
            "fieldType": "text",
            "value": "テキスト6",
            "name": ""
          },
          {
            "fieldCode": "field7",
            "fieldType": "date",
            "value": "2020-10-01",
            "name": ""
          },
          {
            "fieldCode": "field8",
            "fieldType": "ValueList",
            "value": "1",
            "name": "男"
          },
          {
            "fieldCode": "field9",
            "fieldType": "Amt.",
            "amountValue": {
              "amount": 100.22,
              "currencyCode": "CNY"
            }
          }
        ]
      ]
    }
  ],
  "approvalHistories": [
    {
      "operation": 2001,
      "operationDetail": "通过后意见3",
      "operationDate": "2023-08-15 17:54:46",
      "operator": {
        "employeeId": "empid1",
        "fullName": "田中"
      },
      "applicant": null,
      "approver": {
        "employeeId": "empid2",
        "fullName": "佐々木"
      },
      "transmit": null
    },
    {
      "operation": 1001,
      "operationDetail": null,
      "operationDate": "2023-08-15 17:52:24",
      "operator": {
        "employeeId": "empid1",
        "fullName": "田中"
      },
      "applicant": {
        "employeeId": "empid2",
        "fullName": "佐々木"
      },
      "approver": null,
      "transmit": null
    }
  ]
}

リクエスト項目

パラメータ名 タイプ 規則 説明
entityKey String 業務キー
workflowCode String ワークフローコード
processStatus String プロセスステータス
承認中：1001
差戻し：1002
取消：1003
承認済：1004
lastApprovalDate String 最終承認時間
lastApproverCode String 最終承認者
lastApproverMail String 最終承認者メール
processCode String プロセス番号
entityFields entityFields[] 項目テーブル項目リスト
approvalHistories approvalHistories[] 承認履歴

entityFields

パラメータ名 タイプ 規則 説明
fieldCode String 項目テーブルの当項目のコード
fieldType String 項目テーブルの当項目のタイプ
value String 項目テーブルの項目値
name String 名称
amountValue amountValue{} 金額
tableData tableData[] 下級項目テーブル項目リスト
attachments attachments[] リンクリスト
inputType String 銀行口座の入力方法
details details{} 銀行口座の情報
account account{} 勘定科目
partner partner{} パートナー
referenceEntity referenceEntity[] 引用項目テーブル

amountValue

パラメータ名 タイプ 規則 説明
amount BigDecimal 金額の値
currencyCode String 通貨コード
rate String 通貨レート
baseCurrencyAmount BigDecimal 主要通貨の金額
baseCurrency String 主要通貨
companyCurrencyRate String 企業レート
includingTaxAmount BigDecimal 税込額
excludingTaxAmount BigDecimal 税抜額
exemptedExcludingTaxAmount BigDecimal 税抜額（税額控除後）
taxAmount BigDecimal 税額
exemptedTaxAmount BigDecimal 税額（税額控除後）

tableData

パラメータ名 タイプ 規則 説明
entityFields entityFields[] 項目テーブル情報

attachments(ATTACHMENT)

パラメータ名 タイプ 規則 説明
fileName String 添付ファイルの名称
fileUrl String 添付ファイルのUrl
パラメータ名 タイプ 規則 説明
linkName String リンク名称
linkValue String リンクアドレス

inputType

列挙値 説明
company 会社口座
partner パートナー口座
employee 従業員口座
spot スポット入力

details(BANK_ACCOUNT)

参数名 类型 约束 说明
country String 国家
bankCode String 銀行コード
bankName String 銀行名
branchCode String 支店コード
branchName String 支店名
accountCategory String 口座種別
1：普通預金
2：当座預金
4：貯蓄預金
9：その他
bankAccount String 口座番号
accountName String 口座名称
accountNameKana String 口座名称(半角カナ)

account

パラメータ名 タイプ 規則 説明
accountCode String 勘定科目コード
accountName String 勘定科目名
auxiliaryAccountCode String 補助科目コード
auxiliaryAccountName String 補助科目名
accountTypeCode String 科目タイプコード
ASSET
COST
LIABILITY
OWNERS_EQUITY
PROFIT_AND_LOSS
accountTypeName String 科目タイプ名
資産
費用
負債
資本
収益

partner

パラメータ名 タイプ 規則 説明
modeType String パートナータイプ
supplier
client
paymentType String 支払タイプ
pre_defined
spot_payment
supplier String 仕入先
client String 顧客

modeType=supplier

パラメータ名 タイプ 必須 キー 規則 説明
customFormValues customFormValues{} 拡張項目
vendorCode String 仕入先コード
vendorName String 仕入先名
vendorSemiangleName String 仕入先名（半角カナ）
postalCode String 郵便番号
address String 住所
businessRegistrationNumber String 事業者登録番号
businessCategory String 事業者区分
businessRegistrationDate String 事業者登録日
legalRepresentative String 代表取締役
taxId String タックス登録番号
checkNetNo String でんさいネットNO.
contact String 連絡先
contactPhone String 連絡先電話
contactMail String メールアドレス
fax String ファックス
semiangleAddress String 住所（半角カナ）
remark String 備考
description String 備考（検索用）
paymentTerms String 支払パターン

modeType=client

パラメータ名 タイプ 必須 キー 規則 説明
customFormValues customFormValues{} 拡張項目
clientCode String 顧客コード
clientName String 顧客名
clientSemiangleName String 顧客名（半角カナ）
postalCode String 郵便番号
address String 住所
legalRepresentative String 代表取締役
contactPhone String 連絡先電話
contact String 連絡先
contactMail String メールアドレス
fax String ファックス
semiangleAddress String 住所（半角カナ）
collectionTerm String 入金パターン
remark String 備考
description String 備考（検索用）
tradingConditions String 取引条件
effectiveDate String 有効日
principalDepartment String 担当部門
principalUser String 担当者

customFormValues

パラメータ名 タイプ 必須 キー 規則 説明
fieldCode String ○ ○ 項目コード（拡張項目）
value String ○ ○ 入力値（拡張項目）

ReferenceEntity

パラメータ名 タイプ 規則 説明
entityFields entityFields[] 項目テーブル情報

approvalHistories

パラメータ名 タイプ 規則 説明
operation Integer ApprovalOperationを参照 操作タイプ
operationDetail String 最大 1000 文字 操作備考
operationDate String 時間フォーマット：yyyy-MM-dd'T'HH:mm:ssZ 承認時間
operator UserSummary UserSummaryを参照 操作者
applicant UserSummary UserSummaryを参照 申請者
approver UserSummary UserSummaryを参照 承認者
transmit UserSummary UserSummaryを参照 委譲対象

UserSummary

パラメータ名 タイプ 規則 説明
employeeId String 従業員番号
fullName String 従業員名称

ApprovalOperation

値 説明
1001 提出
2001 承認済
2002 差戻し
2006 承認者通知
2800 自己承認
5009 承認者追加
5010 委譲
8004 申請者返事
9001 管理員は承認ステージをジャンプする
9004 管理者承認済
9005 管理者差戻し

外部システム処理後、Spendiaにコールバック例

成功例

{
  "message": "success",
  "code":1001
}

失敗例

{
  "message": "コールバック失敗、タイムアウト、インターネット環境およびコールバックアドレスを確認してください、あるいはタイムアウト時間を修正して再度試してください",
  "code":1002
}

項目説明

項目名 タイプ 説明
message String コールバックメッセージ説明
code String コールバックコード

エラーコード説明

errorCode message 説明
1002 コールバック失敗、外部システム {0}
1002 コールバック失敗、タイムアウト、インターネット環境およびコールバックアドレスを確認してください、あるいはタイムアウト時間を修正して再度試してください

← ワークフロー完了 →