Input Data Reference
Payee information represents the details of the entity that is issuing an invoice or quote. Unlike line item data, payee data is completely freeform and is passed unmodified to templates by the invoice generator. This means the information schema for payee data is prescribed entirely by the template, providing users with the freedom to incorporate any type of payee information they like when writing templates.
There is one special case where the invoice generator will inspect the contents of payee data and transform it. If the payee data includes two top-level keys named
international then the contents of the appropriate key for the current invoice type (domestic or international) will be passed to the template instead of the entire payee data. This functionality is provided as a convenience for users who commonly include different information about themselves depending on whether an invoice or quote is being issued to an overseas recipient (e.g. different company name for international trading, excluding the country from their address details in domestic communications, etc.)
|When using this interface:||Use this data format:|
|Command-line interface||YAML file|
|Python API||Mapping[str, Any]|
|gRPC Microservice||(coming soon)|
Note: the examples provided below follow the information schema prescribed by the default template that ships with the command-line interface for gen-invoice. Your own payee data may look very different if your template prescribes a different schema.
Example YAML file for use with the command-line interface:
Example data for use with the API: