Skip to content

Latest commit

 

History

History
593 lines (454 loc) · 39.8 KB

README.md

File metadata and controls

593 lines (454 loc) · 39.8 KB

Invoice manager

Invoice management system, microservice architecture.

The services implement Vertical Slice Architecture, YARP reverse proxy, RabbitMq message broker, request-response pattern, minimal api, PFD file generation, miniIO object storage, integration and unit tests.

👷 Frameworks, Libraries and Technologies

🏗️ List of microservices

  • Gateway service: Single entry point to the application.

  • Identity service: User authentication.

  • Company service: Manages interactions with companies.

  • Invoice service: Manages interaction with the invoices.

  • FileGenerator service: Generates PDF files.

  • Storage service: Stores invoices in MinIO storage.

🔍️ Microservices diagram

Microservices diagram

🐳 List of docker containers

  • gateway.api - reverse proxy gateway container.

  • rabbitmq - message broker container.

  • minio - object storage for storage service.

  • storage.api - asp.net app container for storage service.

  • file-generator.api - asp.net app container for file generator service.

  • identity.api - asp.net app container for identity service.

  • identity.api.database - postgresql database container for identity service.

  • company.api - asp.net app container for company service.

  • company.api.database - postgresql database container for company service.

  • invoice.api - asp.net app container for invoice service.

  • invoice.api.database - postgresql database container for invoice service.

🩺 How to run tests

Allows you to run all integration and unit tests.

> dotnet test  # donet SKD is required

🚜 How to run the server

  1. Build and start Docker images based on the configuration defined in the docker-compose.yml

    > make up  # docker-compose up --build

  2. Stop and remove containers

    > make down  # docker-compose down

🔐 Service access

container port login password access
gateway.api 5000 - - http://localhost:5000
rabbitMQ 5672 / 15672 user password http://localhost:15672 (local access)
minIO 9000 / 9001 user password http://localhost:9001/login (local access)
fileGenerator.api - - - -
identity.api 8000 - - http://localhost:8000 (local access)
company.api 8001 - - http://localhost:8001 (local access)
invoice.api 8002 - - http://localhost:8002 (local access)
storage.api 8080 - - http://localhost:8080 (local access)
identity.api.database 5432 user password http://localhost:5432 (local access)
company.api.database 5433 user password http://localhost:5433 (local access)
invoice.api.database 5434 user password http://localhost:5434 (local access)

🖨️ Swagger UI documentation (local access)

  • Identity service

      http://localhost:8000/swagger/index.html

  • Company service

      http://localhost:8001/swagger/index.html

  • Invoice service

      http://localhost:8002/swagger/index.html

  • Storage service

      http://localhost:8080/swagger/index.html

🔧 Implementation features

Gateway base Url: http://localhost:5000

Identity service

Register

