Belege
30 Endpunkte unter /api/rest/2.0
Receipts/documents (invoices, offers, orders, delivery notes, etc.)
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/receipts |
List all receipts |
POST |
/receipts |
Create a receipt |
POST |
/receipts/from-template |
Create a receipt from a template |
GET |
/receipts/{id} |
Get a receipt |
PATCH |
/receipts/{id} |
Partially update a receipt |
DELETE |
/receipts/{id} |
Delete a receipt |
POST |
/receipts/{id}/advance-payment |
Create advance payment invoice |
POST |
/receipts/{id}/assign-customer |
Assign to different customer |
POST |
/receipts/{id}/cancel |
Cancel receipt |
POST |
/receipts/{id}/copy |
Copy receipt |
POST |
/receipts/{id}/payment |
Record a payment |
GET |
/receipts/{id}/pdf |
Get receipt PDF |
POST |
/receipts/{id}/positions |
Add position to receipt |
GET |
/receipts/{id}/positions/export |
Export positions as AI-optimized JSON |
POST |
/receipts/{id}/positions/import |
Import positions from JSON |
DELETE |
/receipts/{id}/positions/{pos_id} |
Delete receipt position |
POST |
/receipts/{id}/pursue |
Pursue receipt to next type |
POST |
/receipts/{id}/recalculate |
Recalculate receipt |
GET |
/receipts/{id}/related |
Get related receipts |
POST |
/receipts/{id}/reload-customer |
Reload customer data |
POST |
/receipts/{id}/reload-prices |
Reload prices |
GET |
/receipts/{id}/status |
Get available status transitions |
POST |
/receipts/{id}/status |
Update receipt status |
GET |
/receipts/{id}/subscription |
Get subscription data |
PATCH |
/receipts/{id}/subscription |
Update subscription settings |
POST |
/receipts/{id}/subscription/execute |
Execute subscription |
POST |
/receipts/{id}/subscription/generate-draft |
Generate draft invoice from subscription |
GET |
/receipts/{id}/subscription/invoices |
List generated invoices |
POST |
/receipts/{id}/uncancel |
Uncancel receipt |
GET |
/receipts/{id}/xml |
Get receipt XML |
Felder
Diese Felder liefert die API zu Belege. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
chain |
string | Chain identifier linking related receipts |
customer_id |
integer | Customer ID |
business_id |
integer | Business unit ID (for multi-tenant setups) |
person_id |
integer | Contact person ID |
user_id |
integer | Assigned user ID |
sale_id |
integer | Linked sale/opportunity ID |
external_id |
string | External ID for integration |
receipttype |
string | Receipt type (token) |
subtype |
string | Receipt subtype |
receiptstatus |
string | Receipt status (token) |
receipt |
string | Receipt name/title |
receipt_number |
string | Receipt number |
reference |
string | Customer reference |
contract_reference |
string | Contract reference |
order_reference |
string | Order reference |
leitwegid |
string | Leitweg-ID (German e-invoicing) |
date |
date | Receipt date |
language |
string | Language code |
mwst |
string | Tax calculation mode (brutto/netto) |
taxtype |
string | Tax type |
subject |
string | Subject/header text |
closure |
string | Closing/footer text |
notice |
string | Internal notice |
salutation |
string | Salutation |
name |
string | Company or last name |
name_suffix |
string | Name suffix |
title |
string | Academic title |
first_name |
string | First name |
street |
string | Street address |
postal_code |
string | Postal code |
city |
string | City |
country_code |
string | ISO 3166-1 alpha-2 country code |
email |
Email address | |
has_delivery_address |
boolean | Has separate delivery address |
delivery_customer_id |
integer | Delivery address customer ID |
delivery_salutation |
string | Delivery address salutation |
delivery_name |
string | Delivery address name |
delivery_name_suffix |
string | Delivery address name suffix |
delivery_addition |
string | Delivery address addition |
delivery_title |
string | Delivery address academic title |
delivery_first_name |
string | Delivery address first name |
delivery_street |
string | Delivery address street |
delivery_postal_code |
string | Delivery address postal code |
delivery_city |
string | Delivery address city |
delivery_country |
string | Delivery address country name |
delivery_country_code |
string | Delivery address ISO country code |
has_billing_address |
boolean | Has separate billing address |
billing_customer_id |
integer | Billing address customer ID |
billing_salutation |
string | Billing address salutation |
billing_name |
string | Billing address name |
billing_name_suffix |
string | Billing address name suffix |
billing_addition |
string | Billing address addition |
billing_title |
string | Billing address academic title |
billing_first_name |
string | Billing address first name |
billing_street |
string | Billing address street |
billing_postal_code |
string | Billing address postal code |
billing_city |
string | Billing address city |
billing_country |
string | Billing address country name |
billing_country_code |
string | Billing address ISO country code |
total_gross |
number | Total gross amount |
total_net |
number | Total net amount |
total_outstanding |
number | Outstanding amount |
total_paid |
number | Paid amount |
total_cost |
number | Total cost |
payment |
string | Payment method |
paymentcondition_id |
integer | Payment condition ID |
term_of_payment |
date | Payment due date |
shipping_id |
integer | Shipping method ID |
delivery |
string | Delivery method |
delivery_date |
date | Delivery date |
performance_period_start |
date | Performance period start |
performance_period_end |
date | Performance period end |
hide_position_price |
boolean | Hide position prices on printout |
hide_total |
boolean | Hide total on printout |
status_changed_at |
date-time | Status change timestamp |
status_changed_by |
integer | User ID who changed status |
cancelled |
boolean | Is cancelled |
cancelled_at |
date | Cancellation date |
corrects_receipt_id |
integer | ID of receipt this corrects |
corrected_by_receipt_id |
integer | ID of receipt that corrected this |
subscription_receipt_id |
integer | Parent subscription receipt ID |
template_id |
integer | PDF template ID |
pricegroup_id |
integer | Price group ID |
bankdetails_id |
integer | Bank details ID |
stock_id |
integer | Stock/warehouse ID |
completion_date |
date | Completion date (only for receipttype=order) |
cancellationreason_id |
integer | Cancellation reason ID (only for receipttype=cancellationdocument) |
proforma_payable |
boolean | Is payable (only for receipttype=proformainvoice) |
template_name |
string | Template name (only for receipttype=template) |
template_full |
boolean | Full template mode (only for receipttype=template) |
template_pos |
boolean | Template positions mode (only for receipttype=template) |
template_leasingcondition_id |
integer | Leasing condition ID for template (only for receipttype=template) |
template_use_stock |
integer | Stock ID for template (only for receipttype=template) |
customer_number |
integer | Customer number (snapshot) |
creditor_number |
integer | Creditor number (snapshot) |
supplier_invoice_number |
string | Supplier invoice number (only for receipttype=incominginvoice) |
return_reason_id |
integer | Return reason ID (only for receipttype=returnnote) |
created_at |
date-time | Creation timestamp |
created_by |
integer | User ID who created the receipt |
updated_at |
date-time | Last modification timestamp |
updated_by |
integer | User ID who last modified |
content_changed_at |
date-time | Content change timestamp |
exported_at |
date-time | Export timestamp |
printed_at |
date-time | Print timestamp |
email_available |
boolean | Email sending available |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Nächster Schritt
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.