1. 账期
西之月开放接口(openapi)
  • 西之月开放平台介绍
  • 西之月接入流程
  • 西之月开放API
  • 西之月订阅通知
  • 公共错误码
  • 货盘页面接入说明
  • openapi
    • 商品
      • 📖商品能力
      • SKU
        • SKU列表
        • SKU信息
        • SKU信息及价格
        • SKU查询客户价格
        • SKU查询英代欧代美代协议
        • SKU一体化标签
        • SKU一体化标签平台
        • SKU证书
        • SKU六面图
        • SKU商品图包
        • SKU视频
        • SKU商品标签【国内】
        • SKU产品文案
        • SKU实拍图附带一体化标签
        • SKU图包资料
      • 库存
        • 商品总库存列表
        • 商品分仓库存列表
        • 指定商品分仓库存
        • 圈货、备货库存查询
        • SKU实时库存【国内】
      • 商品列表
      • 商品详情
      • 商品价格
      • 个性化商品价格列表
      • 商品所有档位价格
      • 商品分类
      • 商品分类-获取子分类
      • 商品品牌
      • 商品证书
      • 商品使用说明书
    • 订单
      • 📖订单能力
      • 交接单
        • 交接单列表
        • 验证订单允许上传交接单
        • 上传交接单文件
        • 保存交接单
      • 创建订单
      • 订单预计算
      • 订单列表
      • 订单详情
      • 订单详情列表
      • 订单取消
      • 订单状态
      • 订单支付状态
      • 订单物流轨迹
    • 支付
      • 📖支付能力
      • 订单支付页面
      • 发起支付
      • 获取支付方式
      • 获取订单支付信息
    • 售后
      • 📖售后能力
      • 获取发起售后配置数据
      • 订单发起售后
      • 撤销售后
    • 账期
      • 📖账期能力
      • 已结清账期-账单列表
        POST
      • 未结清账期-账单列表
        POST
      • 未结清账单-销售订单列表
        POST
      • 未结清账单-售后订单列表
        POST
    • 品牌授权
      • 📖品牌授权能力
      • 获取授权平台列表
      • 获取模板类型列表
      • 获取授权品牌列表
      • 获取执照列表信息
      • 品牌授权申请
      • 品牌授权记录
      • 品牌授权作废
    • 其他
      • 📖其它能力
      • 仓库
        • 仓库列表信息
        • 发货区域列表
      • 物流
        • 物流公司列表
        • 获取运费接口
      • 平台
        • 获取授权码
        • 平台列表信息-新
        • 平台列表信息
      • 用户
        • 根据token获取用户信息
    • 订阅通知
      • 商品信息变更
      • 商品上下架状态变更
      • 商品库存变更
      • 商品价格变更
      • 商品删除
  1. 账期

已结清账期-账单列表

外部-测试环境
https://testing.westmonth.com
外部-测试环境
https://testing.westmonth.com
POST
/openapi/quotaPeriod/getQuotaSettledPeriods

已结清账期-账单列表接口#

提供获取用户已结清账期的账单列表能力,支持分页查询,可获取已结清账期的详细信息、客户信息及收款账号等相关数据。

适用场景#

查询用户已结清的账期账单信息
获取与已结清账期相关的客户信息和收款账号信息

接口类型#

POST

请求频率限制#

默认频率:以平台配额为准

请求说明#

请求URL
正式环境:https://www.westmonth.com/openapi/quotaPeriod/getQuotaSettledPeriods
测试环境:https://testing.westmonth.com/openapi/quotaPeriod/getQuotaSettledPeriods

请求参数#

Header参数#

参数名类型必填示例值说明
Authorizationstring是authorization身份验证Token
Content-Typestring是application/json建议固定传此值

Body参数#

根 字段
参数名类型必填默认值可选值说明
pageinteger是--当前页码
page_sizeinteger是--每页展示数量
customer_idinteger否--客户ID
customer_uidstring否--客户UID
customer_namestring否--客户名称

响应字段说明#

