查詢客戶合約額度 | OrderUpB2B

依客戶序號查詢目前的合約額度水位。查無此客戶（含跨租戶命中）一律回傳 404 company_not_found，兩種情況無法從回應內容區分。

客戶存在但從未設定過合約額度時仍是 200，不是 404：creditAmount 為 0、enabled 為 false（合約額度側「缺列即不卡控」，與點數額度側的預設相反）、memo 為空字串、updatedAt 為 null。

依客戶序號查詢目前的合約額度水位。查無此客戶（含跨租戶命中）一律回傳 404 company_not_found，兩種情況無法從回應內容區分。客戶存在但從未設定過合約額度時仍是 200，不是 404：`creditAmount` 為 0、`enabled` 為 false（合約額度側「缺列即不卡控」，與點數額度側的預設相反）、`memo` 為空字串、`updatedAt` 為 null。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。

canonical string 的組成、可複製的簽章範例與 401 排查步驟，請參閱「驗證與簽章」。

每個 /v1 請求都必須帶 `X-Client-Id`、`X-Timestamp`、`X-Nonce` 與 `X-Signature` 四個標頭。`X-Signature` 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。 canonical string 的組成、可複製的簽章範例與 401 排查步驟，請參閱[「驗證與簽章」](/authentication)。

Path parameters

idlongRequired

要查詢的客戶序號，對應客戶主檔的 id。查無此客戶或屬於其他租戶時，一律回傳 404 company_not_found。

Response

companyIdlongOptional

客戶序號，對應客戶主檔的 id。

companyOuterSysCodestring or nullOptional

這個客戶的 ERP 代碼，即 outerSysCode。

creditAmountdoubleOptional

目前的絕對合約額度，數值（小數 4 位），由批次同步端點寫入的最新值。

pendingAmountdoubleOptional

已下單但尚未出貨、佔用中的額度金額。

availableAmountdoubleOptional

目前還能使用的額度，等於 creditAmount 減去 pendingAmount；可能為負，代表佔用已經超過額度，刻意不夾在 0。

enabledbooleanOptional

是否啟用合約額度卡控。這個欄位真的會影響下單：下單流程會讀它，false 時不檢查合約額度、直接放行。

與點數額度側的同名欄位不對稱——那邊目前只回報不卡控，詳見批次同步端點的說明。

memostring or nullOptional

備註，最長 200 字元，由批次同步端點寫入。

updatedAtdatetime or nullOptional

最後一次同步的時間；從未設定過時為 null。

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error