PATCH /api/account/recurring-receipts/{id}

patch/api/account/recurring-receipts/{id}

Example request

PATCH https://api.jupiter-erp.com/api/account/recurring-receipts/example-id

Code

curl -X PATCH 'https://api.jupiter-erp.com/api/account/recurring-receipts/example-id' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "receipt_type": "expense",
  "status": "active",
  "automatic_generation": true,
  "auto_approve": true,
  "contact_id": 0
}'

Parameters

Name	In	Required	Description
id	path	yes	—

Request body

Optional

ModelUpdateRecurringReceiptRequest

Partial update; all fields are optional.

Field

Type

Description

account_user_id

integer

—

auto_approve

boolean

—

automatic_generation

boolean

—

contact_id

integer

—

cost_center_id

integer

—

currency_code

string

—

due_days

integer

—

end_date

string

Date in Y-m-d format

exchange_rate

string

—

file_hash

string

Hash of a previously staged/uploaded document (see analyzeReceiptFile) to attach to the template.

first_period_start

string

Date in Y-m-d format

interval_amount

integer

—

interval_unit

string

day
week
month
year

issuer_reference

string

—

last_created_period_start

string

Date in Y-m-d format

name

string

—

positions

object[]

array

Elements

Field	Type	Description
booking_account_catalog_category_id	integer	Snapshot of catalog category id at save time
booking_account_catalog_category_name	string	Snapshot of catalog category name at save time
booking_account_catalog_id	integer	Selected platform booking account catalog entry
booking_account_source	string	Origin of a booking account selection string catalog custom manual
booking_account_type	string	Booking account catalog account type (Kontoart) string expense revenue tax other
chart_of_accounts	string	Chart of accounts snapshot string deu-skr03 deu-skr04
custom_ledger_account_id	integer	Selected tenant custom ledger account
depreciation_afa_ledger_account_name	string	Snapshot of the mapped AfA expense ledger account name
depreciation_afa_ledger_account_number	string	Snapshot of the mapped AfA expense ledger account
depreciation_method	string	Depreciation method when this position is treated as a fixed asset string linear gwg
depreciation_useful_life_years	integer	Useful life in years (required for linear depreciation)
description*	string	—
id	integer	Stable identifier of the persisted receipt position. Returned in responses; send it back on update to preserve position identity. Omit for newly added positions.
ledger_account_name	string	Ledger account name snapshot
ledger_account_number	string	Ledger account number (category / account)
position*	string	—
price_unit*	integer	Net line amount in cents (quantity is always 1)
tax_rate*	number	—

positions_price_input_mode

string

Whether position unit prices were entered as net or gross (display preference; price_unit is always stored net).

string

net
gross

project_id

integer

—

receipt_type

string

expense
income

reference

string

—

remove_file

boolean

When true, removes the currently attached document from the template.

service_order_id

integer

—

status

string

active
inactive

vat_rule_code

string

—

Example request

{
  "name": "string",
  "receipt_type": "expense",
  "status": "active",
  "automatic_generation": true,
  "auto_approve": true,
  "contact_id": 0
}

Responses

200OK

ModelRecurringReceipt

Recurring receipt (Dauerbeleg) template. Periodically generates receipts using the same fields as a regular receipt plus a service-contract-style interval schedule.

Field

Type

Description

account_user_id

integer

—

auto_approve*

boolean

When true, generated receipts are created with status "open" instead of "draft".

automatic_generation*

boolean

When true, the scheduler generates receipts automatically for due periods.

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

cost_center

object

Field	Type	Description
booking_account_number	integer	—
code	string	—
created_at	string (date-time)	Creation timestamp in ISO 8601 format.
id*	integer	—
name*	string	—
updated_at	string (date-time)	Last update timestamp in ISO 8601 format.

cost_center_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

currency_code*

string

—

due_days

integer

Offset in days added to the period start to compute the generated receipt's due date.

e_invoice

boolean

Whether the attached document is a ZUGFeRD e-invoice (detected from embedded XML in the PDF).

end_date

string

Date in Y-m-d format

exchange_rate*

string

Exchange rate to the EUR base currency. 1 for EUR.

