@ampeco/public-api-mcp 3.251.10 → 3.252.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1631,9 +1631,16 @@
1631
1631
  "type": "string",
1632
1632
  "enum": [
1633
1633
  "corporate_billing_policy_inactive",
1634
+ "corporate_billing_limit_exceeded",
1635
+ "corporate_billing_currency_mismatch",
1636
+ "corporate_billing_charger_type_not_covered",
1637
+ "corporate_billing_location_not_covered",
1638
+ "corporate_billing_cross_operator_not_opted_in",
1639
+ "corporate_billing_exchange_rate_unavailable",
1640
+ "corporate_billing_ad_hoc_tariff_unavailable",
1634
1641
  "cannot_use_payment_method"
1635
1642
  ],
1636
- "description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method."
1643
+ "description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
1637
1644
  }
1638
1645
  }
1639
1646
  }
@@ -3911,9 +3918,16 @@
3911
3918
  "type": "string",
3912
3919
  "enum": [
3913
3920
  "corporate_billing_policy_inactive",
3921
+ "corporate_billing_limit_exceeded",
3922
+ "corporate_billing_currency_mismatch",
3923
+ "corporate_billing_charger_type_not_covered",
3924
+ "corporate_billing_location_not_covered",
3925
+ "corporate_billing_cross_operator_not_opted_in",
3926
+ "corporate_billing_exchange_rate_unavailable",
3927
+ "corporate_billing_ad_hoc_tariff_unavailable",
3914
3928
  "cannot_use_payment_method"
3915
3929
  ],
3916
- "description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method."
3930
+ "description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
3917
3931
  }
3918
3932
  }
3919
3933
  }
@@ -13990,14 +14004,16 @@
13990
14004
  "description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
13991
14005
  },
13992
14006
  "restrictionCause": {
13993
- "description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
14007
+ "description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n- **cross_operator_not_opted_in**: The service operator and the corporate account home operator have not both opted in to cross-operator corporate billing\n- **exchange_rate_unavailable**: No exchange rate was available to convert the session currency into the corporate account billing currency\n",
13994
14008
  "type": "string",
13995
14009
  "enum": [
13996
14010
  "partner",
13997
14011
  "country",
13998
14012
  "location",
13999
14013
  "location_tag",
14000
- "roaming"
14014
+ "roaming",
14015
+ "cross_operator_not_opted_in",
14016
+ "exchange_rate_unavailable"
14001
14017
  ]
14002
14018
  },
14003
14019
  "breakdown": {
@@ -79331,28 +79347,465 @@
79331
79347
  }
79332
79348
  }
79333
79349
  },
