Skip to content

Invoice tools

hypha.apply.projects.templatetags.invoice_tools

register module-attribute 

register = Library()

can_change_status 

can_change_status(invoice, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
27
28
29
@register.simple_tag
def can_change_status(invoice, user):
    return invoice.can_user_change_status(user)

can_show_paid_date 

can_show_paid_date(invoice)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
32
33
34
35
36
@register.simple_tag
def can_show_paid_date(invoice):
    if invoice.status == PAID and invoice.paid_date:
        return True
    return False

can_delete 

can_delete(invoice, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
39
40
41
@register.simple_tag
def can_delete(invoice, user):
    return invoice.can_user_delete(user)

can_edit 

can_edit(invoice, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
44
45
46
@register.simple_tag
def can_edit(invoice, user):
    return invoice.can_user_edit(user)

percentage 

percentage(value, total)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
@register.simple_tag
def percentage(value, total):
    if not total:
        return decimal.Decimal(0)

    unrounded_total = (value / total) * 100

    # round using Decimal since we're dealing with currency
    rounded_total = unrounded_total.quantize(
        decimal.Decimal("0.0"),
        rounding=decimal.ROUND_DOWN,
    )

    return rounded_total

can_edit_deliverables 

can_edit_deliverables(invoice, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
65
66
67
@register.simple_tag
def can_edit_deliverables(invoice, user):
    return invoice.can_user_edit_deliverables(user)

user_can_view_invoices 

user_can_view_invoices(project, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
70
71
72
73
74
@register.simple_tag
def user_can_view_invoices(project, user):
    if project.status in [INVOICING_AND_REPORTING, CLOSING, COMPLETE]:
        return True
    return False

user_can_add_invoices 

user_can_add_invoices(project, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
77
78
79
80
81
82
83
@register.simple_tag
def user_can_add_invoices(project, user):
    if project.status == INVOICING_AND_REPORTING and (
        user.is_apply_staff or user == project.user
    ):
        return True
    return False

get_invoice_form 

get_invoice_form(invoice, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
86
87
88
89
90
91
92
93
94
@register.simple_tag
def get_invoice_form(invoice, user):
    from hypha.apply.projects.views.payment import ChangeInvoiceStatusForm

    form = ChangeInvoiceStatusForm(instance=invoice, user=user)
    if form:
        form.name = "change_invoice_status"
        return form
    return None

get_invoice_form_id 

get_invoice_form_id(form, invoice)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
97
98
99
@register.simple_tag
def get_invoice_form_id(form, invoice):
    return f"{form.name}-{invoice.id}"

extract_status 

extract_status(activity, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
@register.simple_tag
def extract_status(activity, user):
    if activity and user:
        invoice_activity_message = display_for(activity, user)
        invoice_status = invoice_activity_message.replace(
            "Updated Invoice status to: ", ""
        ).replace(".", "")
        if " by " not in str(invoice_status) and not user.is_applicant:
            if activity.user.is_apply_staff:
                user_role = "staff"
            elif activity.user.is_finance:
                user_role = "finance"
            else:
                user_role = "vendor"
            return _("{status} by {user_role}").format(
                status=invoice_status, user_role=user_role
            )
        return invoice_status
    return ""

display_invoice_status_for_user 

display_invoice_status_for_user(user, invoice)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
123
124
125
126
127
@register.simple_tag
def display_invoice_status_for_user(user, invoice):
    if user.is_apply_staff or user.is_contracting or user.is_finance:
        return invoice.status_display
    return get_invoice_public_status(invoice_status=invoice.status)

get_comment_for_invoice_action 

get_comment_for_invoice_action(invoice, action)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
130
131
132
133
134
135
136
137
138
139
140
@register.simple_tag
def get_comment_for_invoice_action(invoice, action):
    if action and invoice:
        return Activity.comments.filter(
            timestamp__range=(
                action.timestamp - timedelta(minutes=1),
                action.timestamp + timedelta(minutes=1),
            ),
            related_content_type__model="invoice",
            related_object_id=invoice.id,
        ).first()

invoice_status_bg_color 

invoice_status_bg_color(invoice_status)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
143
144
145
@register.filter
def invoice_status_bg_color(invoice_status):
    return INVOICE_STATUS_BG_COLORS.get(invoice_status, "bg-gray-100")

invoice_status_fg_color 

invoice_status_fg_color(invoice_status)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
148
149
150
@register.filter
def invoice_status_fg_color(invoice_status):
    return INVOICE_STATUS_FG_COLORS.get(invoice_status, "text-gray-700")

display_invoice_table_status_for_user 

display_invoice_table_status_for_user(status, user)
Source code in hypha/apply/projects/templatetags/invoice_tools.py 
153
154
155
@register.simple_tag
def display_invoice_table_status_for_user(status, user):
    return get_invoice_table_status(status, is_applicant=user.is_applicant)