green-invoice 2.0.0

A Python 3 module to interact with the Green Invoice API.

Green Invoice API

A Python 3 module to interact with the Green Invoice API.

🛑 Versions below 2.0.0 are deprecated and unsupported. They authenticate against Green Invoice's retired /v1/account/token flow, which Morning has replaced with an OAuth 2.0 IdP. Upgrade to 2.0.0+ and provision OAuth client credentials — see Authentication and the Changelog.

Install

pip install green-invoice

Authentication

Authentication uses the OAuth 2.0 client-credentials flow against Morning's IdP host (https://api.morning.co/idp/v1/oauth/token for live, https://api.sandbox.morning.dev/idp/v1/oauth/token for sandbox), which is separate from the resource API host. The api_key_id / api_key_secret passed to configure(...) are your OAuth client id / client secret. The resulting access token is cached in memory and reused across requests until it nears expiry, so you do not need to manage tokens yourself.

Example

from datetime import datetime
import logging
import green_invoice
from green_invoice.models import (
    Currency,
    DocumentLanguage,
    DocumentType,
    DocumentVatType,
    PaymentCardType,
    PaymentDealType,
    PaymentType,
    IncomeVatType,
)
from green_invoice.resources import DocumentResource


def main():
    green_invoice.client.configure(
        env="sandbox",
        # Authentication
        api_key_id="YOUR_API_KEY_ID",
        api_key_secret="YOUR_API_KEY_SECRET",
        # Logger
        logger=logging.root,
    )

    order_amount = 50
    order_amount_currency = Currency.USD
    create_document_for_order(order_amount, order_amount_currency)


def create_document_for_order(amount, amount_currency):
    documentResource = DocumentResource()
    created_document = documentResource.create(
        {
            "type": DocumentType.TAX_INVOICE_RECEIPT,
            "client": {
                "name": "Tom Hanks",
                "add": False,
            },
            "currency": amount_currency,
            "lang": DocumentLanguage.ENGLISH,
            "vatType": DocumentVatType.DEFAULT,
            "signed": True,
            "rounding": False,
            "income": [
                {
                    "price": amount,
                    "currency": amount_currency,
                    "quantity": 1,
                    "description": "My Cool Product",
                    "vatType": IncomeVatType.INCLUDED,
                }
            ],
            "payment": [
                {
                    "type": PaymentType.CREDIT_CARD,
                    "date": datetime.today().strftime("%Y-%m-%d"),
                    "dealType": PaymentDealType.REGULAR,
                    "cardNum": "4242",
                    "cardType": PaymentCardType.VISA,
                    "price": amount,
                    "currency": amount_currency,
                }
            ],
        }
    )
    print(created_document)


if __name__ == "__main__":
    main()

Changelog

2.0.0

⚠️ Breaking change. This release switches authentication to Morning's new OAuth 2.0 IdP. Existing integrations must obtain OAuth client credentials (client id / secret) for their business and ensure network access to the new IdP host — credentials issued for the previous /v1/account/token flow no longer work. Upgrade to 2.0.0 only after the new credentials are provisioned.

1. Change to Green Invoice / Morning API. Authentication migrated to the OAuth 2.0 client-credentials flow against Morning's IdP host (https://api.morning.co/idp/v1/oauth/token for live, https://api.sandbox.morning.dev/idp/v1/oauth/token for sandbox), replacing the previous /v1/account/token header-based token flow. See Authentication.
   • Access tokens are cached in memory and refreshed automatically near expiry.
   • The public configure(...) interface is unchanged — api_key_id / api_key_secret are now your OAuth client id / client secret.
   • Dependencies slimmed to direct requirements (requests, lxml); the transitive deps (certifi / chardet / idna / urllib3) are no longer pinned by this library.

Author

Yaniv Pinchas

• github/yanivps