@ampeco/public-api-mcp 3.224.3 → 3.225.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.
- package/dist/generated/build-stats.json +9 -9
- package/dist/generated/endpoints.json +89 -26
- package/dist/generated/response-schemas.json +1439 -262
- package/dist/generated/schemas.d.ts +20 -0
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +5 -0
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +6 -0
- package/package.json +1 -1
|
@@ -5530,7 +5530,7 @@
|
|
|
5530
5530
|
}
|
|
5531
5531
|
}
|
|
5532
5532
|
},
|
|
5533
|
-
"
|
|
5533
|
+
"partnerInvoiceIssueCreditNote": {
|
|
5534
5534
|
"202": {
|
|
5535
5535
|
"schema": {
|
|
5536
5536
|
"type": "object",
|
|
@@ -6643,24 +6643,12 @@
|
|
|
6643
6643
|
}
|
|
6644
6644
|
}
|
|
6645
6645
|
},
|
|
6646
|
-
"
|
|
6646
|
+
"409": {
|
|
6647
6647
|
"schema": {
|
|
6648
6648
|
"type": "object",
|
|
6649
|
-
"required": [
|
|
6650
|
-
"message"
|
|
6651
|
-
],
|
|
6652
6649
|
"properties": {
|
|
6653
6650
|
"message": {
|
|
6654
6651
|
"type": "string"
|
|
6655
|
-
},
|
|
6656
|
-
"errors": {
|
|
6657
|
-
"type": "object",
|
|
6658
|
-
"additionalProperties": {
|
|
6659
|
-
"type": "array",
|
|
6660
|
-
"items": {
|
|
6661
|
-
"type": "string"
|
|
6662
|
-
}
|
|
6663
|
-
}
|
|
6664
6652
|
}
|
|
6665
6653
|
}
|
|
6666
6654
|
}
|
|
@@ -6676,7 +6664,7 @@
|
|
|
6676
6664
|
}
|
|
6677
6665
|
}
|
|
6678
6666
|
},
|
|
6679
|
-
"
|
|
6667
|
+
"partnerInvoiceUpdateExternalId": {
|
|
6680
6668
|
"202": {
|
|
6681
6669
|
"schema": {
|
|
6682
6670
|
"type": "object",
|
|
@@ -6686,96 +6674,298 @@
|
|
|
6686
6674
|
"properties": {
|
|
6687
6675
|
"id": {
|
|
6688
6676
|
"type": "integer",
|
|
6689
|
-
"description": "Unique
|
|
6677
|
+
"description": "Unique partner invoice identifier."
|
|
6678
|
+
},
|
|
6679
|
+
"operatorId": {
|
|
6680
|
+
"type": "integer",
|
|
6681
|
+
"description": "The ID of the operator this resource belongs to",
|
|
6682
|
+
"example": 1
|
|
6690
6683
|
},
|
|
6691
6684
|
"partnerId": {
|
|
6692
6685
|
"type": "integer",
|
|
6693
|
-
"description": "
|
|
6686
|
+
"description": "Identifier of the partner the invoice is issued to or from."
|
|
6687
|
+
},
|
|
6688
|
+
"settlementReportId": {
|
|
6689
|
+
"type": "integer",
|
|
6690
|
+
"description": "Identifier of the settlement report the invoice was generated from."
|
|
6694
6691
|
},
|
|
6695
6692
|
"number": {
|
|
6696
6693
|
"type": "string",
|
|
6697
|
-
"description": "
|
|
6694
|
+
"description": "Invoice reference number."
|
|
6698
6695
|
},
|
|
6699
|
-
"
|
|
6696
|
+
"externalId": {
|
|
6700
6697
|
"type": "string",
|
|
6701
|
-
"
|
|
6702
|
-
"description": "
|
|
6698
|
+
"maxLength": 255,
|
|
6699
|
+
"description": "An optional external identifier for integration purposes"
|
|
6703
6700
|
},
|
|
6704
|
-
"
|
|
6701
|
+
"type": {
|
|
6702
|
+
"description": "Partner invoice document type:\n- **invoice**: A regular partner invoice generated from a settlement report.\n- **credit_note**: A credit note that cancels an original partner invoice. Always references the cancelled invoice via `referenceId`.\n",
|
|
6703
|
+
"type": "string",
|
|
6704
|
+
"enum": [
|
|
6705
|
+
"invoice",
|
|
6706
|
+
"credit_note"
|
|
6707
|
+
],
|
|
6708
|
+
"example": "invoice"
|
|
6709
|
+
},
|
|
6710
|
+
"issuedOn": {
|
|
6705
6711
|
"type": "string",
|
|
6706
6712
|
"format": "date",
|
|
6707
|
-
"description": "
|
|
6713
|
+
"description": "Date when the partner invoice was issued."
|
|
6708
6714
|
},
|
|
6709
|
-
"
|
|
6715
|
+
"dueOn": {
|
|
6710
6716
|
"type": "string",
|
|
6711
6717
|
"format": "date",
|
|
6712
|
-
"description": "
|
|
6718
|
+
"description": "Date by which the partner invoice must be paid. Equal to the issued date when payment terms are \"Due on receipt\"."
|
|
6719
|
+
},
|
|
6720
|
+
"paymentTermsDays": {
|
|
6721
|
+
"type": "integer",
|
|
6722
|
+
"description": "Number of days the party has to pay after the invoice is issued. `0` represents \"Due on receipt\". Snapshotted at generation time."
|
|
6723
|
+
},
|
|
6724
|
+
"paymentStatus": {
|
|
6725
|
+
"description": "Partner invoice payment status:\n- **unpaid**: No payment has been recorded against the invoice.\n- **partially_paid**: A payment has been recorded but the full amount is not yet covered.\n- **paid**: The full amount has been paid.\n",
|
|
6726
|
+
"type": "string",
|
|
6727
|
+
"enum": [
|
|
6728
|
+
"unpaid",
|
|
6729
|
+
"partially_paid",
|
|
6730
|
+
"paid"
|
|
6731
|
+
],
|
|
6732
|
+
"example": "unpaid"
|
|
6713
6733
|
},
|
|
6714
6734
|
"currencyCode": {
|
|
6735
|
+
"description": "Currency used on the partner invoice (ISO 4217 code).",
|
|
6715
6736
|
"type": "string",
|
|
6716
|
-
"
|
|
6737
|
+
"enum": [
|
|
6738
|
+
"AED",
|
|
6739
|
+
"AFN",
|
|
6740
|
+
"ALL",
|
|
6741
|
+
"AMD",
|
|
6742
|
+
"ANG",
|
|
6743
|
+
"AOA",
|
|
6744
|
+
"ARS",
|
|
6745
|
+
"AUD",
|
|
6746
|
+
"AWG",
|
|
6747
|
+
"AZN",
|
|
6748
|
+
"BAM",
|
|
6749
|
+
"BBD",
|
|
6750
|
+
"BDT",
|
|
6751
|
+
"BGN",
|
|
6752
|
+
"BHD",
|
|
6753
|
+
"BIF",
|
|
6754
|
+
"BMD",
|
|
6755
|
+
"BND",
|
|
6756
|
+
"BOB",
|
|
6757
|
+
"BOV",
|
|
6758
|
+
"BRL",
|
|
6759
|
+
"BSD",
|
|
6760
|
+
"BTN",
|
|
6761
|
+
"BWP",
|
|
6762
|
+
"BYN",
|
|
6763
|
+
"BZD",
|
|
6764
|
+
"CAD",
|
|
6765
|
+
"CDF",
|
|
6766
|
+
"CHE",
|
|
6767
|
+
"CHF",
|
|
6768
|
+
"CHW",
|
|
6769
|
+
"CLF",
|
|
6770
|
+
"CLP",
|
|
6771
|
+
"CNY",
|
|
6772
|
+
"COP",
|
|
6773
|
+
"COU",
|
|
6774
|
+
"CRC",
|
|
6775
|
+
"CUC",
|
|
6776
|
+
"CUP",
|
|
6777
|
+
"CVE",
|
|
6778
|
+
"CZK",
|
|
6779
|
+
"DJF",
|
|
6780
|
+
"DKK",
|
|
6781
|
+
"DOP",
|
|
6782
|
+
"DZD",
|
|
6783
|
+
"EGP",
|
|
6784
|
+
"ERN",
|
|
6785
|
+
"ETB",
|
|
6786
|
+
"EUR",
|
|
6787
|
+
"FJD",
|
|
6788
|
+
"FKP",
|
|
6789
|
+
"GBP",
|
|
6790
|
+
"GEL",
|
|
6791
|
+
"GHS",
|
|
6792
|
+
"GIP",
|
|
6793
|
+
"GMD",
|
|
6794
|
+
"GNF",
|
|
6795
|
+
"GTQ",
|
|
6796
|
+
"GYD",
|
|
6797
|
+
"HKD",
|
|
6798
|
+
"HNL",
|
|
6799
|
+
"HRK",
|
|
6800
|
+
"HTG",
|
|
6801
|
+
"HUF",
|
|
6802
|
+
"IDR",
|
|
6803
|
+
"ILS",
|
|
6804
|
+
"INR",
|
|
6805
|
+
"IQD",
|
|
6806
|
+
"IRR",
|
|
6807
|
+
"ISK",
|
|
6808
|
+
"JMD",
|
|
6809
|
+
"JOD",
|
|
6810
|
+
"JPY",
|
|
6811
|
+
"KES",
|
|
6812
|
+
"KGS",
|
|
6813
|
+
"KHR",
|
|
6814
|
+
"KMF",
|
|
6815
|
+
"KPW",
|
|
6816
|
+
"KRW",
|
|
6817
|
+
"KWD",
|
|
6818
|
+
"KYD",
|
|
6819
|
+
"KZT",
|
|
6820
|
+
"LAK",
|
|
6821
|
+
"LBP",
|
|
6822
|
+
"LKR",
|
|
6823
|
+
"LRD",
|
|
6824
|
+
"LSL",
|
|
6825
|
+
"LYD",
|
|
6826
|
+
"MAD",
|
|
6827
|
+
"MDL",
|
|
6828
|
+
"MGA",
|
|
6829
|
+
"MKD",
|
|
6830
|
+
"MMK",
|
|
6831
|
+
"MNT",
|
|
6832
|
+
"MOP",
|
|
6833
|
+
"MRU",
|
|
6834
|
+
"MUR",
|
|
6835
|
+
"MVR",
|
|
6836
|
+
"MWK",
|
|
6837
|
+
"MXN",
|
|
6838
|
+
"MXV",
|
|
6839
|
+
"MYR",
|
|
6840
|
+
"MZN",
|
|
6841
|
+
"NAD",
|
|
6842
|
+
"NGN",
|
|
6843
|
+
"NIO",
|
|
6844
|
+
"NOK",
|
|
6845
|
+
"NPR",
|
|
6846
|
+
"NZD",
|
|
6847
|
+
"OMR",
|
|
6848
|
+
"PAB",
|
|
6849
|
+
"PEN",
|
|
6850
|
+
"PGK",
|
|
6851
|
+
"PHP",
|
|
6852
|
+
"PKR",
|
|
6853
|
+
"PLN",
|
|
6854
|
+
"PYG",
|
|
6855
|
+
"QAR",
|
|
6856
|
+
"RON",
|
|
6857
|
+
"RSD",
|
|
6858
|
+
"RUB",
|
|
6859
|
+
"RWF",
|
|
6860
|
+
"SAR",
|
|
6861
|
+
"SBD",
|
|
6862
|
+
"SCR",
|
|
6863
|
+
"SDG",
|
|
6864
|
+
"SEK",
|
|
6865
|
+
"SGD",
|
|
6866
|
+
"SHP",
|
|
6867
|
+
"SLL",
|
|
6868
|
+
"SOS",
|
|
6869
|
+
"SRD",
|
|
6870
|
+
"SSP",
|
|
6871
|
+
"STN",
|
|
6872
|
+
"SVC",
|
|
6873
|
+
"SYP",
|
|
6874
|
+
"SZL",
|
|
6875
|
+
"THB",
|
|
6876
|
+
"TJS",
|
|
6877
|
+
"TMT",
|
|
6878
|
+
"TND",
|
|
6879
|
+
"TOP",
|
|
6880
|
+
"TRY",
|
|
6881
|
+
"TTD",
|
|
6882
|
+
"TWD",
|
|
6883
|
+
"TZS",
|
|
6884
|
+
"UAH",
|
|
6885
|
+
"UGX",
|
|
6886
|
+
"USD",
|
|
6887
|
+
"USN",
|
|
6888
|
+
"UYI",
|
|
6889
|
+
"UYU",
|
|
6890
|
+
"UYW",
|
|
6891
|
+
"UZS",
|
|
6892
|
+
"VES",
|
|
6893
|
+
"VND",
|
|
6894
|
+
"VUV",
|
|
6895
|
+
"WST",
|
|
6896
|
+
"XAF",
|
|
6897
|
+
"XAG",
|
|
6898
|
+
"XAU",
|
|
6899
|
+
"XBA",
|
|
6900
|
+
"XBB",
|
|
6901
|
+
"XBC",
|
|
6902
|
+
"XBD",
|
|
6903
|
+
"XCD",
|
|
6904
|
+
"XDR",
|
|
6905
|
+
"XOF",
|
|
6906
|
+
"XPD",
|
|
6907
|
+
"XPF",
|
|
6908
|
+
"XPT",
|
|
6909
|
+
"XSU",
|
|
6910
|
+
"XTS",
|
|
6911
|
+
"XUA",
|
|
6912
|
+
"XXX",
|
|
6913
|
+
"YER",
|
|
6914
|
+
"ZAR",
|
|
6915
|
+
"ZMW",
|
|
6916
|
+
"ZWL"
|
|
6917
|
+
]
|
|
6717
6918
|
},
|
|
6718
6919
|
"totalAmount": {
|
|
6920
|
+
"description": "Total amount on the partner invoice, split by tax inclusion.",
|
|
6719
6921
|
"type": "object",
|
|
6720
6922
|
"properties": {
|
|
6721
6923
|
"withoutTax": {
|
|
6722
|
-
"type": "number"
|
|
6924
|
+
"type": "number",
|
|
6925
|
+
"description": "Total amount on the partner invoice excluding tax. Equal to withTax on invoices that have no tax breakdown (US/Canada)."
|
|
6926
|
+
},
|
|
6927
|
+
"withTax": {
|
|
6928
|
+
"type": "number",
|
|
6929
|
+
"description": "Total amount on the partner invoice including tax."
|
|
6723
6930
|
}
|
|
6724
6931
|
},
|
|
6725
6932
|
"required": [
|
|
6726
|
-
"withoutTax"
|
|
6727
|
-
|
|
6728
|
-
|
|
6729
|
-
},
|
|
6730
|
-
"totalExpenses": {
|
|
6731
|
-
"type": "number",
|
|
6732
|
-
"description": "Total expenses incurred during the settlement period."
|
|
6733
|
-
},
|
|
6734
|
-
"totalRevenue": {
|
|
6735
|
-
"type": "number",
|
|
6736
|
-
"description": "Total revenue generated during the settlement period."
|
|
6737
|
-
},
|
|
6738
|
-
"totalAwaitedRevenue": {
|
|
6739
|
-
"type": "number",
|
|
6740
|
-
"description": "Revenue expected but not yet collected."
|
|
6741
|
-
},
|
|
6742
|
-
"totalCollectedRevenue": {
|
|
6743
|
-
"type": "number",
|
|
6744
|
-
"description": "Revenue collected during the settlement period."
|
|
6745
|
-
},
|
|
6746
|
-
"totalCollectedRevenueFromPreviousPeriod": {
|
|
6747
|
-
"type": "number",
|
|
6748
|
-
"description": "Revenue collected during this period, but related to a previous periods."
|
|
6933
|
+
"withoutTax",
|
|
6934
|
+
"withTax"
|
|
6935
|
+
]
|
|
6749
6936
|
},
|
|
6750
|
-
"
|
|
6937
|
+
"totalTax": {
|
|
6751
6938
|
"type": "number",
|
|
6752
|
-
"description": "Total amount
|
|
6939
|
+
"description": "Total tax amount across all line items. Stored for all invoices; hidden on US/Canada invoices."
|
|
6753
6940
|
},
|
|
6754
|
-
"
|
|
6755
|
-
"type": "
|
|
6756
|
-
"description": "
|
|
6941
|
+
"referenceId": {
|
|
6942
|
+
"type": "integer",
|
|
6943
|
+
"description": "Identifier of the original partner invoice that this credit note cancels. Present only when `type` is `credit_note`."
|
|
6757
6944
|
},
|
|
6758
|
-
"
|
|
6759
|
-
"description": "
|
|
6945
|
+
"seller": {
|
|
6946
|
+
"description": "Seller details captured at the time of invoice generation. The operator is the seller until the self-billing flow is enabled.",
|
|
6760
6947
|
"type": "object",
|
|
6761
6948
|
"properties": {
|
|
6762
6949
|
"type": {
|
|
6950
|
+
"description": "Party type on a partner invoice:\n- **operator**: The party is the operator issuing or receiving the invoice.\n- **partner**: The party is the partner the invoice is issued to or from.\n",
|
|
6763
6951
|
"type": "string",
|
|
6764
6952
|
"enum": [
|
|
6765
|
-
"
|
|
6766
|
-
"
|
|
6767
|
-
]
|
|
6953
|
+
"operator",
|
|
6954
|
+
"partner"
|
|
6955
|
+
],
|
|
6956
|
+
"example": "operator"
|
|
6768
6957
|
},
|
|
6769
6958
|
"name": {
|
|
6770
|
-
"type": "string"
|
|
6959
|
+
"type": "string",
|
|
6960
|
+
"description": "Legal name of the party as captured at invoice generation."
|
|
6771
6961
|
},
|
|
6772
6962
|
"contactPerson": {
|
|
6773
6963
|
"type": "string",
|
|
6774
|
-
"
|
|
6964
|
+
"description": "Contact person at the party."
|
|
6775
6965
|
},
|
|
6776
6966
|
"country": {
|
|
6967
|
+
"description": "ISO 3166-1 alpha-2 country code of the party.",
|
|
6777
6968
|
"type": "string",
|
|
6778
|
-
"nullable": true,
|
|
6779
6969
|
"enum": [
|
|
6780
6970
|
"AF",
|
|
6781
6971
|
"AX",
|
|
@@ -7031,73 +7221,106 @@
|
|
|
7031
7221
|
},
|
|
7032
7222
|
"region": {
|
|
7033
7223
|
"type": "string",
|
|
7034
|
-
"
|
|
7224
|
+
"description": "Region/state of the party's address."
|
|
7035
7225
|
},
|
|
7036
7226
|
"city": {
|
|
7037
7227
|
"type": "string",
|
|
7038
|
-
"
|
|
7228
|
+
"description": "City of the party's address."
|
|
7039
7229
|
},
|
|
7040
7230
|
"postCode": {
|
|
7041
7231
|
"type": "string",
|
|
7042
|
-
"
|
|
7232
|
+
"description": "Postal code of the party's address."
|
|
7043
7233
|
},
|
|
7044
7234
|
"address": {
|
|
7045
7235
|
"type": "string",
|
|
7046
|
-
"
|
|
7236
|
+
"description": "Street address of the party."
|
|
7047
7237
|
},
|
|
7048
7238
|
"regNo": {
|
|
7049
7239
|
"type": "string",
|
|
7050
|
-
"
|
|
7240
|
+
"description": "Registration / company number of the party."
|
|
7051
7241
|
},
|
|
7052
7242
|
"taxId": {
|
|
7053
7243
|
"type": "string",
|
|
7054
|
-
"
|
|
7244
|
+
"description": "Tax identification number of the party."
|
|
7055
7245
|
},
|
|
7056
7246
|
"phone": {
|
|
7057
7247
|
"type": "string",
|
|
7058
|
-
"
|
|
7248
|
+
"description": "Phone number of the party."
|
|
7059
7249
|
},
|
|
7060
7250
|
"email": {
|
|
7061
7251
|
"type": "string",
|
|
7062
|
-
"
|
|
7252
|
+
"description": "Email address of the party."
|
|
7253
|
+
},
|
|
7254
|
+
"bankIban": {
|
|
7255
|
+
"type": "string",
|
|
7256
|
+
"nullable": true,
|
|
7257
|
+
"description": "IBAN of the bank account."
|
|
7258
|
+
},
|
|
7259
|
+
"bankName": {
|
|
7260
|
+
"type": "string",
|
|
7261
|
+
"nullable": true,
|
|
7262
|
+
"description": "Name of the bank."
|
|
7263
|
+
},
|
|
7264
|
+
"bankAddress": {
|
|
7265
|
+
"type": "string",
|
|
7266
|
+
"nullable": true,
|
|
7267
|
+
"description": "Address of the bank."
|
|
7268
|
+
},
|
|
7269
|
+
"bankCode": {
|
|
7270
|
+
"type": "string",
|
|
7271
|
+
"nullable": true,
|
|
7272
|
+
"description": "Bank code assigned by a central bank, a bank supervisory body or a Bankers Association in the country."
|
|
7273
|
+
},
|
|
7274
|
+
"bankAccountNumber": {
|
|
7275
|
+
"type": "string",
|
|
7276
|
+
"nullable": true,
|
|
7277
|
+
"description": "Bank account number."
|
|
7278
|
+
},
|
|
7279
|
+
"bankAccountType": {
|
|
7280
|
+
"type": "string",
|
|
7281
|
+
"nullable": true,
|
|
7282
|
+
"description": "Type of the bank account."
|
|
7283
|
+
},
|
|
7284
|
+
"bankAccountHolder": {
|
|
7285
|
+
"type": "string",
|
|
7286
|
+
"nullable": true,
|
|
7287
|
+
"description": "Name of the bank account holder."
|
|
7288
|
+
},
|
|
7289
|
+
"bankBic": {
|
|
7290
|
+
"type": "string",
|
|
7291
|
+
"nullable": true,
|
|
7292
|
+
"description": "BIC/SWIFT code of the bank."
|
|
7063
7293
|
}
|
|
7064
7294
|
},
|
|
7065
7295
|
"required": [
|
|
7066
7296
|
"type",
|
|
7067
|
-
"name"
|
|
7068
|
-
"contactPerson",
|
|
7069
|
-
"country",
|
|
7070
|
-
"region",
|
|
7071
|
-
"city",
|
|
7072
|
-
"postCode",
|
|
7073
|
-
"address",
|
|
7074
|
-
"regNo",
|
|
7075
|
-
"taxId",
|
|
7076
|
-
"phone",
|
|
7077
|
-
"email"
|
|
7297
|
+
"name"
|
|
7078
7298
|
]
|
|
7079
7299
|
},
|
|
7080
|
-
"
|
|
7081
|
-
"description": "
|
|
7300
|
+
"buyer": {
|
|
7301
|
+
"description": "Buyer details captured at the time of invoice generation.",
|
|
7082
7302
|
"type": "object",
|
|
7083
7303
|
"properties": {
|
|
7084
7304
|
"type": {
|
|
7305
|
+
"description": "Party type on a partner invoice:\n- **operator**: The party is the operator issuing or receiving the invoice.\n- **partner**: The party is the partner the invoice is issued to or from.\n",
|
|
7085
7306
|
"type": "string",
|
|
7086
7307
|
"enum": [
|
|
7087
|
-
"
|
|
7088
|
-
"
|
|
7089
|
-
]
|
|
7308
|
+
"operator",
|
|
7309
|
+
"partner"
|
|
7310
|
+
],
|
|
7311
|
+
"example": "operator"
|
|
7090
7312
|
},
|
|
7091
7313
|
"name": {
|
|
7092
|
-
"type": "string"
|
|
7314
|
+
"type": "string",
|
|
7315
|
+
"description": "Legal name of the party as captured at invoice generation."
|
|
7093
7316
|
},
|
|
7094
7317
|
"contactPerson": {
|
|
7095
7318
|
"type": "string",
|
|
7096
|
-
"
|
|
7319
|
+
"description": "Contact person at the party."
|
|
7097
7320
|
},
|
|
7098
7321
|
"country": {
|
|
7322
|
+
"description": "ISO 3166-1 alpha-2 country code of the party.",
|
|
7099
7323
|
"type": "string",
|
|
7100
|
-
"nullable": true,
|
|
7101
7324
|
"enum": [
|
|
7102
7325
|
"AF",
|
|
7103
7326
|
"AX",
|
|
@@ -7353,176 +7576,168 @@
|
|
|
7353
7576
|
},
|
|
7354
7577
|
"region": {
|
|
7355
7578
|
"type": "string",
|
|
7356
|
-
"
|
|
7579
|
+
"description": "Region/state of the party's address."
|
|
7357
7580
|
},
|
|
7358
7581
|
"city": {
|
|
7359
7582
|
"type": "string",
|
|
7360
|
-
"
|
|
7583
|
+
"description": "City of the party's address."
|
|
7361
7584
|
},
|
|
7362
7585
|
"postCode": {
|
|
7363
7586
|
"type": "string",
|
|
7364
|
-
"
|
|
7587
|
+
"description": "Postal code of the party's address."
|
|
7365
7588
|
},
|
|
7366
7589
|
"address": {
|
|
7367
7590
|
"type": "string",
|
|
7368
|
-
"
|
|
7591
|
+
"description": "Street address of the party."
|
|
7369
7592
|
},
|
|
7370
7593
|
"regNo": {
|
|
7371
7594
|
"type": "string",
|
|
7372
|
-
"
|
|
7595
|
+
"description": "Registration / company number of the party."
|
|
7373
7596
|
},
|
|
7374
7597
|
"taxId": {
|
|
7375
7598
|
"type": "string",
|
|
7376
|
-
"
|
|
7599
|
+
"description": "Tax identification number of the party."
|
|
7377
7600
|
},
|
|
7378
7601
|
"phone": {
|
|
7379
7602
|
"type": "string",
|
|
7380
|
-
"
|
|
7603
|
+
"description": "Phone number of the party."
|
|
7381
7604
|
},
|
|
7382
7605
|
"email": {
|
|
7383
7606
|
"type": "string",
|
|
7384
|
-
"
|
|
7385
|
-
},
|
|
7386
|
-
"bankIban": {
|
|
7387
|
-
"type": "string",
|
|
7388
|
-
"nullable": true,
|
|
7389
|
-
"description": "IBAN of the bank account."
|
|
7390
|
-
},
|
|
7391
|
-
"bankName": {
|
|
7392
|
-
"type": "string",
|
|
7393
|
-
"nullable": true,
|
|
7394
|
-
"description": "Name of the bank."
|
|
7395
|
-
},
|
|
7396
|
-
"bankAddress": {
|
|
7397
|
-
"type": "string",
|
|
7398
|
-
"nullable": true,
|
|
7399
|
-
"description": "Address of the bank."
|
|
7400
|
-
},
|
|
7401
|
-
"bankCode": {
|
|
7402
|
-
"type": "string",
|
|
7403
|
-
"nullable": true,
|
|
7404
|
-
"description": "Bank code assigned by a central bank, a bank supervisory body or a Bankers Association in the country."
|
|
7405
|
-
},
|
|
7406
|
-
"bankAccountNumber": {
|
|
7407
|
-
"type": "string",
|
|
7408
|
-
"nullable": true,
|
|
7409
|
-
"description": "Bank account number."
|
|
7410
|
-
},
|
|
7411
|
-
"bankAccountType": {
|
|
7412
|
-
"type": "string",
|
|
7413
|
-
"nullable": true,
|
|
7414
|
-
"description": "Type of the bank account."
|
|
7415
|
-
},
|
|
7416
|
-
"bankAccountHolder": {
|
|
7417
|
-
"type": "string",
|
|
7418
|
-
"nullable": true,
|
|
7419
|
-
"description": "Name of the bank account holder."
|
|
7420
|
-
},
|
|
7421
|
-
"bankBic": {
|
|
7422
|
-
"type": "string",
|
|
7423
|
-
"nullable": true,
|
|
7424
|
-
"description": "BIC/SWIFT code of the bank."
|
|
7607
|
+
"description": "Email address of the party."
|
|
7425
7608
|
}
|
|
7426
7609
|
},
|
|
7427
7610
|
"required": [
|
|
7428
7611
|
"type",
|
|
7429
|
-
"name"
|
|
7430
|
-
"contactPerson",
|
|
7431
|
-
"country",
|
|
7432
|
-
"region",
|
|
7433
|
-
"city",
|
|
7434
|
-
"postCode",
|
|
7435
|
-
"address",
|
|
7436
|
-
"regNo",
|
|
7437
|
-
"taxId",
|
|
7438
|
-
"phone",
|
|
7439
|
-
"email",
|
|
7440
|
-
"bankIban",
|
|
7441
|
-
"bankName",
|
|
7442
|
-
"bankAddress",
|
|
7443
|
-
"bankCode",
|
|
7444
|
-
"bankAccountNumber",
|
|
7445
|
-
"bankAccountType",
|
|
7446
|
-
"bankAccountHolder",
|
|
7447
|
-
"bankBic"
|
|
7612
|
+
"name"
|
|
7448
7613
|
]
|
|
7449
7614
|
},
|
|
7450
|
-
"
|
|
7451
|
-
"type": "
|
|
7452
|
-
"
|
|
7453
|
-
|
|
7454
|
-
|
|
7455
|
-
|
|
7456
|
-
|
|
7457
|
-
|
|
7458
|
-
|
|
7459
|
-
|
|
7460
|
-
|
|
7461
|
-
|
|
7462
|
-
|
|
7463
|
-
|
|
7464
|
-
|
|
7465
|
-
|
|
7466
|
-
|
|
7467
|
-
|
|
7468
|
-
|
|
7469
|
-
|
|
7470
|
-
|
|
7471
|
-
|
|
7472
|
-
|
|
7473
|
-
|
|
7474
|
-
|
|
7475
|
-
|
|
7476
|
-
|
|
7477
|
-
|
|
7615
|
+
"lineItems": {
|
|
7616
|
+
"type": "array",
|
|
7617
|
+
"items": {
|
|
7618
|
+
"type": "object",
|
|
7619
|
+
"properties": {
|
|
7620
|
+
"id": {
|
|
7621
|
+
"type": "integer",
|
|
7622
|
+
"description": "Unique line item identifier."
|
|
7623
|
+
},
|
|
7624
|
+
"service": {
|
|
7625
|
+
"type": "string",
|
|
7626
|
+
"description": "Service description for the line item."
|
|
7627
|
+
},
|
|
7628
|
+
"unit": {
|
|
7629
|
+
"type": "string",
|
|
7630
|
+
"description": "Unit of measure for the line item, as captured on the source settlement report entry."
|
|
7631
|
+
},
|
|
7632
|
+
"quantity": {
|
|
7633
|
+
"type": "number",
|
|
7634
|
+
"description": "Quantity of the unit billed on the line item."
|
|
7635
|
+
},
|
|
7636
|
+
"unitPrice": {
|
|
7637
|
+
"description": "Unit price for the line item, split by tax inclusion.",
|
|
7638
|
+
"type": "object",
|
|
7639
|
+
"properties": {
|
|
7640
|
+
"withTax": {
|
|
7641
|
+
"type": "number"
|
|
7642
|
+
},
|
|
7643
|
+
"withoutTax": {
|
|
7644
|
+
"type": "number"
|
|
7645
|
+
}
|
|
7646
|
+
},
|
|
7647
|
+
"required": [
|
|
7648
|
+
"withTax"
|
|
7649
|
+
]
|
|
7650
|
+
},
|
|
7651
|
+
"lineTotal": {
|
|
7652
|
+
"description": "Total amount for the line item, split by tax inclusion.",
|
|
7653
|
+
"type": "object",
|
|
7654
|
+
"properties": {
|
|
7655
|
+
"withTax": {
|
|
7656
|
+
"type": "number"
|
|
7657
|
+
},
|
|
7658
|
+
"withoutTax": {
|
|
7659
|
+
"type": "number"
|
|
7660
|
+
}
|
|
7661
|
+
},
|
|
7662
|
+
"required": [
|
|
7663
|
+
"withTax"
|
|
7664
|
+
]
|
|
7665
|
+
},
|
|
7666
|
+
"displayOrder": {
|
|
7667
|
+
"type": "integer",
|
|
7668
|
+
"description": "Order in which the line item is displayed on the invoice."
|
|
7669
|
+
},
|
|
7670
|
+
"originType": {
|
|
7671
|
+
"description": "Origin of the partner invoice line item:\n- **revenue**: The line item originated from a revenue entry on the settlement report.\n- **expense**: The line item originated from an expense entry on the settlement report.\n",
|
|
7672
|
+
"type": "string",
|
|
7673
|
+
"enum": [
|
|
7674
|
+
"revenue",
|
|
7675
|
+
"expense"
|
|
7676
|
+
],
|
|
7677
|
+
"example": "revenue"
|
|
7678
|
+
},
|
|
7679
|
+
"taxPercentage": {
|
|
7680
|
+
"type": "number",
|
|
7681
|
+
"description": "Tax percentage applied to the line item. Omitted on US/Canada invoices that have no tax breakdown."
|
|
7682
|
+
}
|
|
7478
7683
|
},
|
|
7479
|
-
"
|
|
7480
|
-
"
|
|
7481
|
-
"
|
|
7482
|
-
|
|
7684
|
+
"required": [
|
|
7685
|
+
"id",
|
|
7686
|
+
"service",
|
|
7687
|
+
"unit",
|
|
7688
|
+
"quantity",
|
|
7689
|
+
"unitPrice",
|
|
7690
|
+
"lineTotal",
|
|
7691
|
+
"displayOrder",
|
|
7692
|
+
"originType"
|
|
7693
|
+
]
|
|
7483
7694
|
},
|
|
7484
|
-
"
|
|
7485
|
-
"feePerSessionAc",
|
|
7486
|
-
"feePerSessionDc",
|
|
7487
|
-
"feePerKwhAc",
|
|
7488
|
-
"feePerKwhDc",
|
|
7489
|
-
"handlingFee"
|
|
7490
|
-
]
|
|
7491
|
-
},
|
|
7492
|
-
"invoiceState": {
|
|
7493
|
-
"description": "Partner invoicing lifecycle state of a settlement report:\n- **ready_to_invoice**: The settlement report is approved and no partner invoice has been generated yet.\n- **in_progress**: A partner invoice has been requested or is being processed by the invoice processor.\n- **invoiced**: A partner invoice has been successfully generated from this settlement report.\n",
|
|
7494
|
-
"type": "string",
|
|
7495
|
-
"enum": [
|
|
7496
|
-
"ready_to_invoice",
|
|
7497
|
-
"in_progress",
|
|
7498
|
-
"invoiced"
|
|
7499
|
-
],
|
|
7500
|
-
"example": "ready_to_invoice"
|
|
7695
|
+
"description": "Line items snapshotted from the source settlement report. Revenue entries appear as credits, expense entries as charges."
|
|
7501
7696
|
},
|
|
7502
|
-
"
|
|
7503
|
-
"type": "
|
|
7504
|
-
"
|
|
7697
|
+
"taxBreakdown": {
|
|
7698
|
+
"type": "array",
|
|
7699
|
+
"items": {
|
|
7700
|
+
"type": "object",
|
|
7701
|
+
"properties": {
|
|
7702
|
+
"taxPercentage": {
|
|
7703
|
+
"type": "number",
|
|
7704
|
+
"description": "Tax percentage applied to this group of line items."
|
|
7705
|
+
},
|
|
7706
|
+
"taxableAmount": {
|
|
7707
|
+
"type": "number",
|
|
7708
|
+
"description": "Sum of net line totals for line items at this tax rate."
|
|
7709
|
+
},
|
|
7710
|
+
"taxAmount": {
|
|
7711
|
+
"type": "number",
|
|
7712
|
+
"description": "Sum of tax amounts for line items at this tax rate."
|
|
7713
|
+
}
|
|
7714
|
+
},
|
|
7715
|
+
"required": [
|
|
7716
|
+
"taxPercentage",
|
|
7717
|
+
"taxableAmount",
|
|
7718
|
+
"taxAmount"
|
|
7719
|
+
]
|
|
7720
|
+
},
|
|
7721
|
+
"description": "Per-rate tax breakdown grouped from line items. Empty when the invoice has no line items or all line items have no tax rate (US/Canada)."
|
|
7505
7722
|
}
|
|
7506
7723
|
},
|
|
7507
7724
|
"required": [
|
|
7508
7725
|
"id",
|
|
7726
|
+
"operatorId",
|
|
7509
7727
|
"partnerId",
|
|
7728
|
+
"settlementReportId",
|
|
7510
7729
|
"number",
|
|
7511
|
-
"
|
|
7512
|
-
"
|
|
7513
|
-
"
|
|
7730
|
+
"type",
|
|
7731
|
+
"issuedOn",
|
|
7732
|
+
"dueOn",
|
|
7733
|
+
"paymentTermsDays",
|
|
7734
|
+
"paymentStatus",
|
|
7514
7735
|
"currencyCode",
|
|
7515
7736
|
"totalAmount",
|
|
7516
|
-
"
|
|
7517
|
-
"
|
|
7518
|
-
"
|
|
7519
|
-
"
|
|
7520
|
-
"totalCollectedRevenueFromPreviousPeriod",
|
|
7521
|
-
"totalEnergyCpoWh",
|
|
7522
|
-
"totalEnergyEmspWh",
|
|
7523
|
-
"supplier",
|
|
7524
|
-
"customer",
|
|
7525
|
-
"downloadUrl"
|
|
7737
|
+
"seller",
|
|
7738
|
+
"buyer",
|
|
7739
|
+
"lineItems",
|
|
7740
|
+
"taxBreakdown"
|
|
7526
7741
|
]
|
|
7527
7742
|
}
|
|
7528
7743
|
},
|
|
@@ -7595,8 +7810,8 @@
|
|
|
7595
7810
|
}
|
|
7596
7811
|
}
|
|
7597
7812
|
},
|
|
7598
|
-
"
|
|
7599
|
-
"
|
|
7813
|
+
"partnerSettlementReportIssuePartnerInvoice": {
|
|
7814
|
+
"202": {
|
|
7600
7815
|
"schema": {
|
|
7601
7816
|
"type": "object",
|
|
7602
7817
|
"properties": {
|
|
@@ -8408,19 +8623,918 @@
|
|
|
8408
8623
|
"handlingFee"
|
|
8409
8624
|
]
|
|
8410
8625
|
},
|
|
8411
|
-
"
|
|
8412
|
-
"
|
|
8626
|
+
"partnerInvoiceId": {
|
|
8627
|
+
"type": "integer",
|
|
8628
|
+
"description": "Identifier of the latest issued partner invoice for this settlement report.\nOmitted when no partner invoice has been issued.\nRetained after a credit note is issued — the credit note is a separate document and the reference points at the invoice the report produced.\n"
|
|
8629
|
+
}
|
|
8630
|
+
},
|
|
8631
|
+
"required": [
|
|
8632
|
+
"id",
|
|
8633
|
+
"partnerId",
|
|
8634
|
+
"number",
|
|
8635
|
+
"date",
|
|
8636
|
+
"periodStart",
|
|
8637
|
+
"periodEnd",
|
|
8638
|
+
"currencyCode",
|
|
8639
|
+
"totalAmount",
|
|
8640
|
+
"totalExpenses",
|
|
8641
|
+
"totalRevenue",
|
|
8642
|
+
"totalAwaitedRevenue",
|
|
8643
|
+
"totalCollectedRevenue",
|
|
8644
|
+
"totalCollectedRevenueFromPreviousPeriod",
|
|
8645
|
+
"totalEnergyCpoWh",
|
|
8646
|
+
"totalEnergyEmspWh",
|
|
8647
|
+
"supplier",
|
|
8648
|
+
"customer",
|
|
8649
|
+
"downloadUrl"
|
|
8650
|
+
]
|
|
8651
|
+
}
|
|
8652
|
+
},
|
|
8653
|
+
"required": [
|
|
8654
|
+
"data"
|
|
8655
|
+
]
|
|
8656
|
+
}
|
|
8657
|
+
},
|
|
8658
|
+
"401": {
|
|
8659
|
+
"schema": {
|
|
8660
|
+
"type": "object",
|
|
8661
|
+
"properties": {
|
|
8662
|
+
"message": {
|
|
8663
|
+
"type": "string"
|
|
8664
|
+
}
|
|
8665
|
+
}
|
|
8666
|
+
}
|
|
8667
|
+
},
|
|
8668
|
+
"403": {
|
|
8669
|
+
"schema": {
|
|
8670
|
+
"type": "object",
|
|
8671
|
+
"properties": {
|
|
8672
|
+
"message": {
|
|
8673
|
+
"type": "string",
|
|
8674
|
+
"default": "This action is unauthorized."
|
|
8675
|
+
}
|
|
8676
|
+
}
|
|
8677
|
+
}
|
|
8678
|
+
},
|
|
8679
|
+
"404": {
|
|
8680
|
+
"schema": {
|
|
8681
|
+
"type": "object",
|
|
8682
|
+
"properties": {
|
|
8683
|
+
"message": {
|
|
8684
|
+
"type": "string"
|
|
8685
|
+
}
|
|
8686
|
+
}
|
|
8687
|
+
}
|
|
8688
|
+
},
|
|
8689
|
+
"422": {
|
|
8690
|
+
"schema": {
|
|
8691
|
+
"type": "object",
|
|
8692
|
+
"required": [
|
|
8693
|
+
"message"
|
|
8694
|
+
],
|
|
8695
|
+
"properties": {
|
|
8696
|
+
"message": {
|
|
8697
|
+
"type": "string"
|
|
8698
|
+
},
|
|
8699
|
+
"errors": {
|
|
8700
|
+
"type": "object",
|
|
8701
|
+
"additionalProperties": {
|
|
8702
|
+
"type": "array",
|
|
8703
|
+
"items": {
|
|
8704
|
+
"type": "string"
|
|
8705
|
+
}
|
|
8706
|
+
}
|
|
8707
|
+
}
|
|
8708
|
+
}
|
|
8709
|
+
}
|
|
8710
|
+
},
|
|
8711
|
+
"429": {
|
|
8712
|
+
"schema": {
|
|
8713
|
+
"type": "object",
|
|
8714
|
+
"properties": {
|
|
8715
|
+
"message": {
|
|
8716
|
+
"type": "string"
|
|
8717
|
+
}
|
|
8718
|
+
}
|
|
8719
|
+
}
|
|
8720
|
+
}
|
|
8721
|
+
},
|
|
8722
|
+
"partnerSettlementReportUpdateExternalId": {
|
|
8723
|
+
"200": {
|
|
8724
|
+
"schema": {
|
|
8725
|
+
"type": "object",
|
|
8726
|
+
"properties": {
|
|
8727
|
+
"data": {
|
|
8728
|
+
"type": "object",
|
|
8729
|
+
"properties": {
|
|
8730
|
+
"id": {
|
|
8731
|
+
"type": "integer",
|
|
8732
|
+
"description": "Unique settlement report identifier."
|
|
8733
|
+
},
|
|
8734
|
+
"partnerId": {
|
|
8735
|
+
"type": "integer",
|
|
8736
|
+
"description": "Unique identifier of the partner involved in the settlement."
|
|
8737
|
+
},
|
|
8738
|
+
"number": {
|
|
8413
8739
|
"type": "string",
|
|
8414
|
-
"
|
|
8415
|
-
|
|
8416
|
-
|
|
8417
|
-
|
|
8740
|
+
"description": "Settlement report reference number."
|
|
8741
|
+
},
|
|
8742
|
+
"date": {
|
|
8743
|
+
"type": "string",
|
|
8744
|
+
"format": "date",
|
|
8745
|
+
"description": "Date the settlement report was generated."
|
|
8746
|
+
},
|
|
8747
|
+
"periodStart": {
|
|
8748
|
+
"type": "string",
|
|
8749
|
+
"format": "date",
|
|
8750
|
+
"description": "Start date of the period covered by the report."
|
|
8751
|
+
},
|
|
8752
|
+
"periodEnd": {
|
|
8753
|
+
"type": "string",
|
|
8754
|
+
"format": "date",
|
|
8755
|
+
"description": "End date of the period covered by the report."
|
|
8756
|
+
},
|
|
8757
|
+
"currencyCode": {
|
|
8758
|
+
"type": "string",
|
|
8759
|
+
"description": "Currency used in the settlement (e.g., USD, EUR)."
|
|
8760
|
+
},
|
|
8761
|
+
"totalAmount": {
|
|
8762
|
+
"type": "object",
|
|
8763
|
+
"properties": {
|
|
8764
|
+
"withoutTax": {
|
|
8765
|
+
"type": "number"
|
|
8766
|
+
}
|
|
8767
|
+
},
|
|
8768
|
+
"required": [
|
|
8769
|
+
"withoutTax"
|
|
8418
8770
|
],
|
|
8419
|
-
"
|
|
8771
|
+
"description": "Total settlement amount."
|
|
8772
|
+
},
|
|
8773
|
+
"totalExpenses": {
|
|
8774
|
+
"type": "number",
|
|
8775
|
+
"description": "Total expenses incurred during the settlement period."
|
|
8776
|
+
},
|
|
8777
|
+
"totalRevenue": {
|
|
8778
|
+
"type": "number",
|
|
8779
|
+
"description": "Total revenue generated during the settlement period."
|
|
8780
|
+
},
|
|
8781
|
+
"totalAwaitedRevenue": {
|
|
8782
|
+
"type": "number",
|
|
8783
|
+
"description": "Revenue expected but not yet collected."
|
|
8784
|
+
},
|
|
8785
|
+
"totalCollectedRevenue": {
|
|
8786
|
+
"type": "number",
|
|
8787
|
+
"description": "Revenue collected during the settlement period."
|
|
8788
|
+
},
|
|
8789
|
+
"totalCollectedRevenueFromPreviousPeriod": {
|
|
8790
|
+
"type": "number",
|
|
8791
|
+
"description": "Revenue collected during this period, but related to a previous periods."
|
|
8792
|
+
},
|
|
8793
|
+
"totalEnergyCpoWh": {
|
|
8794
|
+
"type": "number",
|
|
8795
|
+
"description": "Total amount of energy (in Wh) delivered by the Charge Point Operator."
|
|
8796
|
+
},
|
|
8797
|
+
"totalEnergyEmspWh": {
|
|
8798
|
+
"type": "number",
|
|
8799
|
+
"description": "Total amount of energy (in Wh) consumed by the EMSP."
|
|
8800
|
+
},
|
|
8801
|
+
"supplier": {
|
|
8802
|
+
"description": "Company details for the entity supplying the service - the CPO.",
|
|
8803
|
+
"type": "object",
|
|
8804
|
+
"properties": {
|
|
8805
|
+
"type": {
|
|
8806
|
+
"type": "string",
|
|
8807
|
+
"enum": [
|
|
8808
|
+
"individual",
|
|
8809
|
+
"company"
|
|
8810
|
+
]
|
|
8811
|
+
},
|
|
8812
|
+
"name": {
|
|
8813
|
+
"type": "string"
|
|
8814
|
+
},
|
|
8815
|
+
"contactPerson": {
|
|
8816
|
+
"type": "string",
|
|
8817
|
+
"nullable": true
|
|
8818
|
+
},
|
|
8819
|
+
"country": {
|
|
8820
|
+
"type": "string",
|
|
8821
|
+
"nullable": true,
|
|
8822
|
+
"enum": [
|
|
8823
|
+
"AF",
|
|
8824
|
+
"AX",
|
|
8825
|
+
"AL",
|
|
8826
|
+
"DZ",
|
|
8827
|
+
"AS",
|
|
8828
|
+
"AD",
|
|
8829
|
+
"AO",
|
|
8830
|
+
"AI",
|
|
8831
|
+
"AQ",
|
|
8832
|
+
"AG",
|
|
8833
|
+
"AR",
|
|
8834
|
+
"AM",
|
|
8835
|
+
"AW",
|
|
8836
|
+
"AU",
|
|
8837
|
+
"AT",
|
|
8838
|
+
"AZ",
|
|
8839
|
+
"BS",
|
|
8840
|
+
"BH",
|
|
8841
|
+
"BD",
|
|
8842
|
+
"BB",
|
|
8843
|
+
"BY",
|
|
8844
|
+
"BE",
|
|
8845
|
+
"BZ",
|
|
8846
|
+
"BJ",
|
|
8847
|
+
"BM",
|
|
8848
|
+
"BT",
|
|
8849
|
+
"BO",
|
|
8850
|
+
"BQ",
|
|
8851
|
+
"BA",
|
|
8852
|
+
"BW",
|
|
8853
|
+
"BV",
|
|
8854
|
+
"BR",
|
|
8855
|
+
"IO",
|
|
8856
|
+
"BN",
|
|
8857
|
+
"BG",
|
|
8858
|
+
"BF",
|
|
8859
|
+
"BI",
|
|
8860
|
+
"KH",
|
|
8861
|
+
"CM",
|
|
8862
|
+
"CA",
|
|
8863
|
+
"CV",
|
|
8864
|
+
"KY",
|
|
8865
|
+
"CF",
|
|
8866
|
+
"TD",
|
|
8867
|
+
"CL",
|
|
8868
|
+
"CN",
|
|
8869
|
+
"CX",
|
|
8870
|
+
"CC",
|
|
8871
|
+
"CO",
|
|
8872
|
+
"KM",
|
|
8873
|
+
"CG",
|
|
8874
|
+
"CD",
|
|
8875
|
+
"CK",
|
|
8876
|
+
"CR",
|
|
8877
|
+
"CI",
|
|
8878
|
+
"HR",
|
|
8879
|
+
"CU",
|
|
8880
|
+
"CW",
|
|
8881
|
+
"CY",
|
|
8882
|
+
"CZ",
|
|
8883
|
+
"DK",
|
|
8884
|
+
"DJ",
|
|
8885
|
+
"DM",
|
|
8886
|
+
"DO",
|
|
8887
|
+
"EC",
|
|
8888
|
+
"EG",
|
|
8889
|
+
"SV",
|
|
8890
|
+
"GQ",
|
|
8891
|
+
"ER",
|
|
8892
|
+
"EE",
|
|
8893
|
+
"ET",
|
|
8894
|
+
"FK",
|
|
8895
|
+
"FO",
|
|
8896
|
+
"FJ",
|
|
8897
|
+
"FI",
|
|
8898
|
+
"FR",
|
|
8899
|
+
"GF",
|
|
8900
|
+
"PF",
|
|
8901
|
+
"TF",
|
|
8902
|
+
"GA",
|
|
8903
|
+
"GM",
|
|
8904
|
+
"GE",
|
|
8905
|
+
"DE",
|
|
8906
|
+
"GH",
|
|
8907
|
+
"GI",
|
|
8908
|
+
"GR",
|
|
8909
|
+
"GL",
|
|
8910
|
+
"GD",
|
|
8911
|
+
"GP",
|
|
8912
|
+
"GU",
|
|
8913
|
+
"GT",
|
|
8914
|
+
"GG",
|
|
8915
|
+
"GN",
|
|
8916
|
+
"GW",
|
|
8917
|
+
"GY",
|
|
8918
|
+
"HT",
|
|
8919
|
+
"HM",
|
|
8920
|
+
"VA",
|
|
8921
|
+
"HN",
|
|
8922
|
+
"HK",
|
|
8923
|
+
"HU",
|
|
8924
|
+
"IS",
|
|
8925
|
+
"IN",
|
|
8926
|
+
"ID",
|
|
8927
|
+
"IR",
|
|
8928
|
+
"IQ",
|
|
8929
|
+
"IE",
|
|
8930
|
+
"IM",
|
|
8931
|
+
"IL",
|
|
8932
|
+
"IT",
|
|
8933
|
+
"JM",
|
|
8934
|
+
"JP",
|
|
8935
|
+
"JE",
|
|
8936
|
+
"JO",
|
|
8937
|
+
"KZ",
|
|
8938
|
+
"KE",
|
|
8939
|
+
"KI",
|
|
8940
|
+
"KP",
|
|
8941
|
+
"KR",
|
|
8942
|
+
"XK",
|
|
8943
|
+
"KW",
|
|
8944
|
+
"KG",
|
|
8945
|
+
"LA",
|
|
8946
|
+
"LV",
|
|
8947
|
+
"LB",
|
|
8948
|
+
"LS",
|
|
8949
|
+
"LR",
|
|
8950
|
+
"LY",
|
|
8951
|
+
"LI",
|
|
8952
|
+
"LT",
|
|
8953
|
+
"LU",
|
|
8954
|
+
"MO",
|
|
8955
|
+
"MK",
|
|
8956
|
+
"MG",
|
|
8957
|
+
"MW",
|
|
8958
|
+
"MY",
|
|
8959
|
+
"MV",
|
|
8960
|
+
"ML",
|
|
8961
|
+
"MT",
|
|
8962
|
+
"MH",
|
|
8963
|
+
"MQ",
|
|
8964
|
+
"MR",
|
|
8965
|
+
"MU",
|
|
8966
|
+
"YT",
|
|
8967
|
+
"MX",
|
|
8968
|
+
"FM",
|
|
8969
|
+
"MD",
|
|
8970
|
+
"MC",
|
|
8971
|
+
"MN",
|
|
8972
|
+
"ME",
|
|
8973
|
+
"MS",
|
|
8974
|
+
"MA",
|
|
8975
|
+
"MZ",
|
|
8976
|
+
"MM",
|
|
8977
|
+
"NA",
|
|
8978
|
+
"NR",
|
|
8979
|
+
"NP",
|
|
8980
|
+
"NL",
|
|
8981
|
+
"NC",
|
|
8982
|
+
"NZ",
|
|
8983
|
+
"NI",
|
|
8984
|
+
"NE",
|
|
8985
|
+
"NG",
|
|
8986
|
+
"NU",
|
|
8987
|
+
"NF",
|
|
8988
|
+
"MP",
|
|
8989
|
+
"NO",
|
|
8990
|
+
"OM",
|
|
8991
|
+
"PK",
|
|
8992
|
+
"PW",
|
|
8993
|
+
"PS",
|
|
8994
|
+
"PA",
|
|
8995
|
+
"PG",
|
|
8996
|
+
"PY",
|
|
8997
|
+
"PE",
|
|
8998
|
+
"PH",
|
|
8999
|
+
"PN",
|
|
9000
|
+
"PL",
|
|
9001
|
+
"PT",
|
|
9002
|
+
"PR",
|
|
9003
|
+
"QA",
|
|
9004
|
+
"RE",
|
|
9005
|
+
"RO",
|
|
9006
|
+
"RU",
|
|
9007
|
+
"RW",
|
|
9008
|
+
"BL",
|
|
9009
|
+
"SH",
|
|
9010
|
+
"KN",
|
|
9011
|
+
"LC",
|
|
9012
|
+
"MF",
|
|
9013
|
+
"PM",
|
|
9014
|
+
"VC",
|
|
9015
|
+
"WS",
|
|
9016
|
+
"SM",
|
|
9017
|
+
"ST",
|
|
9018
|
+
"SA",
|
|
9019
|
+
"SN",
|
|
9020
|
+
"RS",
|
|
9021
|
+
"SC",
|
|
9022
|
+
"SL",
|
|
9023
|
+
"SG",
|
|
9024
|
+
"SX",
|
|
9025
|
+
"SK",
|
|
9026
|
+
"SI",
|
|
9027
|
+
"SB",
|
|
9028
|
+
"SO",
|
|
9029
|
+
"ZA",
|
|
9030
|
+
"GS",
|
|
9031
|
+
"SS",
|
|
9032
|
+
"ES",
|
|
9033
|
+
"LK",
|
|
9034
|
+
"SD",
|
|
9035
|
+
"SR",
|
|
9036
|
+
"SJ",
|
|
9037
|
+
"SZ",
|
|
9038
|
+
"SE",
|
|
9039
|
+
"CH",
|
|
9040
|
+
"SY",
|
|
9041
|
+
"TW",
|
|
9042
|
+
"TJ",
|
|
9043
|
+
"TZ",
|
|
9044
|
+
"TH",
|
|
9045
|
+
"TL",
|
|
9046
|
+
"TG",
|
|
9047
|
+
"TK",
|
|
9048
|
+
"TO",
|
|
9049
|
+
"TT",
|
|
9050
|
+
"TN",
|
|
9051
|
+
"TR",
|
|
9052
|
+
"TM",
|
|
9053
|
+
"TC",
|
|
9054
|
+
"TV",
|
|
9055
|
+
"UG",
|
|
9056
|
+
"UA",
|
|
9057
|
+
"AE",
|
|
9058
|
+
"GB",
|
|
9059
|
+
"US",
|
|
9060
|
+
"UM",
|
|
9061
|
+
"UY",
|
|
9062
|
+
"UZ",
|
|
9063
|
+
"VU",
|
|
9064
|
+
"VE",
|
|
9065
|
+
"VN",
|
|
9066
|
+
"VG",
|
|
9067
|
+
"VI",
|
|
9068
|
+
"WF",
|
|
9069
|
+
"EH",
|
|
9070
|
+
"YE",
|
|
9071
|
+
"ZM",
|
|
9072
|
+
"ZW"
|
|
9073
|
+
]
|
|
9074
|
+
},
|
|
9075
|
+
"region": {
|
|
9076
|
+
"type": "string",
|
|
9077
|
+
"nullable": true
|
|
9078
|
+
},
|
|
9079
|
+
"city": {
|
|
9080
|
+
"type": "string",
|
|
9081
|
+
"nullable": true
|
|
9082
|
+
},
|
|
9083
|
+
"postCode": {
|
|
9084
|
+
"type": "string",
|
|
9085
|
+
"nullable": true
|
|
9086
|
+
},
|
|
9087
|
+
"address": {
|
|
9088
|
+
"type": "string",
|
|
9089
|
+
"nullable": true
|
|
9090
|
+
},
|
|
9091
|
+
"regNo": {
|
|
9092
|
+
"type": "string",
|
|
9093
|
+
"nullable": true
|
|
9094
|
+
},
|
|
9095
|
+
"taxId": {
|
|
9096
|
+
"type": "string",
|
|
9097
|
+
"nullable": true
|
|
9098
|
+
},
|
|
9099
|
+
"phone": {
|
|
9100
|
+
"type": "string",
|
|
9101
|
+
"nullable": true
|
|
9102
|
+
},
|
|
9103
|
+
"email": {
|
|
9104
|
+
"type": "string",
|
|
9105
|
+
"nullable": true
|
|
9106
|
+
}
|
|
9107
|
+
},
|
|
9108
|
+
"required": [
|
|
9109
|
+
"type",
|
|
9110
|
+
"name",
|
|
9111
|
+
"contactPerson",
|
|
9112
|
+
"country",
|
|
9113
|
+
"region",
|
|
9114
|
+
"city",
|
|
9115
|
+
"postCode",
|
|
9116
|
+
"address",
|
|
9117
|
+
"regNo",
|
|
9118
|
+
"taxId",
|
|
9119
|
+
"phone",
|
|
9120
|
+
"email"
|
|
9121
|
+
]
|
|
9122
|
+
},
|
|
9123
|
+
"customer": {
|
|
9124
|
+
"description": "Company details for the entity receiving the service - the Partner/EMSP.",
|
|
9125
|
+
"type": "object",
|
|
9126
|
+
"properties": {
|
|
9127
|
+
"type": {
|
|
9128
|
+
"type": "string",
|
|
9129
|
+
"enum": [
|
|
9130
|
+
"individual",
|
|
9131
|
+
"company"
|
|
9132
|
+
]
|
|
9133
|
+
},
|
|
9134
|
+
"name": {
|
|
9135
|
+
"type": "string"
|
|
9136
|
+
},
|
|
9137
|
+
"contactPerson": {
|
|
9138
|
+
"type": "string",
|
|
9139
|
+
"nullable": true
|
|
9140
|
+
},
|
|
9141
|
+
"country": {
|
|
9142
|
+
"type": "string",
|
|
9143
|
+
"nullable": true,
|
|
9144
|
+
"enum": [
|
|
9145
|
+
"AF",
|
|
9146
|
+
"AX",
|
|
9147
|
+
"AL",
|
|
9148
|
+
"DZ",
|
|
9149
|
+
"AS",
|
|
9150
|
+
"AD",
|
|
9151
|
+
"AO",
|
|
9152
|
+
"AI",
|
|
9153
|
+
"AQ",
|
|
9154
|
+
"AG",
|
|
9155
|
+
"AR",
|
|
9156
|
+
"AM",
|
|
9157
|
+
"AW",
|
|
9158
|
+
"AU",
|
|
9159
|
+
"AT",
|
|
9160
|
+
"AZ",
|
|
9161
|
+
"BS",
|
|
9162
|
+
"BH",
|
|
9163
|
+
"BD",
|
|
9164
|
+
"BB",
|
|
9165
|
+
"BY",
|
|
9166
|
+
"BE",
|
|
9167
|
+
"BZ",
|
|
9168
|
+
"BJ",
|
|
9169
|
+
"BM",
|
|
9170
|
+
"BT",
|
|
9171
|
+
"BO",
|
|
9172
|
+
"BQ",
|
|
9173
|
+
"BA",
|
|
9174
|
+
"BW",
|
|
9175
|
+
"BV",
|
|
9176
|
+
"BR",
|
|
9177
|
+
"IO",
|
|
9178
|
+
"BN",
|
|
9179
|
+
"BG",
|
|
9180
|
+
"BF",
|
|
9181
|
+
"BI",
|
|
9182
|
+
"KH",
|
|
9183
|
+
"CM",
|
|
9184
|
+
"CA",
|
|
9185
|
+
"CV",
|
|
9186
|
+
"KY",
|
|
9187
|
+
"CF",
|
|
9188
|
+
"TD",
|
|
9189
|
+
"CL",
|
|
9190
|
+
"CN",
|
|
9191
|
+
"CX",
|
|
9192
|
+
"CC",
|
|
9193
|
+
"CO",
|
|
9194
|
+
"KM",
|
|
9195
|
+
"CG",
|
|
9196
|
+
"CD",
|
|
9197
|
+
"CK",
|
|
9198
|
+
"CR",
|
|
9199
|
+
"CI",
|
|
9200
|
+
"HR",
|
|
9201
|
+
"CU",
|
|
9202
|
+
"CW",
|
|
9203
|
+
"CY",
|
|
9204
|
+
"CZ",
|
|
9205
|
+
"DK",
|
|
9206
|
+
"DJ",
|
|
9207
|
+
"DM",
|
|
9208
|
+
"DO",
|
|
9209
|
+
"EC",
|
|
9210
|
+
"EG",
|
|
9211
|
+
"SV",
|
|
9212
|
+
"GQ",
|
|
9213
|
+
"ER",
|
|
9214
|
+
"EE",
|
|
9215
|
+
"ET",
|
|
9216
|
+
"FK",
|
|
9217
|
+
"FO",
|
|
9218
|
+
"FJ",
|
|
9219
|
+
"FI",
|
|
9220
|
+
"FR",
|
|
9221
|
+
"GF",
|
|
9222
|
+
"PF",
|
|
9223
|
+
"TF",
|
|
9224
|
+
"GA",
|
|
9225
|
+
"GM",
|
|
9226
|
+
"GE",
|
|
9227
|
+
"DE",
|
|
9228
|
+
"GH",
|
|
9229
|
+
"GI",
|
|
9230
|
+
"GR",
|
|
9231
|
+
"GL",
|
|
9232
|
+
"GD",
|
|
9233
|
+
"GP",
|
|
9234
|
+
"GU",
|
|
9235
|
+
"GT",
|
|
9236
|
+
"GG",
|
|
9237
|
+
"GN",
|
|
9238
|
+
"GW",
|
|
9239
|
+
"GY",
|
|
9240
|
+
"HT",
|
|
9241
|
+
"HM",
|
|
9242
|
+
"VA",
|
|
9243
|
+
"HN",
|
|
9244
|
+
"HK",
|
|
9245
|
+
"HU",
|
|
9246
|
+
"IS",
|
|
9247
|
+
"IN",
|
|
9248
|
+
"ID",
|
|
9249
|
+
"IR",
|
|
9250
|
+
"IQ",
|
|
9251
|
+
"IE",
|
|
9252
|
+
"IM",
|
|
9253
|
+
"IL",
|
|
9254
|
+
"IT",
|
|
9255
|
+
"JM",
|
|
9256
|
+
"JP",
|
|
9257
|
+
"JE",
|
|
9258
|
+
"JO",
|
|
9259
|
+
"KZ",
|
|
9260
|
+
"KE",
|
|
9261
|
+
"KI",
|
|
9262
|
+
"KP",
|
|
9263
|
+
"KR",
|
|
9264
|
+
"XK",
|
|
9265
|
+
"KW",
|
|
9266
|
+
"KG",
|
|
9267
|
+
"LA",
|
|
9268
|
+
"LV",
|
|
9269
|
+
"LB",
|
|
9270
|
+
"LS",
|
|
9271
|
+
"LR",
|
|
9272
|
+
"LY",
|
|
9273
|
+
"LI",
|
|
9274
|
+
"LT",
|
|
9275
|
+
"LU",
|
|
9276
|
+
"MO",
|
|
9277
|
+
"MK",
|
|
9278
|
+
"MG",
|
|
9279
|
+
"MW",
|
|
9280
|
+
"MY",
|
|
9281
|
+
"MV",
|
|
9282
|
+
"ML",
|
|
9283
|
+
"MT",
|
|
9284
|
+
"MH",
|
|
9285
|
+
"MQ",
|
|
9286
|
+
"MR",
|
|
9287
|
+
"MU",
|
|
9288
|
+
"YT",
|
|
9289
|
+
"MX",
|
|
9290
|
+
"FM",
|
|
9291
|
+
"MD",
|
|
9292
|
+
"MC",
|
|
9293
|
+
"MN",
|
|
9294
|
+
"ME",
|
|
9295
|
+
"MS",
|
|
9296
|
+
"MA",
|
|
9297
|
+
"MZ",
|
|
9298
|
+
"MM",
|
|
9299
|
+
"NA",
|
|
9300
|
+
"NR",
|
|
9301
|
+
"NP",
|
|
9302
|
+
"NL",
|
|
9303
|
+
"NC",
|
|
9304
|
+
"NZ",
|
|
9305
|
+
"NI",
|
|
9306
|
+
"NE",
|
|
9307
|
+
"NG",
|
|
9308
|
+
"NU",
|
|
9309
|
+
"NF",
|
|
9310
|
+
"MP",
|
|
9311
|
+
"NO",
|
|
9312
|
+
"OM",
|
|
9313
|
+
"PK",
|
|
9314
|
+
"PW",
|
|
9315
|
+
"PS",
|
|
9316
|
+
"PA",
|
|
9317
|
+
"PG",
|
|
9318
|
+
"PY",
|
|
9319
|
+
"PE",
|
|
9320
|
+
"PH",
|
|
9321
|
+
"PN",
|
|
9322
|
+
"PL",
|
|
9323
|
+
"PT",
|
|
9324
|
+
"PR",
|
|
9325
|
+
"QA",
|
|
9326
|
+
"RE",
|
|
9327
|
+
"RO",
|
|
9328
|
+
"RU",
|
|
9329
|
+
"RW",
|
|
9330
|
+
"BL",
|
|
9331
|
+
"SH",
|
|
9332
|
+
"KN",
|
|
9333
|
+
"LC",
|
|
9334
|
+
"MF",
|
|
9335
|
+
"PM",
|
|
9336
|
+
"VC",
|
|
9337
|
+
"WS",
|
|
9338
|
+
"SM",
|
|
9339
|
+
"ST",
|
|
9340
|
+
"SA",
|
|
9341
|
+
"SN",
|
|
9342
|
+
"RS",
|
|
9343
|
+
"SC",
|
|
9344
|
+
"SL",
|
|
9345
|
+
"SG",
|
|
9346
|
+
"SX",
|
|
9347
|
+
"SK",
|
|
9348
|
+
"SI",
|
|
9349
|
+
"SB",
|
|
9350
|
+
"SO",
|
|
9351
|
+
"ZA",
|
|
9352
|
+
"GS",
|
|
9353
|
+
"SS",
|
|
9354
|
+
"ES",
|
|
9355
|
+
"LK",
|
|
9356
|
+
"SD",
|
|
9357
|
+
"SR",
|
|
9358
|
+
"SJ",
|
|
9359
|
+
"SZ",
|
|
9360
|
+
"SE",
|
|
9361
|
+
"CH",
|
|
9362
|
+
"SY",
|
|
9363
|
+
"TW",
|
|
9364
|
+
"TJ",
|
|
9365
|
+
"TZ",
|
|
9366
|
+
"TH",
|
|
9367
|
+
"TL",
|
|
9368
|
+
"TG",
|
|
9369
|
+
"TK",
|
|
9370
|
+
"TO",
|
|
9371
|
+
"TT",
|
|
9372
|
+
"TN",
|
|
9373
|
+
"TR",
|
|
9374
|
+
"TM",
|
|
9375
|
+
"TC",
|
|
9376
|
+
"TV",
|
|
9377
|
+
"UG",
|
|
9378
|
+
"UA",
|
|
9379
|
+
"AE",
|
|
9380
|
+
"GB",
|
|
9381
|
+
"US",
|
|
9382
|
+
"UM",
|
|
9383
|
+
"UY",
|
|
9384
|
+
"UZ",
|
|
9385
|
+
"VU",
|
|
9386
|
+
"VE",
|
|
9387
|
+
"VN",
|
|
9388
|
+
"VG",
|
|
9389
|
+
"VI",
|
|
9390
|
+
"WF",
|
|
9391
|
+
"EH",
|
|
9392
|
+
"YE",
|
|
9393
|
+
"ZM",
|
|
9394
|
+
"ZW"
|
|
9395
|
+
]
|
|
9396
|
+
},
|
|
9397
|
+
"region": {
|
|
9398
|
+
"type": "string",
|
|
9399
|
+
"nullable": true
|
|
9400
|
+
},
|
|
9401
|
+
"city": {
|
|
9402
|
+
"type": "string",
|
|
9403
|
+
"nullable": true
|
|
9404
|
+
},
|
|
9405
|
+
"postCode": {
|
|
9406
|
+
"type": "string",
|
|
9407
|
+
"nullable": true
|
|
9408
|
+
},
|
|
9409
|
+
"address": {
|
|
9410
|
+
"type": "string",
|
|
9411
|
+
"nullable": true
|
|
9412
|
+
},
|
|
9413
|
+
"regNo": {
|
|
9414
|
+
"type": "string",
|
|
9415
|
+
"nullable": true
|
|
9416
|
+
},
|
|
9417
|
+
"taxId": {
|
|
9418
|
+
"type": "string",
|
|
9419
|
+
"nullable": true
|
|
9420
|
+
},
|
|
9421
|
+
"phone": {
|
|
9422
|
+
"type": "string",
|
|
9423
|
+
"nullable": true
|
|
9424
|
+
},
|
|
9425
|
+
"email": {
|
|
9426
|
+
"type": "string",
|
|
9427
|
+
"nullable": true
|
|
9428
|
+
},
|
|
9429
|
+
"bankIban": {
|
|
9430
|
+
"type": "string",
|
|
9431
|
+
"nullable": true,
|
|
9432
|
+
"description": "IBAN of the bank account."
|
|
9433
|
+
},
|
|
9434
|
+
"bankName": {
|
|
9435
|
+
"type": "string",
|
|
9436
|
+
"nullable": true,
|
|
9437
|
+
"description": "Name of the bank."
|
|
9438
|
+
},
|
|
9439
|
+
"bankAddress": {
|
|
9440
|
+
"type": "string",
|
|
9441
|
+
"nullable": true,
|
|
9442
|
+
"description": "Address of the bank."
|
|
9443
|
+
},
|
|
9444
|
+
"bankCode": {
|
|
9445
|
+
"type": "string",
|
|
9446
|
+
"nullable": true,
|
|
9447
|
+
"description": "Bank code assigned by a central bank, a bank supervisory body or a Bankers Association in the country."
|
|
9448
|
+
},
|
|
9449
|
+
"bankAccountNumber": {
|
|
9450
|
+
"type": "string",
|
|
9451
|
+
"nullable": true,
|
|
9452
|
+
"description": "Bank account number."
|
|
9453
|
+
},
|
|
9454
|
+
"bankAccountType": {
|
|
9455
|
+
"type": "string",
|
|
9456
|
+
"nullable": true,
|
|
9457
|
+
"description": "Type of the bank account."
|
|
9458
|
+
},
|
|
9459
|
+
"bankAccountHolder": {
|
|
9460
|
+
"type": "string",
|
|
9461
|
+
"nullable": true,
|
|
9462
|
+
"description": "Name of the bank account holder."
|
|
9463
|
+
},
|
|
9464
|
+
"bankBic": {
|
|
9465
|
+
"type": "string",
|
|
9466
|
+
"nullable": true,
|
|
9467
|
+
"description": "BIC/SWIFT code of the bank."
|
|
9468
|
+
}
|
|
9469
|
+
},
|
|
9470
|
+
"required": [
|
|
9471
|
+
"type",
|
|
9472
|
+
"name",
|
|
9473
|
+
"contactPerson",
|
|
9474
|
+
"country",
|
|
9475
|
+
"region",
|
|
9476
|
+
"city",
|
|
9477
|
+
"postCode",
|
|
9478
|
+
"address",
|
|
9479
|
+
"regNo",
|
|
9480
|
+
"taxId",
|
|
9481
|
+
"phone",
|
|
9482
|
+
"email",
|
|
9483
|
+
"bankIban",
|
|
9484
|
+
"bankName",
|
|
9485
|
+
"bankAddress",
|
|
9486
|
+
"bankCode",
|
|
9487
|
+
"bankAccountNumber",
|
|
9488
|
+
"bankAccountType",
|
|
9489
|
+
"bankAccountHolder",
|
|
9490
|
+
"bankBic"
|
|
9491
|
+
]
|
|
9492
|
+
},
|
|
9493
|
+
"downloadUrl": {
|
|
9494
|
+
"type": "string",
|
|
9495
|
+
"format": "url",
|
|
9496
|
+
"description": "Link to download the full settlement report document."
|
|
9497
|
+
},
|
|
9498
|
+
"externalId": {
|
|
9499
|
+
"type": "string",
|
|
9500
|
+
"description": "External invoice or reference ID for integration with external accounting systems."
|
|
9501
|
+
},
|
|
9502
|
+
"deductedFees": {
|
|
9503
|
+
"description": "Aggregated deducted fees for the settlement period. Included only when at least one fee is non-zero.",
|
|
9504
|
+
"type": "object",
|
|
9505
|
+
"properties": {
|
|
9506
|
+
"feePerSessionAc": {
|
|
9507
|
+
"type": "number",
|
|
9508
|
+
"description": "Total fixed fee for AC sessions in the settlement period."
|
|
9509
|
+
},
|
|
9510
|
+
"feePerSessionDc": {
|
|
9511
|
+
"type": "number",
|
|
9512
|
+
"description": "Total fixed fee for DC sessions in the settlement period."
|
|
9513
|
+
},
|
|
9514
|
+
"feePerKwhAc": {
|
|
9515
|
+
"type": "number",
|
|
9516
|
+
"description": "Total fee per AC kWh delivered in the settlement period."
|
|
9517
|
+
},
|
|
9518
|
+
"feePerKwhDc": {
|
|
9519
|
+
"type": "number",
|
|
9520
|
+
"description": "Total fee per DC kWh delivered in the settlement period."
|
|
9521
|
+
},
|
|
9522
|
+
"handlingFee": {
|
|
9523
|
+
"type": "number",
|
|
9524
|
+
"description": "Total percentage-based handling fee for the settlement period."
|
|
9525
|
+
}
|
|
9526
|
+
},
|
|
9527
|
+
"required": [
|
|
9528
|
+
"feePerSessionAc",
|
|
9529
|
+
"feePerSessionDc",
|
|
9530
|
+
"feePerKwhAc",
|
|
9531
|
+
"feePerKwhDc",
|
|
9532
|
+
"handlingFee"
|
|
9533
|
+
]
|
|
8420
9534
|
},
|
|
8421
9535
|
"partnerInvoiceId": {
|
|
8422
9536
|
"type": "integer",
|
|
8423
|
-
"description": "Identifier of the latest issued partner invoice for this settlement report
|
|
9537
|
+
"description": "Identifier of the latest issued partner invoice for this settlement report.\nOmitted when no partner invoice has been issued.\nRetained after a credit note is issued — the credit note is a separate document and the reference points at the invoice the report produced.\n"
|
|
8424
9538
|
}
|
|
8425
9539
|
},
|
|
8426
9540
|
"required": [
|
|
@@ -10462,6 +11576,19 @@
|
|
|
10462
11576
|
}
|
|
10463
11577
|
}
|
|
10464
11578
|
},
|
|
11579
|
+
"424": {
|
|
11580
|
+
"schema": {
|
|
11581
|
+
"type": "object",
|
|
11582
|
+
"required": [
|
|
11583
|
+
"message"
|
|
11584
|
+
],
|
|
11585
|
+
"properties": {
|
|
11586
|
+
"message": {
|
|
11587
|
+
"type": "string"
|
|
11588
|
+
}
|
|
11589
|
+
}
|
|
11590
|
+
}
|
|
11591
|
+
},
|
|
10465
11592
|
"429": {
|
|
10466
11593
|
"schema": {
|
|
10467
11594
|
"type": "object",
|
|
@@ -25436,6 +26563,12 @@
|
|
|
25436
26563
|
"powerOptions": {
|
|
25437
26564
|
"type": "object",
|
|
25438
26565
|
"properties": {
|
|
26566
|
+
"maxOutputVoltage": {
|
|
26567
|
+
"type": "integer",
|
|
26568
|
+
"minimum": 1,
|
|
26569
|
+
"maximum": 1000,
|
|
26570
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
26571
|
+
},
|
|
25439
26572
|
"maxPower": {
|
|
25440
26573
|
"type": "integer",
|
|
25441
26574
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -25444,7 +26577,7 @@
|
|
|
25444
26577
|
"maxVoltage": {
|
|
25445
26578
|
"type": "string",
|
|
25446
26579
|
"nullable": true,
|
|
25447
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
26580
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
25448
26581
|
"enum": [
|
|
25449
26582
|
"230",
|
|
25450
26583
|
"380",
|
|
@@ -26020,6 +27153,12 @@
|
|
|
26020
27153
|
"powerOptions": {
|
|
26021
27154
|
"type": "object",
|
|
26022
27155
|
"properties": {
|
|
27156
|
+
"maxOutputVoltage": {
|
|
27157
|
+
"type": "integer",
|
|
27158
|
+
"minimum": 1,
|
|
27159
|
+
"maximum": 1000,
|
|
27160
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
27161
|
+
},
|
|
26023
27162
|
"maxPower": {
|
|
26024
27163
|
"type": "integer",
|
|
26025
27164
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -26028,7 +27167,7 @@
|
|
|
26028
27167
|
"maxVoltage": {
|
|
26029
27168
|
"type": "string",
|
|
26030
27169
|
"nullable": true,
|
|
26031
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
27170
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
26032
27171
|
"enum": [
|
|
26033
27172
|
"230",
|
|
26034
27173
|
"380",
|
|
@@ -26649,6 +27788,12 @@
|
|
|
26649
27788
|
"powerOptions": {
|
|
26650
27789
|
"type": "object",
|
|
26651
27790
|
"properties": {
|
|
27791
|
+
"maxOutputVoltage": {
|
|
27792
|
+
"type": "integer",
|
|
27793
|
+
"minimum": 1,
|
|
27794
|
+
"maximum": 1000,
|
|
27795
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
27796
|
+
},
|
|
26652
27797
|
"maxPower": {
|
|
26653
27798
|
"type": "integer",
|
|
26654
27799
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -26657,7 +27802,7 @@
|
|
|
26657
27802
|
"maxVoltage": {
|
|
26658
27803
|
"type": "string",
|
|
26659
27804
|
"nullable": true,
|
|
26660
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
27805
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
26661
27806
|
"enum": [
|
|
26662
27807
|
"230",
|
|
26663
27808
|
"380",
|
|
@@ -27269,6 +28414,12 @@
|
|
|
27269
28414
|
"powerOptions": {
|
|
27270
28415
|
"type": "object",
|
|
27271
28416
|
"properties": {
|
|
28417
|
+
"maxOutputVoltage": {
|
|
28418
|
+
"type": "integer",
|
|
28419
|
+
"minimum": 1,
|
|
28420
|
+
"maximum": 1000,
|
|
28421
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
28422
|
+
},
|
|
27272
28423
|
"maxPower": {
|
|
27273
28424
|
"type": "integer",
|
|
27274
28425
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -27277,7 +28428,7 @@
|
|
|
27277
28428
|
"maxVoltage": {
|
|
27278
28429
|
"type": "string",
|
|
27279
28430
|
"nullable": true,
|
|
27280
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
28431
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
27281
28432
|
"enum": [
|
|
27282
28433
|
"230",
|
|
27283
28434
|
"380",
|
|
@@ -53057,6 +54208,12 @@
|
|
|
53057
54208
|
"powerOptions": {
|
|
53058
54209
|
"type": "object",
|
|
53059
54210
|
"properties": {
|
|
54211
|
+
"maxOutputVoltage": {
|
|
54212
|
+
"type": "integer",
|
|
54213
|
+
"minimum": 1,
|
|
54214
|
+
"maximum": 1000,
|
|
54215
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
54216
|
+
},
|
|
53060
54217
|
"maxPower": {
|
|
53061
54218
|
"type": "integer",
|
|
53062
54219
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -53065,7 +54222,7 @@
|
|
|
53065
54222
|
"maxVoltage": {
|
|
53066
54223
|
"type": "string",
|
|
53067
54224
|
"nullable": true,
|
|
53068
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
54225
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
53069
54226
|
"enum": [
|
|
53070
54227
|
"230",
|
|
53071
54228
|
"380",
|
|
@@ -53668,6 +54825,12 @@
|
|
|
53668
54825
|
"powerOptions": {
|
|
53669
54826
|
"type": "object",
|
|
53670
54827
|
"properties": {
|
|
54828
|
+
"maxOutputVoltage": {
|
|
54829
|
+
"type": "integer",
|
|
54830
|
+
"minimum": 1,
|
|
54831
|
+
"maximum": 1000,
|
|
54832
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
54833
|
+
},
|
|
53671
54834
|
"maxPower": {
|
|
53672
54835
|
"type": "integer",
|
|
53673
54836
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -53676,7 +54839,7 @@
|
|
|
53676
54839
|
"maxVoltage": {
|
|
53677
54840
|
"type": "string",
|
|
53678
54841
|
"nullable": true,
|
|
53679
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
54842
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
53680
54843
|
"enum": [
|
|
53681
54844
|
"230",
|
|
53682
54845
|
"380",
|
|
@@ -54230,6 +55393,12 @@
|
|
|
54230
55393
|
"powerOptions": {
|
|
54231
55394
|
"type": "object",
|
|
54232
55395
|
"properties": {
|
|
55396
|
+
"maxOutputVoltage": {
|
|
55397
|
+
"type": "integer",
|
|
55398
|
+
"minimum": 1,
|
|
55399
|
+
"maximum": 1000,
|
|
55400
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
55401
|
+
},
|
|
54233
55402
|
"maxPower": {
|
|
54234
55403
|
"type": "integer",
|
|
54235
55404
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -54238,7 +55407,7 @@
|
|
|
54238
55407
|
"maxVoltage": {
|
|
54239
55408
|
"type": "string",
|
|
54240
55409
|
"nullable": true,
|
|
54241
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
55410
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
54242
55411
|
"enum": [
|
|
54243
55412
|
"230",
|
|
54244
55413
|
"380",
|
|
@@ -54855,6 +56024,12 @@
|
|
|
54855
56024
|
"powerOptions": {
|
|
54856
56025
|
"type": "object",
|
|
54857
56026
|
"properties": {
|
|
56027
|
+
"maxOutputVoltage": {
|
|
56028
|
+
"type": "integer",
|
|
56029
|
+
"minimum": 1,
|
|
56030
|
+
"maximum": 1000,
|
|
56031
|
+
"description": "Maximum output voltage for DC charging.\n"
|
|
56032
|
+
},
|
|
54858
56033
|
"maxPower": {
|
|
54859
56034
|
"type": "integer",
|
|
54860
56035
|
"description": "Maximum power of the EVSE in W (Watts).",
|
|
@@ -54863,7 +56038,7 @@
|
|
|
54863
56038
|
"maxVoltage": {
|
|
54864
56039
|
"type": "string",
|
|
54865
56040
|
"nullable": true,
|
|
54866
|
-
"description": "The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
56041
|
+
"description": "The maximum intake (input) voltage of the EVSE. For the ac current type the output voltage is the same as this intake voltage, while for the dc current type the output voltage can differ and is exposed separately in maxOutputVoltage. The maxVoltage of a charge point can fluctuate. Hence, when creating a charge point in the system, the maxVoltage is given as a range. For OCPI purposes it maps as follows: 220-240 = 230 110-130 = 120 400 = 400 380 = 380\n",
|
|
54867
56042
|
"enum": [
|
|
54868
56043
|
"230",
|
|
54869
56044
|
"380",
|
|
@@ -89103,19 +90278,9 @@
|
|
|
89103
90278
|
"handlingFee"
|
|
89104
90279
|
]
|
|
89105
90280
|
},
|
|
89106
|
-
"invoiceState": {
|
|
89107
|
-
"description": "Partner invoicing lifecycle state of a settlement report:\n- **ready_to_invoice**: The settlement report is approved and no partner invoice has been generated yet.\n- **in_progress**: A partner invoice has been requested or is being processed by the invoice processor.\n- **invoiced**: A partner invoice has been successfully generated from this settlement report.\n",
|
|
89108
|
-
"type": "string",
|
|
89109
|
-
"enum": [
|
|
89110
|
-
"ready_to_invoice",
|
|
89111
|
-
"in_progress",
|
|
89112
|
-
"invoiced"
|
|
89113
|
-
],
|
|
89114
|
-
"example": "ready_to_invoice"
|
|
89115
|
-
},
|
|
89116
90281
|
"partnerInvoiceId": {
|
|
89117
90282
|
"type": "integer",
|
|
89118
|
-
"description": "Identifier of the latest issued partner invoice for this settlement report
|
|
90283
|
+
"description": "Identifier of the latest issued partner invoice for this settlement report.\nOmitted when no partner invoice has been issued.\nRetained after a credit note is issued — the credit note is a separate document and the reference points at the invoice the report produced.\n"
|
|
89119
90284
|
}
|
|
89120
90285
|
},
|
|
89121
90286
|
"required": [
|
|
@@ -89217,6 +90382,28 @@
|
|
|
89217
90382
|
}
|
|
89218
90383
|
}
|
|
89219
90384
|
},
|
|
90385
|
+
"422": {
|
|
90386
|
+
"schema": {
|
|
90387
|
+
"type": "object",
|
|
90388
|
+
"required": [
|
|
90389
|
+
"message"
|
|
90390
|
+
],
|
|
90391
|
+
"properties": {
|
|
90392
|
+
"message": {
|
|
90393
|
+
"type": "string"
|
|
90394
|
+
},
|
|
90395
|
+
"errors": {
|
|
90396
|
+
"type": "object",
|
|
90397
|
+
"additionalProperties": {
|
|
90398
|
+
"type": "array",
|
|
90399
|
+
"items": {
|
|
90400
|
+
"type": "string"
|
|
90401
|
+
}
|
|
90402
|
+
}
|
|
90403
|
+
}
|
|
90404
|
+
}
|
|
90405
|
+
}
|
|
90406
|
+
},
|
|
89220
90407
|
"429": {
|
|
89221
90408
|
"schema": {
|
|
89222
90409
|
"type": "object",
|
|
@@ -90041,19 +91228,9 @@
|
|
|
90041
91228
|
"handlingFee"
|
|
90042
91229
|
]
|
|
90043
91230
|
},
|
|
90044
|
-
"invoiceState": {
|
|
90045
|
-
"description": "Partner invoicing lifecycle state of a settlement report:\n- **ready_to_invoice**: The settlement report is approved and no partner invoice has been generated yet.\n- **in_progress**: A partner invoice has been requested or is being processed by the invoice processor.\n- **invoiced**: A partner invoice has been successfully generated from this settlement report.\n",
|
|
90046
|
-
"type": "string",
|
|
90047
|
-
"enum": [
|
|
90048
|
-
"ready_to_invoice",
|
|
90049
|
-
"in_progress",
|
|
90050
|
-
"invoiced"
|
|
90051
|
-
],
|
|
90052
|
-
"example": "ready_to_invoice"
|
|
90053
|
-
},
|
|
90054
91231
|
"partnerInvoiceId": {
|
|
90055
91232
|
"type": "integer",
|
|
90056
|
-
"description": "Identifier of the latest issued partner invoice for this settlement report
|
|
91233
|
+
"description": "Identifier of the latest issued partner invoice for this settlement report.\nOmitted when no partner invoice has been issued.\nRetained after a credit note is issued — the credit note is a separate document and the reference points at the invoice the report produced.\n"
|
|
90057
91234
|
}
|
|
90058
91235
|
},
|
|
90059
91236
|
"required": [
|