会計仕訳データの一括取得

OpenAPI説明

当該OpenAPIは、指定された日付範囲で「未連携」の仕訳データを取得する際に利用します。

リクエストURI

/api/openapi/ledger/journals

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/ledger/journals?page=1&size=50&setOfBookId&transactionStartTime=2020-02-23%2020:47:00&transactionEndTime=2020-05-23%2021:47:00&companyOID=d52b2787-e1c3-49fb-9a12-775c0f249318

リクエストパラメータ説明

パラメーター名	カテゴリ	必須	説明
transactionStartTime	DateTime	○	検索開始日。フォーマット: yyyy-MM-dd HH:mm:ss
transactionEndTime	DateTime	○	検索終了日。フォーマット: yyyy-MM-dd HH:mm:ss
page	int	○	ページ、最初のページは１
size	int	○	ページ毎のデータ数。最大50
companyOID	UUID		会社OID テナント単位の「企業キー」でtokenを取得した時、companyOIDまたはsetOfBookIdが必須入力１元帳複数会社の場合、該当パラメータを利用しない
setOfBookId	Long		元帳ID

{
    "total": 1,
    "current": 1,
    "pageSize": 50,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
    "data": [
        {
            "journalHeadValueId": 1243164744448253954,            
            "journalLineValueId": 1243164744481808386,
            "department_code": "SPD-001",
            "amount": "500",
            "business_code": "ER00313285",
            "custom_field_code": "00600001",
            "line_no": "1",
            "description": "Custom Visit",
            "type": "expense"
        }
    ]
}

OpenAPIリターン項目

PageResposne

パラメータ名	タイプ	説明
total	int	検索結果の総件数
current	int	当ページ数
pageSize	int	ページごとの結果数
pages	int	検索結果総ページ数
hasPrevious	boolean	前のページがあるかどうか
hasNext	boolean	次のページがあるかどうか
data	Ledger[]	仕訳データリスト

Ledger

フィールド名	カテゴリ	説明
journalHeadValueId	Long	仕訳ヘッダーID。例えば精算伝票リスト
journalLineValueId	Long	仕訳行ID。例えば精算伝票での費用リスト
他のフィールド		会計エンジンにて仕訳テンプレートに追加した項目を出力する

失敗例

{
    "message": "必須項目が不足していますcompanyOID",
    "errorCode": "120003"
}

項目説明

項目名	タイプ	説明
message	String	エラーメッセージを返す
errorCode	String	エラーコードを返す

エラーコード説明

errorCode	message	説明
4002	無効な頁数です:{0}。
120003	必須項目が不足しています{0}
120005	パラメータ送信フォーマット異常{0}、正しいフォーマット{1}

会計仕訳データのステータス更新 →