79334
- "422": {
79335
- "schema": {
79336
- "type": "object",
79337
- "required": [
79338
- "message"
79339
- ],
79340
- "properties": {
79341
- "message": {
79342
- "type": "string"
79343
- },
79344
- "errors": {
79345
- "type": "object",
79346
- "additionalProperties": {
79347
- "type": "array",
79348
- "items": {
79349
- "type": "string"
79350
- }
79351
- }
79352
- }
79353
- }
79354
- }
79355
- },
79350
+ "422": {
79351
+ "schema": {
79352
+ "type": "object",
79353
+ "required": [
79354
+ "message"
79355
+ ],
79356
+ "properties": {
79357
+ "message": {
79358
+ "type": "string"
79359
+ },
79360
+ "errors": {
79361
+ "type": "object",
79362
+ "additionalProperties": {
79363
+ "type": "array",
79364
+ "items": {
79365
+ "type": "string"
79366
+ }
79367
+ }
79368
+ }
79369
+ }
79370
+ }
79371
+ },
79372
+ "429": {
79373
+ "schema": {
79374
+ "type": "object",
79375
+ "properties": {
79376
+ "message": {
79377
+ "type": "string"
79378
+ }
79379
+ }
79380
+ }
79381
+ }
79382
+ },
79383
+ "ocpiCommandsListing": {
79384
+ "200": {
79385
+ "schema": {
79386
+ "type": "object",
79387
+ "properties": {
79388
+ "data": {
79389
+ "type": "array",
79390
+ "items": {
79391
+ "description": "A command received from an eMSP over OCPI and the result returned for it.",
79392
+ "type": "object",
79393
+ "properties": {
79394
+ "id": {
79395
+ "type": "integer",
79396
+ "readOnly": true,
79397
+ "description": "Identifier of the command."
79398
+ },
79399
+ "type": {
79400
+ "description": "The command the roaming partner sent:\n- **cancel_reservation**: Cancel a reservation\n- **reserve_now**: Reserve an EVSE\n- **start_session**: Start a charging session\n- **stop_session**: Stop a charging session\n- **unlock_connector**: Unlock a connector\n- **change_availability**: Change the availability of an EVSE (protocol extension)\n- **get_diagnostics**: Request charge point diagnostics (protocol extension)\n- **reset_evse**: Reset an EVSE (protocol extension)\n- **unknown**: Any command outside this set\n",
79401
+ "type": "string",
79402
+ "enum": [
79403
+ "cancel_reservation",
79404
+ "reserve_now",
79405
+ "start_session",
79406
+ "stop_session",
79407
+ "unlock_connector",
79408
+ "change_availability",
79409
+ "get_diagnostics",
79410
+ "reset_evse",
79411
+ "unknown"
79412
+ ]
79413
+ },
79414
+ "result": {
79415
+ "description": "The result the platform returned to the roaming partner:\n- **accepted**: The command was accepted\n- **rejected**: The command was rejected\n- **not_supported**: The command is not supported for this charge point\n- **timeout**: The charge point did not respond in time\n- **unknown_session**: The referenced session is unknown\n- **failed**: The command failed during execution\n- **evse_occupied**: The EVSE is already in use\n- **evse_inoperative**: The EVSE is not operational\n- **unknown_reservation**: The referenced reservation is unknown\n- **canceled_reservation**: The reservation was cancelled\n- **unknown**: Any result outside the OCPI result set\n",
79416
+ "type": "string",
79417
+ "enum": [
79418
+ "accepted",
79419
+ "rejected",
79420
+ "not_supported",
79421
+ "timeout",
79422
+ "unknown_session",
79423
+ "failed",
79424
+ "evse_occupied",
79425
+ "evse_inoperative",
79426
+ "unknown_reservation",
79427
+ "canceled_reservation",
79428
+ "unknown"
79429
+ ]
79430
+ },
79431
+ "failureReason": {
79432
+ "description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**: The corporate account limit is reached\n- **corporate_billing_currency_mismatch**: The session currency differs from the corporate billing currency\n- **corporate_billing_cross_operator_not_opted_in**: The operator serving the session is not opted in to the partner's cross-operator corporate billing\n- **corporate_billing_exchange_rate_unavailable**: No exchange rate is available to convert the session amount into the corporate billing currency\n- **corporate_billing_charger_type_not_covered**: The charger type is not covered by the corporate billing policy\n- **corporate_billing_partner_not_covered**: The partner is not covered by the corporate billing policy\n- **corporate_billing_country_not_covered**: The country is not covered by the corporate billing policy\n- **corporate_billing_location_not_covered**: The location is not covered by the corporate billing policy\n- **corporate_billing_location_tag_not_covered**: The location tag is not covered by the corporate billing policy\n- **corporate_billing_roaming_not_covered**: Roaming is not covered by the corporate billing policy\n\nTariffs:\n- **tariff_charging_not_allowed**: The applicable tariff does not allow charging\n- **no_tariff_group_configured**: No tariff group is configured for the charge point\n- **tariff_resolution_failed**: No tariff could be resolved for the requested charging\n\nCharge point and EVSE state:\n- **evse_disabled**: The requested EVSE is disabled\n- **evse_out_of_order**: The requested EVSE is out of order\n- **evse_occupied**: The requested EVSE is already in use\n- **evse_inoperative**: The requested EVSE is not operational\n- **evse_has_queued_reservations**: The requested EVSE has queued reservations\n- **ev_not_connected_to_evse**: No vehicle is connected to the requested EVSE\n- **session_already_running**: A charging session is already running\n\nRFID tokens:\n- **rfid_tag_expired**: The RFID tag has expired\n- **rfid_tag_disabled**: The RFID tag is disabled\n- **rfid_tag_suspended**: The RFID tag is suspended\n- **rfid_charge_point_scope_mismatch**: The RFID tag may not be used on the requested charge point\n\nRoaming setup:\n- **ocpi_roaming_not_setup**: The OCPI roaming configuration needed to serve the command is missing\n- **internal_roaming_not_setup**: The internal roaming configuration needed to serve the command is missing\n\nCommand execution:\n- **remote_start_failed**: The charge point refused or failed the remote start\n- **rejected**: The charge point rejected the command\n- **failed**: The command failed while it was being executed\n- **not_supported**: The command is not supported for the requested charge point\n- **timeout**: The charge point did not respond within the command timeout\n- **command_expired**: The command was no longer valid by the time it could be executed\n- **unknown_session**: The referenced charging session is unknown to the platform\n- **unknown_reservation**: The referenced reservation is unknown to the platform\n- **canceled_reservation**: The reservation was cancelled instead of being honoured\n",
79433
+ "type": "string",
79434
+ "enum": [
79435
+ "charging_not_allowed",
79436
+ "location_is_closed",
79437
+ "access_restricted",
79438
+ "user_verification_not_complete",
79439
+ "terms_not_accepted",
79440
+ "subscription_required",
79441
+ "cannot_bill_payment_method",
79442
+ "session_already_running",
79443
+ "previous_session_not_paid",
79444
+ "unpaid_subscription_fees",
79445
+ "payment_method_required",
79446
+ "corporate_billing_policy_inactive",
79447
+ "corporate_billing_limit_exceeded",
79448
+ "corporate_account_limit_reached",
79449
+ "corporate_billing_currency_mismatch",
79450
+ "corporate_billing_cross_operator_not_opted_in",
79451
+ "corporate_billing_exchange_rate_unavailable",
79452
+ "corporate_billing_charger_type_not_covered",
79453
+ "corporate_billing_partner_not_covered",
79454
+ "corporate_billing_country_not_covered",
79455
+ "corporate_billing_location_not_covered",
79456
+ "corporate_billing_location_tag_not_covered",
79457
+ "corporate_billing_roaming_not_covered",
79458
+ "payment_method_expired",
79459
+ "payment_method_not_allowed",
79460
+ "payment_method_doesnt_have_sufficient_funds",
79461
+ "internal_roaming_not_setup",
79462
+ "rfid_tag_expired",
79463
+ "rfid_tag_disabled",
79464
+ "rfid_tag_suspended",
79465
+ "user_invoice_details_not_provided",
79466
+ "invalid_payment_method_for_direct_charges",
79467
+ "user_is_disabled",
79468
+ "token_not_authorized_for_booking",
79469
+ "evse_has_queued_reservations",
79470
+ "evse_disabled",
79471
+ "evse_out_of_order",
79472
+ "tariff_charging_not_allowed",
79473
+ "no_tariff_group_configured",
79474
+ "tariff_resolution_failed",
79475
+ "operator_in_migration_mode",
79476
+ "rfid_charge_point_scope_mismatch",
79477
+ "remote_start_failed",
79478
+ "rejected",
79479
+ "canceled_reservation",
79480
+ "evse_occupied",
79481
+ "evse_inoperative",
79482
+ "failed",
79483
+ "not_supported",
79484
+ "timeout",
79485
+ "unknown_reservation",
79486
+ "ev_not_connected_to_evse",
79487
+ "authorization_failed",
79488
+ "pre_authorization_failed",
79489
+ "unknown_session",
79490
+ "ocpi_roaming_not_setup",
79491
+ "command_expired"
79492
+ ]
79493
+ },
79494
+ "sessionId": {
79495
+ "type": "integer",
79496
+ "description": "The related charging session ID."
79497
+ },
79498
+ "reservationId": {
79499
+ "type": "integer",
79500
+ "description": "The related reservation ID."
79501
+ },
79502
+ "evseId": {
79503
+ "type": "integer",
79504
+ "description": "The targeted EVSE ID."
79505
+ },
79506
+ "roamingEmspId": {
79507
+ "type": "integer",
79508
+ "description": "The roaming eMSP ID (`resources/roaming-emsps/v1.0`) the command was received from."
79509
+ },
79510
+ "roamingConnectionId": {
79511
+ "type": "integer",
79512
+ "description": "The roaming connection ID."
79513
+ },
79514
+ "createdAt": {
79515
+ "type": "string",
79516
+ "format": "date-time",
79517
+ "description": "ISO 8601 formatted date",
79518
+ "readOnly": true
79519
+ }
79520
+ },
79521
+ "required": [
79522
+ "id",
79523
+ "type",
79524
+ "createdAt"
79525
+ ]
79526
+ }
79527
+ },
79528
+ "links": {
79529
+ "type": "object",
79530
+ "properties": {
79531
+ "first": {
79532
+ "type": "string",
79533
+ "description": "The URL to fetch the first page",
79534
+ "nullable": true
79535
+ },
79536
+ "last": {
79537
+ "type": "string",
79538
+ "description": "The URL to fetch the last page",
79539
+ "nullable": true
79540
+ },
79541
+ "prev": {
79542
+ "type": "string",
79543
+ "description": "The URL to fetch the previous page",
79544
+ "nullable": true
79545
+ },
79546
+ "next": {
79547
+ "type": "string",
79548
+ "description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
79549
+ "nullable": true
79550
+ }
79551
+ }
79552
+ },
79553
+ "meta": {
79554
+ "type": "object",
79555
+ "properties": {
79556
+ "path": {
79557
+ "type": "string",
79558
+ "description": "The base route of the endpoint (unpaginated)"
79559
+ },
79560
+ "per_page": {
79561
+ "type": "integer",
79562
+ "description": "The max number of items in each page"
79563
+ },
79564
+ "next_cursor": {
79565
+ "type": "string",
79566
+ "description": "The cursor to fetch the next page. Do not use this directly. It will be populated by using the previous response's links.next.",
79567
+ "nullable": true
79568
+ },
79569
+ "prev_cursor": {
79570
+ "type": "string",
79571
+ "description": "The cursor to fetch the previous page. Do not use this directly. It will be populated by using the previous response's links.prev.",
79572
+ "nullable": true
79573
+ }
79574
+ }
79575
+ }
79576
+ }
79577
+ }
79578
+ },
79579
+ "401": {
79580
+ "schema": {
79581
+ "type": "object",
79582
+ "properties": {
79583
+ "message": {
79584
+ "type": "string"
79585
+ }
79586
+ }
79587
+ }
79588
+ },
79589
+ "403": {
79590
+ "schema": {
79591
+ "type": "object",
79592
+ "properties": {
79593
+ "message": {
79594
+ "type": "string",
79595
+ "default": "This action is unauthorized."
79596
+ }
79597
+ }
79598
+ }
79599
+ },
79600
+ "422": {
79601
+ "schema": {
79602
+ "type": "object",
79603
+ "required": [
79604
+ "message"
79605
+ ],
79606
+ "properties": {
79607
+ "message": {
79608
+ "type": "string"
79609
+ },
79610
+ "errors": {
79611
+ "type": "object",
79612
+ "additionalProperties": {
79613
+ "type": "array",
79614
+ "items": {
79615
+ "type": "string"
79616
+ }
79617
+ }
79618
+ }
79619
+ }
79620
+ }
79621
+ },
79622
+ "429": {
79623
+ "schema": {
79624
+ "type": "object",
79625
+ "properties": {
79626
+ "message": {
79627
+ "type": "string"
79628
+ }
79629
+ }
79630
+ }
79631
+ }
79632
+ },
79633
+ "ocpiCommandRead": {
79634
+ "200": {
79635
+ "schema": {
79636
+ "type": "object",
79637
+ "properties": {
79638
+ "data": {
79639
+ "description": "A command received from an eMSP over OCPI and the result returned for it.",
79640
+ "type": "object",
79641
+ "properties": {
79642
+ "id": {
79643
+ "type": "integer",
79644
+ "readOnly": true,
79645
+ "description": "Identifier of the command."
79646
+ },
79647
+ "type": {
79648
+ "description": "The command the roaming partner sent:\n- **cancel_reservation**: Cancel a reservation\n- **reserve_now**: Reserve an EVSE\n- **start_session**: Start a charging session\n- **stop_session**: Stop a charging session\n- **unlock_connector**: Unlock a connector\n- **change_availability**: Change the availability of an EVSE (protocol extension)\n- **get_diagnostics**: Request charge point diagnostics (protocol extension)\n- **reset_evse**: Reset an EVSE (protocol extension)\n- **unknown**: Any command outside this set\n",
79649
+ "type": "string",
79650
+ "enum": [
79651
+ "cancel_reservation",
79652
+ "reserve_now",
79653
+ "start_session",
79654
+ "stop_session",
79655
+ "unlock_connector",
79656
+ "change_availability",
79657
+ "get_diagnostics",
79658
+ "reset_evse",
79659
+ "unknown"
79660
+ ]
79661
+ },
79662
+ "result": {
79663
+ "description": "The result the platform returned to the roaming partner:\n- **accepted**: The command was accepted\n- **rejected**: The command was rejected\n- **not_supported**: The command is not supported for this charge point\n- **timeout**: The charge point did not respond in time\n- **unknown_session**: The referenced session is unknown\n- **failed**: The command failed during execution\n- **evse_occupied**: The EVSE is already in use\n- **evse_inoperative**: The EVSE is not operational\n- **unknown_reservation**: The referenced reservation is unknown\n- **canceled_reservation**: The reservation was cancelled\n- **unknown**: Any result outside the OCPI result set\n",
79664
+ "type": "string",
79665
+ "enum": [
79666
+ "accepted",
79667
+ "rejected",
79668
+ "not_supported",
79669
+ "timeout",
79670
+ "unknown_session",
79671
+ "failed",
79672
+ "evse_occupied",
79673
+ "evse_inoperative",
79674
+ "unknown_reservation",
79675
+ "canceled_reservation",
79676
+ "unknown"
79677
+ ]
79678
+ },
79679
+ "failureReason": {
79680
+ "description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**: The corporate account limit is reached\n- **corporate_billing_currency_mismatch**: The session currency differs from the corporate billing currency\n- **corporate_billing_cross_operator_not_opted_in**: The operator serving the session is not opted in to the partner's cross-operator corporate billing\n- **corporate_billing_exchange_rate_unavailable**: No exchange rate is available to convert the session amount into the corporate billing currency\n- **corporate_billing_charger_type_not_covered**: The charger type is not covered by the corporate billing policy\n- **corporate_billing_partner_not_covered**: The partner is not covered by the corporate billing policy\n- **corporate_billing_country_not_covered**: The country is not covered by the corporate billing policy\n- **corporate_billing_location_not_covered**: The location is not covered by the corporate billing policy\n- **corporate_billing_location_tag_not_covered**: The location tag is not covered by the corporate billing policy\n- **corporate_billing_roaming_not_covered**: Roaming is not covered by the corporate billing policy\n\nTariffs:\n- **tariff_charging_not_allowed**: The applicable tariff does not allow charging\n- **no_tariff_group_configured**: No tariff group is configured for the charge point\n- **tariff_resolution_failed**: No tariff could be resolved for the requested charging\n\nCharge point and EVSE state:\n- **evse_disabled**: The requested EVSE is disabled\n- **evse_out_of_order**: The requested EVSE is out of order\n- **evse_occupied**: The requested EVSE is already in use\n- **evse_inoperative**: The requested EVSE is not operational\n- **evse_has_queued_reservations**: The requested EVSE has queued reservations\n- **ev_not_connected_to_evse**: No vehicle is connected to the requested EVSE\n- **session_already_running**: A charging session is already running\n\nRFID tokens:\n- **rfid_tag_expired**: The RFID tag has expired\n- **rfid_tag_disabled**: The RFID tag is disabled\n- **rfid_tag_suspended**: The RFID tag is suspended\n- **rfid_charge_point_scope_mismatch**: The RFID tag may not be used on the requested charge point\n\nRoaming setup:\n- **ocpi_roaming_not_setup**: The OCPI roaming configuration needed to serve the command is missing\n- **internal_roaming_not_setup**: The internal roaming configuration needed to serve the command is missing\n\nCommand execution:\n- **remote_start_failed**: The charge point refused or failed the remote start\n- **rejected**: The charge point rejected the command\n- **failed**: The command failed while it was being executed\n- **not_supported**: The command is not supported for the requested charge point\n- **timeout**: The charge point did not respond within the command timeout\n- **command_expired**: The command was no longer valid by the time it could be executed\n- **unknown_session**: The referenced charging session is unknown to the platform\n- **unknown_reservation**: The referenced reservation is unknown to the platform\n- **canceled_reservation**: The reservation was cancelled instead of being honoured\n",
79681
+ "type": "string",
79682
+ "enum": [
79683
+ "charging_not_allowed",
79684
+ "location_is_closed",
79685
+ "access_restricted",
79686
+ "user_verification_not_complete",
79687
+ "terms_not_accepted",
79688
+ "subscription_required",
79689
+ "cannot_bill_payment_method",
79690
+ "session_already_running",
79691
+ "previous_session_not_paid",
79692
+ "unpaid_subscription_fees",
79693
+ "payment_method_required",
79694
+ "corporate_billing_policy_inactive",
79695
+ "corporate_billing_limit_exceeded",
79696
+ "corporate_account_limit_reached",
79697
+ "corporate_billing_currency_mismatch",
79698
+ "corporate_billing_cross_operator_not_opted_in",
79699
+ "corporate_billing_exchange_rate_unavailable",
79700
+ "corporate_billing_charger_type_not_covered",
79701
+ "corporate_billing_partner_not_covered",
79702
+ "corporate_billing_country_not_covered",
79703
+ "corporate_billing_location_not_covered",
79704
+ "corporate_billing_location_tag_not_covered",
79705
+ "corporate_billing_roaming_not_covered",
79706
+ "payment_method_expired",
79707
+ "payment_method_not_allowed",
79708
+ "payment_method_doesnt_have_sufficient_funds",
79709
+ "internal_roaming_not_setup",
79710
+ "rfid_tag_expired",
79711
+ "rfid_tag_disabled",
79712
+ "rfid_tag_suspended",
79713
+ "user_invoice_details_not_provided",
79714
+ "invalid_payment_method_for_direct_charges",
79715
+ "user_is_disabled",
79716
+ "token_not_authorized_for_booking",
79717
+ "evse_has_queued_reservations",
79718
+ "evse_disabled",
79719
+ "evse_out_of_order",
79720
+ "tariff_charging_not_allowed",
79721
+ "no_tariff_group_configured",
79722
+ "tariff_resolution_failed",
79723
+ "operator_in_migration_mode",
79724
+ "rfid_charge_point_scope_mismatch",
79725
+ "remote_start_failed",
79726
+ "rejected",
79727
+ "canceled_reservation",
79728
+ "evse_occupied",
79729
+ "evse_inoperative",
79730
+ "failed",
79731
+ "not_supported",
79732
+ "timeout",
79733
+ "unknown_reservation",
79734
+ "ev_not_connected_to_evse",
79735
+ "authorization_failed",
79736
+ "pre_authorization_failed",
79737
+ "unknown_session",
79738
+ "ocpi_roaming_not_setup",
79739
+ "command_expired"
79740
+ ]
79741
+ },
79742
+ "sessionId": {
79743
+ "type": "integer",
79744
+ "description": "The related charging session ID."
79745
+ },
79746
+ "reservationId": {
79747
+ "type": "integer",
79748
+ "description": "The related reservation ID."
79749
+ },
79750
+ "evseId": {
79751
+ "type": "integer",
79752
+ "description": "The targeted EVSE ID."
79753
+ },
79754
+ "roamingEmspId": {
79755
+ "type": "integer",
79756
+ "description": "The roaming eMSP ID (`resources/roaming-emsps/v1.0`) the command was received from."
79757
+ },
79758
+ "roamingConnectionId": {
79759
+ "type": "integer",
79760
+ "description": "The roaming connection ID."
79761
+ },
79762
+ "createdAt": {
79763
+ "type": "string",
79764
+ "format": "date-time",
79765
+ "description": "ISO 8601 formatted date",
79766
+ "readOnly": true
79767
+ }
79768
+ },
79769
+ "required": [
79770
+ "id",
79771
+ "type",
79772
+ "createdAt"
79773
+ ]
79774
+ }
79775
+ }
79776
+ }
79777
+ },
79778
+ "401": {
79779
+ "schema": {
79780
+ "type": "object",
79781
+ "properties": {
79782
+ "message": {
79783
+ "type": "string"
79784
+ }
79785
+ }
79786
+ }
79787
+ },
79788
+ "403": {
79789
+ "schema": {
79790
+ "type": "object",
79791
+ "properties": {
79792
+ "message": {
79793
+ "type": "string",
79794
+ "default": "This action is unauthorized."
79795
+ }
79796
+ }
79797
+ }
79798
+ },
79799
+ "404": {
79800
+ "schema": {
79801
+ "type": "object",
79802
+ "properties": {
79803
+ "message": {
79804
+ "type": "string"
79805
+ }
79806
+ }
79807
+ }
79808
+ },
79356
79809
  "429": {
79357
79810
  "schema": {
79358
79811
  "type": "object",
@@ -129176,14 +129629,16 @@
129176
129629
  "description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
129177
129630
  },
129178
129631
  "restrictionCause": {
129179
- "description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
129632
+ "description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n- **cross_operator_not_opted_in**: The service operator and the corporate account home operator have not both opted in to cross-operator corporate billing\n- **exchange_rate_unavailable**: No exchange rate was available to convert the session currency into the corporate account billing currency\n",
129180
129633
  "type": "string",
129181
129634
  "enum": [
129182
129635
  "partner",
129183
129636
  "country",
129184
129637
  "location",
129185
129638
  "location_tag",
129186
- "roaming"
129639
+ "roaming",
129640
+ "cross_operator_not_opted_in",
129641
+ "exchange_rate_unavailable"
129187
129642
  ]
129188
129643
  },
129189
129644
  "breakdown": {
@@ -130456,14 +130911,16 @@
130456
130911
  "description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
130457
130912
  },
130458
130913
  "restrictionCause": {
130459
- "description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
130914
+ "description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n- **cross_operator_not_opted_in**: The service operator and the corporate account home operator have not both opted in to cross-operator corporate billing\n- **exchange_rate_unavailable**: No exchange rate was available to convert the session currency into the corporate account billing currency\n",
130460
130915
  "type": "string",
130461
130916
  "enum": [
130462
130917
  "partner",
130463
130918
  "country",
130464
130919
  "location",
130465
130920
  "location_tag",
130466
- "roaming"
130921
+ "roaming",
130922
+ "cross_operator_not_opted_in",
130923
+ "exchange_rate_unavailable"
130467
130924
  ]
130468
130925
  },
130469
130926
  "breakdown": {
@@ -142194,6 +142651,29 @@
142194
142651
  "maximum": 99,
142195
142652
  "description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
142196
142653
  "nullable": true
142654
+ },
142655
+ "stopWhenPreAuthorizedAmountFallsBelow": {
142656
+ "type": "number",
142657
+ "format": "decimal",
142658
+ "minimum": 0,
142659
+ "description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
142660
+ },
142661
+ "autoStopAmount": {
142662
+ "type": "number",
142663
+ "format": "decimal",
142664
+ "minimum": 0,
142665
+ "description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
142666
+ }
142667
+ }
142668
+ },
142669
+ "startSessionRestrictions": {
142670
+ "type": "object",
142671
+ "properties": {
142672
+ "minimumBalance": {
142673
+ "type": "number",
142674
+ "format": "decimal",
142675
+ "minimum": 0,
142676
+ "description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
142197
142677
  }
142198
142678
  }
142199
142679
  },
