GetMyInvoices¶
The GetMyInvoices modules allow you to watch, upload, retrieve, update, list, and delete the documents and companies in your GetMyInvoices account.
Getting Started with GetMyInvoices¶
Prerequisites
- A GetMyInvoices account
In order to use GetMyInvoices with Ibexa Connect, it is necessary to have a GetMyInvoices account. If you do not have one, you can create a GetMyInvoices account at getmyinvoices.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting GetMyInvoices to Ibexa Connect¶
To connect your GetMyInvoices account to Ibexa Connect you need to obtain the API Key from your GetMyInvoices account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your GetMyInvoices account and open your Dashboard.
2. Click Your Profile Icon > API Access > Add API Key. Enter the details for API Key and click Save.
3. Copy the API Key to your clipboard.
4. Go to Ibexa Connect and open the GetMyInvoices modules Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 3 and click Continue.
The connection has been established.
Triggers¶
Watch Documents¶
Runs when a new document is added to the account.
| Limit | Set the maximum number of documents Ibexa Connect should return during one scenario execution cycle. |
Watch Companies¶
Runs when a new company is added to the account.
| Limit | Set the maximum number of companies Ibexa Connect should return during one scenario execution cycle. |
Actions¶
Upload a New Document¶
Upload a new document to the account.
| File Name | Enter a new name for the document. |
| File Content | Enter the content details of the file. |
| Document Type | Enter the document type. For example, payment receipt, travel expense. |
| Document Number | Enter the document number on the document. |
| Document Date | Enter the date on which the document is created in the YYYY-MM-DD format. |
| Document Due Date | Enter the date on which the document is due for payment in the YYYY-MM-DD format. |
| Payment Method | Enter the payment method allowed. For example, cash, direct debit, credit, online transfer, PayPal, online payment, amazon pay, apple pay, google pay, external receivables management, cashbox, offsetting, |
| Payment Status | Enter the payment status. For example, Paid, Not Paid, Unknown. |
| Net Amount | Enter the amount to be paid. |
| Gross Amount | Enter the gross amount for the document. |
| Currency | Enter the currency applicable. For example, USD. |
| VAT | Enter the VAT amount applicable to the invoice. |
| Cash Discount Value | Enter the cash discount applicable to the invoice. |
Get a Document¶
Get one document from the account.
| Document Prim UID | Enter the unique Document PRIM UID whose details you want to retrieve. |
| Load Line Items | Select whether you want to retrieve line items related to the document. |
| Readable Text | Select whether you want only the readable content from the document. |
| Include Document | Select whether you want only basic data without the document content. |
Add a Custom Company¶
Adds a new custom company.
| Company Name | Enter a company name. |
| Company Country | Enter the country in which the company is located. |
| Company Tags | Add the tags for the company. |
| Company Street | Enter the street address of the company. |
| Company Zip | Enter the zip code of the region where the company is located. |
| Company City | Enter the company's city name. |
| Company Email | Enter the company's contact email address. |
| Company Phone | Enter the company's contact phone number. |
| Company Fax | Enter the company's fax number. |
| Company Tax Number | Enter the company's tax number. |
| Company VAT Number | Enter the company's VAT number. |
| Company VAT ID | Enter the company's VAT ID. |
| Company Commercial Register | Enter the company's registration number. |
| Company IBAN | Enter the company's International Bank Account Number (IBAN). |
| Company BIC | Enter the company's Business Identifier Code (BIC). |
| Company URL | Enter the company's website URL address. |
Update a Custom Company¶
Updates an existing custom company.
| Company ID | Select the Company ID whose details you want to update. |
| Company Name | Enter a company name. |
| Company Country | Enter the country in which the company is located. |
| Company Tags | Add the tags for the company. |
| Company Street | Enter the street address of the company. |
| Company Zip | Enter the zip code of the region where the company is located. |
| Company City | Enter the company's city name. |
| Company Email | Enter the company's contact email address. |
| Company Phone | Enter the company's contact phone number. |
| Company Fax | Enter the company's fax number. |
| Company Tax Number | Enter the company's tax number. |
| Company VAT Number | Enter the company's VAT number. |
| Company VAT ID | Enter the company's VAT ID. |
| Company Commercial Register | Enter the company's registration number. |
| Company IBAN | Enter the company's International Bank Account Number (IBAN). |
| Company BIC | Enter the company's Business Identifier Code (BIC). |
| Company URL | Enter the company's website's URL address. |
Delete a Custom Company¶
Deletes an existing custom company.
| Company ID | Enter the Company ID you want to delete. |
Searches¶
List Documents¶
Gets a list of all the documents from the account.
| Limit | Set the maximum number of documents Ibexa Connect should return during one scenario execution cycle. |
List Companies¶
Get a list of all companies from the account.
| Limit | Set the maximum number of companies Ibexa Connect should return during one scenario execution cycle. |
For more information, see GetMyInvoices API Documentation.