Skip to content
web240 edited this page Jul 18, 2016 · 1 revision

政采云开放api文档

查询后台类目

  • 请求 url 地址

    POST  QuerySupplierStatements
    
  • 请求参数示例

    {
        "data": {
            "pageNo": 0,
            "pageSize": 5,
            "endAt":  "2016-02-09 11:12:23",
            "startAt": "2016-01-09 11:12:23",
            "status": "未支付"
        }
    }
  • 请求参数说明

    参数名 说明 必填 类型 长度 备注
    startAt 查询时间范围的开始时间,时间格式:yyyy-mm-dd hh:mm:ss 字符串 19
    endAt 查询时间范围的截止时间,时间格式:yyyy-mm-dd hh:mm:ss 字符串 19
    status 结算单状态 字符串 64 结算单状态枚举:
    1、“未支付”
    2、“已匹配”
    使用说明:
    - 传入“未支付”时,startAt和endAt视作结算单的创建时间查询范围
    - 传入“已匹配”时,startAt和endAt视作结算单的匹配完成查询范围。返回的数据中携带有payRecords内容。
    pageNo 页码 整型 4
    pageSize 页面大小 整型 4
  • 返回结果集

    • 正确结果示例, HTTP STATUS=200

      {
          "data_response": {
              "total": 1,
              "data": [
                  {
                      "statementId": 1004032000000010000,
                      "statementNo": "1004032000000010000",
                      "statementName": "天猫第一笔结算单",
                      "totalAmount": 540000,
                      "matchAmount": 1000000,
                      "status": "未支付",
                      "createAt": "2016-01-09 11:12:23",
                      "purchaserOrgName": "杭州市第二中学",
                      "districtName": "杭州市",
                      "orders": [
                          {
                              "orderId": 22
                          },
                          {
                              "orderId": 21
                          }
                      ],
                      "invoices": [
                          {
                              "serialNo": "4004032000000010000",
                              "invoiceType": "增值税普通发票",
                              "invoiceTitle": "杭州市第二中学",
                              "invoiceAmount": 180000,
                              "postAddr": "东信大道72-4",
                              "postContact": "买买提",
                              "postContactPhone": "15623312563",
                              "orders": [
                                  {
                                      "orderId": 22
                                  }
                              ],
                              "items": [
                                  {
                                      "category": "生活电器",
                                      "amount": 180000
                                  }
                              ]
                          },
                          {
                              "serialNo": "F011601020100000018",
                              "invoiceType": "增值税普通发票",
                              "invoiceTitle": "杭州市第二中学",
                              "invoiceAmount": 360000,
                              "postAddr": "东信大道72-76号 ",
                              "postContact": "张三",
                              "postContactPhone": "15626547892",
                              "orders": [
                                  {
                                      "orderId": 21
                                  }
                              ],
                              "items": [
                                  {
                                      "category": "生活电器",
                                      "amount": 360000
                                  }
                              ]
                          }
                      ],
                      "payRecords": [
                          {
                              "payId": 3029327340242,
                              "payer": "岳云",
                              "payBankName": "工商银行",
                              "payBankCardNo": "12739337348323",
                              "payAmount": 1000000,
                              "payRemark": "付款备注",
                              "matchVostro": [
                                  {
                                      "vostroNo": "1234556",
                                      "payerBankName": "工商银行",
                                      "payerBankCardNo": "12739337348323",
                                      "payerCardOwnerName": "张伟",
                                      "payeeBankCardNo": "83279374293445",
                                      "payeeCardOwnerName": "王兴",
                                      "totalAmount": 1000000,
                                      "matchAmount": 1000000,
                                      "matchRemark": "匹配说明",
                                      "currency": "CNY",
                                      "transferTime": "2016-03-16 14:20:22",
                                      "transferRemark": "转账备注"
                                  }
                              ]
                          }
                      ]
                  }
              ]
          }
      }
  • 正确结果说明

    参数名 说明 类型 备注
    total 返回表项个数 Long
    data.statementId 结算单ID Long
    data.statementNo 结算单编号 String
    data.statementName 结算单名称 String
    data.status 结算单状态 String 结算单状态:
    1、“未支付”
    2、“已匹配”
    已匹配状态的结算单会携带payRecords数据。
    data.totalAmount 结算单总金额,单位:分 Long
    data.matchAmount 已匹配金额,单位:分 Long
    data.createAt 结算单创建时间,格式:yyyy-mm-dd hh:mm:ss String
    data.purchaserOrgName 采购单位 采购单位名称 String
    data.districtName 行政区划名称 String
    data.orders.orderId 结算单关联订单ID Long
    data.invoices.serialNo 平台开票需求序列号 String
    data.invoices.invoiceType 发票类型 String 1、 普通发票
    2、 增值税普通发票
    3、 增值税专用发票
    data.invoices.invoiceTitle 发票抬头 String
    data.invoices.invoiceAmount 发票金额,单位:分 Long
    data.invoices.postAddr 发票寄送地址 String
    data.invoices.postContact 发票寄送联系人 String
    data.invoices.postContactPhone 发票寄送联系方式 String
    data.invoices.items.catagory 发票内容中商品一级类目名称 String
    data.invoices.items.amount 发票内容中商品金额,单位:分 Long
    data.invoices.orders.orderId 发票关联订单ID Long
    data.payRecords.payId 支付记录ID Long
    data.payRecords.payer 支付经办人   String
    data.payRecords.payBankName 支付记录付款银行 String
    data.payRecords.payBankCardNo 支付记录付款银行卡号 String 
    data.payRecords.payAmount   支付记录支付金额,单位:分  Long 
    data.payRecords.payRemark  付款备注   String 
    data.payRecords.matchVostro.vostroNo   网商银行来款流水号   String 
    data.payRecords.matchVostro.payerBankName  网商银行来款流水付款银行名称  String 
    data.payRecords.matchVostro.payerBankCardNo  网商银行来款流水付款银行卡号 String 
    data.payRecords.matchVostro.payerCardOwnerName   网商银行来款流水付款银行卡号户名  String 
    data.payRecords.matchVostro.payeeBankCardNo 网商银行来款流水目标收款银行账号 String
    data.payRecords.matchVostro.payeeCardOwnerName 网商银行来款流水目标收款银行卡户名 String
    data.payRecords.matchVostro.totalAmount 网商银行来款流水总金额,单位:分。 Long
    data.payRecords.matchVostro.matchAmount 网商银行来款流水总金额中,当前匹配记录占用的额度。单位:分 Long
    data.payRecords.matchVostro.matchRemark 匹配说明备注 String
    data.payRecords.matchVostro.currency 币种,默认”CNY”,人民币。 String
    data.payRecords.matchVostro.transferTime 来款流水转入时间,格式:yyyy-mm-dd hh:mm:ss String
    data.payRecords.matchVostro.transferRemark 转账备注 String
  • 错误结果示例, HTTP STATUS=500

    {
        "error_response": {
            "resultCode": -1,
            "resultMsg": "入参非法"
        }
    }
    

