Skip to content

Commit

Permalink
MTDSA-1480 added new testing section and modified Submit Vat Return r…
Browse files Browse the repository at this point in the history
…esponse RAML (#144)
  • Loading branch information
jonathanleather authored and MarkAKelly committed May 3, 2018
1 parent 682faa6 commit e4da66b
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 14 deletions.
4 changes: 2 additions & 2 deletions public/api/conf/1.0/application.raml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ documentation:
content: !include docs/context.md
- title: Technical support
content: !include docs/technicalSupport.md
- title: Sandbox
content: !include docs/sandbox.md
- title: Testing
content: !include docs/testing.md
- title: Versioning
content: !include https://developer.service.hmrc.gov.uk/api-documentation/assets/common/docs/versioning.md
- title: Errors
Expand Down
8 changes: 0 additions & 8 deletions public/api/conf/1.0/docs/sandbox.md

This file was deleted.

6 changes: 6 additions & 0 deletions public/api/conf/1.0/docs/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
You can use the sandbox environment to <a href="/api-documentation/docs/testing">test this API</a>.

It may not be possible to test all scenarios in the sandbox. You can test some scenarios by passing the Gov-Test-Scenario header. Documentation for each endpoint includes a **Test data** section, which explains the scenarios that you can simulate using the Gov-Test-Scenario header.

If you have a specific testing need that is not supported in the sandbox, contact <a href="/developer/support">our support team</a>.

8 changes: 4 additions & 4 deletions public/api/conf/1.0/schemas/VatReturnResponse.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@
],
"properties": {
"processingDate": {
"description": "Time stamp for when message was processed in the system",
"description": "The time that the message was processed in the system.",
"type": "string",
"format": "date-time"
},
"formBundleNumber": {
"description": "Unique number representing Form Bundle, the system creates forms to store return data, those are held in form bundle that is unique within the system",
"description": "Unique number that represents the form bundle. The system stores VAT Return data in forms, which are held in a unique form bundle.",
"type": "string",
"pattern": "^[0-9]{12}$"
},
"paymentIndicator": {
"description": "Can be either DD or BANK or not present at all, when return is a debit i.e. Trader has to pay and Direct Debit is set up for such trader we would return DD, when return is a claim i.e. credit where HMRC will pay out and bank details are present on master data then BANK indicator is sent, for NIL returns, or where bank / DD data does not exist nothing will be sent",
"description": "Is DD if the netVatDue value is a debit and HMRC holds a Direct Debit Instruction for the client. Is BANK if the netVatDue value is a credit and HMRC holds the client’s bank data. Otherwise not present.",
"type": "string",
"enum": [
"DD",
"BANK"
]
},
"chargeRefNumber": {
"description": "Represents charge reference number, this number is only derived in case where charge is a debit, intention was to pass it to back end so that trader can make payment against this number, however I believe that business does not want to disturb current status quo where traders use VRN to pay",
"description": "The charge reference number is returned, only if the netVatDue value is a debit.",
"type": "string",
"minLength": 1,
"maxLength": 16
Expand Down

0 comments on commit e4da66b

Please sign in to comment.