obligationDetails.md

Get Obligation Details

Returns the Obligation Details (including those not Open).

Calls to this API must be made by an authenticated and authorised user with an ADR enrolment in order for the data to be returned.

URL: /alcohol-duty-returns/obligationDetails/:appaId

Method: GET

URL Params

Parameter Name	Type	Description	Notes
appaId	String	The appa Id

Required Request Headers:

Header Name	Header Value	Description
Authorization	Bearer {TOKEN}	A valid bearer token from the auth service

Example request:

/alcohol-duty-returns/obligationDetails/AP0000000001

Responses

Success response

Code: 200 OK

Response Body

The response body returns an array of obligations (each containing the following fields)

If NOT_FOUND is returned by the downstream API, an empty array is returned.

Field Name	Description	Data Type	Mandatory/Optional	Notes
status	The current obligation status	Enum	Mandatory	Open, Fulfilled
fromDate	The date from which the period applies	Date	Mandatory	YYYY-MM-DD
toDate	The date to which the period applies	Date	Mandatory	YYYY-MM-DD
dueDate	The date the return is due to be filed and paid by	Date	Mandatory	YYYY-MM-DD
periodKey	The period key of the obligation	String	Mandatory	YYAM (year, 'A', month A-L)

Response Body Examples

Two obligations returned, one open, one fulfilled:

[
  {
    "status": "Open",
    "fromDate": "2024-08-01",
    "toDate": "2024-08-31",
    "dueDate": "2024-09-10",
    "periodKey": "24AH"
  },
  {
    "status": "Fulfilled",
    "fromDate": "2024-05-01",
    "toDate": "2024-05-31",
    "dueDate": "2024-06-15",
    "periodKey": "24AE"
  }
]

No obligation details found:

[]

Responses

Code: 401 UNAUTHORIZED This response can occur when a call is made by any consumer without an authorized session that has an ADR enrolment.

Code: 404 NOT_FOUND This response can occur if the downstream call to accounts does not return OK