@@ -143348,6 +143828,29 @@
143348
143828
  "maximum": 99,
143349
143829
  "description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
143350
143830
  "nullable": true
143831
+ },
143832
+ "stopWhenPreAuthorizedAmountFallsBelow": {
143833
+ "type": "number",
143834
+ "format": "decimal",
143835
+ "minimum": 0,
143836
+ "description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
143837
+ },
143838
+ "autoStopAmount": {
143839
+ "type": "number",
143840
+ "format": "decimal",
143841
+ "minimum": 0,
143842
+ "description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
143843
+ }
143844
+ }
143845
+ },
143846
+ "startSessionRestrictions": {
143847
+ "type": "object",
143848
+ "properties": {
143849
+ "minimumBalance": {
143850
+ "type": "number",
143851
+ "format": "decimal",
143852
+ "minimum": 0,
143853
+ "description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
143351
143854
  }
143352
143855
  }
143353
143856
  },
@@ -144629,6 +145132,29 @@
144629
145132
  "maximum": 99,
144630
145133
  "description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
144631
145134
  "nullable": true
145135
+ },
145136
+ "stopWhenPreAuthorizedAmountFallsBelow": {
145137
+ "type": "number",
145138
+ "format": "decimal",
145139
+ "minimum": 0,
145140
+ "description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
145141
+ },
145142
+ "autoStopAmount": {
145143
+ "type": "number",
145144
+ "format": "decimal",
145145
+ "minimum": 0,
145146
+ "description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
145147
+ }
145148
+ }
145149
+ },
145150
+ "startSessionRestrictions": {
145151
+ "type": "object",
145152
+ "properties": {
145153
+ "minimumBalance": {
145154
+ "type": "number",
145155
+ "format": "decimal",
145156
+ "minimum": 0,
145157
+ "description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
144632
145158
  }
144633
145159
  }
144634
145160
  },