成功响应(HTTP 200)
根 字段
字段类型说明
codeinteger请求状态码
msgstring请求描述
dataobject返回参数
data对象 字段
字段类型说明
listarray已结清账期账单列表
totalinteger账期账单数量
quota_customerobject客户主数据
payee_listobject收款账户列表
list数组 字段
字段类型说明
idinteger账期id
delivery_region_typeinteger发货区域(1中国,2海外)
numinteger账期
ended_atstring本期结束时间
started_atstring本期开始时间
end_delayed_atstring逾期日期(本期结束时间 + 还款期限)
statusstring账期状态(running:进行中;arrived:待生成账单;bill_auditing:账单审核中;bill_confirmed:账单已生成;unpaid:待还款;done:全部结清)
sale_amountstring消费金额
after_sale_amountstring售后金额
settled_amountstring已结清金额
received_amountstring已收金额
currency_listarray货币列表
quotax_bill_idinteger账单id(可选)
sale_amount_formatstring消费金额(格式化)
after_sale_amount_formatstring售后金(格式化)
probably_amountstring待还金额
probably_amount_formatstring待还金额(格式化)
settled_amount_formatstring已结清金额(格式化)
received_amount_formatstring已收金额(格式化)
adjust_amountinteger调整金额
adjust_amount_formatstring调整金额(格式化)
receivable_amountstring应收金额
receivable_amount_formatstring应收金额(格式化)
total_amountstring剩余应还金额
total_amount_formatstring剩余应还金额(格式化)
currency_list数组 字段
字段类型说明
namestring货币名称
codestring货币代码
symbol_leftstring左侧符号
symbol_rightstring右侧符号
decimal_placeinteger小数位数
valueinteger货币价值
quota_customer对象 字段
字段类型说明
customer_idinteger客户id
customer_uidstring客户uid
customer_namestring客户名称
payee_list对象 字段(以常见类型为例,其他类型结构类似)
字段类型说明
万里汇array万里汇收款账号列表
储蓄卡array储蓄卡收款账号列表
派安盈array派安盈收款账号列表
微信array微信收款账号列表
支付宝array支付宝收款账号列表
其他array其他类型收款账号列表
银行账户array银行账户收款账号列表
payee_list下各类型账号数组 字段
字段类型说明
nointeger收款账号No
platform_namestring收款方式名称
accountstring账号
account_namestring账号名称
channelstring渠道类型(1688线下、阿里巴巴、独立站、分销商、义务等)
bank_namestring开户行
body_typeinteger主体类型(1公户、2个人账户)
owner_namestring持卡人
body_type_formatstring格式化主体类型

调用示例#

URL请求#

请求示例#

{
  "page": 1,
  "page_size": 30
}

成功返回示例#

{
    "code": 0,
    "msg": "",
    "data": {
        "list": [],
        "total": 0,
        "quota_customer": {
            "customer_id": 880,
            "customer_uid": "WM202405271201537338",
            "customer_name": "1"
        },
        "payee_list": {
            "万里汇": [
                {
                    "no": 10001,
                    "platform_name": "万里汇",
                    "account": "XXXX",
                    "account_name": "XXXX",
                    "channel": "分销商,独立站",
                    "bank_name": "XXXX",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                }
            ],
            "储蓄卡": [
                {
                    "no": 10008,
                    "platform_name": "储蓄卡",
                    "account": "XXXX",
                    "account_name": "XXXX",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "汇丰银行",
                    "body_type": 2,
                    "owner_name": "XXXX",
                    "body_type_format": "个人账户"
                }
            ],
            "派安盈": [
                {
                    "no": 10010,
                    "platform_name": "派安盈",
                    "account": "XXXX",
                    "account_name": "XXXX,
                    "channel": "1688线下",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "XXXX",
                    "body_type_format": "公户"
                }
            ],
            "微信": [
                {
                    "no": 10011,
                    "platform_name": "微信",
                    "account": "XXXX",
                    "account_name": "广东省西之月科技有限公司",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                }
            ],
            "支付宝": [
                {
                    "no": 10013,
                    "platform_name": "支付宝",
                    "account": "XXXX",
                    "account_name": "广东省西之月科技有限公司",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                }
            ],
            "其他": [
                {
                    "no": 10024,
                    "platform_name": "其他",
                    "account": "其他",
                    "account_name": "其他",
                    "channel": "其他",
                    "bank_name": "其他",
                    "body_type": 0,
                    "owner_name": "其他",
                    "body_type_format": "其他"
                }
            ],
            "银行账户": [
                {
                    "no": 10021,
                    "platform_name": "银行账户",
                    "account": "XXXX",
                    "account_name": "广东省西之月科技有限公司",
                    "channel": "独立站",
                    "bank_name": "中信银行股份有限公司汕头分行",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                }
            ],
            "pingpong": [
                {
                    "no": 10020,
                    "platform_name": "pingpong",
                    "account": "XXXX",
                    "account_name": "XXXX",
                    "channel": "独立站",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "西之月香港有限公司",
                    "body_type_format": "公户"
                }
            ]
        }
    }
}

