Skip to main content

UnpaidDto

DTO for storing unpaid bill details

billerIdstring

Unique identifier of the biller

Example: CN00123456
debtIdstring

Identifier of the related debt

Example: DET00098765
itemIdstring

Unique identifier of the bill

Example: FAC2721176
billDatestring

Bill issue date

Example: 24/06/2024
totalAmountWithTaxnumber<double>

Total amount of the bill including tax

Example: 120.5
itemTypestring

Internal code indicating the bill type

Example: 0
itemTypeLabelstring

Label describing the bill type

Example: Telecom
transactionReferencestring

Transaction reference associated with the bill

Example: TRX-MAR-202406010001
billDateFormattedstring

Formatted bill date for display (ISO 8601)

Example: 2024-06-01
feesnumber<double>

Additional service fees applied to the bill

Example: 10
amountExclTaxnumber<double>

Bill amount before tax

Example: 105
dueDatestring

Bill due date

Example: 2024-06-30
enforceableDatestring

Date when the bill becomes legally enforceable

Example: 2024-07-01
isMandatoryboolean

Indicates if the bill is mandatory for payment

Example: true
customerNamestring

Full name of the client

Example: Mohamed El Amrani
customerPhonestring

Client's Moroccan phone number

Example: 0612345678
customerAddressstring

Address of the client

Example: 123
customerBalancenumber<double>

Client's current account balance in MAD

Example: 500
contractReferencestring

Contract reference related to the bill

Example: 0028120
paymentDeadlinestring

Deadline to pay the bill without penalty

Example: 2024-07-10
penaltyAmountnumber<double>

Penalty amount for delayed payment

Example: 15
billBalancenumber<double>

Remaining amount to be paid on the bill

Example: 120.5
currencystring

Currency of the bill

Example: MAD
paymentMethodstring

Chosen payment method

partialPaymentAmountnumber<double>

Amount proposed for partial payment

Example: 60
isSelectedboolean

Whether the bill is selected for payment

Example: true
paymentOrderinteger<int32>

Priority order in which bills are to be processed

Example: 1
settlementAmountnumber<double>

Final amount to be settled for the bill payment, including all applicable fees and adjustments.

Example: 120.5
debtLabelstring

Descriptive label of the debt type

Example: Produit Internet
billerLabelstring

Name of the biller

Example: Maroc Telecom
feeTypestring

Fee type applied

Example: Service Charge
feeValuenumber<double>

Value of the applied fee

Example: 5
minimumThresholdnumber<double>

Minimum required amount to trigger payment

Example: 20
currencyCodestring

ISO 4217 currency code

Example: MAD
partnerReferencestring

External partner reference code

descriptionstring

Detailed description of the bill

Example: Contract No. 0028120, Type: Telecom, Due: 06/24
UnpaidDto
{
"billerId": "CN00123456",
"debtId": "DET00098765",
"itemId": "FAC2721176",
"billDate": "24/06/2024",
"totalAmountWithTax": 120.5,
"itemType": 0,
"itemTypeLabel": "Telecom",
"transactionReference": "TRX-MAR-202406010001",
"billDateFormatted": "2024-06-01",
"fees": 10,
"amountExclTax": 105,
"dueDate": "2024-06-30",
"enforceableDate": "2024-07-01",
"isMandatory": true,
"customerName": "Mohamed El Amrani",
"customerPhone": "0612345678",
"customerAddress": 123,
"customerBalance": 500,
"contractReference": "0028120",
"paymentDeadline": "2024-07-10",
"penaltyAmount": 15,
"billBalance": 120.5,
"currency": "MAD",
"paymentMethod": "string",
"partialPaymentAmount": 60,
"isSelected": true,
"paymentOrder": 1,
"settlementAmount": 120.5,
"debtLabel": "Produit Internet",
"billerLabel": "Maroc Telecom",
"feeType": "Service Charge",
"feeValue": 5,
"minimumThreshold": 20,
"currencyCode": "MAD",
"partnerReference": "string",
"description": "Contract No. 0028120, Type: Telecom, Due: 06/24"
}