Skip to content

Payment

hypha.apply.projects.forms.payment

ChangeInvoiceStatusForm 

ChangeInvoiceStatusForm(instance, user, *args, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/payment.py 
91
92
93
94
95
96
97
98
def __init__(self, instance, user, *args, **kwargs):
    super().__init__(*args, **kwargs, instance=instance)
    self.initial["comment"] = ""
    status_field = self.fields["status"]

    status_field.choices = get_invoice_possible_transition_for_user(
        user, invoice=instance
    )

name_prefix class-attribute instance-attribute 

name_prefix = 'change_invoice_status_form'

Meta

fields class-attribute instance-attribute 
fields = ['status', 'comment']
model class-attribute instance-attribute 
model = Invoice

InvoiceBaseForm 

InvoiceBaseForm(user=None, *args, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/payment.py 
106
107
108
def __init__(self, user=None, *args, **kwargs):
    super().__init__(*args, **kwargs)
    self.initial["message_for_pm"] = ""

Meta

fields class-attribute instance-attribute 
fields = ['invoice_number', 'invoice_amount', 'document', 'message_for_pm']
model class-attribute instance-attribute 
model = Invoice

CreateInvoiceForm 

CreateInvoiceForm(user=None, *args, **kwargs)

Bases: FileFormMixin, InvoiceBaseForm

Source code in hypha/apply/projects/forms/payment.py 
106
107
108
def __init__(self, user=None, *args, **kwargs):
    super().__init__(*args, **kwargs)
    self.initial["message_for_pm"] = ""

document class-attribute instance-attribute 

document = SingleFileField(label=gettext_lazy('Invoice file'), required=True, help_text=gettext_lazy('The invoice must be a PDF.'))

supporting_documents class-attribute instance-attribute 

supporting_documents = MultiFileField(required=False, help_text=gettext_lazy('Files that are related to the invoice. They could be xls, microsoft office documents, open office documents, pdfs, txt files.'))

field_order class-attribute instance-attribute 

field_order = ['invoice_number', 'invoice_amount', 'document', 'supporting_documents', 'message_for_pm']

Meta

fields class-attribute instance-attribute 
fields = ['invoice_number', 'invoice_amount', 'document', 'message_for_pm']
model class-attribute instance-attribute 
model = Invoice

save 

save(commit=True)
Source code in hypha/apply/projects/forms/payment.py 
132
133
134
135
136
137
138
139
140
141
142
def save(self, commit=True):
    invoice = super().save(commit=commit)

    supporting_documents = self.cleaned_data["supporting_documents"] or []

    SupportingDocument.objects.bulk_create(
        SupportingDocument(invoice=invoice, document=document)
        for document in supporting_documents
    )

    return invoice

EditInvoiceForm 

EditInvoiceForm(user=None, *args, **kwargs)

Bases: FileFormMixin, InvoiceBaseForm

Source code in hypha/apply/projects/forms/payment.py 
106
107
108
def __init__(self, user=None, *args, **kwargs):
    super().__init__(*args, **kwargs)
    self.initial["message_for_pm"] = ""

document class-attribute instance-attribute 

document = SingleFileField(label=gettext_lazy('Invoice File'), required=True)

supporting_documents class-attribute instance-attribute 

supporting_documents = MultiFileField(required=False)

field_order class-attribute instance-attribute 

field_order = ['invoice_number', 'invoice_amount', 'document', 'supporting_documents', 'message_for_pm']

Meta

fields class-attribute instance-attribute 
fields = ['invoice_number', 'invoice_amount', 'document', 'message_for_pm']
model class-attribute instance-attribute 
model = Invoice

save 

save(commit=True)
Source code in hypha/apply/projects/forms/payment.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
@transaction.atomic
def save(self, commit=True):
    invoice = super().save(commit=commit)
    not_deleted_original_filenames = [
        file["name"]
        for file in json.loads(self.cleaned_data["supporting_documents-uploads"])
    ]
    for f in invoice.supporting_documents.all():
        if f.document.name not in not_deleted_original_filenames:
            f.document.delete()
            f.delete()

    for f in self.cleaned_data["supporting_documents"]:
        if not isinstance(f, FieldFile):
            try:
                SupportingDocument.objects.create(invoice=invoice, document=f)
            finally:
                f.close()
    return invoice

SelectDocumentForm 

SelectDocumentForm(existing_files, *args, **kwargs)

Bases: ModelForm

Source code in hypha/apply/projects/forms/payment.py 
187
188
189
190
191
192
193
194
def __init__(self, existing_files, *args, **kwargs):
    super().__init__(*args, **kwargs)

    self.files = existing_files

    choices = [(f.url, f.filename) for f in self.files]

    self.fields["document"].choices = choices

document class-attribute instance-attribute 

document = ChoiceField(label=gettext_lazy('Document'), widget=Select(attrs={'id': 'from_submission'}))

files instance-attribute 

files = existing_files

Meta

model class-attribute instance-attribute 
model = PacketFile
fields class-attribute instance-attribute 
fields = ['category', 'document']

clean_document 

clean_document()
Source code in hypha/apply/projects/forms/payment.py 
196
197
198
199
200
201
202
203
def clean_document(self):
    file_url = self.cleaned_data["document"]
    for file in self.files:
        if file.url == file_url:
            new_file = ContentFile(file.read())
            new_file.name = file.filename
            return new_file
    raise forms.ValidationError(_("File not found on submission"))

save 

save(*args, **kwargs)
Source code in hypha/apply/projects/forms/payment.py 
205
206
207
@transaction.atomic()
def save(self, *args, **kwargs):
    return super().save(*args, **kwargs)

BatchUpdateInvoiceStatusForm 

BatchUpdateInvoiceStatusForm(*args, **kwargs)

Bases: Form

Source code in hypha/apply/projects/forms/payment.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
def __init__(self, *args, **kwargs):
    self.user = kwargs.pop("user")
    super().__init__(*args, **kwargs)
    if self.user.is_apply_staff:
        self.fields["invoice_action"].choices = [
            (DECLINED, get_invoice_status_display_value(DECLINED))
        ]
    elif self.user.is_finance:
        self.fields["invoice_action"].choices = [
            (DECLINED, get_invoice_status_display_value(DECLINED)),
            (PAID, get_invoice_status_display_value(PAID)),
            (PAYMENT_FAILED, get_invoice_status_display_value(PAYMENT_FAILED)),
        ]

invoice_action class-attribute instance-attribute 

invoice_action = ChoiceField(label=gettext_lazy('Status'))

invoices class-attribute instance-attribute 

invoices = CharField(widget=HiddenInput(attrs={'class': 'js-invoices-id'}))

user instance-attribute 

user = pop('user')

clean_invoices 

clean_invoices()
Source code in hypha/apply/projects/forms/payment.py 
230
231
232
233
def clean_invoices(self):
    value = self.cleaned_data["invoices"]
    invoice_ids = [int(invoice) for invoice in value.split(",")]
    return Invoice.objects.filter(id__in=invoice_ids)

filter_request_choices 

filter_request_choices(choices, user_choices)
Source code in hypha/apply/projects/forms/payment.py 
34
35
36
37
def filter_request_choices(choices, user_choices):
    return [
        (k, v) for k, v in INVOICE_STATUS_CHOICES if k in choices and k in user_choices
    ]

get_invoice_possible_transition_for_user 

get_invoice_possible_transition_for_user(user, invoice)
Source code in hypha/apply/projects/forms/payment.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def get_invoice_possible_transition_for_user(user, invoice):
    user_choices = invoice_status_user_choices(user)
    possible_status_transitions_lut = {
        SUBMITTED: filter_request_choices(
            [CHANGES_REQUESTED_BY_STAFF, APPROVED_BY_STAFF, DECLINED], user_choices
        ),
        RESUBMITTED: filter_request_choices(
            [CHANGES_REQUESTED_BY_STAFF, APPROVED_BY_STAFF, DECLINED], user_choices
        ),
        CHANGES_REQUESTED_BY_STAFF: filter_request_choices([DECLINED], user_choices),
        APPROVED_BY_STAFF: filter_request_choices(
            [
                CHANGES_REQUESTED_BY_FINANCE,
                APPROVED_BY_FINANCE,
            ],
            user_choices,
        ),
        CHANGES_REQUESTED_BY_FINANCE: filter_request_choices(
            [CHANGES_REQUESTED_BY_STAFF, DECLINED], user_choices
        ),
        APPROVED_BY_FINANCE: filter_request_choices([PAID], user_choices),
        PAID: filter_request_choices([PAYMENT_FAILED], user_choices),
        PAYMENT_FAILED: filter_request_choices([PAID], user_choices),
    }
    if settings.INVOICE_EXTENDED_WORKFLOW:
        possible_status_transitions_lut.update(
            {
                CHANGES_REQUESTED_BY_FINANCE_2: filter_request_choices(
                    [
                        CHANGES_REQUESTED_BY_FINANCE,
                        APPROVED_BY_FINANCE,
                    ],
                    user_choices,
                ),
                APPROVED_BY_FINANCE: filter_request_choices(
                    [CHANGES_REQUESTED_BY_FINANCE_2, APPROVED_BY_FINANCE_2],
                    user_choices,
                ),
                APPROVED_BY_FINANCE_2: filter_request_choices([PAID], user_choices),
            }
        )
    return possible_status_transitions_lut.get(invoice.status, [])