API Docs
AbsenceAbsence Additional ContingentAbsence ContingentAccountAccountingAccounting ContactAdded ValueAsset AccountAttachmentAttendanceAuthBank AccountCatalogCommissionContactCraftCredit InvoiceCreditorCustom FilterCustom ReportCustomerCustomFieldDashboardDebitorEmailEmployment ContractEstimateFinanceFinance JournalFinance Journal PositionsFinDocCategoryFollowupForecastGeneral InfoHolidayIntegrationsInvoiceJobJob TasksLogin MethodMeMetricsOffice LocationOrder ConfirmationOrganisationPaymentPersonProcedureProcedure ViewPurchase InvoicePurchase OrderReportResource PlanningSnippetTargetTeamTemplateTimeUserUser CraftUser GroupUser Group ActionsUser Group UsersWorkPattern
Modelobject

app.FinanceJournal

Properties

app.FinanceJournalobject
accounting_contact
app.AccountingContact
No description.
accounting_contact_id
integer
No description.
accounting_lines
array<object>
No description.
Inspect array<object>
Array item type
Map values
additionalProperty
string
No description.
add_estimate_of_cost
string
No description.
address
app.ContactAddress
No description.
address_id
integer
No description.
agency_service_total
number
No description.
akonto_of
integer
No description.
allowance_days
integer
No description.
allowance_mode
app.AllowanceMode
No description.
allowance_percentage
number
No description.
allowance_total
number
No description.
asset_account
string
No description.
blocked
string
TODO: still in use?
categories
array<app.FinDocCategoryToDocument>
No description.
collapse_position_groups
integer
No description.
created_at
integer
No description.
currency
app.Currency
No description.
currency_gross_total
integer
No description.
custom_fields
array<app.CustomFields>
Must be fetched manually with the type of the journal
date_customer_approval
integer
No description.
date_delivery
integer
No description.
date_document
integer
No description.
date_due
integer
No description.
date_dunning
integer
No description.
date_expire
integer
No description.
date_final_notice
integer
No description.
date_inspection
integer
No description.
date_payment
integer
No description.
date_received
integer
No description.
date_reminder
integer
No description.
delivery_address
string
No description.
description
string
No description.
display_vat_in_positions
boolean
No description.
document_type_label
string
No description.
expense_type
string
used for purchase orders, it determins the expense type for the supplier invoice that (later) is associated with it
external
array<app.FinanceJournalExternal>
No description.
external_service_total
number
No description.
external_services
array<app.ExternalService>
No description.
foot_note
string
No description.
gross_total
number
No description.
head_note
string
No description.
head_note_due_notice
string
No description.
head_note_dunning
string
No description.
head_note_final_notice
string
No description.
hide_document_totals
boolean
No description.
hide_external_services
boolean
No description.
hide_group_totals
boolean
No description.
hide_groups
boolean
No description.
hide_position_amount_and_unit
boolean
No description.
hide_position_group_header
boolean
No description.
hide_position_totals
boolean
No description.
hide_position_value_per_unit
boolean
No description.
hide_positions
boolean
No description.
id
integer
No description.
identification_code
string
No description.
is_partial_invoice
boolean
No description.
job_id
integer
No description.
job_id_suggestions
string
No description.
lang
string
No description.
markup
integer
No description.
markup_label
string
No description.
modified_at
integer
No description.
name
string
No description.
net_total
number
No description.
organisation
app.ContactOrganisation
No description.
organisation_id
integer
No description.
page_break_before_foot_note
boolean
No description.
page_break_before_head_note
boolean
No description.
payed_amount_credit
number
No description.
payed_amount_debit
number
No description.
payment_approval_user_id
integer
No description.
payment_method
app.PaymentMethod
No description.
payment_method_id
integer
No description.
payment_status
app.FinanceJournalPaymentStatus
No description.
payments
array<app.Payment>
No description.
period_of_performance_end
integer
No description.
period_of_performance_start
integer
No description.
periodical_payment_interval
number
No description.
periodical_payment_label
string
No description.
person
app.ContactPerson
No description.
person_id
integer
No description.
position_order_number_display_type
string
No description.
positions
array<app.FinanceJournalPosition>
No description.
print_version_show_period_of_performance
integer
No description.
probability
app.ProbabilityType
No description.
purchase_invoice_attachment
app.Attachment
No description.
purchase_invoice_identifier
string
No description.
purchase_order_id
integer
No description.
purchaser_address
string
No description.
recipient_addr1
string
No description.
recipient_addr2
string
No description.
recipient_address
string
No description.
recipient_city
string
No description.
recipient_country_code
app.CountryCode
No description.
recipient_email
string
No description.
recipient_organisation_name
string
No description.
recipient_person_first_name
string
No description.
recipient_person_last_name
string
No description.
recipient_zip
string
No description.
sender
string
No description.
show_commissions_in_group
boolean
No description.
show_commissions_in_position
boolean
No description.
show_commissions_in_total
boolean
No description.
show_signature_line
boolean
No description.
show_vat
boolean
No description.
small_job
app.SmallJob
No description.
small_user
app.SmallUser
No description.
stationary_id
integer
No description.
status
app.FinanceJournalStatus
No description.
storno_of
integer
No description.
subscribed_users
array<app.SmallUser>
No description.
tab_left
string
No description.
tab_right
string
No description.
token
string
No description.
type
app.ModeType
No description.
user_id
integer
No description.
vat
types.Vat
No description.
vat_id
string
No description.