获取附件上传凭证

  • 请求服务名

     POST SupplierGetUploadCredentials
    
  • 请求参数示例

     {
       "fileNum":2
     }
  • 请求参数说明

    参数名 说明 必填 类型 长度 备注
    fileNum 上传文件的个数 整型 32
  • 返回结果集

    • 正确结果示例, HTTP STATUS=200

      {
          "data_response": {
              "securityToken": "CAES4wIIARKAASvjuJy98AeOGeQXIEj3Kl3yGIAWbqRe/PApvVnkVb54JyikjI5JO/DWfR0VBoZoAJAOay/MwuYZ6W3jeS9wi5dShjJnkw3fs/3En4927qKUGPjuHx6OsjJiyJcPq2W8V653aZK066bqSGV7OtLDwN7LDr4ChGkybJgInNA6FJyOGhhTVFMuT2RoS3hoakJjV2VjeUtGelZqYW8iEjMyNDk4ODk0ODkzNDE2NTc5NSoDemN5MKa7hPGwKjoGUnNhTUQ1QkoKATEaRQoFQWxsb3cSGwoMQWN0aW9uRXF1YWxzEgZBY3Rpb24aAwoBKhIfCg5SZXNvdXJjZUVxdWFscxIIUmVzb3VyY2UaAwoBKkoQMTg2MjAyNzc2OTMyMDk2NFIFMjY4NDJaD0Fzc3VtZWRSb2xlVXNlcmAAahIzMjQ5ODg5NDg5MzQxNjU3OTVyBXdyaXRleISsgv6RsKcD",
              "accessKeySecret": "hzSarZTMTwgIZLrpb0b4aY0PaszjJ4Ca3EJpBB6g",
              "accessKeyId": "STS.OdhKxhjBcWecyKFzVjao",
              "expiration": "2016-02-23T12:36:04Z",
              "bucket": "zcy-dc",
              "data": [
                  "null/f789eb9c-0cbc-40c5-afd9-4b7ba1dd4e6c"
              ]
          }
      }
      
    参数名 说明 类型 备注
    securityToken OSS访问Token String
    accessKeySecret OSS访问AccessKey Secret String
    accessKeyId OSS访问AccessKey ID String
    expiration Token过期时间 String
    bucket OSS Bucket名称 String
    data 文件ID信息 String
    • 错误结果示例, HTTP STATUS=500

      {
          "error_response": {
              "resultCode": -1,
              "resultMsg": "入参非法"
          }
      }

