取引一覧取得APIで取得できる項目について
取引一覧取得APIを使用して取得した項目を、別のシステムに登録しようと考えています。
そこで検討の一環として、スマレジ管理画面の「取引履歴一覧」から「CSVダウンロード」を行なってみたのですが、
先日お伺いした日次締め情報一覧取得APIと同様、APIから取得できる項目と差異があるようです。
いくつかの項目はなんとか自己解決しましたが、、、
下記の項目について「CSVダウンロード」で出力される内容と同等のものを取得したい場合、取引一覧取得API、取引取得API、あるいは何らかの別の方法で実現可能でしょうか。
・(101) 小計値引／割引区分
・(102) 単品値引／割引区分
・(105) 前受金(現金)
・(156) 販売価格計（値引済）（税込）
・(157) 販売価格（値引済）（税込）
・(158) 販売価格計（値引済）（税抜）
・(159) 販売価格（値引済）（税抜）
・(183) 品番
ベストアンサー
-
小計値引き/割引区分：subtotalDiscountDivision
前受金：partPayment
・取引取得API
単品値引き/割引区分：unitDiscountDivision
・取引取得API（with_detailを"all"か "summary"に指定してリクエストしてください）
・取引明細取得API
販売価格計
こちらのスレッドを参考に集計ください。
https://community.smaregi.dev/discussion/comment/309
品番
品番に関しては、取引取得や取引一覧取得では参照できません。
商品一覧取得APIなどで取得した商品ID：productIdや商品コード：productCodeを利用して、
品番のご確認をお願いいたします。
-
回答に不足があり申し訳ございません。
「前受金：partPayment」を取得する際には、
取引取得APIにて、with_layawayを"all"に指定してリクエストしてください。
また、「小計値引き/割引区分：subtotalDiscountDivision」「単品値引き/割引区分：unitDiscountDivision」については、
プラットフォームAPIで値引区分名／割引区分名を取得することができません。
スマレジ管理画面の「設定 ＞ 販売区分 ＞ 値引区分」もしくは「割引区分」の、ID番号が返却されます。
お手数ですがIDをもとに管理画面で値引区分名／割引区分名との照らし合わせを行い、ご確認をお願いします。
-
＠エーエヌラボ
分かりづらい表記で申し訳ございません。
直訳すると内消費税はtaxIncludeと同じ意味に捉えられるのですが、実際は含まれる内容が異なります。
≪取引履歴CSVの項目≫
- 内消費税(12)
取引の消費税額の合計です。
- 外消費税(77)
該当取引で発生した外税金額です。
参考：取引履歴CSVダウンロード項目 https://help.smaregi.jp/hc/ja/articles/360051346134
≪プラットフォームAPIの項目≫
- taxInclude
該当取引で発生した内税金額です。
- taxExclude
該当取引で発生した外税金額です。
答え
ご回答ありがとうございます。
念のため、下記について再度確認をさせてください。
> 小計値引き/割引区分：subtotalDiscountDivision
> 単品値引き/割引区分：unitDiscountDivision
APIリファレンスを見るとこれらの項目は数字が返ってくると解釈できます（取得系のAPIではstringとしか書かれていないが、取引登録時APIでは同じ名称の項目がstring<int>となっているため）が、「CSVダウンロード」で取得したファイルには名称が入っているようです。
スマレジ管理画面で言うと「設定」→「販売区分」→「値引区分」or「割引区分」で表示される「名前」が入っているのだと拝察しますが、この「名前」の値を取得する方法はありますでしょうか。
> 前受金：partPayment
当該項目はlayawayオブジェクトの中に入っているようです。
「単品値引き/割引区分」のご回答と違い QUERY PARAMETERS の補足がありませんでしたが、
もしや、リクエスト時に「with_layaway=all」が必須となりますでしょうか。
何度もすみません。どうぞよろしくお願いいたします。
たびたびのご回答、ありがとうございます。
すっきりクリアになりました！😉
ご回答いただいてすっきりクリアになった直後で大変恐縮なのですが、もう１点ご確認をお願いいたします。
・「内消費税」(12)について
「外消費税」(77)という項目が他にあるので一見 taxInclude を取ればよいように見えますが、実際のところは taxInclude + taxExclude となりますでしょうか。
たとえば外税販売の店舗で
"taxInclude": "276","taxExclude": "152",となるような取引を立ててCSVファイルをダウンロードしたところ、
内消費税 428
外消費税 152
と出力されたので、少し気になった次第です。
ご連絡ありがとうございます。
ご心配頂いた通り、字面から考えて「内消費税」「外消費税」は対なるものという印象がありましたが、
内消費税(12)についてはひとまずスッキリしました。