Send Contract Document - Gofive OpenAPI

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Content-Type

string

required

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

รหัส subscriptionของลูกค้า

Example:

<Your-Subscription-Key>

Body Params application/json

contractNo

string

required

หมายเลขสัญญา

language

string

required

ภาษา example th-TH, en-GB

roleName

string | null

optional

บทบาท (กรณีที่ลูกค้าในสัญญาเป็นเประเภท Individual)

contactSignatures

array [object {3}] | null

optional

รายการลายเซ็นต์ (กรณีที่ลูกค้าในสัญญาเป็นเประเภท Business)

contactName

string | null

optional

ผู้ติดต่อ

roleName

string

required

บทบาท

seq

integer

optional

ลำดับ

contractTemplates

array [object {2}]

required

รายการ template เอกสารสัญญา

contractTemplateId

integer

optional

Id template เอกสารสัญญา

attachmentIds

array[integer]

optional

ลิส id ของ attahment ประเภท ContractDocumentAttachment

Example

{
    "contractNo": "string",
    "language": "th-TH",
    "roleName": "string",
    "contactSignatures": [
        {
            "contactName": "string",
            "roleName": "string",
            "seq": 0
        }
    ],
    "contractTemplates": [
        {
            "contractTemplateId": 6,
            "attachmentIds": []
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.gofive.co.th/v1/contract/contract-document/send' \
--header 'Ocp-Apim-Subscription-Key: <Your-Subscription-Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contractNo": "string",
    "language": "th-TH",
    "roleName": "string",
    "contactSignatures": [
        {
            "contactName": "string",
            "roleName": "string",
            "seq": 0
        }
    ],
    "contractTemplates": [
        {
            "contractTemplateId": 6,
            "attachmentIds": []
        }
    ]
}'

Responses

🟢200Success

application/json

Body

data

object (SendContractDto)

required

contractNo

string

required

หมายเลขสัญญา

language

string

required

ภาษา example th-TH, en-GB

customerCode

string

optional

รหัสลูกค้า

roleName

string | null

optional

บทบาท (กรณีที่ลูกค้าในสัญญาเป็นเประเภท Individual)

contactSignatures

array [object {3}] | null

optional

รายการลายเซ็นต์ (กรณีที่ลูกค้าในสัญญาเป็นเประเภท Business)

contractTemplates

array [object {2}]

required

รายการ template เอกสารสัญญา

statusCode

integer

required

httpStatusCode

integer

required

Example

{
    "status": {
        "code": "1000",
        "description": "Success"
    },
    "data": {
        "contractNo": "string",
        "language": "th-TH",
        "customerCode": "string",
        "roleName": "string",
        "contactSignatures": [
            {
                "contactName": "string",
                "roleName": "string",
                "seq": 0
            }
        ],
        "contractTemplates": [
            {
                "contractTemplateId": 6,
                "attachments": []
            }
        ]
    }
}

🟠400Bad Request