Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/defra/rpa-mit-invoice

A minimal api for managing invoices (.Net 6)
https://github.com/defra/rpa-mit-invoice

Last synced: 6 days ago
JSON representation

A minimal api for managing invoices (.Net 6)

Host: GitHub
URL: https://github.com/defra/rpa-mit-invoice
Owner: DEFRA
Created: 2023-06-05T13:27:58.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-22T12:23:27.000Z (7 months ago)
Last Synced: 2024-04-22T13:06:01.147Z (7 months ago)
Language: C#
Size: 586 KB
Stars: 1
Watchers: 7
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: changelog/db.changelog-1.0.xml

Awesome Lists containing this project

README

# Invoice API

This repository hosts a minimal API that exposes multiple endpoints, these endpoints are primarily called by other services, its use is as a data store for persisting data on in flight manual invoice templates.

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rpa-mit-invoice&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=rpa-mit-invoice) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=rpa-mit-invoice&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=rpa-mit-invoice) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=rpa-mit-invoice&metric=coverage)](https://sonarcloud.io/summary/new_code?id=rpa-mit-invoice) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=rpa-mit-invoice&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=rpa-mit-invoice)
## Requirements

Amend as needed for your distribution, this assumes you are using windows with WSL.
-
.NET 8 SDK

#### Basic instructions for installing the .NET 8 SDK on a debian based system.

Amend as needed for your distribution.

```bash
wget https://packages.microsoft.com/config/debian/12/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
sudo apt-get update && sudo apt-get install -y dotnet-sdk-8.0
```

- [Docker](https://docs.docker.com/desktop/install/linux-install/)
- Service Bus Queue

---
## Create the database

Create the postgres database in docker

```bash
docker pull postgres
```
```bash
docker run --name MY_POSTGRES_DB -e POSTGRES_PASSWORD=password -p 5432:5432 -d postgres
```

---
## Local Setup

To run this service locally complete the following steps.
### Set up user secrets

Use the secrets-template to create a secrets.json in the same folder location.

**Example** values that work in local environments for these 2 keys.

```json
{
"AzureADPostgreSQLResourceID": "https://ossrdbms-aad.database.windows.net/.default",
"DbConnectionTemplate": "Server={0};Port={1};Database={2};User Id={3};Password={4};"
}
```

Once this is done run the following command to add the projects user secrets

```bash
cat secrets.json | dotnet user-secrets set
```

These values can also be created as environment variables or as a development app settings file, but the preferred method is via user secrets.

### Start the Api

**NOTE** - You will need to create the database in postgres before starting for the first time.

```bash
cd EST.MIT.Invoice.Api
```

```bash
dotnet run
```

---
## Endpoints

### HTTP

#### Invoices

Retrieves invoice details for a specific scheme and invoice ID.
```http
GET /invoice/{scheme}/{invoiceId}
```

Retrieves invoice details for a specific invoice ID.
```http
GET /invoice/{invoiceId}
```

Retrieves invoice details associated with a specific payment request ID.
```http
GET /invoice/paymentrequest/{paymentRequestId}
```

Retrieves approval details for a specific invoice.
```http
GET /invoice/approvals/{invoiceId}
```

Retrieves all invoice approvals.
```http
GET /invoice/approvals
```

Retrieves all invoices for a specific user ID.
```http
GET /invoices/user/{userId}
```

Creates a new invoice.
```http
POST /invoice
```

Creates multiple invoices in bulk.
```http
POST /invoices
```

Updates an existing invoice by its ID.
```http
PUT /invoice/{invoiceId}
```

Deletes a specific invoice by its scheme and ID.
```http
DELETE /invoice/{scheme}/{invoiceId}
```

#### Swagger

Swagger is also available in development environments with more detailed information on the endpoints and their expected payloads.
```http
/swagger
```