com.xforceplus.tower.econtract.api

Interface ContractApi

@RequestMapping(value="/{tenantId}/enterprise/v1/econtract")
public interface ContractApi

Method Summary

Modifier and Type	Method and Description
DefaultResponse	createContract(Long tenantId, Long appId, Long companyId, @Valid ContractCreationRequest contractCreationRequest)
DefaultResponse	fetchContract(Long tenantId, Long appId, List<String> taxNo, Integer signStatus, @Min(value=1L) Integer page, @Min(value=1L) @Max(value=200L) Integer size)
DefaultResponse	importContract(Long tenantId, Long appId, Long companyId, String contractTemplateCode, org.springframework.web.multipart.MultipartFile multipartFile)
DefaultResponse	obtainContract(Long tenantId, String contractId, Long appId, Long companyId, Boolean download)
DefaultResponse	queryContract(Long tenantId, Long appId, String companyName, String taxNo, String contractTemplateCode, Integer signStatus, @Min(value=1L) Integer page, @Min(value=1L) @Max(value=200L) Integer size)
DefaultResponse	signContract(Long tenantId, String contractId, Long appId, Long companyId, Boolean auto, @Valid ContractSignRequest contractSignRequest)
DefaultResponse	signedContract(Long tenantId, Long appId, Long companyId, @Valid ContractSignRequest contractSignRequest)
DefaultResponse	updateContractStatus(Long tenantId, Long appId, List<String> taxNo, String contractTemplateCode, Integer signStatus)
DefaultResponse	uploadTemplate(Long tenantId, Long appId, Long companyId, org.springframework.web.multipart.MultipartFile multipartFile)

Method Detail

uploadTemplate

@RequestMapping(value="/contracts/templates",
                method=POST,
                produces="application/json;charset=UTF-8")
DefaultResponse uploadTemplate(@PathVariable(value="tenantId")
                                                                                                                                                                     Long tenantId,
                                                                                                                                                                     @RequestParam(value="appId")
                                                                                                                                                                     Long appId,
                                                                                                                                                                     @RequestParam(value="companyId")
                                                                                                                                                                     Long companyId,
                                                                                                                                                                     @RequestParam(value="multipartFile")
                                                                                                                                                                     org.springframework.web.multipart.MultipartFile multipartFile)

createContract

@RequestMapping(value="/contracts",
                method=POST,
                produces="application/json;charset=UTF-8",
                consumes="application/json;charset=UTF-8")
DefaultResponse createContract(@PathVariable(value="tenantId")
                                                                                                                                                                                                                      Long tenantId,
                                                                                                                                                                                                                      @RequestParam(value="appId")
                                                                                                                                                                                                                      Long appId,
                                                                                                                                                                                                                      @RequestParam(value="companyId")
                                                                                                                                                                                                                      Long companyId,
                                                                                                                                                                                                                      @RequestBody @Valid
                                                                                                                                                                                                                      @Valid ContractCreationRequest contractCreationRequest)

signContract

@RequestMapping(value="/contracts/{contractId}/signature",
                method=POST,
                produces="application/json;charset=UTF-8",
                consumes="application/json;charset=UTF-8")
DefaultResponse signContract(@PathVariable(value="tenantId")
                                                                                                                                                                                                                                           Long tenantId,
                                                                                                                                                                                                                                           @PathVariable(value="contractId")
                                                                                                                                                                                                                                           String contractId,
                                                                                                                                                                                                                                           @RequestParam(value="appId")
                                                                                                                                                                                                                                           Long appId,
                                                                                                                                                                                                                                           @RequestParam(value="companyId")
                                                                                                                                                                                                                                           Long companyId,
                                                                                                                                                                                                                                           @RequestParam(value="auto")
                                                                                                                                                                                                                                           Boolean auto,
                                                                                                                                                                                                                                           @RequestBody @Valid
                                                                                                                                                                                                                                           @Valid ContractSignRequest contractSignRequest)

obtainContract

@RequestMapping(value="/contracts/{contractId}",
                method=GET,
                produces="application/json;charset=UTF-8")
DefaultResponse obtainContract(@PathVariable(value="tenantId")
                                                                                                                                                                       Long tenantId,
                                                                                                                                                                       @PathVariable(value="contractId")
                                                                                                                                                                       String contractId,
                                                                                                                                                                       @RequestParam(value="appId")
                                                                                                                                                                       Long appId,
                                                                                                                                                                       @RequestParam(value="companyId")
                                                                                                                                                                       Long companyId,
                                                                                                                                                                       @RequestParam(value="download")
                                                                                                                                                                       Boolean download)