上传结算单发票

  • 请求服务名

     POST SupplierUploadInvoiceInfo
    
  • 请求参数示例

     {
         "data": {
             "serialNo": "FP001",
             "invoiceNo": "27990480762",
             "invoiceCode": "ADA121321",
             "expressCompany": "中通快递",
             "expressCompanyCode": "111",
             "expressNo": "SF0021",
             "attachFile": {
                 "fileId": "201",
                 "filename": "发票附件1",
                 "fileType": "jpg",
                 "fileBytes": 1000
             }
     }
     }
  • 请求参数说明

    参数名 说明 必填 类型 长度 备注
    data.serialNo 平台开票需求序列号 String 64
    data.invoiceNo 发票号码 String 32
    data.invoiceCode 发票代码 String 32
    data.expressCompany 快递公司 String 128
    data.expressCompanyCode 菜鸟物流关于快递公司的编码 String 128
    data.expressNo 快递单号 String 32
    data.attachFile.fileId 发票关联附件ID String 64
    data.attachFile.fileName 发票关联附件名称 String 255
    data.attachFile.fileType 发票关联附件文件类型 String 255
    data.attachFile.fileBytes 发票关联附件大小,单位:字节 Long 8
  • 返回结果集

    • 正确结果示例, HTTP STATUS=200

      {
          "data_response": {
            " code": -1,
            " message": "业务处理失败"
          }
      }
      
      参数名 说明 类型 备注
      code 0:表示成功,非0:表示失败 Long
      message 失败原因 String
    • 错误结果示例, HTTP STATUS=500

      {
          "error_response": {
              "resultCode": -1,
              "resultMsg": "入参非法"
          }
      }

提交结算单支付匹配确认结果

  • 请求服务名

     POST SubmitStatementMatchConfirm
    
  • 请求参数示例

     {
         "data": {
             "statementNo": "1004032000000010000",
             "confirm": "不通过",
             "remark": "不通过原因描述"
         }
     }
  • 请求参数说明

    参数名 说明 必填 类型 长度 备注
    statementNo 结算单编码 字符串 64
    confirm 确认结果:
    “通过”
    “不通过”
    字符串 32
    remark 不通过时,填详细原因 字符串 128
  • 返回结果集

    • 正确结果示例, HTTP STATUS=200

      {
             "data_response": {
               " code": -1,
               " message": "业务处理失败"
             }
         }
      
      参数名 说明 类型 备注
      code 0:表示成功,非0:表示失败 Long
      message 失败原因 String
    • 错误结果示例, HTTP STATUS=500

      {
          "error_response": {
              "resultCode": -1,
              "resultMsg": "入参非法"
          }
      }
Clone this wiki locally