What is the endpoint for [P047]Receive Patent Fee Data?

The [P047]Receive Patent Fee Data endpoint is POST https://connect.patsnap.com/fee/get_fee.

What data can [P047]Receive Patent Fee Data return?

[P047]Receive Patent Fee Data Receiving patent fee data by ticket_id. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [P047]Receive Patent Fee Data?

The OpenAPI schema is available at /openapi.json#/paths/~1fee~1get_fee/post. You can also browse the full specification at /openapi.json.

[P047]Receive Patent Fee Data

post

https://connect.patsnap.com/fee/get_fee

Try in Sandbox

Receiving patent fee data by ticket_id

1.After creating the ticket_id, please wait a while before calling current API to obtain the patent fee data. In particular, due to the large number of patents, some time is needed for data synchronization and preparation. 2.If the apno_status of some application numbers shows "Data is synchronizing, please try again later", please try again later; 3.Multiple traffic/costs deductions were made according to the number of patents that successfully returned fee data. Repeated acquisition will only be deducted once.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`ticket` Required	`string`	`3fafc688-4977-4194-aa5d-880dacd3ba8b`	Enter the ticket

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`size`	`integer<int32>`	`10`	list size
`ticket`	`string`	`3fafc688-4977-4194-aa5d-880dacd3ba8b`	user ticket
`fee_infos_list`	`array`	`Please check the form: FeeOutputInfos`	application details
`apno`	`string`	`CN201610244038.2`	application number
`data`	`object`	`Please check the form: Patent_maintenance_fee_cnModel`	value of fee if sync is succ
`apno`	`string`	`CN201680038597.6`	application number
`chongh`	`array`	`Please check the form: Fee_chonghField`	chonghong information
`fee_type`	`string`	`冲红前：发明专利申请费;冲红后：发明专利申请费`	Type of Payment
`chong_date`	`integer<int64>`	`20210525`	chonghong date
`paid_amount`	`string`	`冲红前： 900;冲红后： 0`	Paid Amount
`receipt_code`	`string`	`冲红前： 100010220;冲红后： --`	Receipt code
`receipt_number`	`string`	`冲红前： 0000088346;冲红后：--`	Receipt Number
`refund`	`array`	`Please check the form: RefundField`	Refund Information
`payee`	`string`	`TCL集团股份有限公司`	Payee
`fee_type`	`string`	`发明专利申请审查费`	Type of Fee
`refund_date`	`integer<int64>`	`20150813`	Date of Refund
`receipt_code`	`string`	`100010220`	Receipt code
`refund_amount`	`number<double>`	`2500`	Refund Amount
`receipt_number`	`string`	`33130256`	Receipt Number
`paid_fee`	`array`	`Please check the form: Paid_feeField`	Information of Paid Fee
`payer`	`string`	`深圳中一专利商标事务所`	Payer
`fee_type`	`string`	`发明专利登记印刷费`	Type of Payment
`paid_amount`	`number<double>`	`250`	Paid Amount
`payment_date`	`integer<int64>`	`20150813`	Date of Payment
`receipt_code`	`string`	`44296705`	Receipt code
`receipt_number`	`string`	`44296705`	Receipt Number
`update_ts`	`integer<int64>`	`1695093322836`	update time
`fee_to_pay`	`array`	`Please check the form: Fee_to_payField`	Information of Fee to pay
`fee_type`	`string`	`恢复权利请求费`	Type of fee
`payment_amount`	`number<double>`	`1000`	Payment Amount
`payment_status`	`string`	`未缴`	Payment status
`payment_dateline`	`integer<int64>`	`20230731`	Deadline of Payment
`legal_status`	`string`	`等年费滞纳金`	legal status
`overdue_fine`	`array`	`Please check the form: Overdue_fineField`	overdue fine information
`sum`	`number<double>`	`5000`	Sum
`end_date`	`integer<int64>`	`20230410`	End Date of Payment
`start_date`	`integer<int64>`	`20221111`	Start Date of Payment
`late_payment_fee`	`number<double>`	`1000`	Amount of late payment fee payable
`annual_fee_amount`	`number<double>`	`4000`	Current annual fee amount
`receipt_information`	`array`	`Please check the form: ReceiptInfo`	Receipt dispath information
`type`	`string`	`发明专利年费滞纳金`	Type of Receipt
`payer`	`string`	`TCL集团股份有限公司技术中心`	name of payer
`amount`	`number<double>`	`100`	amout of fee
`mailed`	`string`	`是`	is mailed
`pay_date`	`integer<int64>`	`20191127`	Date of Fee
`issue_date`	`integer<int64>`	`20191127`	Date of issue
`remit_date`	`integer<int64>`	`20191127`	date of remit
`refund_date`	`integer<int64>`	`20191127`	date of refund
`receipt_title`	`string`	`收据抬头`	title of receipt
`receipt_number`	`string`	`1910295808`	receipt number
`mailing_address`	`string`	`XXX@mail.com`	address
`tracking_number`	`string`	`5012312312312`	number of track
`patent_maintenance_fee_cn_id`	`string`	`82c5ad4f-2f59-11ed-b2e9-e454e89e8034`	fee id
`apno_status`	`string`	`成功`	sync status: Success No fee fata Data is synchronizing, please try again later Error application number
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "size": 10,
    "ticket": "3fafc688-4977-4194-aa5d-880dacd3ba8b",
    "fee_infos_list": [
      {
        "apno": "CN201610244038.2",
        "data": {
          "apno": "CN201680038597.6",
          "chongh": [
            {
              "fee_type": "冲红前： 发明专利申请费;冲红后： 发明专利申请费",
              "chong_date": 20210525,
              "paid_amount": "冲红前： 900;冲红后： 0",
              "receipt_code": "冲红前： 100010220;冲红后： --",
              "receipt_number": "冲红前： 0000088346;冲红后：--"
            }
          ],
          "refund": [
            {
              "payee": "TCL集团股份有限公司",
              "fee_type": "发明专利申请审查费",
              "refund_date": 20150813,
              "receipt_code": 100010220,
              "refund_amount": 2500,
              "receipt_number": 33130256
            }
          ],
          "paid_fee": [
            {
              "payer": "深圳中一专利商标事务所",
              "fee_type": "发明专利登记印刷费",
              "paid_amount": 250,
              "payment_date": 20150813,
              "receipt_code": 44296705,
              "receipt_number": 44296705
            }
          ],
          "update_ts": 1695093322836,
          "fee_to_pay": [
            {
              "fee_type": "恢复权利请求费",
              "payment_amount": 1000,
              "payment_status": "未缴",
              "payment_dateline": 20230731
            }
          ],
          "legal_status": "等年费滞纳金",
          "overdue_fine": [
            {
              "sum": 5000,
              "end_date": 20230410,
              "start_date": 20221111,
              "late_payment_fee": 1000,
              "annual_fee_amount": 4000
            }
          ],
          "receipt_information": [
            {
              "type": "发明专利年费滞纳金",
              "payer": "TCL集团股份有限公司技术中心",
              "amount": 100,
              "mailed": "是",
              "pay_date": 20191127,
              "issue_date": 20191127,
              "remit_date": 20191127,
              "refund_date": 20191127,
              "receipt_title": "收据抬头",
              "receipt_number": 1910295808,
              "mailing_address": "XXX@mail.com",
              "tracking_number": 5012312312312
            }
          ],
          "patent_maintenance_fee_cn_id": "82c5ad4f-2f59-11ed-b2e9-e454e89e8034"
        },
        "apno_status": "成功"
      }
    ]
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms