Connect API 是什么
英国税务申报合规网关:您的软件通过客户端及其数据调用一个端点, # GoFile处理从该调用到HMRC收到数据之间的所有操作。
“数字化税务申报”并非调用一次就能完成的复杂API,而是一个难以实现的API。 自己的. 识别、18 个月后过期的 OAuth 授权、必须描述真实发起设备的防欺诈标头、义务匹配、绝不能捏造的周期密钥、提交幂等性以及多年后仍然有效的审计跟踪——这就是工作,而且永无止境。
Connect API 就是这项在小型 REST 接口背后完成和维护的工作。版本 1 涵盖 增值税:检查客户是否获得授权,了解其完整的增值税情况,提交申报表,并跟踪直至收到收据。
简而言之: 三次通话,一次重定向。核对客户信息,查看待处理事项,提交数据——然后将授权人员引导至我们返回的托管审批页面。您无需接触政府门户网站凭证、 HMRC令牌或期间密钥。
适用人群
簿记和会计软件
您已经掌握了相关数据。无需成为英国税务海关总署HMRC整合团队,即可轻松实现符合MTD增值税申报。
垂直行业及ERP平台
贸易、零售、酒店或特定行业的系统,需要将归档作为一项功能,而不是一个项目。
实践工具和金融科技
为会计师及其客户提供的产品,其中文件归档必须在您的工作流程中进行。
内部财务系统
团体可以在一个地方为多个实体提交文件,每次提交都有审计跟踪。
该API专为代理模式设计:您的合作公司将其与HMRC连接起来。 代理服务账户 只需一次授权,该单一授权即可涵盖其获授权代表的所有客户。
工作原理
每个请求都是一个经过签名的 REST 调用。所有法律上需要人工干预的操作都在我们托管的页面上进行。
请确认客户已获得授权。
只需一个电话即可确认贵公司的代理帐户已获得该增值税号的授权——只需给出明确的答复,无需解码HMRC错误代码。
GET /api/v1/vat/193054661/status
阅读客户的增值税立场
只需一次查询,即可获取所有未结清的申报期及其截止日期、所有已完成的申报期以及任何正在处理中的申报信息。我们会与HMRC保持同步,因此您可以根据需要随时查询。
{
"vat_number": "193054661",
"mode": "live",
"obligations": {
"open": [
{ "period": { "start": "2026-04-01",
"end": "2026-06-30" },
"due": "2026-08-07",
"overdue": false }
],
"fulfilled": [ /* filed periods + figures */ ]
}
}
退货后
请以十进制字符串的形式发送客户参考编号和九个增值税申报表。省略期间,我们将提交未结清的申报表。您将收到一个申报编号和一个 continue_url.
{
"external_client_id": "CLIENT-91827",
"client_name": "Acme Trading Ltd",
"vat_number": "193054661",
"return": {
"vat_due_sales": "12500.00",
"total_vat_due": "12500.00",
"net_vat_due": "8300.00"
/* ...nine boxes in total */
}
}
重定向授权人员
把他们送到 continue_url他们会审核申报表,如果是公司首次申报,则联系HMRC ,然后按下按钮。 确认并提交我们提交并保存收据。
按照步骤完成
轮询文件状态或接收我们的网络钩子,直到状态更新。 submitted 附上HMRC收据。
{
"id": "vfs_...",
"status": "submitted",
"receipt": {
"gofile_reference": "GF-VAT-123",
"form_bundle": "258868935084"
}
}
主办方的审批流程——以及它为何如此重要
HMRC不仅仅需要一份申报表;它还想知道这份申报表是否出自真人之手,是否使用真实设备提交,以及是否由真人对申报内容负责。这正是防欺诈抬头的作用所在,抬头出错属于合规性问题,而非程序漏洞。
因此,Connect API 绝不会要求您的软件伪造这些信息。当您提交文件时,我们会返回一个指向相应页面的 URL。 我们主办在该页面上,授权人员使用双因素身份验证登录,系统会采集其真实设备信息,完整显示申报表,并由其确认申报。只有在确认无误后,我们才会致电HMRC ——届时我们会将基于该设备生成的报税表头截图与申报表一同作为证据。
它能给你带来什么: 您的产品中无需政府网关凭证,无需维护和重新认证欺诈标头实现,无需正确编写声明措辞——并且会记录谁批准了什么,并与他们看到的准确数字关联起来,形成不可篡改的记录。
该页面还会引导您的客户完成与HMRC一次性连接。当公司首次提交申报表时,它会在该页面授权其代理服务帐户,然后直接返回申报页面。
你无需建造什么
| MTD问题 | 它属于谁? |
|---|---|
| HMRC OAuth 授权、刷新和 18 个月重新授权上限 | #GoFile |
| 来自真实原始设备的防欺诈标头 | #GoFile |
| 义务匹配和期间键 | #GoFile |
| 人类声明和批准记录 | #GoFile |
| 提交幂等性和超时协调 | #GoFile |
| 审计追踪和提交证据 | #GoFile |
| 您的客户名单及其增值税数据 | 你 |
您永远不会被要求输入句号键或 finalised 标志——API 直接拒绝它们,因为这些是我们来决定的,而弄错这些标志会导致糟糕的申报。
沙盒和实时
模式由您签名时使用的密钥选择,因此无需切换全局开关,部署过程中也无需遗忘任何内容:
gfk_sandbox_…密钥文件将用于HMRC的测试环境。免费、无限制,可在持续集成 (CI) 环境中安全运行。gfk_live_…关键文件真实回报。
两者可以同时运行。您的测试套件可以在生产文件运行的同时访问沙盒环境,切换环境只需使用您登录的凭证即可。使用情况、请求日志和每日限额会根据不同的模式分别进行跟踪。
安全与证据
已签署的请求
每次调用都会对方法、路径、时间戳、随机数和请求体哈希值进行 HMAC-SHA256 签名。拒绝重放攻击;密钥仅显示一次,绝不记录。
静态加密
HMRC令牌、增值税号、客户身份和已提交的数据在存储中都经过加密,而不仅仅是访问控制。
仅追加审计
每次状态变更、 HMRC来电和批准都会记录在一个永远不会被覆盖的账簿中,并附有电报发送的确切标题。
绝不盲目重试
超时不视为失败。对于不确定的提交内容,在进行任何更改之前,会先与HMRC的记录进行核对。
轮换机制实现了零停机时间:多个密钥可以同时处于活动状态,因此您可以颁发新的密钥对,部署它,并在没有新密钥对签名时撤销旧密钥对。
Webhooks、日志和开发者门户
申报流程本质上是异步的——需要人工审核, HMRC也需要回复。为了避免您频繁轮询,我们会在申报状态更新时(例如等待审核、已提交、失败等)向您的终端推送已签名的事件。每次推送都会使用您的 webhook 密钥进行 HMAC 签名,以便您验证其来源。
合作伙伴门户网站 api.gofile.co.uk 为你的团队带来:
- API密钥 — 发布沙盒和实时配对,查看上次使用情况,轮换和撤销。
- 请求日志 — 每个已签名的请求都会显示其状态、错误代码、模式、持续时间和请求 ID。签名失败的情况也会显示,这正是你在凌晨 2 点 HMAC 出错时所需要的。
- Webhook 交付 — 每个事件的状态、响应代码和重试计划。
- 用法 — 按日期、按方式统计请求和文件。
- 账单 — 发票、付款方式和您的计划。
定价
沙盒
自由的针对英国税务海关HMRC ) 的沙盒环境,您可以无限次提交测试申请。免费构建和运行您的集成测试。
平台
£150/月启用实时文件归档、Webhook、日志记录和技术支持。按月计费。
根据文件
£1.50每 成功的 实时增值税申报。提交失败不收取任何费用。所有其他 API 操作均免费。
价格不含增值税。申报费将计入您的下个月账单。不收取客户费,没有最低申报量限制,沙盒申报也免费——只有在正式申报提交至HMRC时,您才需要付费。
接下来会发生什么?
第一版是增值税 (VAT) 版本,因为增值税是MTD强制实施且交易量最大的领域。同样的模式——一次简单的电话沟通、一次托管审批、一份收据——旨在推广到英国其他合规申报领域。
MTD数字化税务申报)在所得税领域是自然而然的下一个应用方向,也是简化API价值最为显著的地方: HMRC自身的ITSA接口涵盖了大量的端点和形式,而我们计划将其简化为与Connect提供的增值税接口相同的简洁界面。如果您的路线图取决于特定的税种或时间表, 告诉我们 — 合作伙伴的需求决定订单。
开始使用
创建合作伙伴帐户
注册 api.gofile.co.uk您将立即获得沙盒密钥对——密钥只会显示一次。
反沙盒式开发
跟随 API 参考:检查客户,了解他们的立场,提交测试报表,并亲自完成托管审批流程。如果您需要一个可运行的示例,我们提供了一个用纯 PHP 编写的、无任何依赖项的参考客户端。
直播
订阅平台套餐,发放有效密钥,您的合作伙伴公司只需连接一次其代理服务账户即可。相同的代码,不同的凭证。