From 5bc201078b29389f76baec122a3a48c52900d524 Mon Sep 17 00:00:00 2001 From: Thepworth95 <56401451+Thepworth95@users.noreply.github.com> Date: Mon, 20 Mar 2023 16:17:10 +0000 Subject: [PATCH] remove RAML files --- .../public/api/conf/1.0/application.raml | 513 ------------------ .../public/api/conf/1.0/application.yaml | 318 ++++++++++- .../public/api/conf/1.0/docs/changeLog.md | 1 - .../public/api/conf/1.0/docs/overview.md | 11 - resources/public/api/conf/1.0/docs/support.md | 2 - resources/public/api/conf/1.0/docs/testing.md | 7 - .../1.0/examples/GetVatReturnDecimals.json | 12 - .../conf/1.0/examples/GetVatReturnHash.json | 12 - .../api/conf/1.0/examples/Liabilities.json | 12 - .../conf/1.0/examples/ObligationsMonthly.json | 20 - .../1.0/examples/ObligationsQuarterly.json | 19 - .../api/conf/1.0/examples/Payments.json | 6 - .../conf/1.0/examples/SubmitVatReturn.json | 13 - .../1.0/examples/SubmitVatReturnHash.json | 13 - .../1.0/examples/SubmitVatReturnResponse.json | 6 - .../examples/penalties/FinancialDetails.json | 41 -- .../1.0/examples/penalties/Penalties.json | 152 ------ .../1.0/examples/penalties/PenaltiesNone.json | 1 - .../vat-financial-details-scenarios.md | 15 - .../scenarios/vat-liabilities-scenarios.md | 36 -- .../1.0/scenarios/vat-obligation-scenarios.md | 90 --- .../1.0/scenarios/vat-payments-scenarios.md | 36 -- .../1.0/scenarios/vat-penalties-scenarios.md | 63 --- .../vat-retrieve-returns-scenarios.md | 20 - .../scenarios/vat-submit-returns-scenarios.md | 36 -- .../public/api/conf/1.0/schemas/FullDate.json | 8 - .../api/conf/1.0/schemas/GetVatReturn.json | 86 --- .../api/conf/1.0/schemas/Liabilities.json | 19 - .../api/conf/1.0/schemas/Liability.json | 50 -- .../api/conf/1.0/schemas/Obligation.json | 48 -- .../api/conf/1.0/schemas/Obligations.json | 19 - .../public/api/conf/1.0/schemas/Payment.json | 32 -- .../public/api/conf/1.0/schemas/Payments.json | 19 - .../api/conf/1.0/schemas/TaxPeriod.json | 23 - .../1.0/schemas/VatReturnDeclaration.json | 92 ---- .../conf/1.0/schemas/VatReturnResponse.json | 37 -- .../schemas/penalties/FinancialDetails.json | 171 ------ .../conf/1.0/schemas/penalties/Penalties.json | 486 ----------------- 38 files changed, 311 insertions(+), 2234 deletions(-) delete mode 100644 resources/public/api/conf/1.0/application.raml delete mode 100644 resources/public/api/conf/1.0/docs/changeLog.md delete mode 100644 resources/public/api/conf/1.0/docs/overview.md delete mode 100644 resources/public/api/conf/1.0/docs/support.md delete mode 100644 resources/public/api/conf/1.0/docs/testing.md delete mode 100644 resources/public/api/conf/1.0/examples/GetVatReturnDecimals.json delete mode 100644 resources/public/api/conf/1.0/examples/GetVatReturnHash.json delete mode 100644 resources/public/api/conf/1.0/examples/Liabilities.json delete mode 100644 resources/public/api/conf/1.0/examples/ObligationsMonthly.json delete mode 100644 resources/public/api/conf/1.0/examples/ObligationsQuarterly.json delete mode 100644 resources/public/api/conf/1.0/examples/Payments.json delete mode 100644 resources/public/api/conf/1.0/examples/SubmitVatReturn.json delete mode 100644 resources/public/api/conf/1.0/examples/SubmitVatReturnHash.json delete mode 100644 resources/public/api/conf/1.0/examples/SubmitVatReturnResponse.json delete mode 100644 resources/public/api/conf/1.0/examples/penalties/FinancialDetails.json delete mode 100644 resources/public/api/conf/1.0/examples/penalties/Penalties.json delete mode 100644 resources/public/api/conf/1.0/examples/penalties/PenaltiesNone.json delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-financial-details-scenarios.md delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-liabilities-scenarios.md delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-obligation-scenarios.md delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-payments-scenarios.md delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-penalties-scenarios.md delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-retrieve-returns-scenarios.md delete mode 100644 resources/public/api/conf/1.0/scenarios/vat-submit-returns-scenarios.md delete mode 100644 resources/public/api/conf/1.0/schemas/FullDate.json delete mode 100644 resources/public/api/conf/1.0/schemas/GetVatReturn.json delete mode 100644 resources/public/api/conf/1.0/schemas/Liabilities.json delete mode 100644 resources/public/api/conf/1.0/schemas/Liability.json delete mode 100644 resources/public/api/conf/1.0/schemas/Obligation.json delete mode 100644 resources/public/api/conf/1.0/schemas/Obligations.json delete mode 100644 resources/public/api/conf/1.0/schemas/Payment.json delete mode 100644 resources/public/api/conf/1.0/schemas/Payments.json delete mode 100644 resources/public/api/conf/1.0/schemas/TaxPeriod.json delete mode 100644 resources/public/api/conf/1.0/schemas/VatReturnDeclaration.json delete mode 100644 resources/public/api/conf/1.0/schemas/VatReturnResponse.json delete mode 100644 resources/public/api/conf/1.0/schemas/penalties/FinancialDetails.json delete mode 100644 resources/public/api/conf/1.0/schemas/penalties/Penalties.json diff --git a/resources/public/api/conf/1.0/application.raml b/resources/public/api/conf/1.0/application.raml deleted file mode 100644 index 8286816a..00000000 --- a/resources/public/api/conf/1.0/application.raml +++ /dev/null @@ -1,513 +0,0 @@ -#%RAML 1.0 ---- - -title: VAT (MTD) -description: Retrieve VAT obligations, liabilities and payments, view VAT returns and submit a VAT return for a given period. -version: 1.0 -protocols: [ HTTPS ] -baseUri: https://api.service.hmrc.gov.uk/ -mediaType: application/json - -uses: - sec: https://developer.service.hmrc.gov.uk/api-documentation/assets/common/modules/securitySchemes.raml - headers: https://developer.service.hmrc.gov.uk/api-documentation/assets/common/modules/headers.raml - annotations: https://developer.service.hmrc.gov.uk/api-documentation/assets/common/modules/annotations.raml - types: https://developer.service.hmrc.gov.uk/api-documentation/assets/common/modules/types.raml - - -documentation: - - title: Overview - content: !include docs/overview.md - - title: Send fraud prevention data - content: !include https://developer.service.hmrc.gov.uk/api-documentation/assets/common/docs/fraud-prevention.md - - title: Changelog - content: !include docs/changeLog.md - - title: Support - content: !include docs/support.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 - content: !include https://developer.service.hmrc.gov.uk/api-documentation/assets/common/docs/errors.md - - -traits: - contentType: - headers: - Content-Type: - description: Specifies the format of the request body, which must be JSON. - type: string - required: true - example: application/json - testScenarioHeader: - headers: - Gov-Test-Scenario: - description: Only in sandbox environment. See Test Data table for all header values. - type: string - required: false - example: '-' - clientOrAgentNotAuthorised: - responses: - 403: - body: - application/json: - type: types.errorResponse - examples: - clientNotSubscribedToMTD: - description: 'The client and/or agent is not authorised. This is normally because: the client is not subscribed to MTD, the agent is not subscribed to Agent Services, or the client has not authorised the agent to act on their behalf.' - value: - code: CLIENT_OR_AGENT_NOT_AUTHORISED - ruleInsolventTrader: - responses: - 403: - body: - application/json: - type: types.errorResponse - examples: - ruleInsolventTrader: - description: 'The request could not be completed as it relates to an insolvent trader, which are not supported by this API.' - value: - code: RULE_INSOLVENT_TRADER - -/organisations/vat: - /{vrn}: - uriParameters: - vrn: - description: VAT registration number.
A nine-digit number. - type: string - example: "123456789" - /obligations: - displayName: Retrieve VAT obligations - description: Retrieve VAT obligations - get: - displayName: Retrieve VAT obligations - description: Retrieve VAT obligations. This endpoint is one of the mandatory endpoints to use to achieve the minimum level of compliance. The other endpoint required to achieve the minimum level of compliance is [Submit VAT return for period](#_submit-vat-return-for-period_post_accordion). - (annotations.sandboxData): !include scenarios/vat-obligation-scenarios.md - is: [headers.acceptHeader, testScenarioHeader, clientOrAgentNotAuthorised, ruleInsolventTrader] - (annotations.scope): "read:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "read:vat" ] } ] - queryParameters: - from: - description: Date from which to return obligations. Mandatory unless the status is O. - type: string - example: 2017-01-25 - required: false - to: - description: Date to which to return obligations. Mandatory unless the status is O. - type: string - example: 2017-01-25 - required: false - status: - description: "Obligation status to return: O=Open, F= Fulfilled. Omit status to retrieve all obligations." - type: string - example: F - required: false - responses: - 200: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - body: - application/json: - type: !include schemas/Obligations.json - examples: - example-1: - description: Quarterly obligations; one fulfilled - value: !include examples/ObligationsQuarterly.json - example-2: - description: Monthly obligations; one fulfilled - value: !include examples/ObligationsMonthly.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: Invalid VRN - value: - code: VRN_INVALID - invalidDateFrom: - description: Invalid date from - value: - code: INVALID_DATE_FROM - invalidDateTo: - description: Invalid date to - value: - code: INVALID_DATE_TO - invalidDateRange: - description: Invalid date range, must be 366 days or less - value: - code: INVALID_DATE_RANGE - invalidStatus: - description: Invalid status - value: - code: INVALID_STATUS - 404: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: The remote endpoint has indicated that no associated data is found - value: - code: NOT_FOUND - /returns: - displayName: VAT Returns - description: Submit and read VAT returns - /{periodKey}: - uriParameters: - periodKey: - description: The ID code for the period that this obligation belongs to. The format is a string of four alphanumeric characters. Occasionally the format includes the "#" symbol, which must be URL-encoded. - type: string - example: "18AD, 18A1, #001" - get: - displayName: View VAT Return - description: Retrieve a submitted VAT return - (annotations.sandboxData): !include scenarios/vat-retrieve-returns-scenarios.md - is: [headers.acceptHeader, testScenarioHeader, clientOrAgentNotAuthorised, ruleInsolventTrader] - (annotations.scope): "read:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "read:vat" ] } ] - responses: - 200: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - body: - application/json: - type: !include schemas/GetVatReturn.json - examples: - example-1: - description: VAT Return with decimals - value: !include examples/GetVatReturnDecimals.json - example-2: - description: VAT Return with a hash in the periodKey - value: !include examples/GetVatReturnHash.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: The provided VRN is invalid - value: - code: VRN_INVALID - periodKeyInvalid: - description: Invalid period key - value: - code: PERIOD_KEY_INVALID - 403: - body: - application/json: - type: types.errorResponse - examples: - dateRangeTooLarge: - description: The date of the requested return cannot be more than four years from the current date - value: - code: DATE_RANGE_TOO_LARGE - 404: - body: - application/json: - type: types.errorResponse - examples: - notFound: - description: The remote endpoint has indicated that no associated data is found - value: - code: NOT_FOUND - post: - displayName: Submit VAT return for period - description: Submit VAT return for period. This endpoint is one of the mandatory endpoints to use to achieve the minimum level of compliance. The other endpoint required to achieve the minimum level of compliance is [Retrieve VAT obligations](#_retrieve-vat-obligations_get_accordion). - (annotations.sandboxData): !include scenarios/vat-submit-returns-scenarios.md - is: [headers.acceptHeader, contentType, testScenarioHeader, clientOrAgentNotAuthorised, ruleInsolventTrader] - (annotations.scope): "write:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "write:vat" ] } ] - body: - application/json: - type: !include schemas/VatReturnDeclaration.json - examples: - example-1: - description: VAT Return with decimals - value: !include examples/SubmitVatReturn.json - example-2: - description: VAT Return with a hash in the periodKey - value: !include examples/SubmitVatReturnHash.json - responses: - 201: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - Receipt-ID: - example: 2dd537bc-4244-4ebf-bac9-96321be13cdc - description: Unique reference number returned for a submission
String, 36 characters. - Receipt-Timestamp: - example: 2018-02-14T09:32:15Z - description: The timestamp from the signature, in ISO8601 format - Receipt-Signature: - example: DO NOT USE - description: This header is not currently used - body: - application/json: - type: !include schemas/VatReturnResponse.json - example: !include examples/SubmitVatReturnResponse.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidVrn: - description: Invalid VRN - value: - code: VRN_INVALID - invalidPeriodKey: - description: Invalid period key - value: - code: PERIOD_KEY_INVALID - invalidRequest: - description: Invalid request - value: - code: INVALID_REQUEST - invalidTotalValue: - description: totalVatDue should be equal to the sum of vatDueSales and vatDueAcquisitions - value: - code: VAT_TOTAL_VALUE - invalidNetValue: - description: netVatDue should be the difference between the largest and the smallest values among totalVatDue and vatReclaimedCurrPeriod - value: - code: VAT_NET_VALUE - invalidNumericValue: - description: Please provide a numeric field - value: - code: INVALID_NUMERIC_VALUE - invalidMonetaryAmount: - description: The monetary amount is invalid - value: - code: INVALID_MONETARY_AMOUNT - 403: - body: - application/json: - type: types.errorResponse - examples: - notDeclared: - description: User has not declared VAT return as final - value: - code: NOT_FINALISED - duplicateSubmission: - description: User has already submitted a VAT return for the given period - value: - code: DUPLICATE_SUBMISSION - submittedToEarly: - description: Return submitted too early - value: - code: TAX_PERIOD_NOT_ENDED - - /liabilities: - displayName: Retrieve VAT liabilities - description: Retrieve VAT liabilities - get: - displayName: Retrieve VAT liabilities - description: Retrieve VAT liabilities - (annotations.sandboxData): !include scenarios/vat-liabilities-scenarios.md - is: [headers.acceptHeader, testScenarioHeader, clientOrAgentNotAuthorised, ruleInsolventTrader] - (annotations.scope): "read:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "read:vat" ] } ] - queryParameters: - from: - description: Liabilities to return from date, the minimum 'from' date is 2017-12-01 - type: string - example: 2018-01-25 - required: true - to: - description: Liabilities to return up to date, the maximum 'to' date is the current date - type: string - example: 2018-12-31 - required: true - responses: - 200: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - body: - application/json: - type: !include schemas/Liabilities.json - example: !include examples/Liabilities.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: Invalid VRN - value: - code: VRN_INVALID - invalidDateFrom: - description: Invalid date from - value: - code: DATE_FROM_INVALID - invalidDateTo: - description: Invalid date to - value: - code: DATE_TO_INVALID - invalidDateRange: - description: Invalid date range, must be 365 days or less - value: - code: DATE_RANGE_INVALID - 404: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: The remote endpoint has indicated that no associated data is found - value: - code: NOT_FOUND - /payments: - displayName: Retrieve VAT payments - description: Retrieve VAT payments - get: - displayName: Retrieve VAT payments - description: Retrieve VAT payments - (annotations.sandboxData): !include scenarios/vat-payments-scenarios.md - is: [headers.acceptHeader, testScenarioHeader, clientOrAgentNotAuthorised, ruleInsolventTrader] - (annotations.scope): "read:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "read:vat" ] } ] - queryParameters: - from: - description: Payments to return from date, the minimum 'from' date is 2017-12-01 - type: string - example: 2018-01-25 - required: true - to: - description: Payments to return up to date, the maximum 'to' date is the current date - type: string - example: 2018-12-31 - required: true - responses: - 200: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - body: - application/json: - type: !include schemas/Payments.json - example: !include examples/Payments.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: Invalid VRN - value: - code: VRN_INVALID - invalidDateFrom: - description: Invalid date from - value: - code: DATE_FROM_INVALID - invalidDateTo: - description: Invalid date to - value: - code: DATE_TO_INVALID - invalidDateRange: - description: Invalid date range, must be 365 days or less - value: - code: DATE_RANGE_INVALID - 404: - body: - application/json: - type: types.errorResponse - examples: - invalidNino: - description: The remote endpoint has indicated that no associated data is found - value: - code: NOT_FOUND - /penalties: - displayName: Retrieve VAT penalties - description: Retrieves details of all the penalties that have been applied to a VAT account. Twenty-four months' worth of penalty information will be returned. - get: - displayName: Retrieve VAT penalties - description: Retrieves details of all the penalties that have been applied to a VAT account. Twenty-four months' worth of penalty information will be returned. - (annotations.sandboxData): !include scenarios/vat-penalties-scenarios.md - is: [headers.acceptHeader, testScenarioHeader, clientOrAgentNotAuthorised] - (annotations.scope): "read:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "read:vat" ] } ] - responses: - 200: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - body: - application/json: - type: !include schemas/penalties/Penalties.json - examples: - example-1: - description: Example of an account with no penalties - value: !include examples/penalties/PenaltiesNone.json - example-2: - description: All fields example - value: !include examples/penalties/Penalties.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidVrn: - description: Invalid VRN. - value: - code: VRN_INVALID - /financial-details: - /{penaltyChargeReference}: - uriParameters: - penaltyChargeReference: - description: The late submission or late payment penalty charge reference, which has been obtained from the Retrieve VAT penalties endpoint. Only the financial details that relate to this charge will be returned. - type: string - example: "XP123456789012" - displayName: Retrieve financial details - description: Retrieves the financial details relating to a late submission or late payment penalty that has been applied to a VAT account. - get: - displayName: Retrieve financial details - description: Retrieves the financial details relating to a late submission or late payment penalty that has been applied to a VAT account. - (annotations.sandboxData): !include scenarios/vat-financial-details-scenarios.md - is: [headers.acceptHeader, testScenarioHeader, clientOrAgentNotAuthorised] - (annotations.scope): "read:vat" - securedBy: [ sec.oauth_2_0: { scopes: [ "read:vat" ] } ] - responses: - 200: - headers: - X-CorrelationId: - example: c75f40a6-a3df-4429-a697-471eeec46435 - description: Unique id for operation tracking
String, 36 characters. - body: - application/json: - type: !include schemas/penalties/FinancialDetails.json - examples: - example-1: - description: all fields example - value: !include examples/penalties/FinancialDetails.json - 400: - body: - application/json: - type: types.errorResponse - examples: - invalidVrn: - description: Invalid VRN. - value: - code: VRN_INVALID - invalidChargeReference: - description: The specified penalty charge reference is invalid. - value: - code: CHARGE_REFERENCE_INVALID - 404: - body: - application/json: - type: types.errorResponse - examples: - notFound: - description: The remote endpoint has indicated that no associated data is found. - value: - code: MATCHING_RESOURCE_NOT_FOUND diff --git a/resources/public/api/conf/1.0/application.yaml b/resources/public/api/conf/1.0/application.yaml index b4c14d66..e6e30ccf 100644 --- a/resources/public/api/conf/1.0/application.yaml +++ b/resources/public/api/conf/1.0/application.yaml @@ -15,7 +15,100 @@ paths: tags: - organisations summary: Retrieve VAT obligations - description: Retrieve VAT obligations. This endpoint is one of the mandatory endpoints to use to achieve the minimum level of compliance. The other endpoint required to achieve the minimum level of compliance is [Submit VAT return for period](#_submit-vat-return-for-period_post_accordion). + description: | + Retrieve VAT obligations. This endpoint is one of the mandatory endpoints to use to achieve the minimum level of compliance. The other endpoint required to achieve the minimum level of compliance is [Submit VAT return for period](#_submit-vat-return-for-period_post_accordion). + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

Default (No header value)

Simulates the scenario where the client has quarterly obligations and one is fulfilled.

QUARTERLY_NONE_MET

Simulates the scenario where the client has quarterly obligations and none are fulfilled.

QUARTERLY_ONE_MET

Simulates the scenario where the client has quarterly obligations and one is fulfilled.

QUARTERLY_TWO_MET

Simulates the scenario where the client has quarterly obligations and two are fulfilled.

QUARTERLY_THREE_MET

Simulates the scenario where the client has quarterly obligations and three are fulfilled.

QUARTERLY_FOUR_MET

Simulates the scenario where the client has quarterly obligations and four are fulfilled.

MONTHLY_NONE_MET

Simulates the scenario where the client has monthly obligations and none are fulfilled.

MONTHLY_ONE_MET

Simulates the scenario where the client has monthly obligations and one month is fulfilled.

MONTHLY_TWO_MET

Simulates the scenario where the client has monthly obligations and two months are fulfilled.

MONTHLY_THREE_MET

Simulates the scenario where the client has monthly obligations and three months are fulfilled.

MONTHLY_OBS_##_OPEN

Simulates the scenario where the client has monthly obligations for 2018 and the ## month is open. All previous obligations for same year will show as fulfilled. Accepts 01 to 12.

+

Example: MONTHLY_OBS_03_OPEN.

MONTHLY_OBS_12_FULFILLED

Simulates the scenario where the client has monthly obligations for 2018 and all obligations are fulfilled.

QUARTERLY_OBS_##_OPEN

Simulates the scenario where the client has quarterly obligations for 2018 and the ## quarter is open. All previous obligations for same year will show as fulfilled. Accepts 01 to 04.

+

Example: QUARTERLY_OBS_02_OPEN.

QUARTERLY_OBS_04_FULFILLED

Simulates the scenario where the client has quarterly obligations for 2018 and all obligations are fulfilled.

MULTIPLE_OPEN_MONTHLY

Simulates the scenario where the client has monthly obligations for 2018 and two are open.

MULTIPLE_OPEN_QUARTERLY

Simulates the scenario where the client has quarterly obligations for 2018 and two are open.

OBS_SPANS_MULTIPLE_YEARS

Simulates the scenario where the client has an obligation that spans both calendar years 2018 and 2019.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

NOT_FOUND

Simulates the scenario where no data is found.

+ operationId: RetrieveVATobligations parameters: - name: vrn @@ -192,7 +285,46 @@ paths: tags: - organisations summary: Submit VAT return for period - description: Submit VAT return for period. This endpoint is one of the mandatory endpoints to use to achieve the minimum level of compliance. The other endpoint required to achieve the minimum level of compliance is [Retrieve VAT obligations](#_retrieve-vat-obligations_get_accordion). + description: | + Submit VAT return for period. This endpoint is one of the mandatory endpoints to use to achieve the minimum level of compliance. The other endpoint required to achieve the minimum level of compliance is [Retrieve VAT obligations](#_retrieve-vat-obligations_get_accordion). + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+

Using this endpoint in the sandbox environment will store the data submitted. There is no requirement to use the periodKeys in the obligation response in the sandbox environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

INVALID_VRN

Submission has not passed validation. Invalid parameter VRN.

INVALID_PERIODKEY

Submission has not passed validation. Invalid parameter PERIODKEY.

INVALID_PAYLOAD

Submission has not passed validation. Invalid parameter Payload.

DUPLICATE_SUBMISSION

The remote endpoint has indicated that VAT has already been submitted for that period.

TAX_PERIOD_NOT_ENDED

The remote endpoint has indicated that the submission is for a tax period that has not ended.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

operationId: SubmitVATreturnforperiod parameters: - name: vrn @@ -392,7 +524,30 @@ paths: tags: - organisations summary: View VAT Return - description: Retrieve a submitted VAT return + description: | + Retrieve a submitted VAT return + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+

Using this endpoint in the sandbox environment will return the previously submitted data. A 404 (Not Found) response will be returned for a periodKey that has not been submitted.

+ + + + + + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

DATE_RANGE_TOO_LARGE

The date of the requested return cannot be further than four years from the current date.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

operationId: ViewVATReturn parameters: - name: vrn @@ -539,7 +694,47 @@ paths: tags: - organisations summary: Retrieve VAT liabilities - description: Retrieve VAT liabilities + description: | + Retrieve VAT liabilities + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

Default (no header value)

Simulates the scenario where the endpoint has indicated that no associated data could be found.

SINGLE_LIABILITY

Returns a single valid liability when used with dates from 2017-01-02 and to 2017-02-02.

MULTIPLE_LIABILITIES

Returns multiple valid liabilities when used with dates from 2017-04-05 and to 2017-12-21.

SINGLE_LIABILITY_2018_19

Returns a single valid liability when used with dates from 2018-01-02 and to 2018-02-02.

MULTIPLE_LIABILITIES_2018_19

Returns multiple valid liabilities when used with dates from 2018-04-05 and to 2018-12-21.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

+

The 'to' date of the liability must fall within the date range provided.

+ operationId: RetrieveVATliabilities parameters: - name: vrn @@ -680,7 +875,47 @@ paths: tags: - organisations summary: Retrieve VAT payments - description: Retrieve VAT payments + description: | + Retrieve VAT payments + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

Default (no header value)

Simulates the scenario where the endpoint has indicated that no associated data could be found.

SINGLE_PAYMENT

Returns a single valid payment when used with dates from 2017-01-02 and to 2017-02-02.

MULTIPLE_PAYMENTS

Returns multiple valid payments when used with dates from 2017-02-27 and to 2017-12-21.

SINGLE_PAYMENT_2018_19

Returns a single valid payment when used with dates from 2018-01-02 and to 2018-02-02.

MULTIPLE_PAYMENTS_2018_19

Returns multiple valid payments when used with dates from 2018-02-27 and to 2018-12-21.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

+

The 'to' date of the payment must fall within the date range provided.

+ operationId: RetrieveVATpayments parameters: - name: vrn @@ -811,7 +1046,57 @@ paths: tags: - organisations summary: Retrieve VAT penalties - description: Retrieves details of all the penalties that have been applied to a VAT account. Twenty-four months' worth of penalty information will be returned. + description: | + Retrieves details of all the penalties that have been applied to a VAT account. Twenty-four months' worth of penalty information will be returned. + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

DEFAULT

The default scenario which has multiple penalties in the last 2 years.

NO_PENALTIES

The scenario where there are no penalties in the last 2 years.

LATE_SUBMISSION

The scenario where there is a single late submission penalty in the last 2 years.

LATE_PAYMENT

The scenario where there is a single late payment penalty in the last 2 years.

MULTIPLE_PENALTIES

The scenario where there is a single late submission penalty and a single late payment penalty in the last 2 years.

MULTIPLE_LATE_PAYMENT_PENALTIES

The scenario where there are multiple late payment penalties in the last 2 years.

MULTIPLE_LATE_SUBMISSION_PENALTIES

The scenario where there are multiple late submission penalties in the last 2 years.

THRESHOLD_LATE_SUBMISSION_PENALTIES

The scenario where the number of penalties meets the penalty point threshold and the first charge has been generated.

CHARGE_LATE_SUBMISSION_PENALTIES

The scenario where the number of penalties exceeds the penalty point threshold and a second charge has been generated.

operationId: RetrieveVATpenalties parameters: - name: vrn @@ -1007,7 +1292,26 @@ paths: tags: - organisations summary: Retrieve financial details - description: Retrieves the financial details relating to a late submission or late payment penalty that has been applied to a VAT account. + description: | + Retrieves the financial details relating to a late submission or late payment penalty that has been applied to a VAT account. + + ### Test data +

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

+ + + + + + + + + + + + + +
Header Value (Gov-Test-Scenario)Scenario

DEFAULT

The default scenario.

+ operationId: Retrievefinancialdetails parameters: - name: vrn diff --git a/resources/public/api/conf/1.0/docs/changeLog.md b/resources/public/api/conf/1.0/docs/changeLog.md deleted file mode 100644 index 4ef8ba99..00000000 --- a/resources/public/api/conf/1.0/docs/changeLog.md +++ /dev/null @@ -1 +0,0 @@ -You can find the changelog in the [vat-api](https://github.com/hmrc/vat-api/wiki/Changelog) GitHub wiki. \ No newline at end of file diff --git a/resources/public/api/conf/1.0/docs/overview.md b/resources/public/api/conf/1.0/docs/overview.md deleted file mode 100644 index 3c287d31..00000000 --- a/resources/public/api/conf/1.0/docs/overview.md +++ /dev/null @@ -1,11 +0,0 @@ -This API allows developers to: -* retrieve VAT obligations -* submit and view a VAT return -* retrieve a VAT liability -* retrieve a VAT payment -* retrieve VAT penalties -* retrieve financial details relating to a penalty - -For more background on the VAT API, see the [MTDfB VAT Guide for Vendors](https://usermanual.wiki/Document/mtdfbvatguideforvendors.996624737/view). - -For information on how to connect to this API [see the VAT MTD end-to-end service guide](https://developer.service.hmrc.gov.uk/guides/vat-mtd-end-to-end-service-guide/). diff --git a/resources/public/api/conf/1.0/docs/support.md b/resources/public/api/conf/1.0/docs/support.md deleted file mode 100644 index 7157a45b..00000000 --- a/resources/public/api/conf/1.0/docs/support.md +++ /dev/null @@ -1,2 +0,0 @@ -* For non-technical, fraud prevention, and platform-related issues, you need to contact the [Software Development Support Team (SDST)](https://developer.service.hmrc.gov.uk/developer/support). -* Raise technical issues on the [vat-api](https://github.com/hmrc/vat-api/issues) GitHub page. \ No newline at end of file diff --git a/resources/public/api/conf/1.0/docs/testing.md b/resources/public/api/conf/1.0/docs/testing.md deleted file mode 100644 index bcd0abca..00000000 --- a/resources/public/api/conf/1.0/docs/testing.md +++ /dev/null @@ -1,7 +0,0 @@ -You can use the sandbox environment to test this API. You can use the Create Test User API or it's frontend service to create test users. - -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 our support team. - -Some APIs may be marked \[test only\]. This means that they are not available for use in production and may change. \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/GetVatReturnDecimals.json b/resources/public/api/conf/1.0/examples/GetVatReturnDecimals.json deleted file mode 100644 index f31c4af5..00000000 --- a/resources/public/api/conf/1.0/examples/GetVatReturnDecimals.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "periodKey": "A001", - "vatDueSales": 105.5, - "vatDueAcquisitions": -100.45, - "totalVatDue": 5.05, - "vatReclaimedCurrPeriod": 105.15, - "netVatDue": 100.1, - "totalValueSalesExVAT": 300, - "totalValuePurchasesExVAT": 300, - "totalValueGoodsSuppliedExVAT": 3000, - "totalAcquisitionsExVAT": 3000 -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/GetVatReturnHash.json b/resources/public/api/conf/1.0/examples/GetVatReturnHash.json deleted file mode 100644 index cb5a05d9..00000000 --- a/resources/public/api/conf/1.0/examples/GetVatReturnHash.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "periodKey": "#001", - "vatDueSales": 100, - "vatDueAcquisitions": 100, - "totalVatDue": 200, - "vatReclaimedCurrPeriod": 100, - "netVatDue": 100, - "totalValueSalesExVAT": 500, - "totalValuePurchasesExVAT": 500, - "totalValueGoodsSuppliedExVAT": 500, - "totalAcquisitionsExVAT": 500 -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/Liabilities.json b/resources/public/api/conf/1.0/examples/Liabilities.json deleted file mode 100644 index ffda5658..00000000 --- a/resources/public/api/conf/1.0/examples/Liabilities.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "liabilities": [{ - "taxPeriod": { - "from": "2018-04-06", - "to": "2018-07-06" - }, - "type": "VAT ...", - "originalAmount": 6000.3, - "outstandingAmount": 100.51, - "due": "2018-07-06" - }] -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/ObligationsMonthly.json b/resources/public/api/conf/1.0/examples/ObligationsMonthly.json deleted file mode 100644 index cdccdbbe..00000000 --- a/resources/public/api/conf/1.0/examples/ObligationsMonthly.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "obligations": [ - { - "start": "2017-01-01", - "end": "2017-01-31", - "due": "2017-03-07", - "status": "F", - "periodKey": "18AD", - "received": "2017-03-06" - }, - { - "start": "2017-02-01", - "end": "2017-02-28", - "due": "2017-04-07", - "status": "O", - "periodKey": "18AE" - } - ] -} - diff --git a/resources/public/api/conf/1.0/examples/ObligationsQuarterly.json b/resources/public/api/conf/1.0/examples/ObligationsQuarterly.json deleted file mode 100644 index a7719e1f..00000000 --- a/resources/public/api/conf/1.0/examples/ObligationsQuarterly.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "obligations": [ - { - "start": "2017-01-01", - "end": "2017-03-31", - "due": "2017-05-07", - "status": "F", - "periodKey": "18A1", - "received": "2017-05-06" - }, - { - "start": "2017-04-01", - "end": "2017-06-30", - "due": "2017-08-07", - "status": "O", - "periodKey": "18A2" - } - ] -} diff --git a/resources/public/api/conf/1.0/examples/Payments.json b/resources/public/api/conf/1.0/examples/Payments.json deleted file mode 100644 index 900fbb1e..00000000 --- a/resources/public/api/conf/1.0/examples/Payments.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "payments": [{ - "amount": 100.05, - "received": "2018-04-06" - }] -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/SubmitVatReturn.json b/resources/public/api/conf/1.0/examples/SubmitVatReturn.json deleted file mode 100644 index 516dcadc..00000000 --- a/resources/public/api/conf/1.0/examples/SubmitVatReturn.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "periodKey": "A001", - "vatDueSales": 105.50, - "vatDueAcquisitions": -100.45, - "totalVatDue": 5.05, - "vatReclaimedCurrPeriod": 105.15, - "netVatDue": 100.10, - "totalValueSalesExVAT": 300, - "totalValuePurchasesExVAT": 300, - "totalValueGoodsSuppliedExVAT": 3000, - "totalAcquisitionsExVAT": 3000, - "finalised": true -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/SubmitVatReturnHash.json b/resources/public/api/conf/1.0/examples/SubmitVatReturnHash.json deleted file mode 100644 index a9a2b58b..00000000 --- a/resources/public/api/conf/1.0/examples/SubmitVatReturnHash.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "periodKey": "#001", - "vatDueSales": 100.00, - "vatDueAcquisitions": 100.00, - "totalVatDue": 200.00, - "vatReclaimedCurrPeriod": 100.00, - "netVatDue": 100.00, - "totalValueSalesExVAT": 500, - "totalValuePurchasesExVAT": 500, - "totalValueGoodsSuppliedExVAT": 500, - "totalAcquisitionsExVAT": 500, - "finalised": true -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/SubmitVatReturnResponse.json b/resources/public/api/conf/1.0/examples/SubmitVatReturnResponse.json deleted file mode 100644 index c4fcbeba..00000000 --- a/resources/public/api/conf/1.0/examples/SubmitVatReturnResponse.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "processingDate": "2018-01-16T08:20:27.895+0000", - "paymentIndicator": "BANK", - "formBundleNumber": "256660290587", - "chargeRefNumber": "aCxFaNx0FZsCvyWF" -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/examples/penalties/FinancialDetails.json b/resources/public/api/conf/1.0/examples/penalties/FinancialDetails.json deleted file mode 100644 index 2d457af0..00000000 --- a/resources/public/api/conf/1.0/examples/penalties/FinancialDetails.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "totalisations": { - "totalOverdue": 123.45, - "totalNotYetDue": 12.34, - "totalBalance": 12.45, - "totalCredit": 13.46, - "totalCleared": 12.35, - "additionalReceivableTotalisations" :{ - "totalAccountPostedInterest": 13.12, - "totalAccountAccruingInterest": 12.10 - } - }, - "documentDetails": [ - { - "postingDate": "2024-05-07", - "issueDate": "2024-05-07", - "documentTotalAmount": 123.45, - "documentClearedAmount": 111.11, - "documentOutstandingAmount": 12.34, - "documentInterestTotals": { - "interestPostedAmount": 13.12, - "interestAccruingAmount": 12.10 - }, - "lineItemDetails": [ - { - "chargeDescription": "VAT Return", - "periodFromDate": "2024-01-01", - "periodToDate": "2024-03-31", - "netDueDate": "2024-05-07", - "amount": 123.45, - "lineItemInterestDetails": { - "interestStartDate": "2024-05-08", - "currentInterestRate": 2, - "interestPostedAmount": 13.12, - "interestAccruingAmount": 12.10 - } - } - ] - } - ] -} diff --git a/resources/public/api/conf/1.0/examples/penalties/Penalties.json b/resources/public/api/conf/1.0/examples/penalties/Penalties.json deleted file mode 100644 index af78bfba..00000000 --- a/resources/public/api/conf/1.0/examples/penalties/Penalties.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "totalisations": { - "lateSubmissionPenaltyTotalValue": 400, - "penalisedPrincipalTotal": 10000, - "latePaymentPenaltyPostedTotal": 425.21, - "latePaymentPenaltyEstimateTotal": 30.68 - }, - "lateSubmissionPenalty": { - "summary": { - "activePenaltyPoints": 4, - "inactivePenaltyPoints": 1, - "periodOfComplianceAchievement": "2025-05-01", - "regimeThreshold": 4, - "penaltyChargeAmount": 400 - }, - "details": [ - { - "penaltyNumber": "00004", - "penaltyOrder": "4", - "penaltyCategory": "point", - "penaltyStatus": "inactive", - "frequencyAdjustmentPointIndicator": "X", - "penaltyCreationDate": "2023-11-08", - "penaltyExpiryDate": "2025-12-01", - "expiryReason": "appeal", - "communicationsDate": "2023-11-11", - "lateSubmissions": [ - { - "lateSubmissionID": "1054600", - "taxReturnStatus": "Fulfilled", - "taxPeriodStartDate": "2023-07-01", - "taxPeriodEndDate": "2023-09-30", - "taxPeriodDueDate": "2023-11-07", - "returnReceiptDate": "2023-11-13" - } - ], - "appealInformation": [ - { - "appealStatus": "appeal-upheld", - "appealLevel": "statutory-review" - } - ] - }, - { - "penaltyNumber": "00005", - "penaltyOrder": "5", - "penaltyCategory": "threshold", - "penaltyStatus": "active", - "penaltyCreationDate": "2024-02-08", - "penaltyExpiryDate": "2026-03-01", - "communicationsDate": "2024-02-11", - "lateSubmissions": [ - { - "lateSubmissionID": "1054700", - "taxReturnStatus": "Fulfilled", - "taxPeriodStartDate": "2023-10-01", - "taxPeriodEndDate": "2023-12-31", - "taxPeriodDueDate": "2024-02-07", - "returnReceiptDate": "2024-02-15" - - } - ], - "chargeReference": "XS198765432109", - "chargeAmount": 200, - "chargeOutstandingAmount": 200, - "chargeDueDate": "2024-02-28" - }, - { - "penaltyNumber": "00006", - "penaltyOrder": "6", - "penaltyCategory": "charge", - "penaltyStatus": "active", - "penaltyCreationDate": "2024-05-08", - "penaltyExpiryDate": "2026-06-01", - "communicationsDate": "2024-05-11", - "lateSubmissions": [ - { - "lateSubmissionID": "1054800", - "taxReturnStatus": "Fulfilled", - "taxPeriodStartDate": "2024-01-01", - "taxPeriodEndDate": "2024-03-31", - "taxPeriodDueDate": "2024-05-07", - "returnReceiptDate": "2024-11-12" - - } - ], - "chargeReference": "XS212345678901", - "chargeAmount": 200, - "chargeOutstandingAmount": 200, - "chargeDueDate": "2024-02-28" - } - ] - }, - "latePaymentPenalty": { - "details": [ - { - "principalChargeReference": "XV123451234512", - "penaltyCategory": "LPP1", - "penaltyStatus": "posted", - "penaltyAmountAccruing": 0, - "penaltyAmountPosted": 400, - "penaltyAmountPaid": 0, - "penaltyAmountOutstanding": 400, - "latePaymentPenalty1LowerRateCalculationAmount": 10000, - "latePaymentPenalty1LowerRatePercentage": 2, - "latePaymentPenalty1HigherRateCalculationAmount": 10000, - "latePaymentPenalty1HigherRatePercentage": 4, - "penaltyChargeCreationDate": "2024-06-06", - "communicationsDate": "2024-06-09", - "penaltyChargeReference": "XP123456789012", - "penaltyChargeDueDate": "2024-07-06", - "principalChargeDocNumber": "10023852", - "principalChargeBillingFrom": "2024-01-01", - "principalChargeBillingTo": "2024-03-31", - "principalChargeDueDate": "2024-05-07", - "principalChargeLatestClearing": "2024-07-31", - "timeToPay": [ - { - "timeToPayStartDate": "2024-07-06", - "timeToPayEndDate": "2024-07-11" - } - ], - "appealInformation": [ - { - "appealStatus": "appeal-rejected", - "appealLevel": "statutory-review" - } - ] - }, - { - "principalChargeReference": "XV123451234512", - "penaltyCategory": "LPP2", - "penaltyStatus": "accruing", - "penaltyAmountAccruing": 30.68, - "penaltyAmountPosted": 25.21, - "penaltyAmountPaid": 0, - "penaltyAmountOutstanding": 25.21, - "latePaymentPenalty2Days": "23", - "latePaymentPenalty2Percentage": 4, - "penaltyChargeCreationDate": "2024-07-01", - "communicationsDate": "2024-07-04", - "penaltyChargeReference": "XP298765432109", - "penaltyChargeDueDate": "2024-08-07", - "principalChargeDocNumber": "10023852", - "principalChargeBillingFrom": "2024-01-01", - "principalChargeBillingTo": "2024-03-31", - "principalChargeDueDate": "2024-05-07", - "principalChargeLatestClearing": "2024-07-31" - } - ] - } -} diff --git a/resources/public/api/conf/1.0/examples/penalties/PenaltiesNone.json b/resources/public/api/conf/1.0/examples/penalties/PenaltiesNone.json deleted file mode 100644 index 0967ef42..00000000 --- a/resources/public/api/conf/1.0/examples/penalties/PenaltiesNone.json +++ /dev/null @@ -1 +0,0 @@ -{} diff --git a/resources/public/api/conf/1.0/scenarios/vat-financial-details-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-financial-details-scenarios.md deleted file mode 100644 index cd71444b..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-financial-details-scenarios.md +++ /dev/null @@ -1,15 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

- - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

DEFAULT

The default scenario.

diff --git a/resources/public/api/conf/1.0/scenarios/vat-liabilities-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-liabilities-scenarios.md deleted file mode 100644 index 6501d1c6..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-liabilities-scenarios.md +++ /dev/null @@ -1,36 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

Default (no header value)

Simulates the scenario where the endpoint has indicated that no associated data could be found.

SINGLE_LIABILITY

Returns a single valid liability when used with dates from 2017-01-02 and to 2017-02-02.

MULTIPLE_LIABILITIES

Returns multiple valid liabilities when used with dates from 2017-04-05 and to 2017-12-21.

SINGLE_LIABILITY_2018_19

Returns a single valid liability when used with dates from 2018-01-02 and to 2018-02-02.

MULTIPLE_LIABILITIES_2018_19

Returns multiple valid liabilities when used with dates from 2018-04-05 and to 2018-12-21.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

-

The 'to' date of the liability must fall within the date range provided.

diff --git a/resources/public/api/conf/1.0/scenarios/vat-obligation-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-obligation-scenarios.md deleted file mode 100644 index 044fc737..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-obligation-scenarios.md +++ /dev/null @@ -1,90 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

Default (No header value)

Simulates the scenario where the client has quarterly obligations and one is fulfilled.

QUARTERLY_NONE_MET

Simulates the scenario where the client has quarterly obligations and none are fulfilled.

QUARTERLY_ONE_MET

Simulates the scenario where the client has quarterly obligations and one is fulfilled.

QUARTERLY_TWO_MET

Simulates the scenario where the client has quarterly obligations and two are fulfilled.

QUARTERLY_THREE_MET

Simulates the scenario where the client has quarterly obligations and three are fulfilled.

QUARTERLY_FOUR_MET

Simulates the scenario where the client has quarterly obligations and four are fulfilled.

MONTHLY_NONE_MET

Simulates the scenario where the client has monthly obligations and none are fulfilled.

MONTHLY_ONE_MET

Simulates the scenario where the client has monthly obligations and one month is fulfilled.

MONTHLY_TWO_MET

Simulates the scenario where the client has monthly obligations and two months are fulfilled.

MONTHLY_THREE_MET

Simulates the scenario where the client has monthly obligations and three months are fulfilled.

MONTHLY_OBS_##_OPEN

Simulates the scenario where the client has monthly obligations for 2018 and the ## month is open. All previous obligations for same year will show as fulfilled. Accepts 01 to 12. - Example: MONTHLY_OBS_03_OPEN.

MONTHLY_OBS_12_FULFILLED

Simulates the scenario where the client has monthly obligations for 2018 and all obligations are fulfilled.

QUARTERLY_OBS_##_OPEN

Simulates the scenario where the client has quarterly obligations for 2018 and the ## quarter is open. All previous obligations for same year will show as fulfilled. Accepts 01 to 04. - Example: QUARTERLY_OBS_02_OPEN.

QUARTERLY_OBS_04_FULFILLED

Simulates the scenario where the client has quarterly obligations for 2018 and all obligations are fulfilled.

MULTIPLE_OPEN_MONTHLY

Simulates the scenario where the client has monthly obligations for 2018 and two are open.

MULTIPLE_OPEN_QUARTERLY

Simulates the scenario where the client has quarterly obligations for 2018 and two are open.

OBS_SPANS_MULTIPLE_YEARS

Simulates the scenario where the client has an obligation that spans both calendar years 2018 and 2019.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

NOT_FOUND

Simulates the scenario where no data is found.

diff --git a/resources/public/api/conf/1.0/scenarios/vat-payments-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-payments-scenarios.md deleted file mode 100644 index 8b44c8f9..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-payments-scenarios.md +++ /dev/null @@ -1,36 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

Default (no header value)

Simulates the scenario where the endpoint has indicated that no associated data could be found.

SINGLE_PAYMENT

Returns a single valid payment when used with dates from 2017-01-02 and to 2017-02-02.

MULTIPLE_PAYMENTS

Returns multiple valid payments when used with dates from 2017-02-27 and to 2017-12-21.

SINGLE_PAYMENT_2018_19

Returns a single valid payment when used with dates from 2018-01-02 and to 2018-02-02.

MULTIPLE_PAYMENTS_2018_19

Returns multiple valid payments when used with dates from 2018-02-27 and to 2018-12-21.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

-

The 'to' date of the payment must fall within the date range provided.

diff --git a/resources/public/api/conf/1.0/scenarios/vat-penalties-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-penalties-scenarios.md deleted file mode 100644 index ca5a4c8b..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-penalties-scenarios.md +++ /dev/null @@ -1,63 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

DEFAULT

The default scenario which has multiple penalties in the last 2 years.

NO_PENALTIES

The scenario where there are no penalties in the last 2 years.

LATE_SUBMISSION

The scenario where there is a single late submission penalty in the last 2 years.

LATE_PAYMENT

The scenario where there is a single late payment penalty in the last 2 years.

MULTIPLE_PENALTIES

The scenario where there is a single late submission penalty and a single late payment penalty in the last 2 years.

MULTIPLE_LATE_PAYMENT_PENALTIES

The scenario where there are multiple late payment penalties in the last 2 years.

MULTIPLE_LATE_SUBMISSION_PENALTIES

The scenario where there are multiple late submission penalties in the last 2 years.

THRESHOLD_LATE_SUBMISSION_PENALTIES

The scenario where the number of penalties meets the penalty point threshold and the first charge has been generated.

CHARGE_LATE_SUBMISSION_PENALTIES

The scenario where the number of penalties exceeds the penalty point threshold and a second charge has been generated.

diff --git a/resources/public/api/conf/1.0/scenarios/vat-retrieve-returns-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-retrieve-returns-scenarios.md deleted file mode 100644 index 41d19458..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-retrieve-returns-scenarios.md +++ /dev/null @@ -1,20 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

-

Using this endpoint in the sandbox environment will return the previously submitted data. A 404 (Not Found) response will be returned for a periodKey that has not been submitted.

- - - - - - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

DATE_RANGE_TOO_LARGE

The date of the requested return cannot be further than four years from the current date.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

\ No newline at end of file diff --git a/resources/public/api/conf/1.0/scenarios/vat-submit-returns-scenarios.md b/resources/public/api/conf/1.0/scenarios/vat-submit-returns-scenarios.md deleted file mode 100644 index 88a85137..00000000 --- a/resources/public/api/conf/1.0/scenarios/vat-submit-returns-scenarios.md +++ /dev/null @@ -1,36 +0,0 @@ -

Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.

-

Using this endpoint in the sandbox environment will store the data submitted. There is no requirement to use the periodKeys in the obligation response in the sandbox environment.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Header Value (Gov-Test-Scenario)Scenario

INVALID_VRN

Submission has not passed validation. Invalid parameter VRN.

INVALID_PERIODKEY

Submission has not passed validation. Invalid parameter PERIODKEY.

INVALID_PAYLOAD

Submission has not passed validation. Invalid parameter Payload.

DUPLICATE_SUBMISSION

The remote endpoint has indicated that VAT has already been submitted for that period.

TAX_PERIOD_NOT_ENDED

The remote endpoint has indicated that the submission is for a tax period that has not ended.

INSOLVENT_TRADER

Simulates the scenario where the client is an insolvent trader.

\ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/FullDate.json b/resources/public/api/conf/1.0/schemas/FullDate.json deleted file mode 100644 index 6888f6fe..00000000 --- a/resources/public/api/conf/1.0/schemas/FullDate.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "id": "full-date", - "description": "Date in the format YYYY-MM-DD", - "type": "string", - "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", - "example": "2017-01-25" -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/GetVatReturn.json b/resources/public/api/conf/1.0/schemas/GetVatReturn.json deleted file mode 100644 index 803b853a..00000000 --- a/resources/public/api/conf/1.0/schemas/GetVatReturn.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Submit VAT", - "description": "Submit VAT", - "type": "object", - "properties": { - "periodKey": { - "description": "The ID code for the period that this obligation belongs to. The format is a string of four alphanumeric characters. Occasionally the format includes the # symbol.", - "type": "string", - "minLength": 4, - "maxLength": 4, - "example": "18AD, 18A1, #001" - }, - "vatDueSales": { - "description": "VAT due on sales and other outputs. This corresponds to box 1 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "vatDueAcquisitions": { - "description": "VAT due in the period on acquisitions of goods made in Northern Ireland from EU Member States. This corresponds to box 2 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "totalVatDue": { - "description": "Total VAT due (the sum of vatDueSales and vatDueAcquisitions). This corresponds to box 3 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "vatReclaimedCurrPeriod": { - "description": "VAT reclaimed in the period on purchases and other inputs (including acquisitions in Northern Ireland from EU member states). This corresponds to box 4 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "netVatDue": { - "description": "The difference between totalVatDue and vatReclaimedCurrPeriod. This corresponds to box 5 on the VAT Return form. The value must be between 0.00 and 99999999999.99", - "$ref": "#/definitions/monetaryPos11" - }, - "totalValueSalesExVAT": { - "description": "Total value of sales and all other outputs excluding any VAT. This corresponds to box 6 on the VAT Return form. The value must be between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "totalValuePurchasesExVAT": { - "description": "Total value of purchases and all other inputs excluding any VAT (including exempt purchases). This corresponds to box 7 on the VAT Return form. The value must be between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "totalValueGoodsSuppliedExVAT": { - "description": "Total value of dispatches of goods and related costs (excluding VAT) from Northern Ireland to EU Member States. This corresponds to box 8 on the VAT Return form. The value must be in pounds (no pence) between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "totalAcquisitionsExVAT": { - "description": "Total value of acquisitions of goods and related costs (excluding VAT) made in Northern Ireland from EU Member States. This corresponds to box 9 on the VAT Return form. The value must be in pounds (no pence) between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - } - }, - "required": [ - "periodKey", - "vatDueSales", - "vatDueAcquisitions", - "totalVatDue", - "vatReclaimedCurrPeriod", - "netVatDue", - "totalValueSalesExVAT", - "totalValuePurchasesExVAT", - "totalValueGoodsSuppliedExVAT", - "totalAcquisitionsExVAT" - ], - "definitions": { - "monetaryPos11": { - "description": "Defines a monetary value (to 2 decimal places), between 0 and 99,999,999,999.99", - "type": "number", - "minimum": 0.0, - "maximum": 99999999999.99, - "multipleOf": 0.01 - }, - "monetaryPosNeg13": { - "description": "Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "type": "number", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "monetaryPosNegZeroDec13": { - "description": "Defines a monetary value (to 2 zeroed decimal places), between -9,999,999,999,999.00 and 9,999,999,999,999.00", - "type": "number", - "minimum": -9999999999999.00, - "maximum": 9999999999999.00 - } - }, - "additionalProperties": false -} diff --git a/resources/public/api/conf/1.0/schemas/Liabilities.json b/resources/public/api/conf/1.0/schemas/Liabilities.json deleted file mode 100644 index f5a7e8fd..00000000 --- a/resources/public/api/conf/1.0/schemas/Liabilities.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Liabilities", - "type": "object", - "properties": { - "liabilities": { - "title": "Liabilities", - "description": "A list of all liabilities", - "type": "array", - "items": { - "$ref": "Liability.json" - } - } - }, - "required": [ - "liabilities" - ], - "additionalProperties": false -} diff --git a/resources/public/api/conf/1.0/schemas/Liability.json b/resources/public/api/conf/1.0/schemas/Liability.json deleted file mode 100644 index 421ef029..00000000 --- a/resources/public/api/conf/1.0/schemas/Liability.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Liability", - "description": "Liability", - "type": "object", - "properties": { - "taxPeriod": { - "title": "Tax Period", - "description": "The tax period", - "$ref": "TaxPeriod.json" - }, - "type": { - "title": "Charge Type", - "description": "The charge type of this liability. Max length, 30 characters.", - "type": "string", - "example": "VAT ..." - }, - "originalAmount": { - "title": "Original Amount", - "description": "The original liability value. Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "$ref": "#/definitions/monetaryPosNeg13", - "example": "6000.00" - }, - "outstandingAmount": { - "title": "Outstanding Amount", - "description": "The outstanding liability value. Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "$ref": "#/definitions/monetaryPosNeg13", - "example": "100.00" - }, - "due": { - "title": "Due", - "description": "Liability due date", - "$ref": "FullDate.json" - } - }, - "required": [ - "type", - "originalAmount" - ], - "definitions": { - "monetaryPosNeg13": { - "description": "Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "type": "number", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - } - }, - "additionalProperties": false -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/Obligation.json b/resources/public/api/conf/1.0/schemas/Obligation.json deleted file mode 100644 index f0ef239e..00000000 --- a/resources/public/api/conf/1.0/schemas/Obligation.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Obligation", - "description": "Obligation", - "type": "object", - "properties": { - "start": { - "title": "Start date", - "description": "The start date of this obligation period", - "$ref": "FullDate.json" - }, - "end": { - "title": "End date", - "description": "The end date of this obligation period", - "$ref": "FullDate.json" - }, - "due": { - "title": "Due date", - "description": "The due date for this obligation period, in the format YYYY-MM-DD. For example: 2017-01-25. The due date for monthly/quarterly obligations is one month and seven days from the end date. The due date for Payment On Account customers is the last working day of the month after the end date. For example if the end date is 2018-02-28, the due date is 2018-03-29 (because the 31 March is a Saturday and the 30 March is Good Friday).", - "type" : "string" - }, - "status": { - "title": "Status", - "description": "Which obligation statuses to return (O = Open, F = Fulfilled)", - "type": "string", - "example": "F" - }, - "received": { - "title": "Received Date", - "description": "The obligation received date, is returned when status is (F = Fulfilled)", - "$ref": "FullDate.json" - }, - "periodKey": { - "title": "Period Key", - "description": "The ID code for the period that this obligation belongs to. The format is a string of four alphanumeric characters. Occasionally the format includes the # symbol.", - "type": "string", - "example": "18AD, 18A1, #001" - } - }, - "required": [ - "start", - "end", - "due", - "status", - "periodKey" - ], - "additionalProperties": false -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/Obligations.json b/resources/public/api/conf/1.0/schemas/Obligations.json deleted file mode 100644 index fae1dba8..00000000 --- a/resources/public/api/conf/1.0/schemas/Obligations.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Obligations", - "type": "object", - "properties": { - "obligations": { - "title": "Obligations", - "description": "A list of all obligations, sorted by start date", - "type": "array", - "items": { - "$ref": "Obligation.json" - } - } - }, - "required": [ - "obligations" - ], - "additionalProperties": false -} diff --git a/resources/public/api/conf/1.0/schemas/Payment.json b/resources/public/api/conf/1.0/schemas/Payment.json deleted file mode 100644 index 56c1e1ab..00000000 --- a/resources/public/api/conf/1.0/schemas/Payment.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Payment", - "description": "Payment", - "type": "object", - "properties": { - "amount": { - "title": "Payment Amount", - "description": "The payment value. Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "$ref": "#/definitions/monetaryPosNeg13", - "example": "100.00" - }, - "received": { - "title": "Received Date", - "description": "Payment received date", - "$ref": "FullDate.json" - } - }, - "required": [ - "amount" - ], - "definitions": { - "monetaryPosNeg13": { - "description": "Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "type": "number", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - } - }, - "additionalProperties": false -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/Payments.json b/resources/public/api/conf/1.0/schemas/Payments.json deleted file mode 100644 index e30f32cb..00000000 --- a/resources/public/api/conf/1.0/schemas/Payments.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Payments", - "type": "object", - "properties": { - "payments": { - "title": "Payments", - "description": "A list of all payments", - "type": "array", - "items": { - "$ref": "Payment.json" - } - } - }, - "required": [ - "payments" - ], - "additionalProperties": false -} diff --git a/resources/public/api/conf/1.0/schemas/TaxPeriod.json b/resources/public/api/conf/1.0/schemas/TaxPeriod.json deleted file mode 100644 index 0ab9f3bc..00000000 --- a/resources/public/api/conf/1.0/schemas/TaxPeriod.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Tax Period", - "description": "Tax Period", - "type": "object", - "properties": { - "from": { - "title": "From date", - "description": "The from date of this tax period", - "$ref": "FullDate.json" - }, - "to": { - "title": "To date", - "description": "The to date of this tax period", - "$ref": "FullDate.json" - } - }, - "required": [ - "from", - "to" - ], - "additionalProperties": false -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/VatReturnDeclaration.json b/resources/public/api/conf/1.0/schemas/VatReturnDeclaration.json deleted file mode 100644 index 46830b98..00000000 --- a/resources/public/api/conf/1.0/schemas/VatReturnDeclaration.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "VAT Return Declaration", - "description": "VAT Return Declaration", - "type": "object", - "properties": { - "periodKey": { - "description": "The ID code for the period that this obligation belongs to. The format is a string of four alphanumeric characters. Occasionally the format includes the # symbol.", - "type": "string", - "minLength": 4, - "maxLength": 4, - "example": "18AD, 18A1, #001" - }, - "vatDueSales": { - "description": "VAT due on sales and other outputs. This corresponds to box 1 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "vatDueAcquisitions": { - "description": "VAT due in the period on acquisitions of goods made in Northern Ireland from EU Member States. This corresponds to box 2 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "totalVatDue": { - "description": "Total VAT due (the sum of vatDueSales and vatDueAcquisitions). This corresponds to box 3 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "vatReclaimedCurrPeriod": { - "description": "VAT reclaimed in the period on purchases and other inputs (including acquisitions in Northern Ireland from EU member states). This corresponds to box 4 on the VAT Return form. The value must be between -9999999999999.99 and 9999999999999.99.", - "$ref": "#/definitions/monetaryPosNeg13" - }, - "netVatDue": { - "description": "The difference between totalVatDue and vatReclaimedCurrPeriod. This corresponds to box 5 on the VAT Return form. The value must be between 0.00 and 99999999999.99", - "$ref": "#/definitions/monetaryPos11" - }, - "totalValueSalesExVAT": { - "description": "Total value of sales and all other outputs excluding any VAT. This corresponds to box 6 on the VAT Return form. The value must be in pounds (no pence) between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "totalValuePurchasesExVAT": { - "description": "Total value of purchases and all other inputs excluding any VAT (including exempt purchases). This corresponds to box 7 on the VAT Return form. The value must be in pounds (no pence) between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "totalValueGoodsSuppliedExVAT": { - "description": "Total value of dispatches of goods and related costs (excluding VAT) from Northern Ireland to EU Member States. This corresponds to box 8 on the VAT Return form. The value must be in pounds (no pence) between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "totalAcquisitionsExVAT": { - "description": "Total value of acquisitions of goods and related costs (excluding VAT) made in Northern Ireland from EU Member States. This corresponds to box 9 on the VAT Return form. The value must be in pounds (no pence) between -9999999999999 and 9999999999999.", - "$ref": "#/definitions/monetaryPosNegZeroDec13" - }, - "finalised": { - "description": "Declaration that the user has finalised their VAT return.", - "type": "boolean", - "example": "true" - } - }, - "required": [ - "periodKey", - "vatDueSales", - "vatDueAcquisitions", - "totalVatDue", - "vatReclaimedCurrPeriod", - "netVatDue", - "totalValueSalesExVAT", - "totalValuePurchasesExVAT", - "totalValueGoodsSuppliedExVAT", - "totalAcquisitionsExVAT", - "finalised" - ], - "definitions": { - "monetaryPos11": { - "description": "Defines a monetary value (to 2 decimal places), between 0 and 99,999,999,999.99", - "type": "number", - "minimum": 0.0, - "maximum": 99999999999.99, - "multipleOf": 0.01 - }, - "monetaryPosNeg13": { - "description": "Defines a monetary value (to 2 decimal places), between -9,999,999,999,999.99 and 9,999,999,999,999.99", - "type": "number", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "monetaryPosNegZeroDec13": { - "description": "Defines a monetary value (to 2 zeroed decimal places), between -9,999,999,999,999.00 and 9,999,999,999,999.00", - "type": "number", - "minimum": -9999999999999.00, - "maximum": 9999999999999.00 - } - }, - "additionalProperties": false -} diff --git a/resources/public/api/conf/1.0/schemas/VatReturnResponse.json b/resources/public/api/conf/1.0/schemas/VatReturnResponse.json deleted file mode 100644 index a769e14d..00000000 --- a/resources/public/api/conf/1.0/schemas/VatReturnResponse.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "MTDFB - API 56 v1.0 Submit 9-Box Vat Return - Success response", - "description": "Submit 9-Box Vat Return - Success response", - "type": "object", - "required": [ - "processingDate", - "formBundleNumber" - ], - "properties": { - "processingDate": { - "description": "The time that the message was processed in the system.", - "type": "string", - "format": "date-time" - }, - "formBundleNumber": { - "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": "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": "The charge reference number is returned, only if the netVatDue value is a debit. Between 1 and 16 characters.", - "type": "string", - "minLength": 1, - "maxLength": 16 - } - }, - "additionalProperties": false -} \ No newline at end of file diff --git a/resources/public/api/conf/1.0/schemas/penalties/FinancialDetails.json b/resources/public/api/conf/1.0/schemas/penalties/FinancialDetails.json deleted file mode 100644 index ddaba1a0..00000000 --- a/resources/public/api/conf/1.0/schemas/penalties/FinancialDetails.json +++ /dev/null @@ -1,171 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "FinancialDetails", - "type": "object", - "properties": { - "totalisations": { - "description": "Totals that relate to the charge.", - "type": "object", - "properties": { - "totalOverdue": { - "description": "The charge amount that is overdue (collectable now). The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "totalNotYetDue": { - "description": "The charge amount that has been posted to the account, but is not yet overdue. The due date is today or in the future. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "totalBalance": { - "description": "The net charge amount (the amount that is overdue, minus any credit that is in the account). The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "totalCredit": { - "description": "Credit that is in the individual's or organisation's account, which has not yet been allocated to any charges. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "totalCleared": { - "description": "The amount that has been paid, reversed, removed or cleared. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "additionalReceivableTotalisations" : { - "description": "Interest totals that relate to the VAT account.", - "type": "object", - "properties": { - "totalAccountPostedInterest": { - "description": "The total amount of interest that HMRC has actually posted to the account.", - "type": "number", - "example": "200.00" - }, - "totalAccountAccruingInterest": { - "description": "The total amount of unposted interest that the account has currently accrued.", - "type": "number", - "example": "45.35" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "documentDetails": { - "description": "All the documents that relate to the charge. An individual document will only relate to one charge reference, but there could be multiple documents relating to that charge reference. For example, this might be the case if a charge has been levied and subsequently reversed, or if multiple periodic interest charges share the same charge reference.", - "type": "array", - "items": { - "type": "object", - "properties": { - "postingDate": { - "description": "The date that the charge was posted to the individual's or organisation's account.", - "type": "string", - "example": "2022-08-16" - }, - "issueDate": { - "description": "The date that correspondence about the charge was sent to the individual or organisation.", - "type": "string", - "example": "2022-08-16" - }, - "documentInterestTotals": { - "description": "Interest totals that relate to the charge.", - "type": "object", - "properties": { - "interestPostedAmount": { - "description": "The amount of interest, relating to the charge, that HMRC has actually posted to the account.", - "type": "number", - "example": "13.12" - }, - "interestAccruingAmount": { - "description": "The amount of unposted interest that has currently accrued on the charge.", - "type": "number", - "example": "12.10" - } - }, - "additionalProperties": false - }, - "documentTotalAmount": { - "description": "The total sum of the line items within the document. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "documentClearedAmount": { - "description": "The amount that has been paid, reversed, removed or cleared. For example, this could be the portion of a charge that has already been paid. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "documentOutstandingAmount": { - "description": "The remaining balance. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "lineItemDetails": { - "description": "The line items that make up the document. A document can contain more than one line item. For example, an individual or organisation might submit an amendment form that contains multiple corrections (perhaps the individual or organisation paid too much VAT for one tax period, but not enough for the next). Each correction will comprise an individual line item. HMRC will take all of the line items into account when it calculates the charge.", - "type": "array", - "items": { - "type": "object", - "properties": { - "chargeDescription": { - "description": "Describes what the charge relates to.", - "type": "string", - "example": "VAT Return" - }, - "periodFromDate": { - "description": "The start date of this period.", - "type": "string", - "example": "2022-08-16" - }, - "periodToDate": { - "description": "The end date of this period.", - "type": "string", - "example": "2022-08-16" - }, - "netDueDate": { - "description": "The due date for payment.", - "type": "string", - "example": "2022-08-16" - }, - "amount": { - "description": "The amount. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.", - "type": "number", - "example": "5009.99" - }, - "lineItemInterestDetails": { - "description": "Details of the interest that relates to the line item.", - "type": "object", - "properties": { - "interestStartDate": { - "description": "The date that the interest charges started.", - "type": "string", - "example": "2022-08-16" - }, - "currentInterestRate": { - "description": "The rate of interest that currently applies to the line item.", - "type": "number", - "example": "2.00" - }, - "interestPostedAmount": { - "description": "The amount of interest, relating to the line item, that HMRC has actually posted to the account. Interest will continue to be posted at the end of each month, until the customer pays the charge upon which the interest is based. At this point, a final interest charge will be calculated and posted.", - "type": "number", - "example": "13.12" - }, - "interestAccruingAmount": { - "description": "The amount of unposted interest that has accrued on the line item to date, since the interest start date.", - "type": "number", - "example": "12.10" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - } - } - }, - "additionalProperties": false - } - } - }, - "additionalProperties": false -} diff --git a/resources/public/api/conf/1.0/schemas/penalties/Penalties.json b/resources/public/api/conf/1.0/schemas/penalties/Penalties.json deleted file mode 100644 index 056e338b..00000000 --- a/resources/public/api/conf/1.0/schemas/penalties/Penalties.json +++ /dev/null @@ -1,486 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Penalties", - "type": "object", - "properties": { - "totalisations": { - "description": "Totals that relate to the penalties that HMRC has levied.", - "type": "object", - "properties": { - "lateSubmissionPenaltyTotalValue": { - "description": "Total value of all unpaid late submission penalties. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "200", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "penalisedPrincipalTotal": { - "description": "Total amount of late VAT (before penalties and interest). The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "4286.55", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "latePaymentPenaltyPostedTotal": { - "description": "Total amount of late payment penalty charges. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "171.46", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "latePaymentPenaltyEstimateTotal": { - "description": "Estimated total amount of uncharged late payment penalties, based upon the amount that is accruing. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "171.46", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - } - }, - "additionalProperties": false - }, - "lateSubmissionPenalty": { - "description": "Information about the late submission penalties that HMRC has levied.", - "type": "object", - "properties": { - "summary": { - "description": "A summary of the individual's or organisation's late submission penalty status.", - "type": "object", - "properties": { - "activePenaltyPoints": { - "description": "Number of active penalty points held for failure to submit on time.", - "type": "number", - "example": "1", - "minimum": 0, - "multipleOf": 1 - }, - "inactivePenaltyPoints": { - "description": "Number of inactive penalty points.", - "type": "number", - "example": "4", - "minimum": 0, - "multipleOf": 1 - }, - "periodOfComplianceAchievement": { - "description": "The date upon which all accrued penalty points will expire, if the individual or organisation meets the requirements for compliance.", - "type": "string", - "example": "2023-04-01" - }, - "regimeThreshold": { - "description": "Total number of penalty points that are required before a financial penalty will be generated.", - "type": "number", - "example": "6", - "minimum": 0, - "multipleOf": 1 - }, - "penaltyChargeAmount": { - "description": "The total late submission penalty charge amount. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "400", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - } - }, - "required": [ - "activePenaltyPoints", - "inactivePenaltyPoints", - "periodOfComplianceAchievement", - "regimeThreshold", - "penaltyChargeAmount" - ], - "additionalProperties": false - }, - "details": { - "description": "Details of each late submission penalty that the individual or organisation has accrued.", - "type": "array", - "items": { - "type": "object", - "properties": { - "penaltyNumber": { - "description": "The unique identification number for the penalty.", - "type": "string", - "example": "12345678901234" - }, - "penaltyOrder": { - "description": "The position that the penalty currently occupies within the individual's or organisation's point balance.", - "type": "string", - "example": "01" - }, - "penaltyCategory": { - "description": "The category of the penalty.", - "type": "string", - "example": "point", - "oneOf": [ - { "enum": ["point"], "description": "The penalty represents a point that has not met the threshold for a charge." }, - { "enum": ["charge"], "description": "The penalty represents a charge that has been levied because the point threshold has been exceeded. Although this penalty will not be added to the point total because the threshold has already been met, it will affect the period of compliance." }, - { "enum": ["threshold"], "description": "The penalty represents a point that has met the threshold for a charge. The penalty thus consists of a point and a charge." } - ] - }, - "penaltyStatus": { - "description": "The status of the penalty. Its meaning depends upon the penalty's category.", - "type": "string", - "example": "active", - "oneOf": [ - { "enum": ["active"], "description": "If the penalty category is 'point', it counts towards the individual's or organisation's point balance. If the penalty category is 'threshold', it counts towards the individual's or organisation's point balance. It has also triggered a penalty charge. If the penalty category is 'charge', then it represents a charge that has been levied because the threshold has been exceeded." }, - { "enum": ["inactive"], "description": "If the penalty category is 'point', it no longer counts towards the individual's or organisation's point balance. This might be because the point has expired, been successfully appealed against, or been removed due to an adjustment. If the penalty category is 'threshold', then it no longer counts towards the individual's or organisation's point balance for the same reasons. Alternatively, a 'threshold' penalty could be inactive because the charge that is associated with it has been reversed. If the penalty category is 'charge', then the charge has been reversed." } - ] - }, - "frequencyAdjustmentPointIndicator": { - "description": "Indicates whether there has been an adjustment to the penalty point because of a change to your submission frequency (for example, changing from quarterly submissions to monthly submissions).", - "type": "string", - "example": "X", - "enum": ["X"] - }, - "penaltyCreationDate": { - "description": "The date that the penalty point was created.", - "type": "string", - "example": "2022-07-01" - }, - "penaltyExpiryDate": { - "description": "The date that the penalty point will expire. If the penalty falls within the points threshold, it will expire once compliance is met.", - "type": "string", - "example": "2024-07-01" - }, - "expiryReason": { - "description": "The reason why a penalty point has expired.", - "type": "string", - "example": "appeal", - "oneOf": [ - { "enum": ["appeal"], "description": "The penalty point has expired due to a successful appeal." }, - { "enum": ["submission-frequency-change"], "description": "The penalty point has expired due to a change in the user's submission frequency." }, - { "enum": ["obligations-reversed"], "description": "A change has resulted in the user's obligations being reversed. For example, a user might have deregistered for VAT before a submission was due." }, - { "enum": ["HMRC-removed"], "description": "An HMRC officer has removed the penalty. This might happen, for example, following a decision made by a tribunal." }, - { "enum": ["natural-expiry"], "description": "The penalty point has expired naturally. For example, it has reached the end of its 24-month lifetime." }, - { "enum": ["penalty-removed"], "description": "The penalty has been removed because the submission was deemed to be on time." }, - { "enum": ["expiry-conditions-met"], "description": "The penalty point has expired because the user has met the conditions for the expiry of all active penalty points." }, - { "enum": ["HMRC-reset"], "description": "An HMRC officer has reset the user's penalty points to zero." } - ] - }, - "communicationsDate": { - "description": "The date when a letter about the penalty was sent to the customer.", - "type": "string", - "example": "2022-07-01" - }, - "lateSubmissions": { - "description": "The late submissions that relate to the period for which the penalty was levied. Note that although only one penalty point will be levied for late submissions of a particular type of obligation during a calendar month, more than one late submission of that type could be made during the month. In that case, the lateSubmissions array will contain more than one object. All of these late submissions are incorporated within the single penalty point and affect the period of compliance and expiry date (which will be set by the date of the most recent failure).", - "type": "array", - "items": { - "type": "object", - "properties": { - "lateSubmissionID": { - "description": "The unique identification number for the late submission penalty.", - "type": "string", - "example": "001" - }, - "taxReturnStatus": { - "description": "The status of the tax return.", - "type": "string", - "example": "Open", - "oneOf": [ - { "enum": ["Open"], "description": "The VAT return is yet to be submitted." }, - { "enum": ["Fulfilled"], "description": "The obligation has been met (whether the submission was late or not)." }, - { "enum": ["Reversed"], "description": "The obligation no longer exists. The individual or organisation is therefore not required to submit any information." } - ] - }, - "taxPeriodStartDate": { - "description": "Start date of the VAT period to which the penalty relates.", - "type": "string", - "example": "2022-04-01" - }, - "taxPeriodEndDate": { - "description": "End date of the VAT period to which the penalty relates.", - "type": "string", - "example": "2022-06-30" - }, - "taxPeriodDueDate": { - "description": "The due date for the VAT return, which was missed and gave rise to the late submission penalty.", - "type": "string", - "example": "2022-07-07" - }, - "returnReceiptDate": { - "description": "The date upon which the VAT return was submitted.", - "type": "string", - "example": "2022-07-15" - } - }, - "required": ["lateSubmissionID", "taxReturnStatus"], - "additionalProperties": false - }, - "additionalProperties": false - }, - "appealInformation":{ - "description": "Details of any appeals that the individual or organisation has made against the penalty point.", - "type": "array", - "items": { - "type": "object", - "properties": { - "appealStatus": { - "description": "The appeal status of a penalty.", - "type": "string", - "example": "under-appeal", - "enum": ["under-appeal", "appeal-upheld", "appeal-rejected", "cannot-be-appealed"] - }, - "appealLevel": { - "description": "The level of appeal.", - "type": "string", - "example": "statutory-review", - "enum": ["statutory-review", "appeal-first-tier-tribunal"] - } - }, - "required": ["appealStatus", "appealLevel"], - "additionalProperties": false - } - }, - "chargeReference": { - "description": "The late submission penalty charge reference.", - "type": "string", - "example": "XS198765432109" - }, - "chargeAmount": { - "description": "The late submission penalty charge amount. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "200", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "chargeOutstandingAmount": { - "description": "The penalty charge amount that remains to be paid. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "103.12", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "chargeDueDate": { - "description": "The due date for the late submission penalty charge (this will be a maximum of 30 days after the submission was originally due).", - "type": "string", - "example": "2022-07-31" - } - }, - "required": ["penaltyNumber", "penaltyOrder", "penaltyCategory", "penaltyStatus", "penaltyCreationDate", "penaltyExpiryDate"], - "additionalProperties": false - } - } - }, - "required": ["summary", "details"], - "additionalProperties": false - }, - "latePaymentPenalty": { - "description": "Information about the late payment penalties that HMRC has levied.", - "type": "object", - "properties": { - "details": { - "description": "Details of all the late payment penalties that the individual or organisation has accrued.", - "type": "array", - "items": { - "type": "object", - "properties": { - "principalChargeReference": { - "description": "The reference for the principal charge upon which the late payment penalty is based. This is the original charge that was not paid on time (typically the VAT return charge reference).", - "type": "string", - "example": "XV123451234512" - }, - "penaltyCategory": { - "description": "The category of the penalty. This specifies whether the penalty is a first late payment penalty (LPP1) or a second late payment penalty (LPP2).", - "type": "string", - "example": "LPP1" - }, - "penaltyStatus": { - "description": "The status of the penalty.", - "type": "string", - "example": "accruing", - "oneOf": [ - { "enum": ["accruing"], "description": "The penalty is accruing, and is yet to be posted to the account." }, - { "enum": ["posted"], "description": "The penalty has been posted to the account." } - ] - }, - "penaltyAmountAccruing": { - "description": "The unposted penalty amount that is accruing. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "400", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "penaltyAmountPosted": { - "description": "The penalty amount that has been posted to the account. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "400", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "penaltyAmountPaid": { - "description": "The penalty amount that has already been paid. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "100", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "penaltyAmountOutstanding": { - "description": "The remaining penalty amount to be paid. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "300", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "latePaymentPenalty1LowerRateCalculationAmount": { - "description": "The amount of VAT that remained unpaid 16 days after the due date. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "3605.50", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "latePaymentPenalty1LowerRatePercentage": { - "description": "The percentage used to calculate the lower-rate part of the first late payment penalty.", - "type": "number", - "example": "2", - "minimum": -99.99, - "maximum": 99.99, - "multipleOf": 0.01 - }, - "latePaymentPenalty1HigherRateCalculationAmount": { - "description": "The amount of VAT that remained unpaid 31 days after the due date. The value must be between -99999999999.99 and 99999999999.99 up to 2 decimal places.", - "type": "number", - "example": "10000", - "minimum": -9999999999999.99, - "maximum": 9999999999999.99, - "multipleOf": 0.01 - }, - "latePaymentPenalty1HigherRatePercentage": { - "description": "The percentage used to calculate the higher-rate part of the first late payment penalty.", - "type": "number", - "example": "2", - "minimum": -99.99, - "maximum": 99.99, - "multipleOf": 0.01 - }, - "latePaymentPenalty2Days": { - "description": "The number of days over which the second late payment penalty has accrued. This is the number of days that have elapsed since day 31 after the VAT payment due date.", - "type": "string", - "example": "14" - }, - "latePaymentPenalty2Percentage": { - "description": "The percentage rate that has been applied to unpaid VAT in order to calculate the second late payment penalty.", - "type": "number", - "example": "2", - "minimum": -99.99, - "maximum": 99.99, - "multipleOf": 0.01 - }, - "penaltyChargeCreationDate": { - "description": "The date when the penalty charge was created.", - "type": "string", - "example": "2022-07-08" - }, - "communicationsDate": { - "description": "The date when a letter about the penalty was sent to the customer.", - "type": "string", - "example": "2022-07-09" - }, - "penaltyChargeReference": { - "description": "The late payment penalty charge reference.", - "type": "string", - "example": "XP123456789012" - }, - "penaltyChargeDueDate": { - "description": "The date that the penalty must be paid by.", - "type": "string", - "example": "2022-07-31" - }, - "appealInformation":{ - "description": "", - "type": "array", - "items": { - "type": "object", - "properties": { - "appealStatus": { - "description": "The appeal status of a penalty.", - "type": "string", - "example": "under appeal", - "enum": ["under-appeal", "appeal-upheld", "appeal-rejected", "cannot-be-appealed"] - }, - "appealLevel": { - "description": "The level of appeal.", - "type": "string", - "example": "appeal to HMRC", - "enum": ["statutory-review", "appeal-first-tier-tribunal"] - } - }, - "required": ["appealStatus", "appealLevel"], - "additionalProperties": false - } - }, - "principalChargeDocNumber": { - "description": "Document number relating to the VAT charge.", - "type": "string", - "example": "123456789012" - }, - "principalChargeBillingFrom": { - "description": "The start date of the obligation period.", - "type": "string", - "example": "2024-01-01" - }, - "principalChargeBillingTo": { - "description": "The end date of the obligation period.", - "type": "string", - "example": "2024-03-31" - }, - "principalChargeDueDate": { - "description": "The date that the principal charge should have been paid by.", - "type": "string", - "example": "2024-05-07" - }, - "principalChargeLatestClearing": { - "description": "The date that the principal charge was paid.", - "type": "string", - "example": "2024-07-31" - }, - "timeToPay": { - "description": "Details of the Time to Pay arrangement that has been made.", - "type": "array", - "items": { - "type": "object", - "properties": { - "timeToPayStartDate": { - "description": "This is the start date of the agreed time to pay the charge.", - "type": "string", - "example": "2024-07-06" - }, - "timeToPayEndDate": { - "description": "This is the last date of the agreed time to pay the charge.", - "type": "string", - "example": "2024-07-11" - } - } - } - } - }, - "required": [ - "principalChargeReference", - "penaltyCategory", - "penaltyStatus", - "penaltyAmountAccruing", - "penaltyAmountPosted", - "principalChargeDocNumber", - "principalChargeBillingFrom", - "principalChargeBillingTo", - "principalChargeDueDate" - ], - "additionalProperties": false - } - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false -}