Example

JSON
{
  "accounting_contact": {...},
  "accounting_contact_id": 123,
  "accounting_lines": [
    {...}
  ],
  "add_estimate_of_cost": "string",
  "address": {...},
  "address_id": 123,
  "agency_service_total": 123.45,
  "akonto_of": 123,
  "allowance_days": 123,
  "allowance_mode": "none",
  "allowance_percentage": 123.45,
  "allowance_total": 123.45,
  "asset_account": "string",
  "blocked": "string",
  "categories": [
    {...}
  ],
  "collapse_position_groups": 123,
  "created_at": 123,
  "currency": "AED",
  "currency_gross_total": 123,
  "custom_fields": [
    {...}
  ],
  "date_customer_approval": 123,
  "date_delivery": 123,
  "date_document": 123,
  "date_due": 123,
  "date_dunning": 123,
  "date_expire": 123,
  "date_final_notice": 123,
  "date_inspection": 123,
  "date_payment": 123,
  "date_received": 123,
  "date_reminder": 123,
  "delivery_address": "string",
  "description": "string",
  "display_vat_in_positions": true,
  "document_type_label": "string",
  "expense_type": "string",
  "external": [
    {...}
  ],
  "external_service_total": 123.45,
  "external_services": [
    {...}
  ],
  "foot_note": "string",
  "gross_total": 123.45,
  "head_note": "string",
  "head_note_due_notice": "string",
  "head_note_dunning": "string",
  "head_note_final_notice": "string",
  "hide_document_totals": true,
  "hide_external_services": true,
  "hide_group_totals": true,
  "hide_groups": true,
  "hide_position_amount_and_unit": true,
  "hide_position_group_header": true,
  "hide_position_totals": true,
  "hide_position_value_per_unit": true,
  "hide_positions": true,
  "id": 123,
  "identification_code": "string",
  "is_partial_invoice": true,
  "job_id": 123,
  "job_id_suggestions": "string",
  "lang": "string",
  "markup": 123,
  "markup_label": "string",
  "modified_at": 123,
  "name": "string",
  "net_total": 123.45,
  "organisation": {...},
  "organisation_id": 123,
  "page_break_before_foot_note": true,
  "page_break_before_head_note": true,
  "payed_amount_credit": 123.45,
  "payed_amount_debit": 123.45,
  "payment_approval_user_id": 123,
  "payment_method": {...},
  "payment_method_id": 123,
  "payment_status": "offen",
  "payments": [
    {...}
  ],
  "period_of_performance_end": 123,
  "period_of_performance_start": 123,
  "periodical_payment_interval": 123.45,
  "periodical_payment_label": "string",
  "person": {...},
  "person_id": 123,
  "position_order_number_display_type": "string",
  "positions": [
    {...}
  ],
  "print_version_show_period_of_performance": 123,
  "probability": "sicher",
  "purchase_invoice_attachment": {...},
  "purchase_invoice_identifier": "string",
  "purchase_order_id": 123,
  "purchaser_address": "string",
  "recipient_addr1": "string",
  "recipient_addr2": "string",
  "recipient_address": "string",
  "recipient_city": "string",
  "recipient_country_code": "AF",
  "recipient_email": "string",
  "recipient_organisation_name": "string",
  "recipient_person_first_name": "string",
  "recipient_person_last_name": "string",
  "recipient_zip": "string",
  "sender": "string",
  "show_commissions_in_group": true,
  "show_commissions_in_position": true,
  "show_commissions_in_total": true,
  "show_signature_line": true,
  "show_vat": true,
  "small_job": {...},
  "small_user": {...},
  "stationary_id": 123,
  "status": "wartet auf Freigabe",
  "storno_of": 123,
  "subscribed_users": [
    {...}
  ],
  "tab_left": "string",
  "tab_right": "string",
  "token": "string",
  "type": "kv",
  "user_id": 123,
  "vat": {...},
  "vat_id": "string"
}