失败返回示例#

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理#

公共错误码
HTTP status code错误码错误信息描述

常见问题#

Q1:分页查询时如何获取下一页数据?#

A:通过递增page参数的值(如当前page=1,下一页page=2),并保持page_size不变,即可获取下一页的已结清账期账单列表数据。

Q2:返回的账期状态中,“done”代表什么意思?#

A:“done”表示该账期状态为全部结清,即该账期内的款项已全部还清。

版本历史#

版本日期修改说明
v1.02025-07-09初始版本

请求参数

Header 参数

Body 参数application/json

示例
{
  "page": 1,
  "page_size": 30,
  "customer_id": 19135,
  "customer_uid": "",
  "customer_name": ""
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://testing.westmonth.com/openapi/quotaPeriod/getQuotaSettledPeriods' \
--header 'Authorization: {{token}}' \
--header 'Cookie: {{cookie}};{{cookie}}' \
--header 'Content-Type: application/json' \
--data '{
  "page": 1,
  "page_size": 30,
  "customer_id": 19135,
  "customer_uid": "",
  "customer_name": ""
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "code": 0,
    "msg": "",
    "data": {
        "list": [
            {
                "id": 2681,
                "delivery_region_type": 1,
                "num": 3,
                "ended_at": "2025-02-16",
                "started_at": "2025-02-10",
                "end_delayed_at": "2025-03-03",
                "status": "done",
                "sale_amount": "91.20",
                "after_sale_amount": "0.00",
                "settled_amount": "91.20",
                "received_amount": "0.00",
                "currency_list": [
                    {
                        "name": "人民币",
                        "code": "CNY",
                        "symbol_left": "¥",
                        "symbol_right": "",
                        "decimal_place": 2,
                        "value": 1
                    },
                    {
                        "name": "美元",
                        "code": "USD",
                        "symbol_left": "$",
                        "symbol_right": "",
                        "decimal_place": 2,
                        "value": 1
                    }
                ],
                "quotax_bill_id": null,
                "sale_amount_format": "¥91.20",
                "after_sale_amount_format": "¥0.00",
                "probably_amount": "91.20",
                "probably_amount_format": "¥91.20",
                "settled_amount_format": "¥91.20",
                "received_amount_format": "¥0.00",
                "adjust_amount": 0,
                "adjust_amount_format": "¥0.00",
                "receivable_amount": "91.20",
                "receivable_amount_format": "¥91.20",
                "total_amount": "91.20",
                "total_amount_format": "¥91.20"
            },
            {
                "id": 2673,
                "delivery_region_type": 1,
                "num": 2,
                "ended_at": "2025-02-09",
                "started_at": "2025-02-03",
                "end_delayed_at": "2025-03-03",
                "status": "done",
                "sale_amount": "76.00",
                "after_sale_amount": "0.00",
                "settled_amount": "76.00",
                "received_amount": "0.00",
                "currency_list": [
                    {
                        "name": "人民币",
                        "code": "CNY",
                        "symbol_left": "¥",
                        "symbol_right": "",
                        "decimal_place": 2,
                        "value": 1
                    },
                    {
                        "name": "美元",
                        "code": "USD",
                        "symbol_left": "$",
                        "symbol_right": "",
                        "decimal_place": 2,
                        "value": 1
                    }
                ],
                "quotax_bill_id": null,
                "sale_amount_format": "¥76.00",
                "after_sale_amount_format": "¥0.00",
                "probably_amount": "76.00",
                "probably_amount_format": "¥76.00",
                "settled_amount_format": "¥76.00",
                "received_amount_format": "¥0.00",
                "adjust_amount": 0,
                "adjust_amount_format": "¥0.00",
                "receivable_amount": "76.00",
                "receivable_amount_format": "¥76.00",
                "total_amount": "76.00",
                "total_amount_format": "¥76.00"
            },
            {
                "id": 2671,
                "delivery_region_type": 1,
                "num": 1,
                "ended_at": "2025-02-02",
                "started_at": "2025-01-27",
                "end_delayed_at": "2025-02-24",
                "status": "done",
                "sale_amount": "80.00",
                "after_sale_amount": "0.00",
                "settled_amount": "80.00",
                "received_amount": "0.00",
                "currency_list": [
                    {
                        "name": "人民币",
                        "code": "CNY",
                        "symbol_left": "¥",
                        "symbol_right": "",
                        "decimal_place": 2,
                        "value": 1
                    },
                    {
                        "name": "美元",
                        "code": "USD",
                        "symbol_left": "$",
                        "symbol_right": "",
                        "decimal_place": 2,
                        "value": 1
                    }
                ],
                "quotax_bill_id": null,
                "sale_amount_format": "¥80.00",
                "after_sale_amount_format": "¥0.00",
                "probably_amount": "80.00",
                "probably_amount_format": "¥80.00",
                "settled_amount_format": "¥80.00",
                "received_amount_format": "¥0.00",
                "adjust_amount": 0,
                "adjust_amount_format": "¥0.00",
                "receivable_amount": "80.00",
                "receivable_amount_format": "¥80.00",
                "total_amount": "80.00",
                "total_amount_format": "¥80.00"
            }
        ],
        "total": 3,
        "quota_customer": {
            "customer_id": 15782,
            "customer_uid": "WM202412101104550852",
            "customer_name": "任利萍"
        },
        "payee_list": {
            "万里汇": [
                {
                    "no": 10001,
                    "platform_name": "万里汇",
                    "account": "342504160",
                    "account_name": "Guangdong Province West Moon Technology Co., Ltd.",
                    "channel": "分销商,独立站",
                    "bank_name": "CITIBANK N.A.HONG KONG BRANCH",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                },
                {
                    "no": 10019,
                    "platform_name": "万里汇",
                    "account": "342505885",
                    "account_name": "WEST MOON HK LIMITED",
                    "channel": "独立站",
                    "bank_name": "CITIBANK N.A.HONG KONG BRANCH",
                    "body_type": 1,
                    "owner_name": "西之月香港有限公司",
                    "body_type_format": "公户"
                }
            ],
            "储蓄卡": [
                {
                    "no": 10008,
                    "platform_name": "储蓄卡",
                    "account": "814252813833",
                    "account_name": "ZhangNana",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "汇丰银行",
                    "body_type": 2,
                    "owner_name": "张娜娜",
                    "body_type_format": "个人账户"
                },
                {
                    "no": 10003,
                    "platform_name": "储蓄卡",
                    "account": "6217680915177401",
                    "account_name": "周婵柔",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "中信银行股份有限公司",
                    "body_type": 2,
                    "owner_name": "周婵柔",
                    "body_type_format": "个人账户"
                },
                {
                    "no": 10009,
                    "platform_name": "储蓄卡",
                    "account": "8888888924854662",
                    "account_name": "广东省西之月科技有限公司",
                    "channel": "分销商,义乌,独立站,1688线下",
                    "bank_name": "浙江网商银行股份有限公司",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                },
                {
                    "no": 10004,
                    "platform_name": "储蓄卡",
                    "account": "6227076220203552",
                    "account_name": "张娜娜",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "中国建设银行股份有限公司汕头金砂支行",
                    "body_type": 2,
                    "owner_name": "张娜娜",
                    "body_type_format": "个人账户"
                },
                {
                    "no": 10005,
                    "platform_name": "储蓄卡",
                    "account": "6228480136721081679",
                    "account_name": "张浩忠",
                    "channel": "分销商,独立站",
                    "bank_name": "中国农业银行",
                    "body_type": 2,
                    "owner_name": "张浩忠",
                    "body_type_format": "个人账户"
                },
                {
                    "no": 10007,
                    "platform_name": "储蓄卡",
                    "account": "735477820064",
                    "account_name": "汕头市皓物科技有限公司",
                    "channel": "分销商",
                    "bank_name": "中国银行汕头珠池支行",
                    "body_type": 1,
                    "owner_name": "汕头市皓物科技有限公司",
                    "body_type_format": "公户"
                },
                {
                    "no": 10006,
                    "platform_name": "储蓄卡",
                    "account": "645777659187",
                    "account_name": "汕头市西月电子商务有限公司",
                    "channel": "分销商",
                    "bank_name": "中国银行汕头金园支行",
                    "body_type": 1,
                    "owner_name": "汕头市西月电子商务有限公司",
                    "body_type_format": "公户"
                },
                {
                    "no": 10002,
                    "platform_name": "储蓄卡",
                    "account": "6217680915177393",
                    "account_name": "陈静",
                    "channel": "分销商",
                    "bank_name": "中信银行",
                    "body_type": 2,
                    "owner_name": "陈静",
                    "body_type_format": "个人账户"
                }
            ],
            "派安盈": [
                {
                    "no": 10010,
                    "platform_name": "派安盈",
                    "account": "ivyandyan@163.com",
                    "account_name": "深圳市依欧好产品设计有限公司",
                    "channel": "1688线下",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "深圳市依欧好产品设计有限公司",
                    "body_type_format": "公户"
                }
            ],
            "微信": [
                {
                    "no": 10011,
                    "platform_name": "微信",
                    "account": "广东省西之月科技有限公司",
                    "account_name": "广东省西之月科技有限公司",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                },
                {
                    "no": 10012,
                    "platform_name": "微信",
                    "account": "张育玲",
                    "account_name": "张育玲",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 2,
                    "owner_name": "张育玲",
                    "body_type_format": "个人账户"
                },
                {
                    "no": 10018,
                    "platform_name": "微信",
                    "account": "汕头市西月电子商务有限公司",
                    "account_name": "汕头市西月电子商务有限公司",
                    "channel": "独立站",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "汕头市西月电子商务有限公司",
                    "body_type_format": "公户"
                }
            ],
            "支付宝": [
                {
                    "no": 10013,
                    "platform_name": "支付宝",
                    "account": "gdwestmonth3@163.com",
                    "account_name": "广东省西之月科技有限公司",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 1,
                    "owner_name": "广东省西之月科技有限公司",
                    "body_type_format": "公户"
                },
                {
                    "no": 10014,
                    "platform_name": "支付宝",
                    "account": "jaysuingsheji@163.com",
                    "account_name": "张育玲",
                    "channel": "义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 2,
                    "owner_name": "张育玲",
                    "body_type_format": "个人账户"
                }
            ],
            "其他": [
                {
                    "no": 10016,
                    "platform_name": "其他",
                    "account": "",
                    "account_name": "直新仓充值",
                    "channel": "分销商,义乌,独立站,1688线下",
                    "bank_name": "",
                    "body_type": 0,
                    "owner_name": "",
                    "body_type_format": "其他"
                }
            ],
            "银行账户": [
                {
                    "no": 10017,
                    "platform_name": "银行账户",
                    "account": "8888 8886 1912 6541",
                    "account_name": "汕头市西月电子商务有限公司",
                    "channel": "独立站",
                    "bank_name": "浙江网商银行股份有限公司",
                    "body_type": 1,
                    "owner_name": "汕头市西月电子商务有限公司",
                    "body_type_format": "公户"
                }
            ]
        }
    }
}
修改于 2026-02-24 03:28:28
上一页
📖账期能力
下一页
未结清账期-账单列表
Built with