#GoFile API Cysylltu

Beth yw'r API Cysylltu

Porth cydymffurfio ar gyfer ffeilio trethi yn y DU: mae eich meddalwedd yn galw un pwynt terfynol gyda chleient a'u ffigurau, ac # GoFile yn trin popeth rhwng yr alwad honno a derbynneb HMRC .

Nid yw Gwneud Treth yn Ddigidol yn API anodd i'w alw unwaith. Mae'n API anodd i'w eich hunCydnabyddiaeth, grantiau OAuth sy'n dod i ben ar ôl 18 mis, penawdau atal twyll y mae'n rhaid iddynt ddisgrifio'r ddyfais wreiddiol wirioneddol, paru rhwymedigaethau, allweddi cyfnod na ddylech byth eu dyfeisio, anhyblygedd cyflwyno, a llwybr archwilio sy'n sefyll flynyddoedd yn ddiweddarach - dyna'r gwaith, ac nid yw byth yn dod i ben.

Yr API Connect yw'r gwaith hwnnw, a wneir ac a gynhelir, y tu ôl i arwyneb REST bach. Mae Fersiwn 1 yn cwmpasu TAW: gwirio bod cleient wedi'i awdurdodi, darllen ei sefyllfa TAW lawn, ffeilio ffurflen dreth, a'i dilyn hyd at dderbynneb.

Ar gyfer pwy y mae

Mae'r API wedi'i gynllunio ar gyfer model asiant: mae eich cwmni partner yn cysylltu ei HMRC cyfrif gwasanaethau asiant unwaith, ac mae'r awdurdodiad sengl hwnnw'n cwmpasu pob cleient y mae wedi'i awdurdodi i weithredu ar ei ran.

Sut mae'n gweithio

Mae pob cais yn alwad REST wedi'i llofnodi. Mae popeth sy'n gofyn am berson yn ôl y gyfraith yn digwydd ar dudalen rydyn ni'n ei chynnal.

GET /api/v1/vat/193054661/status

{
  "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 */ ]
  }
}

{
  "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 */
  }
}

{
  "id": "vfs_...",
  "status": "submitted",
  "receipt": {
    "gofile_reference": "GF-VAT-123",
    "form_bundle": "258868935084"
  }
}

Y cymeradwyaeth a gynhelir — a pham ei bod yn bwysig

Nid dim ond ffurflen dreth y mae HMRC eisiau; mae eisiau gwybod bod y ffurflen dreth wedi dod gan berson go iawn ar ddyfais go iawn, a bod bod dynol wedi cymryd cyfrifoldeb am y datganiad. Dyna bwrpas penawdau atal twyll, ac mae eu cael yn anghywir yn broblem cydymffurfio, nid yn nam.

Felly nid yw'r API Connect byth yn gofyn i'ch meddalwedd eu ffugio. Pan fyddwch chi'n postio ffeilio rydym yn dychwelyd URL i dudalen. rydym yn cynnalAr y dudalen honno mae'r person awdurdodedig yn mewngofnodi gyda dilysiad dau ffactor, caiff ei ddyfais wirioneddol ei chipio, caiff y ffurflen dreth ei harddangos yn llawn, ac maen nhw'n cadarnhau'r datganiad. Dim ond wedyn y byddwn ni'n ffonio HMRC — gyda phenawdau wedi'u hadeiladu o'r union ddyfais honno, wedi'u cipio ochr yn ochr â'r cyflwyniad fel tystiolaeth.

Mae'r dudalen yn cludo'ch cleient drwy'r cysylltiad untro HMRC hefyd. Pan fydd cwmni'n ffeilio am y tro cyntaf, mae'n awdurdodi ei gyfrif gwasanaethau asiant yno ac yn dod yn syth yn ôl i'r ffeilio.

Yr hyn nad oes rhaid i chi ei adeiladu

Ni ofynnir i chi byth am allwedd cyfnod nac a finalised baner — mae'r API yn eu gwrthod yn llwyr, oherwydd ein rhai ni yw penderfynu arnynt a'u cael yn anghywir yw sut mae ffeilio gwael yn digwydd.

