Account
Attributes
| Attribute | Type | Description | |
|---|---|---|---|
| subdomain | String | Name of the account | |
| plan | String | Subscription plan | |
| plan_price | Integer | Price of subscription plan | |
| plan_paid_users | Integer | Number of paid users | |
| invoice_email | String | Email for sending invoices | |
| phone | String | Phone number | |
| web | String | Account owner's website | |
| name | String | The name of the company | |
| full_name | String | Name of the account holder | |
| registration_no | String | Registration number | |
| vat_no | String | Tax identification number | |
| local_vat_no | String | Tax identification number for SK subject | |
| vat_mode | String | VAT mode Values: vat_payer,non_vat_payer,identified_person | |
| vat_price_mode | String | VAT calculation mode Values: with_vat,without_vat,numerical_with_vat,from_total_with_vatDefault: without_vat | |
| street | String | Street | |
| city | String | City | |
| zip | String | Postal code | |
| country | String | Country (ISO Code) | |
| currency | String | Default currency (ISO Code) | |
| unit_name | String | Default measurement unit | |
| vat_rate | Integer | Default VAT rate | |
| displayed_note | String | Invoice footer | |
| invoice_note | String | Text before lines | |
| due | Integer | Default number of days until an invoice becomes overdue | |
| invoice_language | String | Default invoice language Values: cz,sk,en,de,fr,it,es,ru,pl,hu,roDefault: cz | |
| invoice_payment_method | String | Default payment method Values: bank,card,cash,cod(cash on delivery),paypalWhen value is null, thenbankmethod is used. | |
| invoice_proforma | Boolean | Issue proforma by default | |
| invoice_hide_bank_account_for_payments | Array[String] | Hide bank account for payments Values: card,cash,cod(cash on delivery),paypalDefault: null | |
| fixed_exchange_rate | Boolean | Fixed exchange rate | |
| invoice_selfbilling | Boolean | Selfbilling enabled? | |
| default_estimate_type | String | Default estimate in English Values: estimate,quoteWhen value is null, thenestimateis used. | |
| send_overdue_email | Boolean | Send overdue reminders automatically? | |
| overdue_email_days | Integer | Days after the due date to send a automatic overdue reminder? | |
| send_repeated_reminders | Boolean | Send automatic overdue reminders repeatedly? | |
| send_invoice_from_proforma_email | Boolean | Send email automatically when proforma is paid? | |
| send_thank_you_email | Boolean | Send a thank you email when invoices is paid automatically? | |
| invoice_paypal | Boolean | PayPal enabled for all invoices? | |
| invoice_gopay | Boolean | GoPay enabled for all invoices? | |
| digitoo_enabled | Boolean | Digitoo service enabled? | |
| digitoo_auto_processing_enabled | Boolean | Digitoo service auto processing enabled | |
| digitoo_extractions_remaining | Integer | Number of remaining extractions by Digitoo service | |
| created_at | String | Account creation date | |
| updated_at | String | The date the account was last modified | 
- 
    Required attribute (must always be present).
- 
    Read-only attribute (cannot be changed).
- 
    Write-only attribute (will not be returned).
- 
    
    Unmarked attributes are optional and can be omitted during request.
Account Detail
Account detail is read-only, please use the web interface to make changes.
Request
GET
        https://app.fakturoid.cz/api/v3/accounts/{slug}/account.json
        
      Headers
| Name | Value | 
|---|---|
| User-Agent | YourApp (yourname@example.com) | 
URL Parameters
| Name | Description | Type | Example | 
|---|---|---|---|
| slug | Account name | String | applecorp | 
Response
Status
      200 OK
    Body
{
  "subdomain": "applecorp",
  "plan": "Na maximum",
  "plan_price": 460,
  "plan_paid_users": 0,
  "invoice_email": "testdph@test.cz",
  "phone": null,
  "web": null,
  "name": "Alexandr Hejsek",
  "full_name": null,
  "registration_no": "87654321",
  "vat_no": "CZ12121212",
  "local_vat_no": null,
  "vat_mode": "vat_payer",
  "vat_price_mode": "without_vat",
  "street": "Hopsinková 14",
  "city": "Praha",
  "zip": "10000",
  "country": "CZ",
  "currency": "CZK",
  "unit_name": "",
  "vat_rate": 21,
  "displayed_note": "",
  "invoice_note": "Fakturujeme Vám následující položky",
  "due": 14,
  "invoice_language": "cz",
  "invoice_payment_method": null,
  "invoice_proforma": false,
  "invoice_hide_bank_account_for_payments": null,
  "fixed_exchange_rate": false,
  "invoice_selfbilling": false,
  "default_estimate_type": null,
  "send_overdue_email": false,
  "overdue_email_days": 3,
  "send_repeated_reminders": false,
  "send_invoice_from_proforma_email": false,
  "send_thank_you_email": false,
  "invoice_paypal": false,
  "invoice_gopay": false,
  "digitoo_enabled": true,
  "digitoo_auto_processing_enabled": false,
  "digitoo_remaining_extractions": 44,
  "created_at": "2023-11-22T11:31:08.734+01:00",
  "updated_at": "2023-12-13T14:19:42.675+01:00"
}