PATCHAccount

/accounts/{id}

Update an account partially

get string by ID

Base URL
https://<tenant>.dieagenturverwaltung.de/api/v2
Required Security
ApiKeyAuth (Authorization: Session Token)
Produces
application/json

Request

Path Parameters

NameTypeRequiredDescription
idintegerYesAccount ID

Body Parameters

NameTypeRequiredDescription
accountapp.AccountYesPartial Account

Parameter Models

Inspect object parameters and nested model references without loading the full Swagger file in the browser.

accountBody parameterapp.Account
accumulated_agency_service
string
No description.
accumulated_budget
string
No description.
accumulated_external_service
string
No description.
address
No description.
address_id
integer
No description.
asp_id
integer
No description.
contract_budget_agency_service
number
No description.
contract_budget_external_service
number
No description.
contract_type
No description.
custom_fields
No description.
customer
No description.
customer_id
integer
No description.
date_contract_period_end
integer
No description.
date_contract_period_start
integer
No description.
date_created
integer
No description.
date_modified
integer
No description.
description
string
No description.
disable_authentication
boolean
No description.
due_days
integer
No description.
footNote_akonto
string
No description.
footNote_dueNotice
string
No description.
footNote_dunning
string
No description.
footNote_finalNotice
string
No description.
footNote_gutschr
string
No description.
footNote_kv
string
No description.
footNote_purchase_order
string
No description.
footNote_rg_aus
string
No description.
headNote_akonto
string
No description.
headNote_dueNotice
string
No description.
headNote_dunning
string
No description.
headNote_finalNotice
string
No description.
headNote_gutschr
string
No description.
headNote_kv
string
No description.
headNote_purchase_order
string
No description.
headNote_rg_aus
string
No description.
hide_external_services
boolean
No description.
id
integer
No description.
identification_code
string
No description.
invoice_address
No description.
invoice_address_id
integer
No description.
invoice_email
string
No description.
invoice_organisation
No description.
invoice_organisation_id
integer
No description.
invoice_person
No description.
invoice_person_id
integer
No description.
jobs
array<app.Job>
No description.
lang
string
No description.
name
string
No description.
organisation
No description.
organisation_id
integer
No description.
person
No description.
person_id
integer
No description.
small_customer
No description.
stage_of_completion
number
No description.
stationary_id
integer
No description.
status
No description.
tabLeft_akonto
string
No description.
tabLeft_dueNotice
string
No description.
tabLeft_dunning
string
No description.
tabLeft_finalNotice
string
No description.
14 additional properties are hidden on this page to keep the endpoint view small. Open the model page for a focused view.
cURL
curl -X PATCH 'https://<tenant>.dieagenturverwaltung.de/api/v2/accounts/123' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "accumulated_agency_service": "string",
  "accumulated_budget": "string",
  "accumulated_external_service": "string",
  "address": {},
  "address_id": 123,
  "asp_id": 123,
  "contract_budget_agency_service": 123.45,
  "contract_budget_external_service": 123.45,
  "contract_type": "Honorarvertrag",
  "custom_fields": [
    {}
  ],
  "customer": {},
  "customer_id": 123,
  "date_contract_period_end": 123,
  "date_contract_period_start": 123,
  "date_created": 123,
  "date_modified": 123,
  "description": "string",
  "disable_authentication": true,
  "due_days": 123,
  "footNote_akonto": "string",
  "footNote_dueNotice": "string",
  "footNote_dunning": "string",
  "footNote_finalNotice": "string",
  "footNote_gutschr": "string",
  "footNote_kv": "string",
  "footNote_purchase_order": "string",
  "footNote_rg_aus": "string",
  "headNote_akonto": "string",
  "headNote_dueNotice": "string",
  "headNote_dunning": "string",
  "headNote_finalNotice": "string",
  "headNote_gutschr": "string",
  "headNote_kv": "string",
  "headNote_purchase_order": "string",
  "headNote_rg_aus": "string",
  "hide_external_services": true,
  "id": 123,
  "identification_code": "string",
  "invoice_address": {},
  "invoice_address_id": 123,
  "invoice_email": "string",
  "invoice_organisation": {},
  "invoice_organisation_id": 123,
  "invoice_person": {},
  "invoice_person_id": 123,
  "jobs": [
    {}
  ],
  "lang": "string",
  "name": "string",
  "organisation": {},
  "organisation_id": 123,
  "person": {},
  "person_id": 123,
  "small_customer": {},
  "stage_of_completion": 123.45,
  "stationary_id": 123,
  "status": "aktiv",
  "tabLeft_akonto": "string",
  "tabLeft_dueNotice": "string",
  "tabLeft_dunning": "string",
  "tabLeft_finalNotice": "string",
  "tabLeft_gutschr": "string",
  "tabLeft_kv": "string",
  "tabLeft_purchase_order": "string",
  "tabLeft_rg_aus": "string",
  "tabRight_akonto": "string",
  "tabRight_dueNotice": "string",
  "tabRight_dunning": "string",
  "tabRight_finalNotice": "string",
  "tabRight_gutschr": "string",
  "tabRight_kv": "string",
  "tabRight_purchase_order": "string",
  "tabRight_rg_aus": "string",
  "user_id": 123,
  "valid_days": 123
}'
Request Body (application/json)
{
  "accumulated_agency_service": "string",
  "accumulated_budget": "string",
  "accumulated_external_service": "string",
  "address": {...},
  "address_id": 123,
  "asp_id": 123,
  "contract_budget_agency_service": 123.45,
  "contract_budget_external_service": 123.45,
  "contract_type": "Honorarvertrag",
  "custom_fields": [
    {...}
  ],
  "customer": {...},
  "customer_id": 123,
  "date_contract_period_end": 123,
  "date_contract_period_start": 123,
  "date_created": 123,
  "date_modified": 123,
  "description": "string",
  "disable_authentication": true,
  "due_days": 123,
  "footNote_akonto": "string",
  "footNote_dueNotice": "string",
  "footNote_dunning": "string",
  "footNote_finalNotice": "string",
  "footNote_gutschr": "string",
  "footNote_kv": "string",
  "footNote_purchase_order": "string",
  "footNote_rg_aus": "string",
  "headNote_akonto": "string",
  "headNote_dueNotice": "string",
  "headNote_dunning": "string",
  "headNote_finalNotice": "string",
  "headNote_gutschr": "string",
  "headNote_kv": "string",
  "headNote_purchase_order": "string",
  "headNote_rg_aus": "string",
  "hide_external_services": true,
  "id": 123,
  "identification_code": "string",
  "invoice_address": {...},
  "invoice_address_id": 123,
  "invoice_email": "string",
  "invoice_organisation": {...},
  "invoice_organisation_id": 123,
  "invoice_person": {...},
  "invoice_person_id": 123,
  "jobs": [
    {...}
  ],
  "lang": "string",
  "name": "string",
  "organisation": {...},
  "organisation_id": 123,
  "person": {...},
  "person_id": 123,
  "small_customer": {...},
  "stage_of_completion": 123.45,
  "stationary_id": 123,
  "status": "aktiv",
  "tabLeft_akonto": "string",
  "tabLeft_dueNotice": "string",
  "tabLeft_dunning": "string",
  "tabLeft_finalNotice": "string",
  "tabLeft_gutschr": "string",
  "tabLeft_kv": "string",
  "tabLeft_purchase_order": "string",
  "tabLeft_rg_aus": "string",
  "tabRight_akonto": "string",
  "tabRight_dueNotice": "string",
  "tabRight_dunning": "string",
  "tabRight_finalNotice": "string",
  "tabRight_gutschr": "string",
  "tabRight_kv": "string",
  "tabRight_purchase_order": "string",
  "tabRight_rg_aus": "string",
  "user_id": 123,
  "valid_days": 123
}