@@ -145795,6 +146321,29 @@
145795
146321
  "maximum": 99,
145796
146322
  "description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
145797
146323
  "nullable": true
146324
+ },
146325
+ "stopWhenPreAuthorizedAmountFallsBelow": {
146326
+ "type": "number",
146327
+ "format": "decimal",
146328
+ "minimum": 0,
146329
+ "description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
146330
+ },
146331
+ "autoStopAmount": {
146332
+ "type": "number",
146333
+ "format": "decimal",
146334
+ "minimum": 0,
146335
+ "description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
146336
+ }
146337
+ }
146338
+ },
146339
+ "startSessionRestrictions": {
146340
+ "type": "object",
146341
+ "properties": {
146342
+ "minimumBalance": {
146343
+ "type": "number",
146344
+ "format": "decimal",
146345
+ "minimum": 0,
146346
+ "description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
145798
146347
  }
145799
146348
  }
145800
146349
  },
@@ -146949,6 +147498,29 @@
146949
147498
  "maximum": 99,
146950
147499
  "description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
146951
147500
  "nullable": true
147501
+ },
147502
+ "stopWhenPreAuthorizedAmountFallsBelow": {
147503
+ "type": "number",
147504
+ "format": "decimal",
147505
+ "minimum": 0,
147506
+ "description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
147507
+ },
147508
+ "autoStopAmount": {
147509
+ "type": "number",
147510
+ "format": "decimal",
147511
+ "minimum": 0,
147512
+ "description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
147513
+ }
147514
+ }
147515
+ },
147516
+ "startSessionRestrictions": {
147517
+ "type": "object",
147518
+ "properties": {
147519
+ "minimumBalance": {
147520
+ "type": "number",
147521
+ "format": "decimal",
147522
+ "minimum": 0,
147523
+ "description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
146952
147524
  }
146953
147525
  }
146954
147526
  },
