https://github.com/jedi4ever/eventbrite-invoicer

Simple Ruby script to generate invoices from Eventbrite Events
https://github.com/jedi4ever/eventbrite-invoicer

Last synced: about 1 month ago
JSON representation

Simple Ruby script to generate invoices from Eventbrite Events

• Host: GitHub
• URL: https://github.com/jedi4ever/eventbrite-invoicer
• Owner: jedi4ever
• Created: 2012-12-02T13:14:09.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2020-03-28T12:21:38.000Z (over 4 years ago)
• Last Synced: 2023-04-10T14:22:06.599Z (over 1 year ago)
• Language: Ruby
• Size: 121 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Eventbrite-invoicer

Ruby script to read an eventbrite event and generate invoices for the attendees and optionally email them

This is was created out of the frustration that evenbrite doesn't generate invoices automagically.

## Install

    $ bundle install

## Config

### Credentials.yml

By default it wil look for a file with your eventbrite credentials in your local directory with the name 'credentials.yml'

You can generate them by visiting  and generating one. This will give you 'app_key' and 'user_key'

    ---

    :app_key: your-app-key-here

    :user_key: your-user-key-here

### Settings file

By default it wil look for a file with your eventbrite event/invoice settings in your local directory with the name 'settings.yml'

Adapt to your likings. 

Most likely you'll need to :

- find your eventid

- provide a logo file

        # Event that we used to generate it

        :event:

          :id: YOUREVENTID

        # Settings for the invoice

        :invoice:

          :prefix: F

          :start: 491

          :country: BE

          :locale: :nl

          :output_dir: .

          # passed to Payday::Config.default.

          :config:

            :invoice_logo: logo.png

            :company_name: Your company

            :company_details: |

              your company address

              email@yourcompany

              Tax: your taxnumber

            :date_format: '%D-%M-%Y'

            :currency: USD

            :page_size: A4

          # passed as fields to Payday

          :fields:

            :tax_rate: 0.21

            :tax_description: BTW 21%

            :notes: Paid with Paypal

            :company_name: Yourcompany name

            :description: Your event 2013

        # Setting for the email

        :email:

          :smtp_server: 127.0.0.1

          :smtp_port: 9025

          :from: [email protected]

          :testaddress: [email protected]

          :subject: Your event 2013

          :body: |

           Dear attendee,

           as requested, here is the invoice for your ticket(s) for Your event

           Hope you enjoyed the event!

           The organizers.

## Eventbrite setup

The script currently assumes that you have configured your event with the following 'questions':

- invoice_required: YES OR NO

- company_name: company where to send the invoice to (including Country)

- company_address: where to send the invoice to

- company_tax_number_vat : if applicable

## Run it

    Usage: eventbrite-invoicer [options]

       -h, --help                       Display this screen

       -c, --credentials FILENAME       Path to credentials yamlfile. Default: credentials.yml

       -s, --settings FILENAME          Path to settings yamlfile. Default: settings.yml

       -m, --mail OPTION                Option to mail. Default: none. Other options: "test"|"attendee"

## Big thanks to

- Payday gem : 

- Eventbrite: 

- Eventbrite-Client Gem: