Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions docs/reports-v1/get-invoice-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Get Invoice Status

Get the payment status for a PDC report invoice.

```HTTP
GET {baseUrl}/v1/rosters/{customerKey}/reports/{reportId}/invoice
```

## URI Parameters

| Name | In | Required | Type | Description |
| - | - | - | - | - |
| baseUrl | path | Yes | string | The API URL. |
| customerKey | path | Yes | string | The customer key or `me`. |
| reportId | path | Yes | integer (format: int64) | ID of the report. |

## Responses

| Name | Type | Description |
| - | - | - |
| 200 OK | boolean | Success |
| 204 No Content | | Report not available. |
| 400 Bad Request | [ProblemDetails](../definitions/problem-details.md) | Report ID is invalid. |
| 404 Not Found | | Report not found. |

## Security

### Scopes

- `pdc.member_read`

## Examples

### Get Invoice Status

#### Sample Request

```HTTP
GET /v1/rosters/me/reports/3182769/invoice
```

#### Sample Response

Status code: 200

```json
{
"isPaid": true
}
```

### Get Invoice Status With an Incorrect Report ID

#### Sample Request

```HTTP
GET /v1/rosters/me/reports/3182760/invoice
```

#### Sample Response

Status code: 204 (No Content)
12 changes: 12 additions & 0 deletions docs/reports-v1/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Reports

URL: `/v1/rosters/{customerKey}/reports` \
API Version: `1.0`

This endpoint provides access to report data.

## Operations

| Operation | Description |
| - | - |
| [Get Invoice Status](get-invoice-status.md) | Get the status for a PDC report invoice. |
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Are you migrating from the legacy PDC web service? If so then refer to the [Migr

| Version | Date | Release Notes |
| - | - | - |
| 1.2 | | Added Invoice Status endpoint |
| 1.1 | 16 Feb 2023 | Added PDC data |
| 1.0 | 18 Aug 2022 | Initial version |

Expand All @@ -34,3 +35,4 @@ Are you migrating from the legacy PDC web service? If so then refer to the [Migr

- [Members](docs/members-v1/readme.md)
- [Search](docs/search-v1/readme.md)
- [Reports](docs/reports-v1/readme.md)