@@ -148178,6 +148750,29 @@
148178
148750
  "maximum": 99,
148179
148751
  "description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
148180
148752
  "nullable": true
148753
+ },
148754
+ "stopWhenPreAuthorizedAmountFallsBelow": {
148755
+ "type": "number",
148756
+ "format": "decimal",
148757
+ "minimum": 0,
148758
+ "description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
148759
+ },
148760
+ "autoStopAmount": {
148761
+ "type": "number",
148762
+ "format": "decimal",
148763
+ "minimum": 0,
148764
+ "description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
148765
+ }
148766
+ }
148767
+ },
148768
+ "startSessionRestrictions": {
148769
+ "type": "object",
148770
+ "properties": {
148771
+ "minimumBalance": {
148772
+ "type": "number",
148773
+ "format": "decimal",
148774
+ "minimum": 0,
148775
+ "description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
148181
148776
  }
148182
148777
  }
148183
148778
  },
@@ -154943,12 +155538,14 @@
154943
155538
  },
154944
155539
  "invoiceId": {
154945
155540
  "type": "integer",
154946
- "nullable": true
155541
+ "nullable": true,
155542
+ "description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
154947
155543
  },
154948
155544
  "invoiceNo": {
154949
155545
  "deprecated": true,
154950
155546
  "type": "string",
154951
- "nullable": true
155547
+ "nullable": true,
155548
+ "description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
154952
155549
  },
