Type alias DebitNoteDTO

DebitNoteDTO: {
    activityId: string;
    agreementId: string;
    debitNoteId: string;
    issuerId: string;
    payeeAddr: string;
    payerAddr: string;
    paymentDueDate?: string;
    paymentPlatform: string;
    previousDebitNoteId?: string;
    recipientId: string;
    status: "ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED";
    timestamp: string;
    totalAmountDue: string;
    usageCounterVector?: Record<string, any>;
}

A Debit Note is an artifact issued by the Provider to the Requestor, in the context of a specific Activity. It is a notification of Total Amount Due incurred by the Activity until the moment the Debit Note is issued. This is expected to be used as trigger for payment in upfront-payment or pay-as-you-go scenarios.

NOTE: Only Debit Notes with non-null paymentDueDate are expected to trigger payments.

NOTE: Debit Notes flag the current Total Amount Due, which is accumulated from the start of Activity. Debit Notes are expected to trigger payments, therefore payment amount for the newly received Debit Note is expected to be determined by difference of Total Payments for the Agreement vs Total Amount Due.

Type declaration

  • activityId: string
  • Readonly agreementId: string
  • Readonly debitNoteId: string
  • Readonly issuerId: string
  • Readonly payeeAddr: string
  • Readonly payerAddr: string
  • Optional paymentDueDate?: string
  • Readonly paymentPlatform: string
  • Optional Readonly previousDebitNoteId?: string
  • Readonly recipientId: string
  • Readonly status: "ISSUED" | "RECEIVED" | "ACCEPTED" | "REJECTED" | "FAILED" | "SETTLED" | "CANCELLED"

    Accepted status indicates that the Requestor confirms the Amount/Total Amount Due on the Invoice/Debit Note, respectively. The Payment API Implementation is expected to proceed with the orchestration of the payment. Internals of the payment processing (e.g. payment processing internal states) are specific to the selected Payment Platform, and must be indicated as an attribute of the Accepted status. However, as they are specific - they shall not be standardized by the Payment API.

    A Rejected Invoice/Debit Note can subsequently be Accepted.

    An Accepted Invoice/Debit Note cannot be subsequently Rejected.

    There is a difference between Paid and Settled - depending on a Payment Platform. Paid indicates that the Requestor has ordered Payments of Total Amount Due as indicated by received/accepted Debit Notes/Invoice. Settled indicates that the Provider has reliably received the Payments.

    WARNING: 'Paid' status currently not implemented.

  • Readonly timestamp: string
  • totalAmountDue: string
  • Optional usageCounterVector?: Record<string, any>

Settings

Member Visibility

Theme