POST /auth/register(allows you to register)
Body
name type data type
email required string
password required string
Responses
http code content-type response
201 application/json {"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "string"}
400 application/json array
409 application/json string

Login

POST /auth/login(allows you to login, issues accessToken and refreshToken)
Body
name type data type
email required string
password required string
Responses
http code content-type response
200 application/json {"accessToken": "string", "refreshToken": "string", "refreshTokenExpires": "2024-04-21T17:42:12.146Z", "accessTokenType": "string"}
400 application/json array
404 application/json string

Refresh

POST /auth/refresh(allows to refresh access and refresh tokens)
Body
name type data type
"refreshToken" required string
Responses
http code content-type response
200 application/json {"accessToken": "string", "refreshToken": "string", "refreshTokenExpires": "2024-04-21T17:43:47.494Z", "accessTokenType": "string"}
400 application/json array
401 application/json string

Logout

POST /auth/logout(allows to logout and deactivates refresh tokens)
Body
name type data type
"refreshToken" required string
Responses
http code content-type response
204 application/json NoContent
400 application/json array
401 application/json string

Company service

Functionality that allows to manage and interact with companies

Create new companies (🔒Token required)

POST /company(allows to create new companies 🔒️[token required])
Body
name type data type
"name" required string
"taxNumber" required string
"city" required string
"street" required string
"houseNumber" required string
"postalCode" required string
Responses
http code content-type response
201 application/json {"companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "taxNumber": "string", "city": "string", "street": "string", "houseNumber": "string", "postalCode": "string"}
400 application/json array
401 application/json string
403 application/json string

Update your companies (🔒Token required)

PUT /company(allows to update your companies 🔒️[token required])
Body
name type data type
"companyId" required uuid
"name" not required string
"taxNumber" not required string
"city" not required string
"street" not required string
"houseNumber" not required string
"postalCode" not required string
Responses
http code content-type response
200 application/json {"companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "taxNumber": "string", "city": "string", "street": "string", "houseNumber": "string", "postalCode": "string"}
400 application/json array
401 application/json string
403 application/json string
404 application/json string

Delete your companies (🔒Token required)

DELETE /company/{ id:uuid }(allows to delete your companies 🔒️[token required])
Responses
http code content-type response
204 application/json NoContent
401 application/json string
403 application/json string
404 application/json string

Get all your companies (🔒Token required)

GET /company(allows you to get all your companies 🔒️[token required])
Parameters
name type data type
PageNumber not required int32
PageSize not required int32
Responses
http code content-type response
200 application/json {"items": [ { "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "taxNumber": "string", "city": "string", "street": "string", "houseNumber": "string", "postalCode": "string" } ], "pageNumber": 0, "totalPages": 0, "totalItemsCount": 0 }
401 application/json string
403 application/json string

Get one your company (🔒Token required)

GET /company/{ id:uuid }(allows you to get one your company 🔒️[token required])
Responses
http code content-type response
200 application/json {"companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "taxNumber": "string", "city": "string", "street": "string", "houseNumber": "string", "postalCode": "string"}
401 application/json string
403 application/json string

Invoice service

Invoice

Functionality that allows to manage and interact with invoices

Create invoices (🔒Token required)

POST /invoice(allows to create new invoices 🔒️[token required])
Body
name type data type
"sellerCompanyId" required uuid
"buyerCompanyId" required uuid
"termsOfPayment" required int
"paymentType" required string
"status" required string
Responses
http code content-type response
201 application/json { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sellerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "buyerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "number": "string", "totalNetPrice": 0, "totalGrossPrice": 0, "termsOfPayment": 0, "paymentType": "string", "status": "string", "itemsId": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"] }
400 application/json array
401 application/json string
403 application/json string
404 application/json string

Update your unfinished invoices (🔒Token required)

PUT /invoice(allows to update your invoices 🔒️[token required])
Body
name type data type
"invoiceId" required uuid
"status" required string
Responses
http code content-type response
200 application/json { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sellerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "buyerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "number": "string", "totalNetPrice": 0, "totalGrossPrice": 0, "termsOfPayment": 0, "paymentType": "string", "status": "string", "itemsId": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"] }
400 application/json array
401 application/json string
403 application/json string
404 application/json string

Delete your unfinished invoices (🔒Token required)

DELETE /invoice/{ id:uuid }(allows to delete your invoices 🔒️[token required])
Responses
http code content-type response
204 application/json NoContent
401 application/json string
403 application/json string
404 application/json string

Finalize your unfinished invoices (🔒Token required)

PATCH /invoice/lock/{ id:uuid }(allows to finalize your invoices 🔒️[token required])
Responses
http code content-type response
200 application/json string
401 application/json string
403 application/json string
404 application/json string

Get all your invoices (🔒Token required)

GET /invoice(allows you to get all your invoices 🔒️[token required])
Parameters
name type data type
PageNumber not required int32
PageSize not required int32
Responses
http code content-type response
200 application/json [ { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sellerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "buyerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "number": "string", "totalNetPrice": 0, "totalGrossPrice": 0, "termsOfPayment": 0, "paymentType": "string", "status": "string", "itemsId": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ]
401 application/json string
403 application/json string

Get one your invoice (🔒Token required)

GET /invoice/{ id:uuid }(allows you to get one your company 🔒️[token required])
Responses
http code content-type response
200 application/json [ { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sellerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "buyerCompanyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "number": "string", "totalNetPrice": 0, "totalGrossPrice": 0, "termsOfPayment": 0, "paymentType": "string", "status": "string", "itemsId": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ]
401 application/json string
403 application/json string

Invoice item

Functionality that allows to manage and interact with invoice items

Create new items on your unfinished invoice (🔒Token required)

POST /item(allows to create new items 🔒️[token required])
Body
name type data type
"invoiceId" required uuid
"name" required string
"amount" required int
"unit" required string
"vat" required string
"netPrice" required decimal
Responses
http code content-type response
201 application/json { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "amount": 0, "unit": "string", "vat": "string", "netPrice": 0, "sumNetPrice": 0, "sumGrossPrice": 0 }
400 application/json array
401 application/json string
403 application/json string
404 application/json string

Update items on your unfinished invoice (🔒Token required)

PUT /item(allows to update your items 🔒️[token required])
Body
name type data type
"itemId" required uuid
"name" not required string
"amount" not required int
"netPrice" not required decimal
Responses
http code content-type response
200 application/json { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "amount": 0, "unit": "string", "vat": "string", "netPrice": 0, "sumNetPrice": 0, "sumGrossPrice": 0 }
400 application/json array
401 application/json string
403 application/json string
404 application/json string

Delete items on your unfinished invoice (🔒Token required)

DELETE /item/{ id:uuid }(allows to delete your items 🔒️[token required])
Responses
http code content-type response
204 application/json NoContent
401 application/json string
403 application/json string
404 application/json string

Get all items by invoice (🔒Token required)

GET /item/all-by-invoice/{ id:uuid }(allows you to get items by invoice 🔒️[token required])
Responses
http code content-type response
200 application/json [ { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "amount": 0, "unit": "string", "vat": "string", "netPrice": 0, "sumNetPrice": 0, "sumGrossPrice": 0 } ]
401 application/json string
403 application/json string
404 application/json string

Get one item by id (🔒Token required)

GET /item/{ id:uuid }(allows you to get one item 🔒️[token required])
Responses
http code content-type response
200 application/json [ { "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "amount": 0, "unit": "string", "vat": "string", "netPrice": 0, "sumNetPrice": 0, "sumGrossPrice": 0 } ]
401 application/json string
403 application/json string
404 application/json string

Storage service

PDF file is created automatically when the invoice is finalized

Get names of all your PDF files (🔒Token required)

GET /storage(allows to get names of all your PDF files 🔒️[token required])
Responses
http code content-type response
200 application/json [ "string", "string", ]
401 application/json string
403 application/json string
404 application/json string

Download your PDF file by name (🔒Token required)

GET /storage/{ fileName:string }(allows to download your PDF file 🔒️[token required])
Responses
http code content-type response
200 application/pdf PDFfile
401 application/json string
403 application/json string
404 application/json string