154953
155550
  "receiptId": {
154954
155551
  "type": "integer",
@@ -155505,12 +156102,14 @@
155505
156102
  },
155506
156103
  "invoiceId": {
155507
156104
  "type": "integer",
155508
- "nullable": true
156105
+ "nullable": true,
156106
+ "description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
155509
156107
  },
155510
156108
  "invoiceNo": {
155511
156109
  "deprecated": true,
155512
156110
  "type": "string",
155513
- "nullable": true
156111
+ "nullable": true,
156112
+ "description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
155514
156113
  },
155515
156114
  "receiptId": {
155516
156115
  "type": "integer",
@@ -155805,6 +156404,19 @@
155805
156404
  }
155806
156405
  }
155807
156406
  },
156407
+ "424": {
156408
+ "schema": {
156409
+ "type": "object",
156410
+ "required": [
156411
+ "message"
156412
+ ],
156413
+ "properties": {
156414
+ "message": {
156415
+ "type": "string"
156416
+ }
156417
+ }
156418
+ }
156419
+ },
155808
156420
  "429": {
155809
156421
  "schema": {
155810
156422
  "type": "object",
@@ -155939,12 +156551,14 @@
155939
156551
  },
155940
156552
  "invoiceId": {
155941
156553
  "type": "integer",
155942
- "nullable": true
156554
+ "nullable": true,
156555
+ "description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
155943
156556
  },
155944
156557
  "invoiceNo": {
155945
156558
  "deprecated": true,
155946
156559
  "type": "string",
155947
- "nullable": true
156560
+ "nullable": true,
156561
+ "description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
155948
156562
  },
155949
156563
  "receiptId": {
155950
156564
  "type": "integer",
@@ -156384,12 +156998,14 @@
156384
156998
  },
156385
156999
  "invoiceId": {
156386
157000
  "type": "integer",
156387
- "nullable": true
157001
+ "nullable": true,
157002
+ "description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
156388
157003
  },
156389
157004
  "invoiceNo": {
156390
157005
  "deprecated": true,
156391
157006
  "type": "string",
156392
- "nullable": true
157007
+ "nullable": true,
157008
+ "description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
156393
157009
  },
156394
157010
  "receiptId": {
156395
157011
  "type": "integer",
@@ -156684,6 +157300,19 @@
156684
157300
  }
156685
157301
  }
