Module - Invoice Activities
Collection of functions related to a PDF Invoice.
Activities
Retrieve the invoice number based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getInvoiceNumber |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the invoice number. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the invoice number in the matching text. |
| Get Purchase Order Number (PDF) |
Retrieve the purchase order number based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getPurchaseOrderNumber |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the purchase order. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the purchase order number in the matching text. |
Retrieve the invoice date based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getInvoiceDate |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the invoice date. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the invoice date in the matching text. |
Retrieve the net amount based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getNetAmount |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the net amount. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the net amount in the matching text. |
Retrieve the total amount based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getTotalAmount |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the total amount. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the total amount in the matching text. |
Retrieve the IBAN from an invoice.
| Technical Name |
Type |
Minimal Agent Version |
| getIban |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the IBAN in the matching text. |
Retrieve the Value Added Tax (VAT) number based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getVatNumber |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the VAT. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the VAT number in the matching text. |
| Get Delivery Order Number (PDF) |
Retrieve the delivery order number based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getDeliveryOrderNumber |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the delivery order number. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the delivery order number in the matching text. |
| Get Customer Number (PDF) |
Retrieve the customer number based on the selected language.
| Technical Name |
Type |
Minimal Agent Version |
| getCustomerNumber |
synchronous
|
WIN-2.0.0, MAC-3.17
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| languages |
Array. |
optional
|
|
Provides the list of languages. For example, ['en','de'] for English and German. |
| additionalSearchWords |
Array. |
optional
|
|
Additional words that can be searched and after which you can extract the customer number. Use the "additionalSearchWords" identifier to extend the default dictionary if it's not working for all your documents. |
Output Parameters:
| Name |
Type |
Description |
| matchingString |
string |
Returns the customer number in the matching text. |
