Skip to content

Update readme #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MinaDoncheva merged 3 commits into from
Apr 27, 2026
Merged

Update readme #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d688cf
update readme
NicoleNG18 Apr 24, 2026
3a3c152
Update README.md
NicoleNG18 Apr 24, 2026
f8ecfd1
Update README.md
NicoleNG18 Apr 24, 2026
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
168 changes: 154 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,168 @@
# codbex-payments
## Payments Management Applications
# <img src="https://www.codbex.com/icon.svg" width="32" style="vertical-align: middle;"> codbex-payments

### Model
## 📖 Table of Contents
* [🗺️ Entity Data Model (EDM)](#️-entity-data-model-edm)
* [🧩 Core Entities](#-core-entities)
* [📦 Dependencies](#-dependencies)
* [🔗 Sample Data Modules](#-sample-data-modules)
* [🐳 Local Development with Docker](#-local-development-with-docker)

![payments](images/payments-model.png)
### Application
## 🗺️ Entity Data Model (EDM)

#### Launchpad
![model](images/model.png)

![launchpad](images/payments-launchpad.png)
## 🧩 Core Entities

#### Management
### Entity: `CustomerPayment`

![customer](images/payments-customer-payment.png)
| Field | Type | Details | Description |
| ---------------- | --------- | ----------------------- | ------------------------- |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Customer | INTEGER | FK, Not Null | Reference to customer. |
| Date | DATE | Not Null | Payment date. |
| Valor | DATE | Not Null | Value date. |
| OurPartyIBAN | VARCHAR | Length: 34, Not Null | Our IBAN. |
| CounterpartyIBAN | VARCHAR | Length: 34, Not Null | Counterparty IBAN. |
| CounterpartyName | VARCHAR | Length: 100, Nullable | Counterparty name. |
| Amount | DECIMAL | Precision: 16, Scale: 2, Not Null | Payment amount. |
| Currency | INTEGER | FK , Not Null | Currency reference. |
| Reason | VARCHAR | Length: 100, Not Null | Payment reason. |
| Description | VARCHAR | Length: 100, Nullable | Description. |
| Company | INTEGER | FK, Nullable | Company reference. |
| Name | VARCHAR | Calculated, Length: 20, Nullable | Payment name. |
| UUID | VARCHAR | Calculated, Length: 36, Unique | Unique identifier (UUID). |
| Reference | VARCHAR | Length: 36, Nullable | External reference( e.g. to Invoice) . |
| PaymentMethod | INTEGER | FK, Not Null | Payment method reference. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |

![supplier](images/payments-supplier-payment.png)
### Entity: `SupplierPayment`

![employee](images/payments-employee-payment.png)
| Field | Type | Details | Description |
| ---------------- | --------- | ----------------------- | ------------------------- |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Supplier | INTEGER | FK, Not Null | Reference to supplier. |
| Date | DATE | Not Null | Payment date. |
| Valor | DATE | Not Null | Value date. |
| OurPartyIban | VARCHAR | Length: 34, Not Null | Our IBAN. |
| CounterpartyIban | VARCHAR | Length: 34, Not Null | Counterparty IBAN. |
| CounterpartyName | VARCHAR | Length: 100, Nullable | Counterparty name. |
| Amount | DECIMAL | Precision: 16, Scale: 2, Not Null | Payment amount. |
| Currency | INTEGER | FK, Not Null | Currency reference. |
| Reason | VARCHAR | Length: 100, Not Null | Payment reason. |
| Description | VARCHAR | Length: 100, Nullable | Description. |
| Company | INTEGER | FK, Nullable | Company reference. |
| Name | VARCHAR | Calculated, Length: 20, Nullable | Payment name. |
| UUID | VARCHAR | Calculated, Length: 36, Unique | Unique identifier (UUID). |
| Reference | VARCHAR | Length: 36, Nullable | External reference (e.g. to Invoice) |
| PaymentMethod | INTEGER | FK, Not Null | Payment method reference. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |

![settings](images/payments-settings.png)
### Entity `EmployeePayment`

![report](images/payments-payment-record-report.png)
| Field | Type | Details | Description |
| ---------------- | --------- | ----------------------- | ------------------------- |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Employee | INTEGER | FK, Not Null | Reference to employee. |
| Date | DATE | Not Null | Payment date. |
| Valor | DATE | Not Null | Value date. |
| OurPartyIban | VARCHAR | Length: 34, Not Null | Our IBAN. |
| CounterpartyIban | VARCHAR | Length: 34, Not Null | Counterparty IBAN. |
| CounterpartyName | VARCHAR | Length: 100, Nullable | Counterparty name. |
| Amount | DECIMAL | Precision: 16, Scale: 2, Not Null | Payment amount. |
| Currency | INTEGER | FK, Not Null | Currency reference. |
| Reason | VARCHAR | Length: 100, Not Null | Payment reason. |
| Description | VARCHAR | Length: 100, Nullable | Description. |
| Company | INTEGER | FK, Nullable | Company reference. |
| Name | VARCHAR | Calculated, Length: 20, Nullable | Payment name. |
| UUID | VARCHAR | Calculated, Length: 36, Unique | UUID. |
| Reference | VARCHAR | Length: 36, Nullable | External reference. |
| PaymentMethod | INTEGER | FK, Nullable | Payment method reference. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |

## Local Development with Docker
### Entity `PaymentRecord`

| Field | Type | Details | Description |
| ---------------- | --------- | ----------------------- | -------------------- |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Date | DATE | Not Null | Payment date. |
| Valor | DATE | Not Null | Value date. |
| OurPartyIban | VARCHAR | Length: 34, Not Null | Our IBAN. |
| CounterpartyIban | VARCHAR | Length: 34, Not Null | Counterparty IBAN. |
| CounterpartyName | VARCHAR | Length: 100, Nullable | Counterparty name. |
| Amount | DECIMAL | Precision: 16, Scale: 2, Not Null | Amount. |
| Currency | INTEGER | FK, Not Null | Currency reference. |
| PaymentDirection | INTEGER | FK, Not Null | Payment direction. |
| PaymentType | INTEGER | FK, Not Null | Payment type. |
| Reason | VARCHAR | Length: 100, Nullable | Reason. |
| Description | VARCHAR | Length: 100, Nullable | Description. |
| Company | INTEGER | FK, Nullable | Company reference. |
| UUID | VARCHAR | Calculated, Length: 36, Unique | UUID. |
| Reference | VARCHAR | Length: 36, Nullable | Reference. |
| Deleted | BOOLEAN | Nullable | Soft delete flag. |
| DeletedAt | TIMESTAMP | Nullable | Deletion timestamp. |
| DeletedReason | VARCHAR | Length: 255, Nullable | Reason for deletion. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |

### Entity `PaymentType`

| Field | Type | Details | Description |
| ----- | ------- | ------------ | ------------------ |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Name | VARCHAR | Length: 20, Not Null | Payment type name. |

### Entity `PaymentDirection`

| Field | Type | Details | Description |
| ----- | ------- | ------------ | ----------------------- |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Name | VARCHAR | Length: 20, Not Null | Payment direction name. |

### Entity `PaymentAdjustment`

| Field | Type | Details | Description |
| --------- | --------- | ---------------------------- | ------------------- |
| Id | INTEGER | PK, Identity | Unique identifier. |
| Date | DATE | Not Null | Adjustment date. |
| Valor | DATE | Not Null | Value date. |
| Amount | DECIMAL | Precision: 16, Scale: 2, Not Null | Adjustment amount. |
| Currency | INTEGER | FK, Not Null | Currency reference. |
| Company | INTEGER | FK, Not Null | Company reference. |
| Reason | VARCHAR | Length: 100, Nullable | Reason. |
| UUID | VARCHAR | Calculated, Length: 36, Unique | UUID. |
| CreatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was created. |
| CreatedBy | VARCHAR | Audit, Length: 20, Nullable | User who created the entry. |
| UpdatedAt | TIMESTAMP | Audit, Nullable | Timestamp when the entry was updated. |
| UpdatedBy | VARCHAR | Audit, Length: 20, Nullable | User who updated the entry. |



## 📦 Dependencies

- [codbex-partners](https://github.com/codbex/codbex-partners)
- [codbex-companies](https://github.com/codbex/codbex-companies)
- [codbex-employees](https://github.com/codbex/codbex-employees)
- [codbex-currencies](https://github.com/codbex/codbex-currencies)
- [codbex-number-generator](https://github.com/codbex/codbex-number-generator)
- [codbex-number-generator-data](https://github.com/codbex/codbex-number-generator-data)
- [codbex-navigation-groups](https://github.com/codbex/codbex-navigation-groups)

## 🔗 Sample Data Modules

- [codbex-payments-data](https://github.com/codbex/codbex-payments-data)

## 🐳 Local Development with Docker

When running this project inside the codbex Atlas Docker image, you must provide authentication for installing dependencies from GitHub Packages.
1. Create a GitHub Personal Access Token (PAT) with `read:packages` scope.
Expand Down
Binary file added images/model.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/payments-customer-payment.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-employee-payment.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-launchpad.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-model.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-payment-record-report.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-payment-record.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-settings.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/payments-supplier-payment.png
View file
Open in desktop
Binary file not shown.
Loading