156686
157302
  },
157303
+ "424": {
157304
+ "schema": {
157305
+ "type": "object",
157306
+ "required": [
157307
+ "message"
157308
+ ],
157309
+ "properties": {
157310
+ "message": {
157311
+ "type": "string"
157312
+ }
157313
+ }
157314
+ }
157315
+ },
156687
157316
  "429": {
156688
157317
  "schema": {
156689
157318
  "type": "object",
@@ -157413,6 +158042,120 @@
157413
158042
  }
157414
158043
  }
157415
158044
  },
158045
+ "userGroupReplace": {
158046
+ "200": {
158047
+ "schema": {
158048
+ "type": "object",
158049
+ "properties": {
158050
+ "data": {
158051
+ "type": "object",
158052
+ "properties": {
158053
+ "id": {
158054
+ "type": "integer",
158055
+ "readOnly": true
158056
+ },
158057
+ "operatorId": {
158058
+ "type": "integer",
158059
+ "readOnly": true,
158060
+ "description": "The ID of the operator this resource belongs to",
158061
+ "example": 1
158062
+ },
158063
+ "name": {
158064
+ "type": "string"
158065
+ },
158066
+ "partnerId": {
158067
+ "type": "integer",
158068
+ "description": "The partnerId can be updated only if there are no users added to the user group",
158069
+ "nullable": true
158070
+ },
158071
+ "description": {
158072
+ "type": "string",
158073
+ "nullable": true
158074
+ },
158075
+ "externalId": {
158076
+ "type": "string",
158077
+ "description": "Used to store custom information, usually used for external references or metadata to the resource."
158078
+ },
158079
+ "lastUpdatedAt": {
158080
+ "type": "string",
158081
+ "format": "date-time",
158082
+ "description": "ISO 8601 formatted date",
158083
+ "readOnly": true
158084
+ }
158085
+ },
158086
+ "required": [
158087
+ "id",
158088
+ "operatorId",
158089
+ "name"
158090
+ ]
158091
+ }
158092
+ }
158093
+ }
158094
+ },
158095
+ "401": {
158096
+ "schema": {
158097
+ "type": "object",
158098
+ "properties": {
158099
+ "message": {
158100
+ "type": "string"
158101
+ }
158102
+ }
158103
+ }
158104
+ },
158105
+ "403": {
158106
+ "schema": {
158107
+ "type": "object",
158108
+ "properties": {
158109
+ "message": {
158110
+ "type": "string",
158111
+ "default": "This action is unauthorized."
158112
+ }
158113
+ }
158114
+ }
158115
+ },
158116
+ "404": {
158117
+ "schema": {
158118
+ "type": "object",
158119
+ "properties": {
158120
+ "message": {
158121
+ "type": "string"
158122
+ }
158123
+ }
158124
+ }
158125
+ },
158126
+ "422": {
158127
+ "schema": {
158128
+ "type": "object",
158129
+ "required": [
158130
+ "message"
158131
+ ],
158132
+ "properties": {
158133
+ "message": {
158134
+ "type": "string"
158135
+ },
158136
+ "errors": {
158137
+ "type": "object",
158138
+ "additionalProperties": {
158139
+ "type": "array",
158140
+ "items": {
158141
+ "type": "string"
158142
+ }
158143
+ }
158144
+ }
158145
+ }
158146
+ }
158147
+ },
158148
+ "429": {
158149
+ "schema": {
158150
+ "type": "object",
158151
+ "properties": {
158152
+ "message": {
158153
+ "type": "string"
158154
+ }
158155
+ }
158156
+ }
158157
+ }
158158
+ },
157416
158159
  "userGroupDelete": {
157417
158160
  "401": {
157418
158161
  "schema": {