Responses

200OK
app.Accountapplication/json
Example
{
  "accumulated_agency_service": "string",
  "accumulated_budget": "string",
  "accumulated_external_service": "string",
  "address": {...},
  "address_id": 123,
  "asp_id": 123,
  "contract_budget_agency_service": 123.45,
  "contract_budget_external_service": 123.45,
  "contract_type": "Honorarvertrag",
  "custom_fields": [
    {...}
  ],
  "customer": {...},
  "customer_id": 123,
  "date_contract_period_end": 123,
  "date_contract_period_start": 123,
  "date_created": 123,
  "date_modified": 123,
  "description": "string",
  "disable_authentication": true,
  "due_days": 123,
  "footNote_akonto": "string",
  "footNote_dueNotice": "string",
  "footNote_dunning": "string",
  "footNote_finalNotice": "string",
  "footNote_gutschr": "string",
  "footNote_kv": "string",
  "footNote_purchase_order": "string",
  "footNote_rg_aus": "string",
  "headNote_akonto": "string",
  "headNote_dueNotice": "string",
  "headNote_dunning": "string",
  "headNote_finalNotice": "string",
  "headNote_gutschr": "string",
  "headNote_kv": "string",
  "headNote_purchase_order": "string",
  "headNote_rg_aus": "string",
  "hide_external_services": true,
  "id": 123,
  "identification_code": "string",
  "invoice_address": {...},
  "invoice_address_id": 123,
  "invoice_email": "string",
  "invoice_organisation": {...},
  "invoice_organisation_id": 123,
  "invoice_person": {...},
  "invoice_person_id": 123,
  "jobs": [
    {...}
  ],
  "lang": "string",
  "name": "string",
  "organisation": {...},
  "organisation_id": 123,
  "person": {...},
  "person_id": 123,
  "small_customer": {...},
  "stage_of_completion": 123.45,
  "stationary_id": 123,
  "status": "aktiv",
  "tabLeft_akonto": "string",
  "tabLeft_dueNotice": "string",
  "tabLeft_dunning": "string",
  "tabLeft_finalNotice": "string",
  "tabLeft_gutschr": "string",
  "tabLeft_kv": "string",
  "tabLeft_purchase_order": "string",
  "tabLeft_rg_aus": "string",
  "tabRight_akonto": "string",
  "tabRight_dueNotice": "string",
  "tabRight_dunning": "string",
  "tabRight_finalNotice": "string",
  "tabRight_gutschr": "string",
  "tabRight_kv": "string",
  "tabRight_purchase_order": "string",
  "tabRight_rg_aus": "string",
  "user_id": 123,
  "valid_days": 123
}
400Bad Request
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
404Not Found
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
500Internal Server Error
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}