fetchContract

@RequestMapping(value="/contracts",
                method=GET,
                produces="application/json;charset=UTF-8")
DefaultResponse fetchContract(@PathVariable(value="tenantId")
                                                                                                                                                         Long tenantId,
                                                                                                                                                         @RequestParam(value="appId")
                                                                                                                                                         Long appId,
                                                                                                                                                         @RequestParam(value="taxNo")
                                                                                                                                                         List<String> taxNo,
                                                                                                                                                         @RequestParam(value="signStatus",required=false)
                                                                                                                                                         Integer signStatus,
                                                                                                                                                         @RequestParam(value="pageNo",required=false) @Min(value=1L)
                                                                                                                                                         @Min(value=1L) Integer page,
                                                                                                                                                         @RequestParam(value="pageSize",required=false) @Min(value=1L) @Max(value=200L)
                                                                                                                                                         @Min(value=1L) @Max(value=200L) Integer size)

signedContract

@RequestMapping(value="/contracts/signature",
                method=POST,
                produces="application/json;charset=UTF-8",
                consumes="application/json;charset=UTF-8")
DefaultResponse signedContract(@PathVariable(value="tenantId")
                                                                                                                                                                                                                                Long tenantId,
                                                                                                                                                                                                                                @RequestParam(value="appId")
                                                                                                                                                                                                                                Long appId,
                                                                                                                                                                                                                                @RequestParam(value="companyId")
                                                                                                                                                                                                                                Long companyId,
                                                                                                                                                                                                                                @RequestBody @Valid
                                                                                                                                                                                                                                @Valid ContractSignRequest contractSignRequest)

importContract

@RequestMapping(value="/contracts/import",
                method=POST,
                produces="application/json;charset=UTF-8")
DefaultResponse importContract(@PathVariable(value="tenantId")
                                                                                                                                                                  Long tenantId,
                                                                                                                                                                  @RequestParam(value="appId")
                                                                                                                                                                  Long appId,
                                                                                                                                                                  @RequestParam(value="companyId")
                                                                                                                                                                  Long companyId,
                                                                                                                                                                  @RequestParam(value="contractTemplateCode")
                                                                                                                                                                  String contractTemplateCode,
                                                                                                                                                                  @RequestParam(value="\u4e0a\u4f20\u6587\u4ef6",required=true)
                                                                                                                                                                  org.springframework.web.multipart.MultipartFile multipartFile)

queryContract

@RequestMapping(value="/management/contracts",
                method=GET,
                produces="application/json;charset=UTF-8")
DefaultResponse queryContract(@PathVariable(value="tenantId")
                                                                                                                                                                    Long tenantId,
                                                                                                                                                                    @RequestParam(value="appId")
                                                                                                                                                                    Long appId,
                                                                                                                                                                    @RequestParam(value="companyName")
                                                                                                                                                                    String companyName,
                                                                                                                                                                    @RequestParam(value="taxNo")
                                                                                                                                                                    String taxNo,
                                                                                                                                                                    @RequestParam(value="contractTemplateCode")
                                                                                                                                                                    String contractTemplateCode,
                                                                                                                                                                    @RequestParam(value="signStatus",required=false)
                                                                                                                                                                    Integer signStatus,
                                                                                                                                                                    @RequestParam(value="pageNo",required=false) @Min(value=1L)
                                                                                                                                                                    @Min(value=1L) Integer page,
                                                                                                                                                                    @RequestParam(value="pageSize",required=false) @Min(value=1L) @Max(value=200L)
                                                                                                                                                                    @Min(value=1L) @Max(value=200L) Integer size)

updateContractStatus

@RequestMapping(value="/management/contracts/status",
                method=PUT,
                produces="application/json;charset=UTF-8")
DefaultResponse updateContractStatus(@PathVariable(value="tenantId")
                                                                                                                                                                                  Long tenantId,
                                                                                                                                                                                  @RequestParam(value="appId")
                                                                                                                                                                                  Long appId,
                                                                                                                                                                                  @RequestParam(value="taxNo")
                                                                                                                                                                                  List<String> taxNo,
                                                                                                                                                                                  @RequestParam(value="contractTemplateCode")
                                                                                                                                                                                  String contractTemplateCode,
                                                                                                                                                                                  @RequestParam(value="signStatus",required=true)
                                                                                                                                                                                  Integer signStatus)