From 41ee27b0bbf79ec6af8a3b21841b28fb5c443cd9 Mon Sep 17 00:00:00 2001 From: bmorrill1 Date: Fri, 15 May 2026 13:50:01 -0500 Subject: [PATCH 1/5] Add Get Invoice Status endpoint --- docs/reports-v1/get-invoice-status.md | 62 +++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/reports-v1/get-invoice-status.md diff --git a/docs/reports-v1/get-invoice-status.md b/docs/reports-v1/get-invoice-status.md new file mode 100644 index 0000000..7b20286 --- /dev/null +++ b/docs/reports-v1/get-invoice-status.md @@ -0,0 +1,62 @@ +# Get Invoice Status + +Get the payment status for a PDC report invoice. + +```HTTP +GET {baseUrl}/v1/rosters/{customerKey}/reports/{reportId} +``` + +## 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 +``` + +#### Sample Response + +Status code: 200 + +```json +{ + "isPaid": true +} +``` + +### Get a Report With an Invalid Report ID + +#### Sample Request + +```HTTP +GET /v1/rosters/me/reports/3182760 +``` + +#### Sample Response + +Status code: 204 (No Content) From 9d08de48ec512d1c63e29b318399f330ecffde91 Mon Sep 17 00:00:00 2001 From: bmorrill1 Date: Fri, 15 May 2026 14:00:34 -0500 Subject: [PATCH 2/5] Update README with new Invoice Status endpoint --- readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/readme.md b/readme.md index ec475f7..d86a5f2 100644 --- a/readme.md +++ b/readme.md @@ -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 | @@ -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) From bcf7160b9a694ffbe860f0921ea57d3801d32663 Mon Sep 17 00:00:00 2001 From: bmorrill1 Date: Fri, 15 May 2026 14:04:17 -0500 Subject: [PATCH 3/5] Create readme for reports API --- docs/reports-v1/readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/reports-v1/readme.md diff --git a/docs/reports-v1/readme.md b/docs/reports-v1/readme.md new file mode 100644 index 0000000..4c195b4 --- /dev/null +++ b/docs/reports-v1/readme.md @@ -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. | From 6a792a41a91e26628a954a90f32f1362f4b355ee Mon Sep 17 00:00:00 2001 From: bmorrill1 Date: Fri, 15 May 2026 14:17:02 -0500 Subject: [PATCH 4/5] Update text for example request --- docs/reports-v1/get-invoice-status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reports-v1/get-invoice-status.md b/docs/reports-v1/get-invoice-status.md index 7b20286..1ecf000 100644 --- a/docs/reports-v1/get-invoice-status.md +++ b/docs/reports-v1/get-invoice-status.md @@ -49,7 +49,7 @@ Status code: 200 } ``` -### Get a Report With an Invalid Report ID +### Get Invoice Status With an Incorrect Report ID #### Sample Request From 8f774a493d0b8c14cc54514c50450559979ff99e Mon Sep 17 00:00:00 2001 From: bmorrill1 Date: Fri, 15 May 2026 16:08:32 -0500 Subject: [PATCH 5/5] Correct the endpoint url --- docs/reports-v1/get-invoice-status.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reports-v1/get-invoice-status.md b/docs/reports-v1/get-invoice-status.md index 1ecf000..eb08153 100644 --- a/docs/reports-v1/get-invoice-status.md +++ b/docs/reports-v1/get-invoice-status.md @@ -3,7 +3,7 @@ Get the payment status for a PDC report invoice. ```HTTP -GET {baseUrl}/v1/rosters/{customerKey}/reports/{reportId} +GET {baseUrl}/v1/rosters/{customerKey}/reports/{reportId}/invoice ``` ## URI Parameters @@ -36,7 +36,7 @@ GET {baseUrl}/v1/rosters/{customerKey}/reports/{reportId} #### Sample Request ```HTTP -GET /v1/rosters/me/reports/3182769 +GET /v1/rosters/me/reports/3182769/invoice ``` #### Sample Response @@ -54,7 +54,7 @@ Status code: 200 #### Sample Request ```HTTP -GET /v1/rosters/me/reports/3182760 +GET /v1/rosters/me/reports/3182760/invoice ``` #### Sample Response