Blwch tywod a byw

Dewisir moddau gan yr allwedd rydych chi'n llofnodi â hi, felly does dim switsh byd-eang i'w droi a dim byd i'w anghofio mewn defnydd:

• gfk_sandbox_… ffeil allweddi i amgylchedd prawf HMRC . Am ddim, diderfyn, a diogel i'w redeg yn CI.
• gfk_live_… allweddi ffeilio ffurflenni go iawn.

Mae'r ddau yn gweithio ar yr un pryd. Gall eich cyfres brawf gyrraedd y blwch tywod tra bod ffeiliau cynhyrchu yn fyw, ac mae newid rhyngddynt yn dibynnu ar ba gymhwyster rydych chi'n llofnodi ag ef. Caiff defnydd, logiau ceisiadau a therfynau dyddiol eu holrhain ar wahân fesul modd.

Diogelwch a thystiolaeth

Cylchdroi yw sero amser segur: gall sawl allwedd fod yn weithredol ar unwaith, felly rydych chi'n cyhoeddi'r pâr newydd, yn ei ddefnyddio, ac yn dirymu'r hen un unwaith nad oes dim yn llofnodi ag ef.

Webhooks, logiau a'r porth datblygwyr

Mae ffeilio yn anghydamserol o ran natur — mae'n rhaid i fod dynol gymeradwyo, ac mae'n rhaid i HMRC ateb. Yn hytrach na gwneud i chi bleidleisio, rydym yn gwthio digwyddiadau wedi'u llofnodi i'ch pwynt terfyn wrth i ffeilio symud: yn aros am gymeradwyaeth, wedi'i gyflwyno, wedi methu, a mwy. Mae pob danfoniad wedi'i lofnodi gan HMAC gyda'ch cyfrinach webhook fel y gallwch wirio ei fod wedi dod gennym ni.

Y porth partner yn api.gofile.co.uk yn rhoi i'ch tîm:

• Allweddi API — cyhoeddi parau blwch tywod a byw, gweld y defnydd diwethaf, cylchdroi a dirymu.
• Logiau ceisiadau — pob cais wedi'i lofnodi gyda'i statws, cod gwall, modd, hyd ac ID cais. Mae methiannau llofnod yn ymddangos hefyd, sef yn union yr hyn sydd ei angen arnoch pan fyddwch chi'n cael HMAC yn anghywir am 2am.
• Dosbarthiadau Webhook — statws, cod ymateb ac amserlen ail-geisio fesul digwyddiad.
• Defnydd — ceisiadau a ffeilio wedi'u siartio yn ôl dydd, wedi'u rhannu yn ôl modd.
• Bilio — anfonebau, dulliau talu a'ch cynllun.

Prisio

Nid yw prisiau'n cynnwys TAW. Mae ffioedd ffeilio yn cael eu hychwanegu at eich anfoneb fisol nesaf. Dim ffioedd fesul cleient, dim cyfaint gofynnol, a dim tâl am ffeilio blwch tywod — dim ond pan fydd ffurflen dreth wirioneddol yn cyrraedd HMRC y byddwch yn talu.

Beth nesaf

Fersiwn 1 yw TAW, oherwydd dyna lle mae MTD yn orfodol a lle mae'r gyfaint ar ei uchaf. Mae'r un model — un alwad lân, cymeradwyaeth wedi'i chynnal, derbynneb — wedi'i gynllunio i ymestyn i weddill ffeilio cydymffurfiaeth y DU.

MTD ar gyfer Treth Incwm yw'r arwyneb naturiol nesaf, a dyma lle mae gwerth API symlach ar ei fwyaf: mae rhyngwyneb ITSA HMRC ei hun yn cwmpasu nifer fawr o bwyntiau terfyn a siapiau, ac rydym yn bwriadu cwympo hynny i'r un arwyneb rhesymegol y mae Connect yn ei roi i chi ar gyfer TAW. Os yw eich map ffordd yn dibynnu ar dreth neu amserlen benodol, dywedwch wrthym — mae galw'r partner yn penderfynu'r drefn.

Dechrau arni