获取合同详情 - 探马OpenAPI

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

contractId

string

合同ID

必需

示例

{
    "contractId": "HT.431339837921536"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v3/contract/detail' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contractId": "HT.431339837921536"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

id

string

合同id

必需

title

string

合同名称

必需

customerId

number

客户id

必需

salesId

number

员工id

必需

amount

number

合同金额

必需

contractType

string

合同类型

必需

startTime

string

合同开始时间

必需

endTime

string

合同结束时间

必需

signTime

string

合同签约时间

可选

approvalStatus

integer

审批状态

必需

1-未提交；0审核中；1已通过；2已拒绝；3已撤销；4已删除；5已解锁

mineSign

string

我方签约人

必需

customerSign

string

客方签约人

必需

paymentMethod

string

支付方式

必需

contractStatus

string

合同状态

必需

customDefine

string

自定义字段

必需

gmtCreateTime

string

创建时间

必需

gmtUpdateTime

string

更新时间

必需

gmtUpdateSalesName

string

更新人

必需

gmtUpdateSalesId

number

更新人id

必需

gmtCreateSalesName

string

创建人

必需

gmtCreateSalesId

number

创建人id

必需

orders

array [object {2}]

订单

必需

oppos

array [object {3}]

商机

必需

refund

array [object {2}]

退款单

必需

invoice

array [object {3}]

发票

必需

fundRestreamBill

array [object {3}]

回款单

必需

示例

{
    "code": 0,
    "message": "string",
    "data": {
        "id": "string",
        "title": "string",
        "customerId": 0,
        "salesId": 0,
        "amount": 0,
        "contractType": "string",
        "startTime": "string",
        "endTime": "string",
        "signTime": "string",
        "approvalStatus": 0,
        "mineSign": "string",
        "customerSign": "string",
        "paymentMethod": "string",
        "contractStatus": "string",
        "customDefine": "string",
        "gmtCreateTime": "string",
        "gmtUpdateTime": "string",
        "gmtUpdateSalesName": "string",
        "gmtUpdateSalesId": 0,
        "gmtCreateSalesName": "string",
        "gmtCreateSalesId": 0,
        "orders": [
            {
                "id": "string",
                "amount": 0
            }
        ],
        "oppos": [
            {
                "id": "string",
                "name": "string",
                "amount": 0
            }
        ],
        "refund": [
            {
                "id": "string",
                "amount": 0
            }
        ],
        "invoice": [
            {
                "id": "string",
                "amount": 0,
                "unAmount": 0
            }
        ],
        "fundRestreamBill": [
            {
                "id": "string",
                "amount": 0,
                "unAmount": 0
            }
        ]
    }
}