invoice.get
Requests the details of one or more invoices. When no filter is set, it returns all invoices (ID-Array possible)
FILTER
| Tags | Description |
| INVOICE_ID |
Invoice ID |
| INVOICE_NUMBER |
Invoice number |
| INVOICE_TITLE |
Invoice title |
| CUSTOMER_ID |
A specific customer ID |
| MONTH |
Month |
| YEAR |
Jahr |
| START_DUE_DATE |
Invoices that are due after a specific date |
| END_DUE_DATE |
Invoices that are due before a specific date |
| TYPE |
Invoices of a specific type: outgoing | draft | credit |
RESPONSE
| Tags | Description |
| INVOICE_ID |
Invoice ID |
| INVOICE_EXT_UID |
An additional external invoice ID |
| STATUS |
Result of the action |
| TYPE |
Invoices of a specific type: outgoing | draft | credit |
| CUSTOMER_ID |
A specific customer ID |
| CUSTOMER_NUMBER |
The own customer number |
| CUSTOMER_COSTCENTER_ID |
ID of cost center |
| ORGANIZATION |
Company name [REQUIRED] when customer_type = business |
| SALUTATION |
Salutation: mr | mrs | family | "empty" |
| FIRST_NAME |
First name |
| LAST_NAME |
Last name |
| ADDRESS |
Address |
| ADDRESS_2 |
Address 2 |
| ZIPCODE |
ZIP code |
| CITY |
City |
| COMMENT |
Comment |
| PAYMENT_TYPE |
Payment type : 1 = transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = advanced payment | 6 = credit card |
| DAYS_FOR_PAYMENT |
Days until date of payment |
| BANK_NAME |
Bank name |
| BANK_ACCOUNT_NUMBER |
Bank account number |
| BANK_CODE |
Bank code |
| BANK_ACCOUNT_OWNER |
Bank account owner |
| BANK_IBAN |
IBAN |
| BANK_BIC |
BIC |
| AFFILIATE |
Affiliate |
| COUNTRY_CODE |
A country (ISO 3166 ALPHA-2) |
| VAT_ID |
VAT identification number |
| CURRENCY_CODE |
Currency code (ISO 4217) |
| TEMPLATE_ID |
Template ID |
| SUBSCRIPTION_ID |
Subscription ID |
| SUBSCRIPTION_INVOICE_COUNTER |
Counter for subscription invoice |
| INVOICE_NUMBER |
Invoice number |
| INVOICE_TITLE |
Invoice title |
| INTROTEXT |
Introduction text |
| PAID_DATE |
Date of received payment |
| IS_CANCELED |
Flag for canceled status: 0 = no | 1 = yes |
| INVOICE_DATE |
Invoice date |
| DUE_DATE |
Due date |
| DELIVERY_DATE |
Vesting period |
| CASH_DISCOUNT_PERCENT |
Cash discount in percent |
| CASH_DISCOUNT_DAYS |
Period for cash discount in days |
| SUB_TOTAL |
Net amount |
| VAT_TOTAL |
Input VAT amount |
| VAT_ITEMS |
List of all articles for one entity |
| ITEMS |
List of items |
| TOTAL |
Total |
| PAYMENT_INFO |
Information on payment |
| DOCUMENT_URL |
URL of a document |
| PAYPAL_URL |
Paypal custom payment link |
| ITEMS |
List of items |
| OUTSTANDING_AMOUNT |
Outstanding amount |
| SHIPMENT |
Shipment-ID |
| TRANSACTION_ID |
Transaction-ID |
invoice.create
Creates a new invoice.
DATA
| Tags | Description |
| CUSTOMER_ID Required |
A specific customer ID |
| INVOICE_EXT_UID |
An additional external invoice ID |
| CURRENCY_CODE |
Currency code (ISO 4217) |
| TEMPLATE_ID |
Template ID |
| INTROTEXT |
Introduction text |
| INVOICE_TITLE |
Invoice title |
| INVOICE_DATE |
Invoice date |
| DELIVERY_DATE |
Vesting period |
| CASH_DISCOUNT_PERCENT |
Cash discount in percent |
| CASH_DISCOUNT_DAYS |
Period for cash discount in days |
| EU_DELIVERY |
Flag for Intra-community delivery |
| INVOICE_ITEM_ID |
ID of invoice item |
| ARTICLE_NUMBER |
Article Number |
| DESCRIPTION |
Description |
| QUANTITY |
Amount |
| UNIT_PRICE |
Unit price |
| COMPLETE_GROSS |
Complete gross |
| SORT_ORDER |
Sort key of invoice line item |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
| INVOICE_ID |
Invoice ID |
invoice.update
Updates the information of an invoice.
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
| INVOICE_EXT_UID |
An additional external invoice ID |
| DELETE_EXISTING_ITEMS |
Flag for deleting existing Itels |
| INVOICE_EXT_UID |
An additional external invoice ID |
| CURRENCY_CODE |
Currency code (ISO 4217) |
| TEMPLATE_ID |
Template ID |
| INTROTEXT |
Introduction text |
| INVOICE_TITLE |
Invoice title |
| INVOICE_DATE |
Invoice date |
| DELIVERY_DATE |
Vesting period |
| CASH_DISCOUNT_DAYS |
Period for cash discount in days |
| CASH_DISCOUNT_PERCENT |
Cash discount in percent |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
invoice.delete
Deletes an invoice
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
item.get
Requests the items of an invoice.
FILTER
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
RESPONSE
| Tags | Description |
| INVOICE_ITEM_ID |
ID of invoice item |
| INVOICE_ID |
Invoice ID |
| COSTUMER_ID |
|
| ARTICLE_NUMBER |
Article Number |
| DESCRIPTION |
Description |
| QUANTITY |
Amount |
| UNIT_PRICE |
Unit price |
| VAT_PERCENT |
VAT in percent |
| VAT_VALUE |
VAT value |
| COMPLETE_NET |
Complete netto value |
| COMPLETE_GROSS |
Complete gross |
| CURRENCY_CODE |
Currency code (ISO 4217) |
| SORT_ORDER |
Sort key of invoice line item |
item.delete
Deletes an item of an invoice.
DATA
| Tags | Description |
| INVOICE_ITEM_ID Required |
ID of invoice item |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
invoice.complete
Set a draft invoice as final.
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
| PAYMENT_TOKEN |
customer reference token provided by payment gateway |
| PAYMENT_PROVIDER |
Name of integrated Payment Gateway |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
| INVOICE_NUMBER |
Invoice number |
| INVOICE_ID |
Invoice ID |
invoice.cancel
Cancel an invoice. When you cancel an invoice partially the 'DESCRIPTION' is required.
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
| DESCRIPTION |
Description |
| CANCELLATION_AMOUNT |
Partial cancellation amount |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
| INVOICE_ID |
Invoice ID |
invoice.sendbyemail
Send a completed invoice by e-mail. The invoice is attached as PDF file.
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
| RECIPIENT Required |
Recipient |
| SUBJECT Required |
Subject |
| MESSAGE Required |
eMail Body |
| RECEIPT_CONFIRMATION |
Flag for receiving acknowledgment of receipt |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
invoice.sendbypost
Send a completed invoice by post.
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
| REMAINING_CREDITS |
Remaining credits |
invoice.capture
Payment capture for an invoice
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
invoice.setpaid
Set an invoice as paid.
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
| PAID_DATE |
Date of received payment |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
| INVOICE_NUMBER |
Invoice number |
| COMMENT |
Comment |
invoice.getreminders
Request for all payment reminders belonging to an invoice
FILTER
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
RESPONSE
| Tags | Description |
| REMINDER_ID |
Reminder ID |
| INVOICE_ID |
Invoice ID |
| DUNNING_LEVEL |
Dunning Level |
| DUNNING_FEE |
Dunning Fee |
| DUNNING_DATE |
Dunning Date |
| INTROTEXT |
Introduction text |
| TEMPLATE_ID |
Template ID |
| CREATED |
Date of Creation |
| DAYS_FOR_PAYMENT |
Days until date of payment |
| DOCUMENT_URL |
URL of a document |
| DOWNLOAD_LINK |
Invoice download link |
invoice.correctvat2020
Correction of invoices with wrong vat due to vat reduction 2020
DATA
| Tags | Description |
| INVOICE_ID Required |
Invoice ID |
RESPONSE
| Tags | Description |
| STATUS |
Result of the action |
| INVOICE_ID_OLD |
Invoice ID of the invoice that needs to be corrected |
| INVOICE_ID_CORRECTED |
Invoice ID of the corrected invoice |
| SUBSCRIPTION_ID |
Subscription ID |
| TYPE |
Invoices of a specific type: outgoing | draft | credit |
| CUSTOMER_ID |
A specific customer ID |
| CUSTOMER_NUMBER |
The own customer number |
| CUSTOMER_COSTCENTER_ID |
ID of cost center |
| ORGANIZATION |
Company name [REQUIRED] when customer_type = business |
| SALUTATION |
Salutation: mr | mrs | family | "empty" |
| FIRST_NAME |
First name |
| LAST_NAME |
Last name |
| ADDRESS |
Address |
| ADDRESS_2 |
Address 2 |
| ZIPCODE |
ZIP code |
| CITY |
City |
| COMMENT |
Comment |
| PAYMENT_TYPE |
Payment type : 1 = transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = advanced payment | 6 = credit card |
| DAYS_FOR_PAYMENT |
Days until date of payment |
| BANK_NAME |
Bank name |
| BANK_ACCOUNT_NUMBER |
Bank account number |
| BANK_CODE |
Bank code |
| BANK_ACCOUNT_OWNER |
Bank account owner |
| BANK_IBAN |
IBAN |
| BANK_BIC |
BIC |
| AFFILIATE |
Affiliate |
| COUNTRY_CODE |
A country (ISO 3166 ALPHA-2) |
| VAT_ID |
VAT identification number |
| CURRENCY_CODE |
Currency code (ISO 4217) |
| TEMPLATE_ID |
Template ID |
| SUBSCRIPTION_INVOICE_COUNTER |
Counter for subscription invoice |
| INVOICE_NUMBER |
Invoice number |
| INVOICE_EXT_UID |
An additional external invoice ID |
| INVOICE_TITLE |
Invoice title |
| INTROTEXT |
Introduction text |
| OUTSTANDING_AMOUNT |
Outstanding amount |
| PAID_DATE |
Date of received payment |
| IS_CANCELED |
Flag for canceled status: 0 = no | 1 = yes |
| INVOICE_DATE |
Invoice date |
| DUE_DATE |
Due date |
| DELIVERY_DATE |
Vesting period |
| CASH_DISCOUNT_PERCENT |
Cash discount in percent |
| CASH_DISCOUNT_DAYS |
Period for cash discount in days |
| SUB_TOTAL |
Net amount |
| VAT_TOTAL |
Input VAT amount |