查詢單一客戶
依 id 查詢單一客戶。若該 id 不存在,或屬於其他租戶,一律回傳 404 not_found,兩種情況無法從回應內容區分。
Authentication
每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。
canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。
Path parameters
要查詢的客戶序號。不存在或屬於其他租戶時,一律回傳 404 not_found。
Response
客戶序號。
ERP 端的客戶代碼。
企業名稱。
企業簡稱。
公司電話。
收貨地址。
負責業務(內部使用者)的序號。
客戶狀態,Active(啟用)或 Inactive(停用)。透過本 API 建立的客戶一律為 Active;後續狀態變更由後台維護,本 API 目前不提供寫入。
這個客戶的結帳條件,Cash(現結)或 Monthly(月結)。可由 POST/PUT /v1/companies 寫入,寫入時填的值就是這裡回傳的值。
這個客戶可用付款方式的決定方式,Inherit(沿用租戶已啟用的全部付款方式)或 Specify(只用 paymentMethods 列出的那幾種)。可由 POST/PUT /v1/companies 寫入,與 paymentMethods 成對。
paymentMethodMode 為 Specify 時,這個客戶可用的付款方式 key 清單;為 Inherit 時固定是空陣列,實際可用的方式由租戶已啟用的付款方式決定,不會在這裡展開。注意「月結」不會出現在這個清單裡,它是結帳條件而不是付款方式,請看 settlementType。可由 POST/PUT /v1/companies 寫入;合法的 key 可由 GET /v1/payment-methods 取得。
這個客戶所屬的客戶總部(群組)序號;不屬於任何群組時為 null。唯讀欄位:成員關係只能透過 /v1/company-groups 維護,POST/PUT /v1/companies 不收這個欄位。總部客戶本身也是自己群組的成員,所以它的這個欄位同樣有值。