file

object

Field

Type

Description

category

string

—

contact

object

Field

Type

Description

avatar

object

Field	Type	Description
url	string	—

name

string

—

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

created_by

object

Field	Type	Description
image_url	string	—
name	string	—

created_user_id

integer

—

date

string

—

deleted_at

string (date-time)

Creation timestamp in ISO 8601 format.

file_bytes

integer

—

file_ext

string

—

file_name*

string

—

file_type

string

—

folder

object

Field	Type	Description
name*	string	—
path	string	Full folder path from root to the file's folder (parent segments joined with " / ").

folder_id

integer

—

id*

integer

—

is_xml

boolean

—

new

boolean

—

notes

string

—

owner_entity_id

integer

ID of the owner entity within the account.

owner_entity_label

string

Cached display label of the linked owner entity (e.g. invoice number).

owner_entity_type

string

API entity type of the owner (e.g. Invoice, Receipt).

protected

boolean

—

reference_number

string

—

scanned_at

string

—

thumbnail_url

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

url

string

—

file_id

integer

Optional source document attached to the template. Copied to each generated receipt.

first_period_start*

string

Date in Y-m-d format

id*

integer

—

interval_amount*

integer

Number of interval units between periods (1-999).

interval_unit*

string

day
week
month
year

issuer_reference

string

—

last_created_period_start

string

Date in Y-m-d format

name*

string

Display name of the template.

next_run_date

string

Date in Y-m-d format

positions

object[]

array

Elements

Field	Type	Description
booking_account_catalog_category_id	integer	Snapshot of catalog category id at save time
booking_account_catalog_category_name	string	Snapshot of catalog category name at save time
booking_account_catalog_id	integer	Selected platform booking account catalog entry
booking_account_source	string	Origin of a booking account selection string catalog custom manual
booking_account_type	string	Booking account catalog account type (Kontoart) string expense revenue tax other
chart_of_accounts	string	Chart of accounts snapshot string deu-skr03 deu-skr04
custom_ledger_account_id	integer	Selected tenant custom ledger account
depreciation_afa_ledger_account_name	string	Snapshot of the mapped AfA expense ledger account name
depreciation_afa_ledger_account_number	string	Snapshot of the mapped AfA expense ledger account
depreciation_method	string	Depreciation method when this position is treated as a fixed asset string linear gwg
depreciation_useful_life_years	integer	Useful life in years (required for linear depreciation)
description*	string	—
id	integer	Stable identifier of the persisted receipt position. Returned in responses; send it back on update to preserve position identity. Omit for newly added positions.
ledger_account_name	string	Ledger account name snapshot
ledger_account_number	string	Ledger account number (category / account)
position*	string	—
price_unit*	integer	Net line amount in cents (quantity is always 1)
tax_rate*	number	—

positions_price_input_mode

string

Whether position unit prices were entered as net or gross (display preference; price_unit is always stored net).

string

net
gross

project

object

Field

Type

Description

account_user

object

Field

Type

Description

abilities

string[]

Ability strings for this account user. Included when listing or getting users (admin editing). Omitted in embedded contexts (e.g. documents, projects, service orders) to avoid leaking permission data.

array

Elements

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Field	Type	Description
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

account_user_id

integer

—

contact

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

description

string

—

end_date

string

—

formatted_number*

string

Display number (account format), unique per account

hex_color

string

—

id*

integer

—

name*

string

—

number*

integer

Sequential project number per account (internal)

start_date

string

—

status

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

project_id

integer

—

receipt_type*

string

expense
income

receipts_count

integer

Number of receipts generated from this template. Present when the count was loaded.

reference

string

—

service_order_id

integer

—

status*

string

active
inactive

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_rule_code

string

—

Example response

{
  "id": 0,
  "name": "string",
  "receipt_type": "expense",
  "status": "active",
  "automatic_generation": true,
  "auto_approve": true,
  "currency_code": "string",
  "exchange_rate": "string",
  "first_period_start": "2025-01-14T00:00:00.000Z",
  "interval_amount": 0,
  "interval_unit": "day"
}

Recurring Receipts

Questions about integration?