{"components":{"responses":{"4XX_Client_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 4XX"},"5XX_Server_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 5XX"}},"schemas":{"AddressDto":{"description":"Shipping address for the debtor.","properties":{"academicTitle":{"description":"the academic title of the debtor. Must be between 0 and 255 characters/elements.","example":"Dr.","type":"string"},"addressAddition":{"description":"Optional additional address information. Must be between 0 and 255 characters/elements.","example":"3rd floor","type":"string"},"addressId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"addressIdent":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"addressType":{"description":"The type of the address. Cannot be changed after the initial POST. Must be one of:.\nMust not be null.","enum":["INVOICE","SHIPPING"],"example":"INVOICE","type":"string"},"agencyProfessionTitle":{"description":"Must be between 0 and 255 characters/elements.","type":"string"},"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"company":{"description":"Company name. Must be between 0 and 255 characters/elements.","example":"Nitrobox","type":"string"},"country":{"default":"DE","description":"Country code. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"debtorId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"department":{"description":"Department within a company. Must be between 0 and 255 characters/elements.","example":"Finance","type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParameters"},"email":{"description":"The debtor´s email. Must be between 0 and 255 characters/elements.","example":"info@customer.com","type":"string"},"firstname":{"description":"First name of recipient. Must be between 0 and 255 characters/elements.","example":"Max","type":"string"},"gender":{"default":"MALE","description":"Recipient's gender. Must be one of:","enum":["MALE","FEMALE","OTHER","NOTSET"],"type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"lastname":{"description":"Last name of recipient. Must be between 0 and 255 characters/elements.","example":"Mustermann","type":"string"},"postOfficeBox":{"description":"Number of the post office box","example":"42000","type":"string"},"preferredDocumentDelivery":{"default":"NONE","description":"Defines the preferred way of delivering documents to this debtor. Only used for Addresses of Type INVOICE. When set to EMAIL and addressType is INVOICE, the field email must be filled. Must be one of:","enum":["EMAIL","LETTER","NONE"],"example":"EMAIL","type":"string"},"properties":{"description":"Array of properties assigned to the specific address.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array","uniqueItems":true},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"stateCode":{"description":"State code. ISO 3166-2 subdivision code. Must be between 0 and 255 characters/elements.","example":"DE-BB","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"},"streetNo":{"description":"Street Number. Must be between 0 and 255 characters/elements.","example":"6","type":"string"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.","example":"3012034567890","type":"string"},"tenantId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"vatId":{"description":"Also known as VAT identification number (VATIN). An identifier used by name countries for Value Added Tax purposes to identify legal entities, especially in the EU","example":"DE1234567890","type":"string"},"zip":{"description":"Postcode. Must be between 0 and 10 characters/elements.","example":"22085","type":"string"}},"required":["addressType"],"type":"object"},"AgreedDepositCreationRequest":{"description":"A request to create an agreed deposit","properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"grossValue":{"$ref":"#/components/schemas/MonetaryValue_73"},"ident":{"description":"Unique external reference.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Human readable name, could be printed on document template","type":"string"},"netValue":{"$ref":"#/components/schemas/MonetaryValue_74"},"properties":{"description":"Additional agreed deposit properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"taxInformation":{"description":"All tax information for this agreed deposit.\nSize must be between 0 and 1.","items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"maxItems":1,"type":"array"},"taxValue":{"$ref":"#/components/schemas/MonetaryValue_75"}},"required":["grossValue","ident"],"type":"object"},"AgreedDepositResponse":{"description":"Deposits the customer agreed to.","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"grossValue":{"$ref":"#/components/schemas/MonetaryValue_33"},"ident":{"description":"Unique external reference.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Human readable name, could be printed on document template","type":"string"},"netValue":{"$ref":"#/components/schemas/MonetaryValue_34"},"properties":{"description":"Additional agreed deposit properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"source":{"description":"Source of the agreed deposit. Can be line item or order.\nMust be one of:\n|           |\n| --------- |\n| ORDER     |\n| LINE_ITEM |","type":"string"},"status":{"description":"Status of the agreed deposit","enum":["EXPECTED","PAID"],"type":"string"},"taxInformation":{"description":"All tax information for this agreed deposit.\nSize must be between 0 and 1.","items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"maxItems":1,"type":"array"},"taxValue":{"$ref":"#/components/schemas/MonetaryValue_35"}},"required":["createdAt","grossValue","ident","lastModifiedAt"],"type":"object"},"AgreedDepositTaxInformationDto":{"description":"Represents the details of associated tax information","properties":{"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","example":"QC","type":"string"},"taxRate":{"description":"Tax rate.\nMust not be null.\nMust be greater than or equal to 0.","example":19,"minimum":0,"type":"number"},"taxValue":{"$ref":"#/components/schemas/MonetaryValue_36"}},"required":["taxRate"],"type":"object"},"AgreedDepositUpdateRequest":{"description":"Deposits the customer agreed to.","properties":{"grossValue":{"$ref":"#/components/schemas/MonetaryValue_38"},"name":{"description":"Human readable name, could be printed on document template","type":"string"},"netValue":{"$ref":"#/components/schemas/MonetaryValue_39"},"properties":{"description":"Additional agreed deposit properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"taxInformation":{"description":"All tax information for this agreed deposit.\nSize must be between 0 and 1.","items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"maxItems":1,"type":"array"},"taxValue":{"$ref":"#/components/schemas/MonetaryValue_40"}},"required":["grossValue"],"type":"object"},"AllowanceCancellationRequest":{"description":"This cancellation request cancels all allowances with the given idents, which are not billed.","properties":{"allowances":{"description":"A List of allowance Idents, which shall be cancelled.\nMust not be empty.","items":{"$ref":"#/components/schemas/OrderAllowanceCancellationRequest"},"minItems":1,"type":"array"}},"required":["allowances"],"type":"object"},"AllowanceCreationRequest":{"description":"A request to create a new allowance. An allowance is assigned to a specific order. It represents a purchased product with its description, price and quantity. A order item is created when a new order is created. Order items automatically generate matching billable items. If additional items need to be assigned to a order, a new billable item must be generated. Please see Billable Item Model for more details.","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"description":{"description":"Description.","type":"string"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"itemGroup":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"itemType":{"description":"Type of the allowance.\nMust not be null.","enum":["DISCOUNT_USE","MULTI_PURPOSE_VOUCHER_USE","GOVERNMENT_GRANT","TRADE_IN"],"type":"string"},"name":{"description":"Name of the item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the iallowance. Only predefined operating site identifiers are allowed.","type":"string"},"performanceLocation":{"$ref":"#/components/schemas/AllowancePerformanceLocationRequest"},"properties":{"description":"Additional allowance properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_77"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_76"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxInformation":{"description":"All tax information for this allowance.\nSize must be between 1 and 1.","items":{"$ref":"#/components/schemas/AllowanceTaxInformationCreationRequest"},"maxItems":1,"minItems":1,"type":"array"},"taxLocation":{"$ref":"#/components/schemas/AllowanceTaxLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an allowance.","enum":["OSS","DEFAULT"],"type":"string"}},"required":["itemType","name","rowTotalGross","rowTotalNet"],"type":"object"},"AllowancePerformanceLocationRequest":{"description":"Where the service has been provided. Used for tax calculation and can be printed on documents.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"AllowancePerformanceLocationResponse":{"description":"Where the service has been provided. Used for tax calculation and can be printed on documents.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"AllowanceResponse":{"description":"A purchase item of this type is assigned to a specific order. It represents a purchased product with its description, price and quantity. A order item is created when a new order is created. Order items automatically generate matching billable items. If additional items need to be assigned to a order, a new billable item must be generated. Please see BillableItemCreationRequest for more details.","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars","example":"A-1234","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currency":{"description":"The currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditType":{"description":"Item type. Must be one of:.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"description":{"description":"Description.","type":"string"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"itemGroup":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"itemType":{"description":"Type of the purchase item.\nMust not be null.","enum":["DISCOUNT_USE","MULTI_PURPOSE_VOUCHER_USE","GOVERNMENT_GRANT","TRADE_IN"],"type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"performanceLocation":{"$ref":"#/components/schemas/AllowancePerformanceLocationResponse"},"processingDate":{"description":"Processing date.","format":"date-time","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_46"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_45"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use taxLocation and performanceLocation instead. The country where the product or service was sold. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"status":{"description":"The status of the purchase item","enum":["CANCELLED","ON_HOLD"],"type":"string"},"taxInformation":{"description":"All tax information for this order item.\nMust not be empty.","items":{"$ref":"#/components/schemas/AllowanceTaxInformationResponse"},"minItems":1,"type":"array"},"taxInformationSource":{"description":"The tax information source of the billable item.","enum":["NITROBOX","AVALARA","FINANCE_ENABLER","CUSTOMER_PROVIDED"],"type":"string"},"taxLocation":{"$ref":"#/components/schemas/AllowanceTaxLocationResponse"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"required":["createdAt","debitCreditType","ident","itemType","lastModifiedAt","name","taxInformation"],"type":"object"},"AllowanceTaxInformationCreationRequest":{"description":"A request to create a new tax information object. Represents the details of associated tax information","properties":{"rowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_41"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","example":"QC","type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"Name of the tax.","example":"GST","type":"string"},"taxRate":{"description":"Tax rate.\nMust not be null.\nMust be greater than or equal to 0.","example":19,"minimum":0,"type":"number"}},"required":["rowTotalTax","taxRate"],"type":"object"},"AllowanceTaxInformationResponse":{"description":"Represents the details of associated tax information","properties":{"rowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_44"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","example":"QC","type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"Name of the tax.","example":"GST","type":"string"},"taxRate":{"description":"Tax rate.","example":19,"type":"number"}},"type":"object"},"AllowanceTaxLocationRequest":{"description":"Where the service is taxable. Can be provided, but might be overwritten during tax calculation.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"AllowanceTaxLocationResponse":{"description":" Where the service is taxable. Can be provided, but might be overwritten during tax calculation. ","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"AllowanceUpdateRequest":{"description":"A request to update an allowance. An allowance is assigned to a specific order. It represents a purchased product with its description, price and quantity. A order item is created when a new order is created. Order items automatically generate matching billable items. If additional items need to be assigned to a order, a new billable item must be generated. Please see Billable Item Model for more details.","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"description":{"description":"Description.","type":"string"},"itemGroup":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"itemType":{"description":"Type of the allowance.\nMust not be null.","enum":["DISCOUNT_USE","MULTI_PURPOSE_VOUCHER_USE","GOVERNMENT_GRANT","TRADE_IN"],"type":"string"},"name":{"description":"Name of the item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the iallowance. Only predefined operating site identifiers are allowed.","type":"string"},"performanceLocation":{"$ref":"#/components/schemas/AllowancePerformanceLocationRequest"},"properties":{"description":"Additional allowance properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_43"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_42"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxInformation":{"description":"All tax information for this allowance.\nSize must be between 1 and 1.","items":{"$ref":"#/components/schemas/AllowanceTaxInformationCreationRequest"},"maxItems":1,"minItems":1,"type":"array"},"taxLocation":{"$ref":"#/components/schemas/AllowanceTaxLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an allowance.","enum":["OSS","DEFAULT"],"type":"string"}},"required":["itemType","name","rowTotalGross","rowTotalNet"],"type":"object"},"ApplicabilityDetailsRequest":{"description":"Information on how this option allowance should be applied to the option","properties":{"totalNumberOfPeriods":{"description":"The number of periods specifies for how many billing periods and thus documents the option allowance will be applied.\nMust be greater than or equal to 1.","format":"int32","minimum":1,"type":"integer"}},"type":"object"},"ApplicabilityDetailsResponse":{"description":"Information on how this option allowance should be applied to the option","properties":{"invoicedPeriods":{"description":"Shows for how many billing periods and thus documents the option allowance was already invoiced","format":"int32","type":"integer"},"totalNumberOfPeriods":{"description":"The number of periods specifies for how many billing periods and thus documents the option allowance will be applied.\nMust be greater than or equal to 1.","format":"int32","minimum":1,"type":"integer"}},"type":"object"},"AttachmentDto":{"description":"An attachment of a contract or order.","properties":{"contentType":{"description":"content type of a file","type":"string"},"fileName":{"description":"name of an attachment","type":"string"},"ident":{"description":"ident of a contract or order","type":"string"},"size":{"description":"size of an attachment","format":"int64","type":"integer"}},"type":"object"},"BatchCancellationRequest":{"description":"This cancellation request cancels the all given contract by idents.","properties":{"cancellationDate":{"description":"The cancellation date. Set to current date by default.","example":"2021-01-01T12:00:00Z","format":"date-time","type":"string"},"cancellationReason":{"description":"The cancellation Reason could be used for the credit note of cancelled items. Depending on the invoice template.","example":"Typo in debtor data.","type":"string"},"idents":{"description":"The idents to be cancelled.","items":{"description":"The idents to be cancelled.","type":"string"},"type":"array"}},"type":"object"},"BatchExtraOrdinaryContractTerminationRequest":{"description":"This contract termination request contains information about the termination.","properties":{"idents":{"description":"Reason for the Termination.","items":{"description":"Reason for the Termination.","type":"string"},"type":"array"},"reason":{"description":"Reason for the Termination.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"terminationDate":{"description":"Termination date, if not set the termination date will be end of today","format":"date-time","type":"string"}},"type":"object"},"BatchOrdinaryContractTerminationRequest":{"description":"contract termination request contains information about the termination.","properties":{"idents":{"description":"contract idents to be terminated.","items":{"description":"contract idents to be terminated.","type":"string"},"type":"array"},"noticeDate":{"description":"The effective notice date which serves as the starting point for calculating the contract endDate taking the notice period into account.","format":"date-time","type":"string"},"reason":{"description":"Reason for the Termination.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"type":"object"},"BillableItemExtraDto":{"description":"A billable item extra is a representation of a voucher for discounts or a discount applied to an item. Those itemExtras reduce the taxAmount that has to be paid for this item","properties":{"baseValue":{"description":"Base value is the unmodified amount of the deduction.","example":119,"type":"number"},"billableItemExtraId":{"description":"Unique Id.","format":"int64","type":"integer"},"currency":{"description":"The currency. Must be one of:.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"description":{"description":"Description.","type":"string"},"externalIdent":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"leftoverAmountGross":{"description":"The amount of money that is left over on the voucher that has been applied.","type":"number"},"name":{"description":"Name of the extra.","type":"string"},"refundabilityType":{"description":"Describes whether the item extra is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"taxInformation":{"description":"All tax information for this item covering multi tax cases and single tax cases as well within that list. Tax information replaces deprecated attributes below for single tax cases. Due to backward compatibility, the following applies:\n\n\n- when sending billable items using taxInformation is the preferred way; either tax information can be used or the single tax attributes, but not both\n- when fetching billable items, both tax information and single tax attributes are populated until all deprecated attributes will be removed\n\nMust not be empty.","items":{"$ref":"#/components/schemas/TaxInformationCreationRequest"},"minItems":1,"type":"array"},"type":{"description":"Type of the extra. Will be one of:.\nMust not be null.","enum":["VOUCHER","DISCOUNT","SINGLE_PURPOSE_VOUCHER"],"example":"SINGLE_PURPOSE_VOUCHER","type":"string"},"valueCumulatedTaxPrice":{"description":"Cumulated tax amount","example":100,"type":"number"},"valueExclusiveVat":{"description":"Net amount excluding vat that will be discounted.","example":100,"type":"number"},"valueInclusiveVat":{"description":"Gross amount including vat that will be discounted.\nMust not be null.","example":119,"type":"number"}},"required":["currency","taxInformation","type","valueExclusiveVat","valueInclusiveVat"],"type":"object"},"BillableItemPerformanceLocationRequest":{"description":"The detailed location where the product or service was performed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"BillableItemPerformanceLocationResponse":{"description":"The detailed location where the product or service was performed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"BillableItemResponse":{"description":"Response containing billable item data","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"billableItemId":{"format":"int64","type":"integer"},"billableItemIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"billablePostTaxItemExtras":{"description":"The item extras that don't reduce the taxAmount that has to be paid for this item.","items":{"$ref":"#/components/schemas/BillablePostTaxItemExtraDto"},"type":"array"},"billingPeriod":{"$ref":"#/components/schemas/BillingPeriodResponse"},"businessCase":{"description":"The action type that created this billable item.","enum":["PURCHASE","DEPOSIT","DEPOSIT_CANCELLATION","CANCELLATION","CORRECTION_CREATION","CORRECTION_CANCELLATION","SELF_BILLED","SELF_BILLED_CANCELLATION","SELF_BILLED_CORRECTION_CREATION","SELF_BILLED_CORRECTION_CANCELLATION"],"type":"string"},"businessSegmentId":{"description":"Reference to the business segment of the billable item.","format":"int64","type":"integer"},"category":{"default":"PHYSICAL_PRODUCT","description":"The category of an item. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","VOUCHER_PURCHASE","VOUCHER_APPLICATION","DISCOUNT","DISCOUNT_USE","MULTI_PURPOSE_VOUCHER_USE","GOVERNMENT_GRANT","TRADE_IN","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"contractId":{"description":"Reference to the contract of the billable item.","format":"int64","type":"integer"},"contractIdent":{"description":"Reference ident to the contract of the billable item.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"creationDate":{"deprecated":true,"description":"DEPRECATED: use 'createdAt'. The creation date","format":"date-time","type":"string"},"creditNoteIdent":{"description":"Credit note number. It is set by Nitrobox system when credit note is generated for this credit billable item.","type":"string"},"currency":{"description":"The currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"deliveryDate":{"description":"The planned delivery date.","format":"date-time","type":"string"},"description":{"description":"The billable item's description.","type":"string"},"detailedPerformanceLocation":{"$ref":"#/components/schemas/BillableItemPerformanceLocationResponse"},"detailedTaxLocation":{"$ref":"#/components/schemas/BillableItemTaxLocationResponse"},"documentDate":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: The custom document creation date for external document creation.","format":"date-time","type":"string"},"documentNumber":{"description":"Field to be used depending on tenant and business segment document generation strategy. Mandatory if CLIENT_PROVIDED strategy is active, not allowed otherwise.","type":"string"},"extras":{"description":"The billable item extras contain representations of vouchers for discounts or discounts applied to an item. Those item extras reduce the taxAmount that has to be paid for this item","items":{"$ref":"#/components/schemas/BillableItemExtraDto"},"type":"array"},"invoiceIdent":{"description":"Invoice number. Is set by Nitrobox system when billable item is invoiced.","type":"string"},"itemGroup":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"itemPeriodDuration":{"description":"Duration for billable items that span a certain period of time.","format":"int64","type":"integer"},"itemPeriodDurationType":{"description":"The type of duration for billable items that span a certain period of time. Must be one of:.\nMust be one of:\n|               |                                             |\n| ------------- | ------------------------------------------- |\n| SECOND        | DEPRECATED: duration of seconds             |\n| MINUTE        | DEPRECATED: duration of minutes             |\n| HOUR          | DEPRECATED: duration of hours               |\n| DAY           | DEPRECATED: duration of days                |\n| WEEK          | DEPRECATED: duration of weeks               |\n| MONTH         | DEPRECATED: duration of months              |\n| QUARTER_YEAR  | DEPRECATED: duration of a quarter of a year |\n| YEAR          | DEPRECATED: duration of a year              |\n| SECONDS       | duration of seconds                         |\n| MINUTES       | duration of minutes                         |\n| HOURS         | duration of hours                           |\n| DAYS          | duration of days                            |\n| WEEKS         | duration of weeks                           |\n| MONTHS        | duration of months                          |\n| QUARTER_YEARS | duration of a quarter of a year             |\n| YEARS         | duration of a year                          |\n| FOREVER       | duration of forever                         |","type":"string"},"itemPeriodEnd":{"description":"End date for billable items that span a certain period of time. Supports ISO 8601 offset information.","example":"2021-02-10T00:00:00Z","format":"date-time","type":"string"},"itemPeriodStart":{"description":"Start date for billable items that span a certain period of time. Supports ISO 8601 offset information.","example":"2021-02-10T00:00:00+01:00","format":"date-time","type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED: use 'lastModifiedAt'. The date of the last modification","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the billable item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"optionDescription":{"description":"The description of the option that belongs to the billable item.","type":"string"},"originType":{"description":"Type of origin.\nMust be one of:\n|           |                              |\n| --------- | ---------------------------- |\n| USAGE     | Origin is of type usage.     |\n| OPTION    | Origin is of type option.    |\n| LINE_ITEM | Origin is of type line item. |\n| ALLOWANCE | Origin is of type allowance. |","type":"string"},"originalRowTotalBase":{"description":"Basis for Tax calculation","type":"number"},"originalRowTotalCumulatedTaxPrice":{"description":"Cumulated tax price of original gross total of all items ","example":100,"type":"number"},"originalRowTotalExclusiveVat":{"description":"Net total of all items without vat before application of item.extras (unitQuantity * unitPriceExclusiveVat).\nMust not be null.","example":100,"type":"number"},"originalRowTotalInclusiveVat":{"description":"Gross total of all items with vat before application of item.extras (unitQuantity * unitPriceInclusiveVat).\nMust not be null.","example":119,"type":"number"},"performanceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"planName":{"description":"Name of the plan, where the billabe item belongs to.","type":"string"},"priceCalculationBasis":{"oneOf":[{"$ref":"#/components/schemas/BlockPriceCalculationBasisResponse"},{"$ref":"#/components/schemas/RecurringPriceCalculationBasisResponse"},{"$ref":"#/components/schemas/TierProgressivePriceCalculationBasisResponse"},{"$ref":"#/components/schemas/TierSinglePriceCalculationBasisResponse"},{"$ref":"#/components/schemas/TimeBasedUsagePriceCalculationBasisResponse"}]},"processedDate":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"date-time","type":"string"},"processingDate":{"description":"The ISO 8601 date at which the billable item will be processed for billing.","example":"2019-10-28T06:36:31Z","format":"date-time","type":"string"},"processingError":{"description":"The reason why the billable item is not processed and has the status error.","type":"string"},"processingStatus":{"description":"Status of processing.","enum":["NOT_STARTED","PENDING_RETRY","STARTED","IN_PROGRESS","RELATED_ITEM_PENDING","COMPLETED","ERROR","TERMINATED","CONFIG_ERROR","RECALCULATION_PENDING","RECALCULATION_ERROR"],"readOnly":true,"type":"string"},"productIdent":{"description":"The product ident of the billable item.","type":"string"},"properties":{"description":"The key-value pairs that can be used to extend the entity with additional custom data as needed.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"referenceType":{"description":"Reference to the contract or order of the billable item.","type":"string"},"relatedItemIdent":{"description":"Ident of related debit billable item. It should be provided to correctly match to debit counterpart","type":"string"},"rowTotalBase":{"description":"Basis for Tax calculation","type":"number"},"rowTotalCumulatedTaxPrice":{"description":"Cumulated tax price of gross total of all items ","example":100,"type":"number"},"rowTotalExclusiveVat":{"description":"Net total of all items without vat after application of item.extras.\nMust not be null.","example":100,"type":"number"},"rowTotalInclusiveVat":{"description":"Gross total of all items with vat after application of item.extras.\nMust not be null.","example":119,"type":"number"},"serviceBillingPeriod":{"$ref":"#/components/schemas/ServiceBillingPeriodResponse"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The country where the product or service was sold. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"statusReason":{"description":"The reason why the billable item is in a given state, e.g. due to processing errors.","type":"string"},"targetDocumentType":{"description":"Must be one of:","enum":["INVOICE","DEPOSITINVOICE","NONE"],"example":"INVOICE","type":"string"},"taxCalculationBasis":{"description":"The tax calculation basis of the billable item. May be null.\nMust be one of:\n|         |\n| ------- |\n| NET     |\n| GROSS   |\n| UNKNOWN |","example":"NET","type":"string"},"taxInformation":{"description":"All tax information for this item covering multi tax cases and single tax cases as well within that list. Tax information replaces deprecated attributes below for single tax cases. Due to backward compatibility, the following applies:\n\n- when sending billable items using taxInformation is the preferred way; either tax information can be used or the single tax attributes, but not both\n- when fetching billable items, both tax information and single tax attributes are populated until all deprecated attributes will be removed\n\nMust not be empty.","items":{"$ref":"#/components/schemas/BillableItemTaxInformationCreationRequest"},"minItems":1,"type":"array"},"taxInformationSource":{"description":"The tax information source of the billable item.","enum":["NITROBOX","AVALARA","FINANCE_ENABLER","CUSTOMER_PROVIDED"],"type":"string"},"taxLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"tenantId":{"description":"The id of the current tenant","format":"int64","type":"integer"},"type":{"description":"Must be one of:.\nMust not be null.","enum":["DEBIT","CREDIT"],"example":"DEBIT","type":"string"},"unitCumulatedTaxPrice":{"description":"Cumulated tax price of gross total of one unit","example":100,"type":"number"},"unitPriceBase":{"description":"Basis for Tax calculation","type":"number"},"unitPriceExclusiveVat":{"description":"Net price of one unit without vat.\nMust not be null.","example":1,"type":"number"},"unitPriceInclusiveVat":{"description":"Gross price of one unit with vat.\nMust not be null.","example":1.19,"type":"number"},"unitQuantity":{"description":"Number of units.\nMust not be null.","example":100,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Must be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"},"usageDescription":{"description":"The description of the usage that belongs to the billable item.","type":"string"}},"required":["name","originalRowTotalExclusiveVat","originalRowTotalInclusiveVat","rowTotalExclusiveVat","rowTotalInclusiveVat","taxInformation","type","unitPriceExclusiveVat","unitPriceInclusiveVat","unitQuantity","unitQuantityType"],"type":"object"},"BillableItemTaxInformationCreationRequest":{"description":"A request to create a new tax information object. Represents the details of associated tax information","properties":{"originalRowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_79"},"rowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_80"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxClassifications":{"description":"Tax classifications, used for filtering the correct tax rule.","items":{"$ref":"#/components/schemas/TaxClassificationDto"},"type":"array"},"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","example":"QC","type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"Name of the tax.","example":"GST","type":"string"},"taxRate":{"description":"Tax rate.\nMust not be null.\nMust be greater than or equal to 0.","example":19,"minimum":0,"type":"number"},"unitPriceTax":{"$ref":"#/components/schemas/MonetaryValue_81"}},"required":["originalRowTotalTax","rowTotalTax","taxRate","unitPriceTax"],"type":"object"},"BillableItemTaxLocationRequest":{"description":"The detailed location where the product or service should be taxed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"BillableItemTaxLocationResponse":{"description":"The detailed location where the product or service should be taxed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"BillablePostTaxItemExtraDto":{"description":"A billable post tax item extra is a representation of a multi purpose voucher applied to an item. Those itemExtras don't reduce the taxAmount that has to be paid for this item.","properties":{"currency":{"description":"The currency. Must be one of:.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"description":{"description":"Description.","type":"string"},"externalReference":{"description":"Additional reference for third party system, like voucher management system.","type":"string"},"id":{"description":"Unique Id.","format":"int64","type":"integer"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"leftoverAmountGross":{"description":"The amount of money that is left over on the voucher that has been applied.","type":"number"},"name":{"description":"Name of the extra.","type":"string"},"refundabilityType":{"description":"Describes whether the item extra is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"type":{"description":"Type of the extra. Will be one of:.\nMust not be null.","enum":["MULTI_PURPOSE_VOUCHER"],"example":"MULTI_PURPOSE_VOUCHER","type":"string"},"value":{"description":"The amount that will be discounted.\nMust not be null.","example":100,"type":"number"}},"required":["currency","type","value"],"type":"object"},"BillingGroupCreationRequest":{"description":"A billing group configures which items can go together on a document.","properties":{"billing":{"description":"Configure if the billing should be handled internal or external","enum":["EXTERNAL_BILLING","NBX_BILLING"],"type":"string"},"billingGroupIdent":{"description":"Ident for the Billing Group, must be unique. If none is provided a random UUID will be generated automatically. This ident can later be used to determine the document template.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"businessSegments":{"description":"List of Business Segments.\nMust not be empty.","items":{"$ref":"#/components/schemas/BusinessSegmentCreationRequest"},"minItems":1,"type":"array"},"contractDocumentDateDetermination":{"description":"Determines which date will be set as document date. Use \"DOCUMENT_CREATION\" when the document date will be the date the actual document is being processed. Use \"BILLING_PERIOD\" when the date should be according to in the plan configured Billing Timing","enum":["DOCUMENT_CREATION","BILLING_PERIOD"],"type":"string"},"currencyRoundingOverrides":{"description":"Specifies the number of decimal places to which a currency should be rounded, overriding the ISO 4217 standard. Must be equal to or less than the standard specified by ISO and cannot be negative. A zero value indicates rounding to whole units.\nMust not be null.","items":{"$ref":"#/components/schemas/CurrencyRoundingOverrideDto"},"type":"array"},"depositInvoiceCreation":{"description":"Configure if a deposit invoice should be created and if in which case it will be created","enum":["NONE","AT_ORDER_CREATION"],"type":"string"},"depositReceivableRelevant":{"default":false,"description":"Determines if a deposit invoice should be treated as a receivables opening document or not","example":false,"type":"boolean"},"documentCorrectionMode":{"default":"ITEM_BASED","description":"Defines how document corrections should be applied. Either on an item level or as a complete document.\nMust be one of:\n|                |\n| -------------- |\n| ITEM_BASED     |\n| DOCUMENT_BASED |","type":"string"},"documentNumberConfiguration":{"description":"Optional configuration to overwrite the document number configuration on tenant level for certain target document types.","items":{"$ref":"#/components/schemas/DocumentNumberConfigurationRequest"},"type":"array"},"localeConfiguration":{"description":"Mandatory configuration that defines country, region, and language configuration for billing group.\nMust not be empty.","items":{"$ref":"#/components/schemas/LocaleCountryConfigurationRequest"},"minItems":1,"type":"array"},"name":{"description":"Name of the Billing Group.\nMust not be blank.\nSize must be between 0 and 255.","example":"Subscriptions","maxLength":255,"type":"string"},"optionPriceDetermination":{"default":"TAX_LOCATION","description":"Determines what location should be used for option price determination: Either TAX_LOCATION or PERFORMANCE_LOCATION.\nMust not be null.\nMust be one of:\n|                      |\n| -------------------- |\n| TAX_LOCATION         |\n| PERFORMANCE_LOCATION |","type":"string"},"taxCalculationConfig":{"$ref":"#/components/schemas/TaxCalculationConfigDto"}},"required":["billingGroupIdent","businessSegments","currencyRoundingOverrides","localeConfiguration","name","optionPriceDetermination"],"type":"object"},"BillingGroupDto":{"description":"A billing group configures which items can go together on a document.","properties":{"billing":{"description":"Configure if the billing should be handled internal or external","enum":["EXTERNAL_BILLING","NBX_BILLING"],"type":"string"},"billingGroupIdent":{"description":"Ident for the Billing Group, must be unique. If none is provided a random UUID will be generated automatically. This ident can later be used to determine the document template.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"businessSegments":{"description":"List of Business Segments.","items":{"$ref":"#/components/schemas/BusinessSegmentDto"},"type":"array"},"contractDocumentDateDetermination":{"description":"Determines which date will be set as document date. Use \"DOCUMENT_CREATION\" when the document date will be the date the actual document is being processed. Use \"BILLING_PERIOD\" when the date should be according to in the plan configured Billing Timing","enum":["DOCUMENT_CREATION","BILLING_PERIOD"],"type":"string"},"currencyRoundingOverrides":{"description":"Specifies the number of decimal places to which a currency should be rounded, overriding the ISO 4217 standard. Must be equal to or less than the standard specified by ISO and cannot be negative. A zero value indicates rounding to whole units.\nMust not be null.","items":{"$ref":"#/components/schemas/CurrencyRoundingOverrideDto"},"type":"array"},"defaultBillingGroup":{"description":"Is true, when this BillingGroup contains the BusinessSegment marked as Default","type":"boolean"},"depositInvoiceCreation":{"description":"Configure if a deposit invoice should be created and if in which case it will be created","enum":["NONE","AT_ORDER_CREATION"],"type":"string"},"depositReceivableRelevant":{"description":"Determines if a deposit invoice should be treated as a receivables opening document or not","type":"boolean"},"documentCorrectionMode":{"description":"Defines how document corrections should be applied. Either on an item level or as a complete document.\nMust be one of:\n|                |\n| -------------- |\n| ITEM_BASED     |\n| DOCUMENT_BASED |","type":"string"},"documentNumberConfiguration":{"description":"Optional configuration to overwrite the document number configuration on tenant level for certain target document types.","items":{"$ref":"#/components/schemas/DocumentNumberConfigurationRequest"},"type":"array"},"id":{"description":"Id of the Billing Group","format":"int64","type":"integer"},"localeConfiguration":{"description":"Mandatory configuration that defines country, region, and language configuration for billing group.","items":{"$ref":"#/components/schemas/LocaleCountryConfigurationRequest"},"type":"array"},"name":{"description":"Name of the Billing Group","type":"string"},"optionPriceDetermination":{"description":"Determines what location should be used for option price determination: Either TAX_LOCATION or PERFORMANCE_LOCATION.\nMust be one of:\n|                      |\n| -------------------- |\n| TAX_LOCATION         |\n| PERFORMANCE_LOCATION |","type":"string"},"splittingConfig":{"$ref":"#/components/schemas/SplittingConfigDto"},"taxCalculationConfig":{"$ref":"#/components/schemas/TaxCalculationConfigDto"}},"required":["currencyRoundingOverrides"],"type":"object"},"BillingGroupResendRequest":{"properties":{"billingGroupIdents":{"items":{"type":"string"},"type":"array"}},"type":"object"},"BillingGroupUpdateRequest":{"description":"Request to update a Billing Group. Only the contained attributes can be changed after creation.","properties":{"contractDocumentDateDetermination":{"description":"Determines which date will be set as document date. Use \"DOCUMENT_CREATION\" when the document date will be the date the actual document is being processed. Use \"BILLING_PERIOD\" when the date should be according to in the plan configured Billing Timing","enum":["DOCUMENT_CREATION","BILLING_PERIOD"],"type":"string"},"currencyRoundingOverrides":{"description":"Specifies the number of decimal places to which a currency should be rounded, overriding the ISO 4217 standard. Must be equal to or less than the standard specified by ISO and cannot be negative. A zero value indicates rounding to whole units.\nMust not be null.","items":{"$ref":"#/components/schemas/CurrencyRoundingOverrideDto"},"type":"array"},"depositInvoiceCreation":{"description":"Configure if a deposit invoice should be created and if in which case it will be created","enum":["NONE","AT_ORDER_CREATION"],"type":"string"},"depositReceivableRelevant":{"default":false,"description":"Determines if a deposit invoice should be treated as a receivables opening document or not","example":false,"type":"boolean"},"documentCorrectionMode":{"default":"ITEM_BASED","description":"Defines how document corrections should be applied. Either on an item level or as a complete document.\nMust be one of:\n|                |\n| -------------- |\n| ITEM_BASED     |\n| DOCUMENT_BASED |","type":"string"},"documentNumberConfiguration":{"description":"Optional configuration to override document number validation for certain target document types","items":{"$ref":"#/components/schemas/DocumentNumberConfigurationRequest"},"type":"array"},"localeConfiguration":{"description":"Configuration that defines country, region, and language configuration for business segment.","items":{"$ref":"#/components/schemas/LocaleCountryConfigurationRequest"},"type":"array"},"name":{"description":"Name of the billing group.\nMust not be blank.\nSize must be between 0 and 255.","example":"My Billing group","maxLength":255,"type":"string"},"optionPriceDetermination":{"default":"TAX_LOCATION","description":"Determines what location should be used for option price determination: Either TAX_LOCATION or PERFORMANCE_LOCATION.\nMust be one of:\n|                      |\n| -------------------- |\n| TAX_LOCATION         |\n| PERFORMANCE_LOCATION |","type":"string"}},"required":["currencyRoundingOverrides","name"],"type":"object"},"BillingPeriodResponse":{"description":"The start and end date of the billing period.","properties":{"end":{"description":"The end date of the billing period.\nMust not be null.","format":"date-time","type":"string"},"start":{"description":"The start date of the billing period.\nMust not be null.","format":"date-time","type":"string"}},"required":["end","start"],"type":"object"},"BlockPriceCalculationBasisResponse":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasisResponse"},{"properties":{"blocks":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/BlockPriceResponse"},"minItems":1,"type":"array"}},"type":"object"}],"required":["blocks","type"],"type":"object"},"BlockPriceResponse":{"description":"Information about each block tier.","properties":{"blockPrice":{"$ref":"#/components/schemas/MonetaryValue_90"},"blockQuantity":{"description":"Number of times a block has been reached.","format":"int64","type":"integer"},"blockSize":{"description":"Size of each block.","type":"number"},"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"totalPrice":{"$ref":"#/components/schemas/MonetaryValue_91"},"usedQuantity":{"description":"Actual quantity used within this block tier.","type":"number"}},"type":"object"},"BusinessSegmentCreationRequest":{"description":"Request to create a business segment. If it is the only segment in the system, it will be set as default automatically.","properties":{"description":{"description":"Description of the business segment.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"name":{"description":"Name of the business segment.\nMust not be blank.\nSize must be between 0 and 255.","example":"My Business segment","maxLength":255,"type":"string"},"segmentIdent":{"description":"Ident of the business segment to create. Must be unique.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"160","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["name","segmentIdent"],"type":"object"},"BusinessSegmentDto":{"description":"A Business segment is a concept to segment the business into different parts. They can be combined or be processed exclusively.","properties":{"billingGroupIdent":{"description":"Reference to the billing group of the order.","type":"string"},"defaultSegment":{"description":"Defines if the Business Segment is used as default if none is specified.","type":"boolean"},"description":{"description":"Description.","type":"string"},"name":{"description":"Name of the Business Segment","type":"string"},"segmentId":{"description":"Id of the Business Segment","format":"int64","type":"integer"},"segmentIdent":{"description":"Ident fo the Business Segment","type":"string"}},"type":"object"},"BusinessSegmentUpdateRequest":{"description":"Request to update a Business Segment. Only the contained attributes can be changed after creation.","properties":{"description":{"description":"Description of the business segment.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"name":{"description":"Name of the business segment.\nMust not be blank.\nSize must be between 0 and 255.","example":"My Business segment","maxLength":255,"type":"string"}},"required":["name"],"type":"object"},"CancellationItemDto":{"description":"This cancellation request cancels all items (purchaseItems, lineItems) with the given idents and optionally adds a reason for the cancellation, so it can be printing on the credit memo.","properties":{"ident":{"description":"An Ident, that specifies the item to be cancelled.\nMust not be empty.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["ident"],"type":"object"},"CancellationRequest":{"description":"This cancellation request cancels the whole contract or order with all regarding items.","properties":{"cancellationDate":{"description":"The cancellation date. Set to current date by default.","example":"2021-01-01T12:00:00Z","format":"date-time","type":"string"},"cancellationReason":{"description":"The cancellation Reason could be used for the credit note of cancelled items. Depending on the invoice template.","example":"Typo in debtor data.","type":"string"}},"type":"object"},"CommissionOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"commissionedOptionIdent":{"description":"Option that, when invoiced, will trigger a commission.","example":"option-ident","type":"string"},"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"An Option that defines for which existing options commissions will be paid.","required":["name","prices","type"],"type":"object"},"CommissionOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"commissionedOptionIdent":{"description":"Option that, when invoiced, will trigger a commission.","example":"option-ident","type":"string"},"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"An Option that defines for which existing options commissions will be paid.","required":["name","prices","type"],"type":"object"},"CommissionOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"type":"object"}],"description":"An Option that defines for which existing options commissions will be paid.","required":["name","prices","type"],"type":"object"},"CommissionOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"commissionedOptionIdent":{"description":"Option that, when invoiced, will trigger a commission.","example":"option-ident","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"}},"type":"object"}],"description":"An Option that defines for which existing options commissions will be paid.","required":["name","prices"],"type":"object"},"ContractActivationRequest":{"description":"This activation request sets the start and end date for the contract to these new values.","properties":{"billingStartDate":{"description":"The date when actual billing starts for this contract. If left empty the contract will be billed from the startDate.","format":"date","type":"string"},"startDate":{"description":"New start date for the contract","format":"date-time","type":"string"}},"type":"object"},"ContractBillableItemCancellationRequest":{"description":"This cancellation request for cancelling the billable item","properties":{"cancellationReason":{"description":"The cancellation reason could be used for the credit note of a cancelled item. Depending on the invoice template.","type":"string"}},"type":"object"},"ContractBillableItemCorrectionRequest":{"description":"This request is used to correct billable items originating from contract options.","properties":{"properties":{"description":"New properties are applied to the issued cancellation and correction items. If a property with the same key already exists, it is updated on both items.","items":{"$ref":"#/components/schemas/PropertyCreationRequest"},"type":"array"},"reason":{"description":"Reason for the correction.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"unitPrice":{"description":"The corrected unit price for the billable item.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 19 integral digits and up to 4 fractional digits.","example":1.19,"type":"number"}},"required":["unitPrice"],"type":"object"},"ContractCreationRequest":{"description":"Please see Plan Model below for more information regarding required values and input type.","properties":{"billingStartDate":{"description":"The date when actual billing starts for this contract. If left empty the contract will be billed from the startDate.","example":"2021-01-01","format":"date","type":"string"},"businessSegmentId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use business segment ident instead. The Id of the business segment for the contract. The default segment will be used if not set.","example":161,"format":"int64","type":"integer"},"businessSegmentIdent":{"description":"The Ident of the business segment for the Plan. The default segment will be used if not set.","type":"string"},"contractIdent":{"description":"Must be a unique external reference. Cannot be changed later on.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust be unique.","example":"nbx_contractIdent_12345","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"contractPriceAdaptation":{"$ref":"#/components/schemas/ContractPriceAdaptationRequest"},"country":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. Country that determines which price and tax will be applied and which price picked for subscriptions and one time options for this contract. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"date":{"description":"Defines when the contract is signed.\nMust not be null.","format":"date-time","type":"string"},"debtorId":{"deprecated":true,"description":"DEPRECATED.\nMust be the correct debtorId to which the contract will be assigned. Either debtorId or debtorIdent must present. DebtorIdent is preferred.","format":"int64","type":"integer"},"debtorIdent":{"description":"Must be the correct debtorIdent to which the contract will be assigned.\nSize must be between 0 and 100.\nMust match with the regular expression '[a-zA-Z0-9_.~@-]*'.","example":"nbx_debtor_12345","maxLength":100,"pattern":"[a-zA-Z0-9_.~@-]*","type":"string"},"durationType":{"deprecated":true,"description":"DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration type. Must be one of:","enum":["DAY","MONTH","YEAR","FOREVER"],"example":"MONTH","type":"string"},"durationValue":{"deprecated":true,"description":"DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration of the contract.","example":12,"format":"int32","type":"integer"},"endDate":{"deprecated":true,"description":"DEPRECATED: Explicitly terminate the contract using our contract termination endpoints instead. Usage of this field can result in unexpected behavior.","format":"date-time","type":"string"},"invoiceAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Must be the correct ID for the invoice address of the debtor to which the contract will be assigned. Please use non-deprecated invoiceAddressIdent.","format":"int64","type":"integer"},"invoiceAddressIdent":{"description":"Must be the correct ident for the invoice address of the debtor to which the contract will be assigned.","type":"string"},"language":{"default":"de","description":"Optional language code in ISO 639-1 standard. Must be one of business segment valid languages.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"lineItems":{"description":"A list of line items included in the contract. Please see Line Item Model for more details","items":{"$ref":"#/components/schemas/ContractLineItemCreationRequest"},"type":"array"},"optionQuantities":{"description":"Must not be null.","items":{"$ref":"#/components/schemas/PhaseOptionQuantityRequest"},"type":"array"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformationCreationRequest"},"paymentReference":{"deprecated":true,"description":"DEPRECATED.\nThe payment reference. Deprecated, PaymentInformation structure should be used instead","type":"string"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermRequest"},"paymentType":{"deprecated":true,"description":"DEPRECATED.\nDeprecated, PaymentInformation structure should be used instead. The type of payment. Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.\n\n**NOTE:** This field also supports the legacy variants.","enum":["APPLE_PAY","CREDITCARD","PAYPAL","DIRECTDEBIT","WIRETRANSFER","ALIPAY","WECHAT","UNIONPAY","PURCHASEORDER","ACH","BANKTRANSFER","IDEAL","PAYU","KLARNA_INSTALLMENT","KLARNA_PAY_LATER","OTHER","ACCEL","AFFIRM","AFFIRM_QR","AFTERPAY","ALIPAY_PLUS","ALMA","AMAZONPAY","ANCV","ATOME","BALOTO","BANCONTACT","BILLIE","BIZUM","BLIK","BOLETOBANCARIO","CARNET","CARTES_BANCAIRES","CASH_APP_PAY","CLEARPAY","CREDIT_CARD","DANA","DIRECT_DEBIT","DOKU_VIRTUAL_ACCOUNTS","DRAGONPAY","DUITNOW","EPS","FISERV","FPX","GCASH","GIROCARD","GIROPAY","GIVEX","GOOGLEPAY","GOPAY","GRABPAY","INTERSOLVE","KAKAOPAY","KLARNA","KLARNA_PAY_NOW","MBWAY","MOBILE_PAY","MOMO","MULTIBANCO","NAVERPAY","OXXO","PAYBRIGHT","PAYME","PAYPAY","PAYPO","PAYTM","PAY_NOW","PIX","PROMPTPAY","PURCHASE_ORDER","RATEPAY","RIVERTY","SAMSUNG_PAY","SCALAPAY","SEPA","SOFORT","STORED_VALUE_SOLUTIONS","SWISH","TOUCH_N_GO","TWINT","UNION_PAY","VENMO","VIPPS","WIRE_TRANSFER","YANDEX","ZAVER","ZIP"],"type":"string"},"performanceLocation":{"$ref":"#/components/schemas/ContractPerformanceLocationRequest"},"planId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Reference to the Plan to use for the contract.","example":16778,"format":"int64","type":"integer"},"planIdent":{"description":"Reference to the Plan to use for the contract.","example":"nbx_plan_12345","type":"string"},"planModifiers":{"description":"Modifiers to apply to a plan and its options to change i.e. the price. Are applied only to this contract.","items":{"oneOf":[{"$ref":"#/components/schemas/OptionPriceListModifierDto"}]},"type":"array"},"properties":{"description":"Additional contract properties to specify the contract.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"relatedContracts":{"description":"Contracts that might have a billing impact from this contract, for example, because they receive a commission.","items":{"$ref":"#/components/schemas/RelatedContractRequest"},"type":"array"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"shippingAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Optional ID of the shipping address to which the contract will be assigned. Please use non-deprecated shippingAddressIdent.","format":"int64","type":"integer"},"shippingAddressIdent":{"description":"Optional ident of the shipping address to which the contract will be assigned.","type":"string"},"startDate":{"description":"Defines start of the active period of the contract. Remains as is even if it was cancelled or terminated before activation start.","format":"date-time","type":"string"},"taxLocation":{"$ref":"#/components/schemas/ContractTaxLocationRequest"}},"required":["contractIdent","date","optionQuantities"],"type":"object"},"ContractDetailsDto":{"description":"Related contracts of this contract","properties":{"currentPhaseCounter":{"description":"Counter determines how many iterations it is in the given phase before it goes to the next.","format":"int64","type":"integer"},"currentPhaseIdent":{"description":"Ident of the current phase","type":"string"},"currentPhaseStartDate":{"description":"Start date of the current phase","format":"date-time","type":"string"},"optionQuantities":{"items":{"$ref":"#/components/schemas/PhaseOptionQuantityResponse"},"type":"array"},"planIdent":{"description":"Reference to the Plan to use for the contract.","type":"string"}},"type":"object"},"ContractDto":{"allOf":[{"$ref":"#/components/schemas/ContractSlimDto"},{"properties":{"attachments":{"description":"List of attachments","items":{"$ref":"#/components/schemas/AttachmentDto"},"type":"array"},"planModifiers":{"description":"History of plan modifiers, including future ones.","items":{"$ref":"#/components/schemas/PlanModifierListEffectivityResponse"},"type":"array"}},"type":"object"}],"description":" A contract is assigned to a specific debtorId. It represents the legal construct around a  purchase or subscription. A contract must contain a planId (e.g. for subscriptions - see Plan Model for more details). \n A contract automatically generates billable items for the associated line items, the usages and for one time and recurring options of the associated plan. ","type":"object"},"ContractLineItemCreationRequest":{"description":"A request to create a new line item. A Line Item represents a product or service to be billed to the customer.","properties":{"agreedDeposits":{"description":"All agreed deposits of the line item.","items":{"$ref":"#/components/schemas/AgreedDepositCreationRequest"},"type":"array"},"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"description":"Category of the line item, might be used for different tax rates.\nMust not be null.","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"debitCreditIndicator":{"description":"Determines if the given item has a debit or credit impact on your business.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"deliveryDate":{"description":"The planned delivery date.","format":"date-time","type":"string"},"description":{"description":"Any additional description, might be printed on the document.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"group":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the item.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"originalRowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_99"},"originalRowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_96"},"performanceLocation":{"$ref":"#/components/schemas/LineItemPerformanceLocationRequest"},"periodEndDate":{"description":"End date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-20T12:00:00Z","format":"date-time","type":"string"},"periodStartDate":{"description":"Start date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-01T12:00:00+03:00","format":"date-time","type":"string"},"postTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item. These extras don't reduce the tax amount.","items":{"$ref":"#/components/schemas/PostTaxItemCreationRequest"},"type":"array"},"preTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item that also reduce the tax amount.","items":{"oneOf":[{"$ref":"#/components/schemas/ItemDiscountExtraCreationRequest"},{"$ref":"#/components/schemas/ItemSingleVoucherExtraCreationRequest"},{"$ref":"#/components/schemas/ItemVoucherExtraCreationRequest"}]},"type":"array"},"processingConfig":{"$ref":"#/components/schemas/LineItemProcessingConfigRequest"},"properties":{"description":"Additional item properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_100"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_97"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"taxInformation":{"description":"All tax information for this order item.","items":{"$ref":"#/components/schemas/TaxInformationCreationRequest"},"type":"array"},"taxLocation":{"$ref":"#/components/schemas/LineItemTaxLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)","enum":["SALES","SELF_BILLING"],"type":"string"},"unitPriceGross":{"$ref":"#/components/schemas/MonetaryValue_101"},"unitPriceNet":{"$ref":"#/components/schemas/MonetaryValue_98"},"unitQuantity":{"description":"Number of units.\nMust not be null.","example":100,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Will be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"}},"required":["category","debitCreditIndicator","name","unitPriceNet","unitQuantity","unitQuantityType"],"type":"object"},"ContractLineItemResponse":{"description":"A line item of this type is assigned to a specific contract.","properties":{"agreedDeposits":{"description":"All agreed deposits of this line item","items":{"$ref":"#/components/schemas/AgreedDepositResponse"},"type":"array"},"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars","example":"A-1234","type":"string"},"category":{"description":"Category of the line item, might be used for different tax rates.\nMust not be null.","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currency":{"deprecated":true,"description":"DEPRECATED.\nThe currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Determines if the given item has a debit or credit impact on your business.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"deliveryDate":{"description":"Planned delivery date","format":"date-time","type":"string"},"depositItemAssignments":{"description":"All deposits of this line item","items":{"$ref":"#/components/schemas/DepositItemAssignmentDto"},"type":"array"},"description":{"description":"Any additional description, might be printed on the document","type":"string"},"group":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"ident":{"description":"Unique external reference.\nMust not be null.","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed","type":"string"},"originalRowTotalCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_57"},"originalRowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_56"},"originalRowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_55"},"performanceLocation":{"$ref":"#/components/schemas/LineItemPerformanceLocationResponse"},"periodEndDate":{"description":"End date for line items that span a certain period of time. Supports ISO 8601 offset information","example":"2021-02-10T00:00:00Z","format":"date-time","type":"string"},"periodStartDate":{"description":"Start date for line items that span a certain period of time. Supports ISO 8601 offset information","example":"2021-02-10T00:00:00+02:00","format":"date-time","type":"string"},"postTaxExtras":{"items":{"$ref":"#/components/schemas/PostTaxLineItemExtraDto"},"type":"array"},"preTaxExtras":{"items":{"$ref":"#/components/schemas/LineItemExtraDto"},"type":"array"},"processingConfig":{"$ref":"#/components/schemas/LineItemProcessingConfigResponse"},"processingDate":{"description":"Processing date","format":"date-time","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_58"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_60"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_59"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use service location instead. The country where the product or service was sold. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationResponse"},"status":{"description":"The status of this line item","enum":["CANCELLED","ON_HOLD"],"type":"string"},"taxCalculationBasis":{"description":"The tax information source of the line item.\nMust be one of:\n|         |\n| ------- |\n| NET     |\n| GROSS   |\n| UNKNOWN |","example":"NITROBOX","type":"string"},"taxInformation":{"description":"All tax information for this item.\nMust not be empty.","items":{"$ref":"#/components/schemas/TaxInformationDto"},"minItems":1,"type":"array"},"taxInformationSource":{"description":"The tax information source of the billable item","enum":["NITROBOX","AVALARA","FINANCE_ENABLER","CUSTOMER_PROVIDED"],"type":"string"},"taxLocation":{"$ref":"#/components/schemas/LineItemTaxLocationResponse"},"taxScheme":{"description":"It defines tax trading procedure of an item","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)","enum":["SALES","SELF_BILLING"],"type":"string"},"unitCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_63"},"unitPriceGross":{"$ref":"#/components/schemas/MonetaryValue_62"},"unitPriceNet":{"$ref":"#/components/schemas/MonetaryValue_61"},"unitQuantity":{"description":"Number of units for this item","example":10,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Will be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"}},"required":["category","debitCreditIndicator","ident","name","taxInformation"],"type":"object"},"ContractLineItemUpdateRequest":{"description":"A request to update a line item. All the fields are optional - if provided, they will overwrite the value(with the exception of properties) Item properties will be merged based on property key(ident). ","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"description":"Category of the line item, might be used for different tax rates.\nMust not be null.","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"debitCreditIndicator":{"description":"Determines if the given item has a debit or credit impact on your business.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"deliveryDate":{"description":"The planned delivery date.","format":"date-time","type":"string"},"description":{"description":"Any additional description, might be printed on the document.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"group":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"name":{"description":"Name of the item.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"originalRowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_52"},"originalRowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_49"},"performanceLocation":{"$ref":"#/components/schemas/LineItemPerformanceLocationRequest"},"periodEndDate":{"description":"End date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-20T12:00:00Z","format":"date-time","type":"string"},"periodStartDate":{"description":"Start date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-01T12:00:00+03:00","format":"date-time","type":"string"},"postTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item. These extras don't reduce the tax amount.","items":{"$ref":"#/components/schemas/PostTaxItemCreationRequest"},"type":"array"},"preTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item that also reduce the tax amount.","items":{"oneOf":[{"$ref":"#/components/schemas/ItemDiscountExtraCreationRequest"},{"$ref":"#/components/schemas/ItemSingleVoucherExtraCreationRequest"},{"$ref":"#/components/schemas/ItemVoucherExtraCreationRequest"}]},"type":"array"},"properties":{"description":"Additional item properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_53"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_50"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"taxInformation":{"description":"All tax information for this order item.","items":{"$ref":"#/components/schemas/TaxInformationCreationRequest"},"type":"array"},"taxLocation":{"$ref":"#/components/schemas/LineItemTaxLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)","enum":["SALES","SELF_BILLING"],"type":"string"},"unitPriceGross":{"$ref":"#/components/schemas/MonetaryValue_54"},"unitPriceNet":{"$ref":"#/components/schemas/MonetaryValue_51"},"unitQuantity":{"description":"Number of units.\nMust not be null.","example":100,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Will be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"}},"required":["category","debitCreditIndicator","name","unitPriceNet","unitQuantity","unitQuantityType"],"type":"object"},"ContractPerformanceLocationRequest":{"description":"Where the service has been provided. Used for tax calculation and can be printed on documents.","properties":{"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"}},"type":"object"},"ContractPerformanceLocationResponse":{"description":"Where the service has been provided. Used for tax calculation and can be printed on documents.","properties":{"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"}},"type":"object"},"ContractPriceAdaptationRequest":{"description":"Optional reference of the price adaptation used to automatically adapt this contracts prices.","properties":{"priceAdaptationIdent":{"description":"Optional reference of the price adaptation used to automatically adapt this contracts prices.","type":"string"}},"type":"object"},"ContractPriceAdaptationResponse":{"description":"Optional reference of the price adaptation used to automatically adapt this contracts prices.","properties":{"priceAdaptationIdent":{"description":"Optional reference of the price adaptation used to automatically adapt this contracts prices.","type":"string"}},"type":"object"},"ContractSlimDto":{"description":"A contract, but without (fields for) attachments and purchase items.","discriminator":{"mapping":{"DEFAULT":"#/components/schemas/ContractDto","SLIM":"#/components/schemas/ContractSlimDto"},"propertyName":"detailLevel"},"properties":{"autoCreateDocument":{"description":"The type of document that is automatically generated at contract creation. Will be one of:","enum":["INVOICE","DEPOSITINVOICE","NONE"],"type":"string"},"billingGroupIdent":{"description":"Reference to the billing group of the order.","type":"string"},"billingStartDate":{"description":"The date when actual billing starts for this contract. If left empty the contract will be billed from the startDate","format":"date","type":"string"},"businessSegmentId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use business segment ident instead. Reference to the business segment of the contract.","format":"int64","type":"integer"},"businessSegmentIdent":{"description":"The Ident of the business segment for the Plan. The default segment will be used if not set.","type":"string"},"cancellationDate":{"description":"The cancellation date of the contract.","format":"date-time","type":"string"},"cancellationReason":{"description":"The reason for cancellation.","type":"string"},"contractId":{"description":"Unique id of the contract.","format":"int64","type":"integer"},"contractIdent":{"description":"Unique external reference.","type":"string"},"contractPriceAdaptation":{"$ref":"#/components/schemas/ContractPriceAdaptationResponse"},"contractStatus":{"description":"The status of the contract. Must be one of:.\nMust be one of:\n|            |\n| ---------- |\n| CANCELLED  |\n| TERMINATED |\n| PENDING    |","type":"string"},"country":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use service location instead. Country that determines which price and tax will be applied for subscriptions and one time options for this contract. A ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currentPhaseCounter":{"description":"Counter determines how many iterations it is in the given phase before it goes to the next.","format":"int64","type":"integer"},"currentPhaseIdent":{"description":"Ident of the current phase","type":"string"},"currentPhaseStartDate":{"description":"Start date of the current phase","format":"date-time","type":"string"},"date":{"description":"Defines when the contract is signed.","format":"date-time","type":"string"},"debtorId":{"description":"Id of the debtor of the contract.","format":"int64","type":"integer"},"debtorIdent":{"description":"Ident of the debtor of the contract.","type":"string"},"detailLevel":{"type":"string"},"documentDate":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: The custom document creation date for external document creation.","format":"date-time","type":"string"},"durationType":{"deprecated":true,"description":"DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration type. Must be one of:","enum":["DAY","MONTH","YEAR","FOREVER"],"type":"string"},"durationValue":{"deprecated":true,"description":"DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration of the contract.","format":"int32","type":"integer"},"endDate":{"description":"Defines the end of the active period of the contract. Remains empty if contract cancelled or terminated before contract becomes active.","format":"date-time","type":"string"},"hasPlanModifiers":{"description":"indicates whether the contract has plan modifiers. Can be retrieved on detail level: DEFAULT.","type":"boolean"},"invoiceAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: ID for the invoice address. Please use invoiceAddressIdent.","format":"int64","type":"integer"},"invoiceAddressIdent":{"description":"Ident for the invoice address.","type":"string"},"language":{"description":"Preferred language code for invoice in ISO 639-1 standard, not required.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"example":"de","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"noticeDate":{"description":"The effective notice date which serves as the starting point for calculating the contract endDate taking the notice period into account.","format":"date-time","type":"string"},"optionQuantities":{"items":{"$ref":"#/components/schemas/PhaseOptionQuantityResponse"},"type":"array"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformationDto"},"paymentReference":{"deprecated":true,"description":"DEPRECATED.\nThe payment reference.","type":"string"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermDto"},"paymentType":{"deprecated":true,"description":"DEPRECATED.\nPayment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.\n\n**NOTE:** This field also supports the legacy variants.","enum":["APPLE_PAY","CREDITCARD","PAYPAL","DIRECTDEBIT","WIRETRANSFER","ALIPAY","WECHAT","UNIONPAY","PURCHASEORDER","ACH","BANKTRANSFER","IDEAL","PAYU","KLARNA_INSTALLMENT","KLARNA_PAY_LATER","OTHER","ACCEL","AFFIRM","AFFIRM_QR","AFTERPAY","ALIPAY_PLUS","ALMA","AMAZONPAY","ANCV","ATOME","BALOTO","BANCONTACT","BILLIE","BIZUM","BLIK","BOLETOBANCARIO","CARNET","CARTES_BANCAIRES","CASH_APP_PAY","CLEARPAY","CREDIT_CARD","DANA","DIRECT_DEBIT","DOKU_VIRTUAL_ACCOUNTS","DRAGONPAY","DUITNOW","EPS","FISERV","FPX","GCASH","GIROCARD","GIROPAY","GIVEX","GOOGLEPAY","GOPAY","GRABPAY","INTERSOLVE","KAKAOPAY","KLARNA","KLARNA_PAY_NOW","MBWAY","MOBILE_PAY","MOMO","MULTIBANCO","NAVERPAY","OXXO","PAYBRIGHT","PAYME","PAYPAY","PAYPO","PAYTM","PAY_NOW","PIX","PROMPTPAY","PURCHASE_ORDER","RATEPAY","RIVERTY","SAMSUNG_PAY","SCALAPAY","SEPA","SOFORT","STORED_VALUE_SOLUTIONS","SWISH","TOUCH_N_GO","TWINT","UNION_PAY","VENMO","VIPPS","WIRE_TRANSFER","YANDEX","ZAVER","ZIP"],"example":"BANKTRANSFER","type":"string"},"performanceLocation":{"$ref":"#/components/schemas/ContractPerformanceLocationResponse"},"planId":{"description":"Reference to the plan of the contract.","format":"int64","type":"integer"},"planIdent":{"description":"Reference to the Plan to use for the contract.","type":"string"},"priceAdaptation":{"$ref":"#/components/schemas/ContractPriceAdaptationResponse"},"properties":{"description":"Contract properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"relatedContracts":{"description":"Contracts that might have a billing impact from this contract, for example, because they receive a commission.","items":{"$ref":"#/components/schemas/RelatedContractResponse"},"type":"array"},"renewalDate":{"description":"The renewal date of the contract. The renewal date is only set when auto renewal is true and the term duration of a phase is not null.","format":"date-time","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationResponse"},"shippingAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Optional ID of the shipping address. Please use shippingAddressIdent.","format":"int64","type":"integer"},"shippingAddressIdent":{"description":"Optional Ident of the shipping address.","type":"string"},"startDate":{"description":"Defines start of the active period of the contract. Remains as is even if it was cancelled or terminated before activation start.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/Status"},"taxLocation":{"$ref":"#/components/schemas/ContractTaxLocationResponse"},"terminationDate":{"description":"Defines the end of the contract, regardless if it was active or not.","format":"date-time","type":"string"}},"required":["createdAt","detailLevel","lastModifiedAt"],"type":"object"},"ContractTaxLocationRequest":{"description":"Where the service is taxable. Can be provided but might be overwritten during tax calculation.","properties":{"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"}},"type":"object"},"ContractTaxLocationResponse":{"description":"Where the service is taxable. Can be provided but might be overwritten during tax calculation.","properties":{"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"}},"type":"object"},"ContractUpdateRequest":{"description":"Please see Contract Model below for more information regarding required values and input type.","properties":{"contractPriceAdaptationRequest":{"$ref":"#/components/schemas/ContractPriceAdaptationRequest"},"durationType":{"deprecated":true,"description":"DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration type. Must be one of:","enum":["DAY","MONTH","YEAR","FOREVER"],"type":"string"},"durationValue":{"deprecated":true,"description":"DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration of the contract.","format":"int32","type":"integer"},"endDate":{"deprecated":true,"description":"DEPRECATED: Explicitly terminate the contract using our contract termination endpoints instead. Usage of this field can result in unexpected behavior.","format":"date-time","type":"string"},"invoiceAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Must be the correct ID for the invoice address to which the contract will be assigned. Please use invoiceAddressIdent.","format":"int64","type":"integer"},"invoiceAddressIdent":{"description":"Must be the correct ident for the invoice address to which the contract will be assigned.","type":"string"},"language":{"default":"de","description":"Optional language code in the ISO 639-1 standard. Must be one of the valid languages from the business segment.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"paymentInformation":{"oneOf":[{"$ref":"#/components/schemas/PaymentInformationChargeUpdateRequest"},{"$ref":"#/components/schemas/PaymentInformationNoChargeUpdateRequest"}]},"paymentReference":{"deprecated":true,"description":"DEPRECATED: Use paymentInformation update instead. The payment reference.","type":"string"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermRequest"},"paymentType":{"deprecated":true,"description":"DEPRECATED: Use paymentInformation update instead. The type of payment. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.\n\n**NOTE:** This field also supports the legacy variants.","enum":["APPLE_PAY","CREDITCARD","PAYPAL","DIRECTDEBIT","WIRETRANSFER","ALIPAY","WECHAT","UNIONPAY","PURCHASEORDER","ACH","BANKTRANSFER","IDEAL","PAYU","KLARNA_INSTALLMENT","KLARNA_PAY_LATER","OTHER","ACCEL","AFFIRM","AFFIRM_QR","AFTERPAY","ALIPAY_PLUS","ALMA","AMAZONPAY","ANCV","ATOME","BALOTO","BANCONTACT","BILLIE","BIZUM","BLIK","BOLETOBANCARIO","CARNET","CARTES_BANCAIRES","CASH_APP_PAY","CLEARPAY","CREDIT_CARD","DANA","DIRECT_DEBIT","DOKU_VIRTUAL_ACCOUNTS","DRAGONPAY","DUITNOW","EPS","FISERV","FPX","GCASH","GIROCARD","GIROPAY","GIVEX","GOOGLEPAY","GOPAY","GRABPAY","INTERSOLVE","KAKAOPAY","KLARNA","KLARNA_PAY_NOW","MBWAY","MOBILE_PAY","MOMO","MULTIBANCO","NAVERPAY","OXXO","PAYBRIGHT","PAYME","PAYPAY","PAYPO","PAYTM","PAY_NOW","PIX","PROMPTPAY","PURCHASE_ORDER","RATEPAY","RIVERTY","SAMSUNG_PAY","SCALAPAY","SEPA","SOFORT","STORED_VALUE_SOLUTIONS","SWISH","TOUCH_N_GO","TWINT","UNION_PAY","VENMO","VIPPS","WIRE_TRANSFER","YANDEX","ZAVER","ZIP"],"type":"string"},"performanceLocation":{"$ref":"#/components/schemas/ContractPerformanceLocationRequest"},"planModifiers":{"description":"Modifiers to apply to a plan and its options to change i.e. the price. Are applied only to this contract.","items":{"oneOf":[{"$ref":"#/components/schemas/OptionPriceListModifierDto"}]},"type":"array"},"properties":{"description":"Properties with additional information for template and bookkeeping. If updating the entire List will be updated.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"shippingAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Optional ID of the shipping address to which the contract will be assigned. Please use shippingAddressIdent.","format":"int64","type":"integer"},"shippingAddressIdent":{"description":"Optional ident of the shipping address to which the contract will be assigned.","type":"string"},"startDate":{"deprecated":true,"description":"DEPRECATED: Use activation endpoint. The start date of the contract.","format":"date-time","type":"string"},"taxLocation":{"$ref":"#/components/schemas/ContractTaxLocationRequest"}},"type":"object"},"CorrectionItemRequest":{"description":"Correction for a single document line item. References the item and defines the credit amount as a positive value.","properties":{"amount":{"description":"Correction amount as a positive value (> 0) in the currency of the related document/item. This amount is a GROSS value (incl. VAT). Semantics: the value is booked as a credit and reduces the item amount. Example: 20.00 means a credit of 20.00 (i.e. -20.00 on the item). The maximum allowed value is the remaining correctable amount (item amount minus sum of prior credits).\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 19 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"itemIdent":{"description":"Unique identifier of the affected document item  the correction (credit) should be applied to.\nMust not be blank.","minLength":1,"type":"string"}},"required":["amount","itemIdent"],"type":"object"},"CorrectionItemResponse":{"description":"Correction for a single document line item in a correction detail. Mirrors the request shape: item ident and credit amount.","properties":{"amount":{"description":"Correction amount (credit) as a positive value in document currency (gross).\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 19 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"itemIdent":{"description":"Identifier of the document item this correction applies to.","type":"string"}},"required":["amount"],"type":"object"},"CreateDebtorRequest":{"allOf":[{"$ref":"#/components/schemas/DebtorOrderDetailsRequest"},{"properties":{"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system","type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID","example":"DEALER_ID","type":"string"},"customerType":{"description":"Specifies the type of the customer. Must be one of:","enum":["B2B","B2C","OTHER","AFFILIATED"],"example":"B2C","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/AddressDto"},"language":{"description":"Country code for the language of the debtor. Uses Alpha-3 or Alpha-2 code (ISO 3166): https://www.iban.com/country-codes.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"example":"de","type":"string"},"properties":{"description":"Array of properties assigned to the specific debtor.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array","uniqueItems":true},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"}},"type":"object"}],"required":["debtorIdent","invoiceAddress"],"type":"object"},"CreditBillableItemCreationRequest":{"description":"Please see Credit Billable Item Model below for more information regarding required values and input type.","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"billableItemIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"billablePostTaxItemExtras":{"description":"The item extras that don't reduce the taxAmount that has to be paid for this item.","items":{"$ref":"#/components/schemas/BillablePostTaxItemExtraDto"},"type":"array"},"businessCase":{"description":"The action type that created this billable item.","enum":["PURCHASE","DEPOSIT","DEPOSIT_CANCELLATION","CANCELLATION","CORRECTION_CREATION","CORRECTION_CANCELLATION","SELF_BILLED","SELF_BILLED_CANCELLATION","SELF_BILLED_CORRECTION_CREATION","SELF_BILLED_CORRECTION_CANCELLATION"],"type":"string"},"businessSegmentId":{"description":"Reference to the business segment of the billable item.","format":"int64","type":"integer"},"category":{"default":"PHYSICAL_PRODUCT","description":"The category of an item. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","VOUCHER_PURCHASE","VOUCHER_APPLICATION","DISCOUNT","DISCOUNT_USE","MULTI_PURPOSE_VOUCHER_USE","GOVERNMENT_GRANT","TRADE_IN","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"contractId":{"description":"Reference to the contract of the billable item.","format":"int64","type":"integer"},"contractIdent":{"description":"Reference ident to the contract of the billable item.","type":"string"},"currency":{"description":"The currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"deliveryDate":{"description":"The planned delivery date.","format":"date-time","type":"string"},"description":{"description":"The billable item's description.","type":"string"},"detailedPerformanceLocation":{"$ref":"#/components/schemas/BillableItemPerformanceLocationRequest"},"detailedTaxLocation":{"$ref":"#/components/schemas/BillableItemTaxLocationRequest"},"documentDate":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: The custom document creation date for external document creation.","format":"date-time","type":"string"},"documentNumber":{"description":"Field to be used depending on tenant and business segment document generation strategy. Mandatory if CLIENT_PROVIDED strategy is active, not allowed otherwise.","type":"string"},"extras":{"description":"The billable item extras contain representations of vouchers for discounts or discounts applied to an item. Those item extras reduce the taxAmount that has to be paid for this item","items":{"$ref":"#/components/schemas/BillableItemExtraDto"},"type":"array"},"invoiceIdent":{"description":"Invoice number of referenced invoice by this credit note.","type":"string"},"itemGroup":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"itemPeriodDuration":{"description":"Duration for billable items that span a certain period of time.","format":"int64","type":"integer"},"itemPeriodDurationType":{"description":"The type of duration for billable items that span a certain period of time. Must be one of:.\nMust be one of:\n|               |                                             |\n| ------------- | ------------------------------------------- |\n| SECOND        | DEPRECATED: duration of seconds             |\n| MINUTE        | DEPRECATED: duration of minutes             |\n| HOUR          | DEPRECATED: duration of hours               |\n| DAY           | DEPRECATED: duration of days                |\n| WEEK          | DEPRECATED: duration of weeks               |\n| MONTH         | DEPRECATED: duration of months              |\n| QUARTER_YEAR  | DEPRECATED: duration of a quarter of a year |\n| YEAR          | DEPRECATED: duration of a year              |\n| SECONDS       | duration of seconds                         |\n| MINUTES       | duration of minutes                         |\n| HOURS         | duration of hours                           |\n| DAYS          | duration of days                            |\n| WEEKS         | duration of weeks                           |\n| MONTHS        | duration of months                          |\n| QUARTER_YEARS | duration of a quarter of a year             |\n| YEARS         | duration of a year                          |\n| FOREVER       | duration of forever                         |","type":"string"},"itemPeriodEnd":{"description":"End date for billable items that span a certain period of time. Supports ISO 8601 offset information.","example":"2021-02-10T00:00:00Z","format":"date-time","type":"string"},"itemPeriodStart":{"description":"Start date for billable items that span a certain period of time. Supports ISO 8601 offset information.","example":"2021-02-10T00:00:00+01:00","format":"date-time","type":"string"},"name":{"description":"Name of the billable item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"optionDescription":{"description":"The description of the option that belongs to the billable item.","type":"string"},"originalRowTotalCumulatedTaxPrice":{"description":"Cumulated tax price of original gross total of all items ","example":100,"type":"number"},"originalRowTotalExclusiveVat":{"description":"Net total of all items without vat before application of item.extras (unitQuantity * unitPriceExclusiveVat).\nMust not be null.\nMust be less than or equal to 0.","example":100,"maximum":0,"type":"number"},"originalRowTotalInclusiveVat":{"description":"Gross total of all items with vat before application of item.extras (unitQuantity * unitPriceInclusiveVat).\nMust not be null.\nMust be less than or equal to 0.","example":119,"maximum":0,"type":"number"},"performanceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"planName":{"description":"Name of the plan, where the billabe item belongs to.","type":"string"},"processedDate":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"date-time","type":"string"},"processingDate":{"description":"The ISO 8601 date at which the billable item will be processed for billing.","example":"2019-10-28T06:36:31Z","format":"date-time","type":"string"},"processingError":{"description":"The reason why the billable item is not processed and has the status error.","type":"string"},"processingStatus":{"description":"Status of processing.","enum":["NOT_STARTED","PENDING_RETRY","STARTED","IN_PROGRESS","RELATED_ITEM_PENDING","COMPLETED","ERROR","TERMINATED","CONFIG_ERROR","RECALCULATION_PENDING","RECALCULATION_ERROR"],"readOnly":true,"type":"string"},"productIdent":{"description":"The product ident of the billable item.","type":"string"},"properties":{"description":"The key-value pairs that can be used to extend the entity with additional custom data as needed.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"referenceType":{"description":"Reference to the contract or order of the billable item.","type":"string"},"relatedItemIdent":{"description":"Ident of related debit billable item. It should be provided to correctly match to debit counterpart","type":"string"},"rowTotalCumulatedTaxPrice":{"description":"Cumulated tax price of gross total of all items ","example":100,"type":"number"},"rowTotalExclusiveVat":{"description":"Net total of all items without vat after application of item.extras.\nMust not be null.\nMust be less than or equal to 0.","example":100,"maximum":0,"type":"number"},"rowTotalInclusiveVat":{"description":"Gross total of all items with vat after application of item.extras.\nMust not be null.\nMust be less than or equal to 0.","example":119,"maximum":0,"type":"number"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The country where the product or service was sold. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"targetDocumentType":{"description":"Must be one of:","enum":["INVOICE","DEPOSITINVOICE","NONE"],"example":"INVOICE","type":"string"},"taxInformation":{"description":"All tax information for this item covering multi tax cases and single tax cases as well within that list. Tax information replaces deprecated attributes below for single tax cases. Due to backward compatibility, the following applies:\n\n- when sending billable items using taxInformation is the preferred way; either tax information can be used or the single tax attributes, but not both\n- when fetching billable items, both tax information and single tax attributes are populated until all deprecated attributes will be removed\n\nMust not be empty.","items":{"$ref":"#/components/schemas/BillableItemTaxInformationCreationRequest"},"minItems":1,"type":"array"},"taxLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Must be one of:.\nMust not be null.","enum":["DEBIT","CREDIT"],"example":"DEBIT","type":"string"},"unitCumulatedTaxPrice":{"description":"Cumulated tax price of gross total of one unit","example":100,"type":"number"},"unitPriceExclusiveVat":{"description":"Net price of one unit without vat.\nMust not be null.\nMust be less than or equal to 0.","example":1,"maximum":0,"type":"number"},"unitPriceInclusiveVat":{"description":"Gross price of one unit with vat.\nMust not be null.\nMust be less than or equal to 0.","example":1.19,"maximum":0,"type":"number"},"unitQuantity":{"description":"Number of units.\nMust not be null.","example":100,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Must be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"},"usageDescription":{"description":"The description of the usage that belongs to the billable item.","type":"string"}},"required":["billableItemIdent","invoiceIdent","name","originalRowTotalExclusiveVat","originalRowTotalInclusiveVat","rowTotalExclusiveVat","rowTotalInclusiveVat","taxInformation","type","unitPriceExclusiveVat","unitPriceInclusiveVat","unitQuantity","unitQuantityType"],"type":"object"},"CriteriaDto":{"description":"Input parameters by which the price will be chosen","properties":{"location":{"$ref":"#/components/schemas/LocationRequest"}},"type":"object"},"CurrencyRoundingOverrideDto":{"description":"Specifies the number of decimal places to which a currency should be rounded, overriding the ISO 4217 standard. Must be equal to or less than the standard specified by ISO and cannot be negative. A zero value indicates rounding to whole units","properties":{"currency":{"description":"Must not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"digits":{"description":"Must not be null.\nMust be greater than or equal to 0.","format":"int32","type":"integer"}},"required":["currency","digits"],"type":"object"},"CustomerConfigResponse":{"description":"The current customer config","properties":{"customerIdent":{"description":"Ident of the customer.\nMust not be blank.","minLength":1,"type":"string"},"isBillingRunActive":{"description":"Billing run is triggered in a regular interval if active.\nMust not be null.","type":"boolean"}},"required":["customerIdent","isBillingRunActive"],"type":"object"},"CustomerConfigUpdateRequest":{"description":"Update customer config","properties":{"isBillingRunActive":{"description":"Billing run is triggered in a regular interval if active.\nMust not be null.","type":"boolean"}},"required":["isBillingRunActive"],"type":"object"},"DebtorBillingRunCriteriaDto":{"description":"Optional parameter to allow billing run for single debtor, with arbitrary processing date.","properties":{"debtorId":{"description":"Id of the debtor for the debtor specific billing run","example":123456789,"format":"int64","type":"integer"},"debtorIdent":{"description":"Ident of the debtor for the debtor specific billing run","example":"nbx_debtor_12345","type":"string"},"processingDate":{"description":"The processing date up to which all unprocessed billable items shall be processed immediately.\nMust not be null.","format":"date-time","type":"string"}},"required":["processingDate"],"type":"object"},"DebtorOrderDetailsRequest":{"description":"Specifies debtor to be used for an order. Can either specify reference to an existing debtor, or details necessary to create a new one","discriminator":{"mapping":{"CREATE":"#/components/schemas/CreateDebtorRequest","USE":"#/components/schemas/UseDebtorRequest"},"propertyName":"debtorRequestType"},"example":{"debtorIdent":"unique-debtor-ident","debtorRequestType":"CREATE","invoiceAddress":{"academicTitle":null,"addressAddition":null,"addressType":"INVOICE","agencyProfessionTitle":null,"city":"Berlin","company":null,"country":"CHN","department":null,"email":null,"firstname":"firstname","gender":"NOTSET","lastname":"lastname","postOfficeBox":null,"state":null,"stateCode":null,"street":"street","streetNo":"5b","vatId":null,"zip":"zip"},"language":"eng"},"properties":{"debtorIdent":{"description":"Unique identifier of the debtor.\nMust not be blank.\nSize must be between 0 and 100.\nMust match with the regular expression '[a-zA-Z0-9_.~@-]*'.","maxLength":100,"pattern":"[a-zA-Z0-9_.~@-]*","type":"string"},"debtorRequestType":{"enum":["CREATE","USE"],"type":"string"}},"required":["debtorIdent"],"type":"object"},"DepositDto":{"description":"Deposits","properties":{"assignmentIdent":{"description":"Reference to payment assignment.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"ident":{"description":"Unique external reference.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentIdent":{"description":"Reference to payment.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"reverted":{"type":"boolean"},"value":{"$ref":"#/components/schemas/MonetaryValue_78"}},"required":["assignmentIdent","ident","paymentIdent","value"],"type":"object"},"DepositItemAssignmentDto":{"description":"The part of a deposit that was assigned to specific purchase item","properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"ident":{"description":"Unique external reference.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"reverted":{"type":"boolean"},"value":{"$ref":"#/components/schemas/MonetaryValue_37"}},"required":["ident","value"],"type":"object"},"DocumentCorrectionDetailResponse":{"description":"Response for a document correction created via POST. Contains the correction ident, document reference, reason, properties and timestamps.","properties":{"createdAt":{"description":"Creation timestamp of the correction.","format":"date-time","type":"string"},"documentIdent":{"description":"Identifier of the document (e.g. invoice) this correction applies to.","type":"string"},"ident":{"description":"Unique identifier of the correction (external reference from creation request).","type":"string"},"items":{"description":"Per-item corrections (item ident and credit amount).","items":{"$ref":"#/components/schemas/CorrectionItemResponse"},"type":"array"},"lastModifiedAt":{"description":"Last modification timestamp of the correction.","format":"date-time","type":"string"},"properties":{"description":"Custom properties attached to the correction.","items":{"$ref":"#/components/schemas/PropertyResponse"},"type":"array"},"reason":{"description":"Reason for the correction.","type":"string"}},"type":"object"},"DocumentCorrectionItemResponse":{"description":"Summary of correctionability for a specific document item. Contains the total correctable amount after allowances, the amount already corrected, the remaining correctable amount, and optionally a history of applied corrections.","properties":{"correctedAmount":{"description":"Amount already corrected or credited for this item.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 19 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"correctionSupported":{"description":"Indicates whether corrections are supported for this item. Currently corrections are only supported for Onetime & Recurring items.\nMust not be null.","type":"boolean"},"currency":{"description":"Currency of the document/item amounts (must match the currency of the document).","type":"string"},"documentIdent":{"description":"Identifier of the document (e.g. invoice) the corrected item belongs to.","type":"string"},"itemIdent":{"description":"Identifier of the specific document item (position) this correction information refers to.","type":"string"},"remainingCorrectableAmount":{"description":"Amount that can still be corrected or credited for this item.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 19 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"totalCorrectableAmount":{"description":"Total amount that is correctable for the item after allowances or reductions, but before any corrections were applied.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 19 integral digits and up to 4 fractional digits.","example":20,"type":"number"}},"required":["correctedAmount","correctionSupported","remainingCorrectableAmount","totalCorrectableAmount"],"type":"object"},"DocumentCorrectionItemsResponse":{"description":"Correctionability information for all items of a document.","properties":{"documentIdent":{"description":"Identifier of the document.","type":"string"},"items":{"items":{"$ref":"#/components/schemas/DocumentCorrectionItemResponse"},"type":"array"}},"type":"object"},"DocumentCorrectionRequest":{"description":"Request to create a correction for an already issued document. A correction reduces one or more specific document invoice items by fixed amounts (no full cancellation, no re-issuance). Reason and properties apply to the whole correction transaction even if multiple items are affected.","properties":{"corrections":{"description":"Must not be empty.\nSize must be between 1 and 20.","items":{"$ref":"#/components/schemas/CorrectionItemRequest"},"maxItems":20,"minItems":1,"type":"array"},"ident":{"description":"Must be a unique external reference. Cannot be changed later on. Prevents duplicated execution when sending the same request.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"isx_correctionIdent_12345","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyRequest"},"type":"array"},"reason":{"description":"Reason for the correction. Applies to all correction items in this request.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["corrections","ident"],"type":"object"},"DocumentNumberConfigurationRequest":{"description":"Within this configuration it possible to define document number configurations per document types that will overwrite the tenant based configuration.","properties":{"documentGenerationStrategy":{"description":"The strategy of the document number configuration must be one of: \n\nCLIENT_PROVIDED - The client needs to provide the document number.\n\nGENERATED - The document number is generated automatically based on the configuration from tenant set up.\n\nCLIENT_PROVIDED_WITH_FALLBACK_GENERATED - The Tenant can send the document number and it will be used, if not provided then it will be generated automatically based on configuration from tenant set up.\nMust not be null.","enum":["CLIENT_PROVIDED","GENERATED","CLIENT_PROVIDED_WITH_FALLBACK_GENERATED"],"type":"string"},"documentType":{"description":"The type of the document that should have a specific document number configuration. Must be one of:.\nMust not be null.","enum":["INVOICE","DEPOSITINVOICE","NONE"],"type":"string"}},"required":["documentGenerationStrategy","documentType"],"type":"object"},"DocumentReissueRequest":{"description":"Data used to perform correction of given document.","properties":{"correctedInvoiceAddress":{"$ref":"#/components/schemas/ReissueAddressUpdateRequest"},"correctedShippingAddress":{"$ref":"#/components/schemas/ReissueAddressUpdateRequest"},"correctionReason":{"description":"Reason for the correction. Information will be relayed to the credit note.","type":"string"}},"type":"object"},"Duration":{"description":"Specifies a time duration","properties":{"unit":{"description":"The unit in which the time is specified.\nMust not be null.","enum":["DAYS","WEEKS","MONTHS","QUARTER_YEARS","YEARS"],"type":"string"},"value":{"description":"Specifies the duration as the number of units.\nMust not be null.","format":"int32","type":"integer"}},"required":["unit","value"],"type":"object"},"EInvoicingParameters":{"description":"Provides information needed to handle e-invoicing.","properties":{"recipientCode":{"description":"The recipient code used in the underlying network of the recipientCodeType.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"recipientCodeType":{"description":"For which e-invoicing scheme the following recipient code is relevant. Further information can be found at https://docs.nitrobox.io/docs/e-invoicing-recipient-codes.","type":"string"}},"type":"object"},"ExtraOrdinaryContractTerminationRequest":{"description":"This contract termination request contains information about the termination.","properties":{"reason":{"description":"Reason for the Termination.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"terminationDate":{"description":"Termination date, if not set the termination date will be end of today","format":"date-time","type":"string"}},"type":"object"},"GlobalErrorResponse":{"description":"error response providing details about the error occurred","properties":{"errors":{"description":"optional list of multiple errors occurred","items":{"type":"object"},"type":"array"},"message":{"description":"message describing the error","type":"string"},"path":{"description":"URL path where the error occurred","type":"string"},"status":{"description":"textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400","type":"string"},"timestamp":{"description":"timestamp in UTC when the error occurred","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries","format":"uuid","type":"string"}},"type":"object"},"IndexPriceAdaptationCreationRequest":{"allOf":[{"$ref":"#/components/schemas/PriceAdaptationCreationRequest"},{"properties":{"baseValue":{"$ref":"#/components/schemas/IndexPriceAdaptationValueCreationRequest"}},"type":"object"}],"description":"Request to define a price adaptation of type INDEX","required":["name","type"],"type":"object"},"IndexPriceAdaptationResponse":{"allOf":[{"$ref":"#/components/schemas/PriceAdaptationResponse"}],"description":"Response for price adaptation of type INDEX","required":["name","type"],"type":"object"},"IndexPriceAdaptationValueCreationRequest":{"allOf":[{"$ref":"#/components/schemas/PriceAdaptationValueCreationRequest"},{"properties":{"date":{"description":"Date from which the index value is valid. This value is used as ident.","format":"date","type":"string"},"value":{"description":"Value of the index","type":"number"}},"type":"object"}],"description":"Request to define a value for price adaptation of type INDEX","required":["type"],"type":"object"},"IndexPriceAdaptationValueResponse":{"allOf":[{"$ref":"#/components/schemas/PriceAdaptationValueResponse"},{"properties":{"date":{"description":"Date from which the index value is valid.\nMust not be null.","format":"date","type":"string"},"value":{"description":"Value of the index.\nMust not be null.","type":"number"}},"type":"object"}],"description":"Response for a value of price adaptation of type INDEX","required":["date","type","value"],"type":"object"},"IndexPriceAdaptationValueUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/PriceAdaptationValueUpdateRequest"},{"properties":{"value":{"description":"Value of the index","type":"number"}},"type":"object"}],"description":"Request to define a value for price adaptation of type INDEX","required":["type"],"type":"object"},"ItemCancellationResponse":{"description":"Container showing debit items and the related credit items.","properties":{"creditItemsForOriginalItems":{"description":"Credit BillableItems created for cancelling the original Debit BillableItems","items":{"$ref":"#/components/schemas/BillableItemResponse"},"type":"array"},"originalItems":{"description":"Debit BillableItems from the given idents","items":{"$ref":"#/components/schemas/BillableItemResponse"},"type":"array"}},"type":"object"},"ItemDiscountExtraCreationRequest":{"allOf":[{"$ref":"#/components/schemas/ItemExtraCreationRequest"}],"description":"Represents a discount applied to an item","required":["type","valueNet"],"type":"object"},"ItemExtraCreationRequest":{"description":"A request to create a item extra which is a representation of a voucher or a discount applied to an item. Those itemExtras reduce the taxAmount that has to be paid for this item.","discriminator":{"mapping":{"DISCOUNT":"#/components/schemas/ItemDiscountExtraCreationRequest","SINGLE_PURPOSE_VOUCHER":"#/components/schemas/ItemSingleVoucherExtraCreationRequest","VOUCHER":"#/components/schemas/ItemVoucherExtraCreationRequest"},"propertyName":"type"},"properties":{"description":{"description":"Description of the extraItem.","type":"string"},"externalReference":{"description":"Additional reference for third party system, like voucher management system.","type":"string"},"ident":{"description":"The unique identifier of an ItemExtra.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"leftoverAmountGross":{"$ref":"#/components/schemas/MonetaryValue_12"},"name":{"description":"Name of the extraItem.","type":"string"},"purchaseItemExtraIdent":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use ident instead. The unique identifier of an ItemExtra.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"taxInformation":{"description":"All tax information for this order item extraItem.","items":{"$ref":"#/components/schemas/TaxInformationCreationRequest"},"type":"array"},"type":{"description":"Type of the extraItem. Will be one of:.\nMust not be null.","enum":["VOUCHER","DISCOUNT","SINGLE_PURPOSE_VOUCHER"],"example":"SINGLE_PURPOSE_VOUCHER","type":"string"},"valueGross":{"$ref":"#/components/schemas/MonetaryValue_11"},"valueNet":{"$ref":"#/components/schemas/MonetaryValue_10"}},"required":["type","valueNet"],"type":"object"},"ItemSingleVoucherExtraCreationRequest":{"allOf":[{"$ref":"#/components/schemas/ItemExtraCreationRequest"},{"properties":{"refundabilityType":{"description":"Describes whether the voucher is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"}},"type":"object"}],"description":"Single Purpose Voucher are used when the product the Voucher is valid for is known - as in this case the VAT of the voucher amount is handled at the purchase of the Voucher.","required":["type","valueNet"],"type":"object"},"ItemVoucherExtraCreationRequest":{"allOf":[{"$ref":"#/components/schemas/ItemExtraCreationRequest"},{"properties":{"refundabilityType":{"description":"Describes whether the voucher is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"}},"type":"object"}],"deprecated":true,"description":"Deprecated: Single purpose voucher should be used instead. Represents a voucher applied to an item.","required":["type","valueNet"],"type":"object"},"ItemsCancellationRequest":{"description":"This cancellation request cancels all purchaseItems with the given idents and optionally adds a reason for the cancellation, so it can be printing on the credit memo.","properties":{"creditMemoCancellationReason":{"description":"Reason of the cancellation, if enabled it will be added to the credit memo.","type":"string"},"items":{"description":"A List of Item Idents, which shall be cancelled.\nMust not be empty.","items":{"$ref":"#/components/schemas/CancellationItemDto"},"minItems":1,"type":"array"}},"required":["items"],"type":"object"},"JsonNode":{"description":"The payload","nullable":true,"type":"object"},"LineItemExtraDto":{"description":"A line item extra is a representation of a voucher or a discount applied to a specific item. Those itemExtras reduce the taxAmount that has to be paid for this item","properties":{"description":{"description":"Description.","type":"string"},"externalReference":{"description":"Additional reference.","type":"string"},"ident":{"description":"Unique external reference.","type":"string"},"leftoverAmountGross":{"$ref":"#/components/schemas/MonetaryValue_30"},"name":{"description":"Name of the extra.","type":"string"},"refundabilityType":{"description":"Describes whether the item extra is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"taxInformation":{"description":"All tax information for this order item extra.","items":{"$ref":"#/components/schemas/TaxInformationDto"},"type":"array"},"type":{"description":"Type of the extra. Will be one of:","enum":["VOUCHER","DISCOUNT","SINGLE_PURPOSE_VOUCHER"],"example":"SINGLE_PURPOSE_VOUCHER","type":"string"},"valueCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_29"},"valueGross":{"$ref":"#/components/schemas/MonetaryValue_28"},"valueNet":{"$ref":"#/components/schemas/MonetaryValue_27"}},"type":"object"},"LineItemOnHoldRequest":{"description":"This request puts all provided line items on hold.","properties":{"idents":{"description":"List of Line Item Idents that should be put on hold.","items":{"description":"List of Line Item Idents that should be put on hold.","type":"string"},"type":"array"}},"type":"object"},"LineItemPerformanceLocationRequest":{"description":"Where the service has been provided. Used for tax calculation and can be printed on documents.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"LineItemPerformanceLocationResponse":{"description":"Where the service has been provided. Used for tax calculation and can be printed on documents.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"LineItemPrepareDocumentRequest":{"description":"This request prepares all given line items for document generation.","properties":{"idents":{"description":"List of Item Idents that should be invoiced.","items":{"description":"List of Item Idents that should be invoiced.","type":"string"},"type":"array"}},"type":"object"},"LineItemProcessingConfigRequest":{"description":"Processing configuration for contract line items","properties":{"billingPeriodDetermination":{"description":"Mode determining calculation of processing and document dates.\nMust be one of: CURRENT_BILLING_PERIOD (default), FUNCTIONAL_DATE_BILLING_PERIOD or NEXT_DOCUMENT.\nMust be one of:\n|                                |\n| ------------------------------ |\n| CURRENT_BILLING_PERIOD         |\n| FUNCTIONAL_DATE_BILLING_PERIOD |\n| NEXT_DOCUMENT                  |","type":"string"}},"required":["billingPeriodDetermination"],"type":"object"},"LineItemProcessingConfigResponse":{"description":"Processing configuration for the contract line item","properties":{"billingPeriodDetermination":{"description":"Mode determining calculation of processing and document dates.\nCan be one of: CURRENT_BILLING_PERIOD (default), FUNCTIONAL_DATE_BILLING_PERIOD or NEXT_DOCUMENT.\nMust be one of:\n|                                |\n| ------------------------------ |\n| CURRENT_BILLING_PERIOD         |\n| FUNCTIONAL_DATE_BILLING_PERIOD |\n| NEXT_DOCUMENT                  |","type":"string"}},"type":"object"},"LineItemTaxLocationRequest":{"description":"Where the service is taxable. Can be provided, but might be overwritten during tax calculation.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"LineItemTaxLocationResponse":{"description":" Where the service is taxable. Can be provided, but might be overwritten during tax calculation. ","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"LocaleCountryConfigurationRequest":{"description":"A request to configure regions for a particular service country.","properties":{"countryCode":{"description":"Country code in ISO 3166-1 alpha-3 or alpha-2 standard.\nMust not be null.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"defaultRegion":{"description":"Name of the default region. Optional, if only one region defined for country.","example":"de","type":"string"},"regions":{"description":"Regions configured for given country. If that country has no specific regions, the region can be the country itself.\nMust not be empty.","items":{"$ref":"#/components/schemas/RegionCreationRequest"},"minItems":1,"type":"array"}},"required":["countryCode","regions"],"type":"object"},"LocationRequest":{"description":"The location based on either taxLocation or performanceLocation, as defined in billing group. Default: taxLocation (previously known as serviceLocation).","nullable":true,"properties":{"country":{"description":"The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"region":{"description":"The region where the product or service was sold.","type":"string"}},"type":"object"},"MigrationDto":{"properties":{"endTime":{"format":"date-time","type":"string"},"entityName":{"type":"string"},"message":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"status":{"enum":["SCHEDULED","RUNNING","COMPLETED","FAILED","ABORTED"],"type":"string"}},"type":"object"},"MigrationPathBillingRequest":{"description":"The billing terms to use when changing plans.","properties":{"usage":{"description":"Must be one of:\n|          |                                                             |\n| -------- | ----------------------------------------------------------- |\n| OCCURRED | Billing of usage events will be based on when they occurred |","type":"string"}},"type":"object"},"MigrationPathBillingResponse":{"description":"The billing terms to use when changing plans.","properties":{"usage":{"description":"Must be one of:\n|          |                                                             |\n| -------- | ----------------------------------------------------------- |\n| OCCURRED | Billing of usage events will be based on when they occurred |","type":"string"}},"type":"object"},"MigrationPathConfigurationRequest":{"description":"The configuration to use when changing plans.","properties":{"term":{"description":"Must not be null.\nMust be one of:\n|            |                                                     |\n| ---------- | --------------------------------------------------- |\n| CARRY_OVER | Use the current contract term after the plan change |","type":"string"},"timing":{"description":"Must not be null.\nMust be one of:\n|                |                                                 |\n| -------------- | ----------------------------------------------- |\n| BILLING_PERIOD | Change plan only at the end of a billing period |","type":"string"}},"required":["term","timing"],"type":"object"},"MigrationPathConfigurationResponse":{"description":"The configuration to use when changing plans.","properties":{"term":{"description":"Defines how the contract terms are applied to the new plan.\nMust be one of:\n|            |                                                     |\n| ---------- | --------------------------------------------------- |\n| CARRY_OVER | Use the current contract term after the plan change |","type":"string"},"timing":{"description":"Defines how the timing of the transition into the new plan.\nMust be one of:\n|                |                                                 |\n| -------------- | ----------------------------------------------- |\n| BILLING_PERIOD | Change plan only at the end of a billing period |","type":"string"}},"type":"object"},"MigrationPathCreationRequest":{"description":"A request to create a migration path.\n A migration path defines whether and how a change from one contract's plan into another is possible.\n","properties":{"billing":{"$ref":"#/components/schemas/MigrationPathBillingRequest"},"configuration":{"$ref":"#/components/schemas/MigrationPathConfigurationRequest"},"description":{"description":"The migration path's description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"ident":{"description":"Must be a unique external reference. Cannot be amended after the initial creation. Will be automatically generated if not set.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"4564-45654-2154-2324","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"The migration path's name.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"target":{"$ref":"#/components/schemas/MigrationPathTargetRequest"}},"required":["name","target"],"type":"object"},"MigrationPathResponse":{"description":"A migration path defines how a contract may change from a given source plan into a target plan.","properties":{"billing":{"$ref":"#/components/schemas/MigrationPathBillingResponse"},"configuration":{"$ref":"#/components/schemas/MigrationPathConfigurationResponse"},"description":{"description":"The description of a migration path.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"ident":{"description":"The unique identifier of a migration path.\nMust not be null.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"The name of a migration path.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"source":{"$ref":"#/components/schemas/MigrationPathSourceResponse"},"target":{"$ref":"#/components/schemas/MigrationPathTargetResponse"}},"required":["billing","configuration","description","ident","name","source","target"],"title":"Migration Path","type":"object"},"MigrationPathSourceResponse":{"description":"The definition of the starting point for a plan change using this migration path.","properties":{"planIdent":{"description":"The unique identifier for the source plan.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["planIdent"],"type":"object"},"MigrationPathTargetRequest":{"description":"The definition of possible targets for a plan change using this migration path.","properties":{"planIdent":{"description":"The unique identifier for the target plan.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["planIdent"],"type":"object"},"MigrationPathTargetResponse":{"description":"The definition of possible targets for a plan change using this migration path.","properties":{"planIdent":{"description":"The unique identifier for the target plan.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["planIdent"],"type":"object"},"MigrationPathUpdateRequest":{"description":"A request to update a migration path.\n A migration path defines whether and how a change from one contract's plan into another is possible.\n The ident is provided via the path parameter and cannot be changed.\n","properties":{"billing":{"$ref":"#/components/schemas/MigrationPathBillingRequest"},"configuration":{"$ref":"#/components/schemas/MigrationPathConfigurationRequest"},"description":{"description":"The migration path's description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"name":{"description":"The migration path's name.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"target":{"$ref":"#/components/schemas/MigrationPathTargetRequest"}},"required":["name","target"],"type":"object"},"MonetaryValue":{"description":"A monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValueTotals":{"description":"Aggregate of net, tax and gross monetary values","properties":{"gross":{"type":"number"},"net":{"type":"number"},"tax":{"type":"number"}},"type":"object"},"MonetaryValue_1":{"description":"Total tax amount before application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_10":{"description":"Net amount excluding vat that will be discounted.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_100":{"description":"Gross total of all items after application of item.extras. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_101":{"description":"Gross price of one unit. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"1.19","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_102":{"description":"Amount the referenced option will be reduced. Is considered net or gross depending on how the option price is configured.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_11":{"description":"Gross amount that will be discounted. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_12":{"description":"Voucher amount that is leftover after part of a voucher is applied.\nA monetary amount along with a currency.","example":"10","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_13":{"description":"The amount that will be discounted.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_14":{"description":"Voucher amount that is leftover after part of a voucher is applied.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_15":{"description":"Total tax amount before application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_16":{"description":"Total tax amount after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_17":{"description":"Tax amount for one unit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_18":{"description":"Net total of this line item without vat before discounts (unitQuantity * unitPriceNet).\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_19":{"description":"Gross total of this line item before discounts (unitQuantity * unitPriceGross).\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_2":{"description":"Total tax amount after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_20":{"description":"Total tax of this line item before application of any item extra.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_21":{"description":"Total tax of this line item after application of any item extra.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_22":{"description":"Net total of this line item without vat after discounts.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_23":{"description":"Gross total of this line item after discounts.\nA monetary amount along with a currency.","example":"1190","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_24":{"description":"Net price of a single unit of this line item without vat.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_25":{"description":"Net price of a single unit of this line item.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_26":{"description":"Total tax of a single unit of this line item before application of any item extra.\nA monetary amount along with a currency.","example":"1000","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_27":{"description":"Net amount excluding vat that will be discounted.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_28":{"description":"Gross amount that will be discounted.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_29":{"description":"Value amount of tax.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_3":{"description":"Tax amount for one unit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_30":{"description":"The amount of money that is left over on the voucher that has been applied.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_31":{"description":"The amount that will be discounted.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_32":{"description":"Voucher amount that is leftover after part of a voucher is applied.\nA monetary amount along with a currency.","example":"10","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_33":{"description":"Monetary value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_34":{"description":"Monetary net value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_35":{"description":"Monetary tax value sum of all tax information of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_36":{"description":"Tax amount for one agreed deposit.\nA monetary amount along with a currency.","example":"0.19","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_37":{"description":"Monetary value that was assigned to this deposit item assignment.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_38":{"description":"Monetary value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_39":{"description":"Monetary net value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_4":{"description":"Net total of all items without vat before application of item.extras (unitQuantity * unitPriceNet).\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_40":{"description":"Monetary tax value sum of all tax information of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_41":{"description":"Total tax amount after application of item.extras.\nA monetary amount along with a currency.","example":"19.00","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_42":{"description":"Net total of all items without vat after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_43":{"description":"Gross total of all items after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_44":{"description":"Total tax amount after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_45":{"description":"Net total of all items without vat after discounts.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_46":{"description":"Gross total of all items after discounts.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_47":{"description":"Monetary value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_48":{"description":"Monetary value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_49":{"description":"Net total of all items without vat before application of item.extras (unitQuantity * unitPriceNet).\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_5":{"description":"Net total of all items without vat after application of item.extras.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_50":{"description":"Net total of all items without vat after application of item.extras.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_51":{"description":"Net price of one unit without vat.\nA monetary amount along with a currency.","example":"1","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_52":{"description":"Gross total of all items before application of item.extras (unitQuantity * unitPriceNet). Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_53":{"description":"Gross total of all items after application of item.extras. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_54":{"description":"Gross price of one unit. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"1.19","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_55":{"description":"Net total of this line item without vat before discounts (unitQuantity * unitPriceNet).\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_56":{"description":"Gross total of this line item before discounts (unitQuantity * unitPriceGross).\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_57":{"description":"Total tax of this line item before application of any item extra.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_58":{"description":"Total tax of this line item after application of any item extra.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_59":{"description":"Net total of this line item without vat after discounts.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_6":{"description":"Net price of one unit without vat.\nA monetary amount along with a currency.","example":"1","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_60":{"description":"Gross total of this line item after discounts.\nA monetary amount along with a currency.","example":"1190","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_61":{"description":"Net price of a single unit of this line item without vat.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_62":{"description":"Net price of a single unit of this line item.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_63":{"description":"Total tax of a single unit of this line item before application of any item extra.\nA monetary amount along with a currency.","example":"1000","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_64":{"description":"Amount the referenced option will be reduced. Is considered net or gross depending on how the option price is configured.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_65":{"description":"Amount the referenced option will be reduced. Is considered net or gross depending on how the option price is configured.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_66":{"description":"Monetary value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_67":{"description":"Net total of all items without vat before application of item.extras (unitQuantity * unitPriceNet).\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_68":{"description":"Net total of all items without vat after application of item.extras.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_69":{"description":"Net price of one unit without vat.\nA monetary amount along with a currency.","example":"1","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_7":{"description":"Gross total of all items before application of item.extras (unitQuantity * unitPriceNet). Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_70":{"description":"Gross total of all items before application of item.extras (unitQuantity * unitPriceNet). Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_71":{"description":"Gross total of all items after application of item.extras. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_72":{"description":"Gross price of one unit. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"1.19","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_73":{"description":"Monetary value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_74":{"description":"Monetary net value of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_75":{"description":"Monetary tax value sum of all tax information of the agreed deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_76":{"description":"Net total of all items without vat after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_77":{"description":"Gross total of all items after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_78":{"description":"Monetary value of the deposit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_79":{"description":"Total tax amount before application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_8":{"description":"Gross total of all items after application of item.extras. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_80":{"description":"Total tax amount after application of item.extras.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_81":{"description":"Tax amount for one unit.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_82":{"description":"Monetary net value of non pro rated option price.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_83":{"description":"Monetary gross value of non pro rated option price.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_84":{"description":"Monetary cumulative tax value of non pro rated option price.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_85":{"description":"A monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_86":{"description":"How much each quantity costs in single tier.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_87":{"description":"The total price for the entire single tier.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_88":{"description":"How much each quantity costs in progressive tier.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_89":{"description":"The total price for the entire progressive tier.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_9":{"description":"Gross price of one unit. Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"1.19","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_90":{"description":"Price per started block.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_91":{"description":"The total price per block in case a block is started multiple times.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_92":{"description":"Total cost across all time slots.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_93":{"description":"Average price per total quantity across all time slots (totalCost / totalQuantity).\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_94":{"description":"Unit price applied per defined time unit (per minute or per second).\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_95":{"description":"Total calculated price for the consumed quantity within this time slot.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_96":{"description":"Net total of all items without vat before application of item.extras (unitQuantity * unitPriceNet).\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_97":{"description":"Net total of all items without vat after application of item.extras.\nA monetary amount along with a currency.","example":"100","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_98":{"description":"Net price of one unit without vat.\nA monetary amount along with a currency.","example":"1","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryValue_99":{"description":"Gross total of all items before application of item.extras (unitQuantity * unitPriceNet). Mandatory, depending on tenant configuration.\nA monetary amount along with a currency.","example":"119","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"default":"EUR","description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"OneTimeOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"An option that is only billed once. e.g. setup fee, signup fee","required":["name","prices","type"],"type":"object"},"OneTimeOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"An option that is only billed once. e.g. setup fee, signup fee","required":["name","prices","type"],"type":"object"},"OneTimeOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"type":"object"}],"description":"An option that is only billed once. e.g. setup fee, signup fee","required":["name","prices","productIdent","type"],"type":"object"},"OneTimeOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"}},"type":"object"}],"description":"An option that is only billed once. e.g. setup fee, signup fee","required":["name","prices"],"type":"object"},"OptionAllowanceCreationRequest":{"description":"A request to create an option allowance of a contract for an option.","properties":{"applicability":{"default":"NEXT_INVOICE","deprecated":true,"description":"DEPRECATED: Applicability determines when and for how long an option allowance will be applied to the given option. Currently only a one time use on the next invoice is supported.","enum":["NEXT_INVOICE"],"type":"string"},"applicabilityDetails":{"$ref":"#/components/schemas/ApplicabilityDetailsRequest"},"description":{"description":"Description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"fixedAmount":{"$ref":"#/components/schemas/MonetaryValue_102"},"ident":{"description":"Unique identifier of an option allowance. When not provided NBX will generate an identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the option allowance to be printed on a document or referenced as booking text.\nSize must be between 0 and 100.","maxLength":100,"type":"string"},"optionIdent":{"description":"Should reference a valid option for this contract.\nMust not be blank.","example":"nbx_optionIdent_4658488","minLength":1,"type":"string"},"percentage":{"description":"Option price will be reduced by the given percentage.\nMust be greater than 0.\nMust be less than or equal to 100.","exclusiveMinimum":true,"maximum":100,"minimum":1,"type":"number"},"type":{"default":"DISCOUNT","description":"Indicates the kind of an option allowance.","enum":["DISCOUNT","SINGLE_PURPOSE_VOUCHER"],"type":"string"}},"required":["optionIdent"],"type":"object"},"OptionAllowanceResponse":{"description":"A response object for an option allowance of a contract for an option.","properties":{"applicability":{"default":"NEXT_INVOICE","deprecated":true,"description":"DEPRECATED: Applicability determines when and for how long an option allowance will be applied to the given option. Currently only a one time use on the next invoice is supported.","enum":["NEXT_INVOICE"],"type":"string"},"applicabilityDetails":{"$ref":"#/components/schemas/ApplicabilityDetailsResponse"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"description":{"description":"Description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"fixedAmount":{"$ref":"#/components/schemas/MonetaryValue_65"},"ident":{"description":"Unique identifier of an option allowance. When not provided NBX will generate an identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the option allowance to be printed on a document or referenced as booking text.\nSize must be between 0 and 100.","maxLength":100,"type":"string"},"optionIdent":{"description":"The unique identifier of an option as given by the tenant.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_optionIdent_4658488","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"percentage":{"description":"Option price will be reduced by the given percentage.\nMust be greater than 0.\nMust be less than or equal to 100.","exclusiveMinimum":true,"maximum":100,"minimum":1,"type":"number"},"type":{"default":"DISCOUNT","description":"Indicates the kind of an option allowance.","enum":["DISCOUNT","SINGLE_PURPOSE_VOUCHER"],"type":"string"}},"required":["applicabilityDetails","createdAt","lastModifiedAt","optionIdent"],"type":"object"},"OptionAllowanceUpdateRequest":{"description":"A request to update an allowance of a contract for an option.","properties":{"applicability":{"default":"NEXT_INVOICE","deprecated":true,"description":"DEPRECATED: Applicability determines when and for how long an option allowance will be applied to the given option. Currently only a one time use on the next invoice is supported.","enum":["NEXT_INVOICE"],"type":"string"},"applicabilityDetails":{"$ref":"#/components/schemas/ApplicabilityDetailsRequest"},"description":{"description":"Description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"fixedAmount":{"$ref":"#/components/schemas/MonetaryValue_64"},"name":{"description":"Name of the option allowance to be printed on a document or referenced as booking text.\nSize must be between 0 and 100.","maxLength":100,"type":"string"},"optionIdent":{"description":"Should reference a valid option for this contract.\nMust not be blank.","example":"nbx_optionIdent_4658488","minLength":1,"type":"string"},"percentage":{"description":"Option price will be reduced by the given percentage.\nMust be greater than 0.\nMust be less than or equal to 100.","exclusiveMinimum":true,"maximum":100,"minimum":1,"type":"number"},"type":{"default":"DISCOUNT","description":"Indicates the kind of an option allowance.","enum":["DISCOUNT","SINGLE_PURPOSE_VOUCHER"],"type":"string"}},"required":["optionIdent"],"type":"object"},"OptionCreationRequestBase":{"deprecated":true,"discriminator":{"mapping":{"COMMISSION":"#/components/schemas/CommissionOptionCreationRequest","ONETIME":"#/components/schemas/OneTimeOptionCreationRequest","QUANTITY":"#/components/schemas/QuantityOptionCreationRequest","RATED_USAGE":"#/components/schemas/RatedUsageOptionCreationRequest","RECURRING":"#/components/schemas/RecurringOptionCreationRequest","TIME_BASED_USAGE":"#/components/schemas/TimeBasedUsageOptionCreationRequest","USAGE":"#/components/schemas/UsageOptionCreationRequest"},"propertyName":"type"},"properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"default":"SERVICE","description":"The option's line item category. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"description":{"description":"Description of the product in human readable form.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"individualOption":{"description":"If the option is individual, it can be only assigned to one plan.","type":"boolean"},"itemGroup":{"description":"The item group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"name":{"description":"Name of the product or service in human readable form. To be used to be displayed on pdf documents.\nMust not be blank.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the option. Only predefined operating site identifiers are allowed.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"optionIdent":{"description":"Unique Identifier for an option. An uuid is generated if not provided.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"optionName":{"description":"Name displayed in option catalog, not used to be displayed on pdf documents.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"productIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"description":"List of all properties for this option.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array","uniqueItems":true},"type":{"description":"Type of the option. Must be one of:.\nMust not be null.","enum":["ONETIME","QUANTITY","RECURRING","USAGE","RATED_USAGE","COMMISSION","TIME_BASED_USAGE"],"example":"QUANTITY","type":"string"}},"required":["name","productIdent","type"],"type":"object"},"OptionDtoBase":{"description":"An option assigned to the Phase.","discriminator":{"mapping":{"COMMISSION":"#/components/schemas/CommissionOptionDto","ONETIME":"#/components/schemas/OneTimeOptionDto","QUANTITY":"#/components/schemas/QuantityOptionDto","RATED_USAGE":"#/components/schemas/RatedUsageOptionDto","RECURRING":"#/components/schemas/RecurringOptionDto","TIME_BASED_USAGE":"#/components/schemas/TimeBasedUsageOptionDto","USAGE":"#/components/schemas/UsageOptionDto"},"propertyName":"type"},"properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"default":"SERVICE","description":"The option's line item category. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"creationDate":{"deprecated":true,"description":"DEPRECATED: use 'createdAt'. The creation date of the option.","format":"date-time","type":"string"},"description":{"description":"Description of the product in human readable form.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"individualOption":{"description":"If the option is individual, it can be only assigned to one plan.","type":"boolean"},"itemGroup":{"description":"The item group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED: use 'lastModifiedAt'. The date of the last modification of the option.","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"modifiedOption":{"description":"If the option is modified, it can not be changed. only original option can be changed.","type":"boolean"},"name":{"description":"Name of the product or service in human readable form. To be used to be displayed on pdf documents.\nMust not be blank.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the option. Only predefined operating site identifiers are allowed.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"optionIdent":{"description":"Unique Identifier for an option. An uuid is generated if not provided.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"optionName":{"description":"Name displayed in option catalog, not used to be displayed on pdf documents.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"originalOptionIdent":{"description":"Unique Identifier for the original option","type":"string"},"originalOptionName":{"description":"Name of the original option","type":"string"},"productIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"description":"Properties of the option. On root level, this list is not stored independently. It is always derived from the option version that is currently effective at request time. A version is considered effective if its validFrom is less than or equal to the current time. Among these, the version with the latest validFrom applies. In the versions list, each version entry contains the properties defined for that specific version.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array","uniqueItems":true},"type":{"description":"Type of the option. Must be one of:.\nMust not be null.","enum":["ONETIME","QUANTITY","RECURRING","USAGE","RATED_USAGE","COMMISSION","TIME_BASED_USAGE"],"example":"QUANTITY","type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.","format":"date-time","type":"string"},"versions":{"description":"List of all versions for this option.","items":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionVersionDto"},{"$ref":"#/components/schemas/OneTimeOptionVersionDto"},{"$ref":"#/components/schemas/QuantityOptionVersionDto"},{"$ref":"#/components/schemas/RatedUsageOptionVersionDto"},{"$ref":"#/components/schemas/RecurringOptionVersionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionVersionDto"},{"$ref":"#/components/schemas/UsageOptionVersionDto"}]},"type":"array"}},"required":["name","type"],"type":"object"},"OptionPriceListModifierDto":{"allOf":[{"$ref":"#/components/schemas/PlanModifierDto"},{"properties":{"optionIdent":{"description":"The option ident for the base option that should be modified.\nMust not be null.","type":"string"},"prices":{"description":"The prices that override the prices of the referenced option for this contract completely.\nMust not be null.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"validFrom":{"description":"If set, modifier will be valid beginning with the first billing period on/after the given date (until there will be a newer modifier).","format":"date-time","type":"string"}},"type":"object"}],"required":["optionIdent","prices","type"],"type":"object"},"OptionQuantityRequest":{"description":"Metadata for phases","properties":{"optionIdent":{"description":"option identifier.\nMust not be blank.","minLength":1,"type":"string"},"quantity":{"description":"the amount of times tha option should be applied.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","minimum":0,"type":"integer"}},"required":["optionIdent","quantity"],"type":"object"},"OptionQuantityResponse":{"description":"Metadata for phases","properties":{"optionIdent":{"description":"option identifier","type":"string"},"quantity":{"description":"the amount of times that option should be applied.","format":"int32","type":"integer"}},"type":"object"},"OptionUpdateRequestBase":{"discriminator":{"mapping":{"COMMISSION":"#/components/schemas/CommissionOptionUpdateRequest","ONETIME":"#/components/schemas/OneTimeOptionUpdateRequest","QUANTITY":"#/components/schemas/QuantityOptionUpdateRequest","RATED_USAGE":"#/components/schemas/RatedUsageOptionUpdateRequest","RECURRING":"#/components/schemas/RecurringOptionUpdateRequest","TIME_BASED_USAGE":"#/components/schemas/TimeBasedUsageOptionUpdateRequest","USAGE":"#/components/schemas/UsageOptionUpdateRequest"},"propertyName":"type"},"properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"default":"SERVICE","description":"The option's line item category. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"description":{"description":"Description of the product in human readable form.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"individualOption":{"description":"If the option is individual, it can be only assigned to one plan.","type":"boolean"},"itemGroup":{"description":"The item group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"name":{"description":"Name of the product or service in human readable form. To be used to be displayed on pdf documents.\nMust not be blank.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the option. Only predefined operating site identifiers are allowed.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"optionName":{"description":"Name displayed in option catalog, not used to be displayed on pdf documents.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"productIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"description":"List of all properties for this option.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array","uniqueItems":true},"type":{"description":"Type of the option. Must be one of:.\nMust not be null.","enum":["ONETIME","QUANTITY","RECURRING","USAGE","RATED_USAGE","COMMISSION","TIME_BASED_USAGE"],"example":"QUANTITY","type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","nullable":true,"type":"string"}},"required":["name","productIdent","type"],"type":"object"},"OptionVersionDtoBase":{"description":"List of all versions for this option.","discriminator":{"mapping":{"OPTION_PRICE_LIST":"#/components/schemas/OptionPriceListModifierDto"},"propertyName":"type"},"properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars","example":"A-1234","type":"string"},"category":{"default":"SERVICE","description":"The option's line item category. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"creationDate":{"deprecated":true,"description":"DEPRECATED: use 'createdAt'. The creation date of the option.","format":"date-time","type":"string"},"description":{"description":"Description of the product in human readable form.","type":"string"},"itemGroup":{"description":"The item group to which an item belongs. Max 64 chars","type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED: use 'lastModifiedAt'. The date of the last modification of the option.","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the product or service in human readable form. To be used to be displayed on pdf documents","type":"string"},"operatingSiteIdent":{"description":"Operating site of the option. Only predefined operating site identifiers are allowed.","type":"string"},"properties":{"description":"Properties of this option version. This list contains the properties defined for this specific version. On the root option level, properties are derived from the currently effective version.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array","uniqueItems":true},"type":{"type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"required":["name","type"],"type":"object"},"OrderAgreedDepositCreationRequest":{"description":"A request to create an agreed deposit on order","properties":{"grossValue":{"$ref":"#/components/schemas/MonetaryValue_66"},"ident":{"description":"Unique external reference.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Human readable name, could be printed on document template","type":"string"},"properties":{"description":"Additional agreed deposit properties on order","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"}},"required":["grossValue","ident"],"type":"object"},"OrderAgreedDepositResponse":{"description":"Deposits the customer agreed to.","properties":{"grossValue":{"$ref":"#/components/schemas/MonetaryValue_48"},"ident":{"description":"Unique external reference.","type":"string"},"name":{"description":"Human readable name, could be printed on document template","type":"string"},"properties":{"description":"Additional agreed deposit properties on order","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"}},"required":["grossValue"],"type":"object"},"OrderAgreedDepositUpdateRequest":{"description":"A request to update an agreed deposit on order","properties":{"grossValue":{"$ref":"#/components/schemas/MonetaryValue_47"},"name":{"description":"Human readable name, could be printed on document template","type":"string"},"properties":{"description":"Additional agreed deposit properties on order","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"}},"required":["grossValue"],"type":"object"},"OrderAllowanceCancellationRequest":{"description":"A List of allowance Idents, which shall be cancelled.","properties":{"ident":{"description":"Must not be blank.","minLength":1,"type":"string"}},"required":["ident"],"type":"object"},"OrderCreationRequest":{"description":"Please see Order Model below for more information regarding required values and input type.","properties":{"agreedDeposits":{"description":"Agreed deposits on order.","items":{"$ref":"#/components/schemas/OrderAgreedDepositCreationRequest"},"type":"array"},"allowances":{"description":"A list of allowances included in the order. Please see Allowance Model for more details","items":{"$ref":"#/components/schemas/AllowanceCreationRequest"},"type":"array"},"autoCreateDocument":{"default":"INVOICE","deprecated":true,"description":"DEPRECATED.\nThe type of document that is automatically generated at order creation. Will be one of:","enum":["INVOICE","DEPOSITINVOICE","NONE"],"type":"string"},"billingTime":{"default":"IMMEDIATELY","description":"It defines billing time, when an invoice should be triggered. Defaults to Immediately.","enum":["IMMEDIATELY","ON_DEMAND"],"type":"string"},"businessSegmentIdent":{"description":"Reference to the business segment of the order. Default business segment will be used if not specified.","example":"160","type":"string"},"debtorOrderDetails":{"oneOf":[{"$ref":"#/components/schemas/CreateDebtorRequest"},{"$ref":"#/components/schemas/UseDebtorRequest"}]},"language":{"default":"de","description":"The language of the order. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"lineItems":{"description":"A list of line items included in the order. Please see Line Item Model for more details","items":{"$ref":"#/components/schemas/OrderLineItemCreationRequest"},"type":"array"},"orderDate":{"description":"The date of the order.","format":"date-time","type":"string"},"orderIdent":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust be unique.","example":"nbx_orderIdent_256644","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformationCreationRequest"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermRequest"},"properties":{"description":"Additional order properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"}},"required":["debtorOrderDetails","orderIdent"],"type":"object"},"OrderDto":{"description":"An order is placed once and has no plan, runtime or recurring elements.","properties":{"agreedDepositSum":{"$ref":"#/components/schemas/MonetaryValue"},"allowanceRowTotals":{"$ref":"#/components/schemas/MonetaryValueTotals"},"allowances":{"description":"A list of allowances included in the order. Please see Allowance Model for more details","items":{"$ref":"#/components/schemas/AllowanceResponse"},"type":"array"},"attachments":{"description":"List of attachments","items":{"$ref":"#/components/schemas/AttachmentDto"},"type":"array"},"autoCreateDocument":{"description":"The type of document that is automatically generated at order creation. Will be one of:","enum":["INVOICE","DEPOSITINVOICE","NONE"],"type":"string"},"billingGroupIdent":{"description":"Reference to the billing group of the order.","type":"string"},"billingTime":{"description":"It defines billing time, when an invoice should be triggered. Defaults to Immediately.","enum":["IMMEDIATELY","ON_DEMAND"],"type":"string"},"businessSegmentId":{"description":"Reference to the business segment of the order.","format":"int64","type":"integer"},"businessSegmentIdent":{"description":"The Ident of the business segment of the order.","type":"string"},"cancellationDate":{"description":"The cancellation date of the order.","format":"date-time","type":"string"},"cancellationReason":{"description":"The reason for cancellation.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currency":{"description":"The currency of the order.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"debtorIdent":{"description":"Ident of the debtor of the order.","type":"string"},"depositSum":{"$ref":"#/components/schemas/MonetaryValue"},"deposits":{"description":"A list of deposits. Please see Deposit Model for more details","items":{"$ref":"#/components/schemas/DepositDto"},"type":"array"},"documentDate":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: The custom document creation date for external document creation.","format":"date-time","type":"string"},"invoiceAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Id for the invoice address. Please use invoiceAddressIdent.","format":"int64","type":"integer"},"invoiceAddressIdent":{"description":"Ident for the invoice address.","type":"string"},"language":{"description":"The language of the order, in ISO 639-3 format","example":"deu","type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED: use 'lastModifiedAt'. Modification date.","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"lineItemRowTotals":{"$ref":"#/components/schemas/MonetaryValueTotals"},"notBilledTotalGross":{"items":{"$ref":"#/components/schemas/MonetaryValue"},"type":"array"},"orderDate":{"description":"The date of the order.","format":"date-time","type":"string"},"orderId":{"description":"Unique id of the order.","format":"int64","type":"integer"},"orderIdent":{"description":"Unique external reference.","type":"string"},"orderStatus":{"description":"The status of the order. Must be one of:","enum":["ACTIVE","CANCELLED"],"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermDto"},"properties":{"description":"Order properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalsSum":{"$ref":"#/components/schemas/MonetaryValueTotals"},"shippingAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Optional Id of the shipping address. Please use shippingAddressIdent.","format":"int64","type":"integer"},"shippingAddressIdent":{"description":"Optional Ident of the shipping address.","type":"string"},"technicalCreationDate":{"deprecated":true,"description":"DEPRECATED: use 'createdAt'. Technical creation date.","format":"date-time","type":"string"}},"required":["createdAt","lastModifiedAt"],"type":"object"},"OrderLineItemCreationRequest":{"description":"A request to create a new line item. A line item is assigned to a specific order. It represents a purchased product with its description, price and quantity. A order item is created when a new order is created. Order items automatically generate matching billable items. If additional items need to be assigned to a order, a new billable item must be generated. Please see Billable Item Model for more details.","properties":{"agreedDeposits":{"description":"All agreed deposits of the line item.","items":{"$ref":"#/components/schemas/AgreedDepositCreationRequest"},"type":"array"},"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"description":"Category of the line item, might be used for different tax rates.\nMust not be null.","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"debitCreditIndicator":{"description":"Determines if the given item has a debit or credit impact on your business.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"deliveryDate":{"description":"The planned delivery date.","format":"date-time","type":"string"},"description":{"description":"Any additional description, might be printed on the document.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"group":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the item.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"originalRowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_70"},"originalRowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_67"},"performanceLocation":{"$ref":"#/components/schemas/LineItemPerformanceLocationRequest"},"periodEndDate":{"description":"End date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-20T12:00:00Z","format":"date-time","type":"string"},"periodStartDate":{"description":"Start date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-01T12:00:00+03:00","format":"date-time","type":"string"},"postTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item. These extras don't reduce the tax amount.","items":{"$ref":"#/components/schemas/PostTaxItemCreationRequest"},"type":"array"},"preTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item that also reduce the tax amount.","items":{"oneOf":[{"$ref":"#/components/schemas/ItemDiscountExtraCreationRequest"},{"$ref":"#/components/schemas/ItemSingleVoucherExtraCreationRequest"},{"$ref":"#/components/schemas/ItemVoucherExtraCreationRequest"}]},"type":"array"},"properties":{"description":"Additional item properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_71"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_68"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"taxInformation":{"description":"All tax information for this order item.","items":{"$ref":"#/components/schemas/TaxInformationCreationRequest"},"type":"array"},"taxLocation":{"$ref":"#/components/schemas/LineItemTaxLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)","enum":["SALES","SELF_BILLING"],"type":"string"},"unitPriceGross":{"$ref":"#/components/schemas/MonetaryValue_72"},"unitPriceNet":{"$ref":"#/components/schemas/MonetaryValue_69"},"unitQuantity":{"description":"Number of units.\nMust not be null.","example":100,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Will be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"}},"required":["category","debitCreditIndicator","name","unitPriceNet","unitQuantity","unitQuantityType"],"type":"object"},"OrderLineItemResponse":{"description":"A line item of this type is assigned to a specific order. It represents a purchased product with its description, price and quantity. A order item is created when a new order is created. Order items automatically generate matching billable items. If additional items need to be assigned to a order, a new billable item must be generated. Please see BillableResponse for more details.","properties":{"agreedDeposits":{"description":"All agreed deposits of this line item","items":{"$ref":"#/components/schemas/AgreedDepositResponse"},"type":"array"},"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars","example":"A-1234","type":"string"},"category":{"description":"Category of the line item, might be used for different tax rates.\nMust not be null.","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currency":{"deprecated":true,"description":"DEPRECATED.\nThe currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Determines if the given item has a debit or credit impact on your business.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"deliveryDate":{"description":"Planned delivery date","format":"date-time","type":"string"},"depositItemAssignments":{"description":"All deposits of this line item","items":{"$ref":"#/components/schemas/DepositItemAssignmentDto"},"type":"array"},"description":{"description":"Any additional description, might be printed on the document","type":"string"},"group":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"ident":{"description":"Unique external reference.\nMust not be null.","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the item.\nMust not be blank.","minLength":1,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed","type":"string"},"originalRowTotalCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_20"},"originalRowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_19"},"originalRowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_18"},"performanceLocation":{"$ref":"#/components/schemas/LineItemPerformanceLocationResponse"},"periodEndDate":{"description":"End date for line items that span a certain period of time. Supports ISO 8601 offset information","example":"2021-02-10T00:00:00Z","format":"date-time","type":"string"},"periodStartDate":{"description":"Start date for line items that span a certain period of time. Supports ISO 8601 offset information","example":"2021-02-10T00:00:00+02:00","format":"date-time","type":"string"},"postTaxExtras":{"items":{"$ref":"#/components/schemas/PostTaxLineItemExtraDto"},"type":"array"},"preTaxExtras":{"items":{"$ref":"#/components/schemas/LineItemExtraDto"},"type":"array"},"processingDate":{"description":"Processing date","format":"date-time","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_21"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_23"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_22"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use service location instead. The country where the product or service was sold. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationResponse"},"status":{"description":"The status of this line item","enum":["CANCELLED","ON_HOLD"],"type":"string"},"taxCalculationBasis":{"description":"The tax information source of the line item.\nMust be one of:\n|         |\n| ------- |\n| NET     |\n| GROSS   |\n| UNKNOWN |","example":"NITROBOX","type":"string"},"taxInformation":{"description":"All tax information for this item.\nMust not be empty.","items":{"$ref":"#/components/schemas/TaxInformationDto"},"minItems":1,"type":"array"},"taxInformationSource":{"description":"The tax information source of the billable item","enum":["NITROBOX","AVALARA","FINANCE_ENABLER","CUSTOMER_PROVIDED"],"type":"string"},"taxLocation":{"$ref":"#/components/schemas/LineItemTaxLocationResponse"},"taxScheme":{"description":"It defines tax trading procedure of an item","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)","enum":["SALES","SELF_BILLING"],"type":"string"},"unitCumulatedTaxPrice":{"$ref":"#/components/schemas/MonetaryValue_26"},"unitPriceGross":{"$ref":"#/components/schemas/MonetaryValue_25"},"unitPriceNet":{"$ref":"#/components/schemas/MonetaryValue_24"},"unitQuantity":{"description":"Number of units for this item","example":10,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Will be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"}},"required":["category","debitCreditIndicator","ident","name","taxInformation"],"type":"object"},"OrderLineItemUpdateRequest":{"description":"A request to update a line item. All the fields are optional - if provided, they will overwrite the value(with the exception of properties) Item properties will be merged based on property key(ident). ","properties":{"articleNumber":{"description":"e.g. article number, SKU, ISBN, not unique. Max 32 Chars.\nSize must be between 0 and 32.","example":"A-1234","maxLength":32,"type":"string"},"category":{"description":"Category of the line item, might be used for different tax rates.\nMust not be null.","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"type":"string"},"debitCreditIndicator":{"description":"Determines if the given item has a debit or credit impact on your business.\nMust not be null.","enum":["DEBIT","CREDIT"],"type":"string"},"deliveryDate":{"description":"The planned delivery date.","format":"date-time","type":"string"},"description":{"description":"Any additional description, might be printed on the document.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"group":{"description":"The group to which an item belongs. Max 64 chars.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"name":{"description":"Name of the item.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Operating site of the item. Only predefined operating site identifiers are allowed.","type":"string"},"originalRowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_7"},"originalRowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_4"},"performanceLocation":{"$ref":"#/components/schemas/LineItemPerformanceLocationRequest"},"periodEndDate":{"description":"End date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-20T12:00:00Z","format":"date-time","type":"string"},"periodStartDate":{"description":"Start date for line items that span a certain period of time. Supports ISO 8601 offset information.","example":"2020-06-01T12:00:00+03:00","format":"date-time","type":"string"},"postTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item. These extras don't reduce the tax amount.","items":{"$ref":"#/components/schemas/PostTaxItemCreationRequest"},"type":"array"},"preTaxExtras":{"description":"Price reductions (e.g. voucher) applied to this line item that also reduce the tax amount.","items":{"oneOf":[{"$ref":"#/components/schemas/ItemDiscountExtraCreationRequest"},{"$ref":"#/components/schemas/ItemSingleVoucherExtraCreationRequest"},{"$ref":"#/components/schemas/ItemVoucherExtraCreationRequest"}]},"type":"array"},"properties":{"description":"Additional item properties","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotalGross":{"$ref":"#/components/schemas/MonetaryValue_8"},"rowTotalNet":{"$ref":"#/components/schemas/MonetaryValue_5"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocationRequest"},"taxInformation":{"description":"All tax information for this order item.","items":{"$ref":"#/components/schemas/TaxInformationCreationRequest"},"type":"array"},"taxLocation":{"$ref":"#/components/schemas/LineItemTaxLocationRequest"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)","enum":["SALES","SELF_BILLING"],"type":"string"},"unitPriceGross":{"$ref":"#/components/schemas/MonetaryValue_9"},"unitPriceNet":{"$ref":"#/components/schemas/MonetaryValue_6"},"unitQuantity":{"description":"Number of units.\nMust not be null.","example":100,"type":"number"},"unitQuantityType":{"description":"The type of quantity that units are measured in. Will be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"type":"string"}},"required":["category","debitCreditIndicator","name","unitPriceNet","unitQuantity","unitQuantityType"],"type":"object"},"OrderUpdateRequest":{"description":"A request to update an existing order. Some attributes of an order can be later updated with this request. Mixing ids and idents for addresses (e. g. id for invoice address and ident for shipping address) is not supported.","properties":{"invoiceAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Invoice address that will be used for the next billing onwards. Please use invoiceAddressIdent.","format":"int64","type":"integer"},"invoiceAddressIdent":{"description":"Invoice address that will be used for the next billing onwards.","type":"string"},"language":{"default":"de","description":"Optional language code in the ISO 639-1 standard. Must be one of the valid languages from the business segment.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"paymentInformation":{"oneOf":[{"$ref":"#/components/schemas/PaymentInformationChargeUpdateRequest"},{"$ref":"#/components/schemas/PaymentInformationNoChargeUpdateRequest"}]},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermRequest"},"properties":{"description":"Properties with additional information for template and bookkeeping. If updating the entire List will be updated.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"shippingAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Shipping address that will be used for the next billing onwards. Please use shippingAddressIdent.","format":"int64","type":"integer"},"shippingAddressIdent":{"description":"Shipping address that will be used for the next billing onwards.","type":"string"}},"type":"object"},"OrdinaryContractTerminationRequest":{"description":"This contract termination request contains information about the termination.","properties":{"noticeDate":{"description":"The effective notice date which serves as the starting point for calculating the contract endDate taking the notice period into account.","format":"date-time","type":"string"},"reason":{"description":"Reason for the Termination.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"type":"object"},"OutboxEntryResponse":{"description":"Outbox Entry","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","nullable":true,"type":"string"},"lastFailureMessage":{"description":"Last failure message","nullable":true,"type":"string"},"nextRetryAt":{"description":"The next retry timestamp","format":"date-time","nullable":true,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/JsonNode"}],"description":"The payload","nullable":true,"type":"object"},"status":{"description":"The status of the outbox entry.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"statusHistory":{"default":[],"description":"The status history.\nMust not be null.","items":{"$ref":"#/components/schemas/StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change.\nMust not be null.","format":"date-time","type":"string"},"tracingAttributes":{"additionalProperties":{"default":"{}","description":"Tracing attributes","type":"string"},"default":{},"description":"Tracing attributes.\nMust not be null.","type":"object"}},"required":["createdAt","failures","id","status","statusHistory","statusTimestamp","tracingAttributes"],"type":"object"},"PageInfo":{"description":"Meta data about the current page and query.","properties":{"number":{"description":"Page number of total pages available.","format":"int32","type":"integer"},"size":{"description":"Size of the page as specified by the query.","format":"int32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.","format":"int64","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.","format":"int32","type":"integer"}},"type":"object"},"PagedResponseAgreedDepositResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AgreedDepositResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseAttachmentDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AttachmentDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseBillableItemResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/BillableItemResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseBillingGroupDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/BillingGroupDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseBusinessSegmentDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/BusinessSegmentDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseContractLineItemResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/ContractLineItemResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseContractSlimDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"oneOf":[{"$ref":"#/components/schemas/ContractSlimDto"},{"$ref":"#/components/schemas/ContractDto"}]},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseCustomerConfigResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/CustomerConfigResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseMigrationPathResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/MigrationPathResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOptionAllowanceResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OptionAllowanceResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOptionDtoBase":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionDto"},{"$ref":"#/components/schemas/OneTimeOptionDto"},{"$ref":"#/components/schemas/QuantityOptionDto"},{"$ref":"#/components/schemas/RatedUsageOptionDto"},{"$ref":"#/components/schemas/RecurringOptionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionDto"},{"$ref":"#/components/schemas/UsageOptionDto"}]},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOrderAgreedDepositResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OrderAgreedDepositResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOrderDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OrderDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOrderLineItemResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OrderLineItemResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOutboxEntryResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponsePlanChangeResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PlanChangeResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponsePlanDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PlanDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponsePriceAdaptationResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationResponse"}]},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponsePriceAdaptationValueResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueResponse"}]},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseUsageDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/UsageDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PaymentInformationChargeUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/PaymentInformationUpdateRequest"},{"properties":{"customerPaymentAccountIdent":{"description":"The account token that can trigger the payment.","type":"string"}},"type":"object"}],"description":"Payment information update request for charge","type":"object"},"PaymentInformationCreationRequest":{"description":"A request to specify payment-related details.","properties":{"cardType":{"description":"The type of credit card you can choose. Only used, when paymentType is \"CREDITCARD\" or \"CREDIT_CARD\".","enum":["VISA","MASTERCARD","JCB","AMERICANEXPRESS","DINERSCLUB","OTHER","YANDEXBANKCARD","DISCOVERCARD","CARTE_BANCAIRE"],"type":"string"},"customerPaymentAccountIdent":{"description":"The account token that can trigger the payment.","type":"string"},"paymentControl":{"description":"Determines whether Nitrobox charges the customer","enum":["CHARGE","NOCHARGE"],"type":"string"},"paymentIdent":{"description":"The payment ident.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentProvider":{"description":"The provider that handle payment.","enum":["ADYEN","OPTILE","PAYPAL","CONTOWORKS","FIRSTDATATELECASH"],"type":"string"},"paymentReference":{"description":"The payment reference.","type":"string"},"paymentStatus":{"description":"The current payment status.","enum":["OPEN","CANCELLED","PARTIALPAID","REFUND","PAID"],"type":"string"},"paymentType":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.\n\n**NOTE:** This field also supports the legacy variants:","enum":["APPLE_PAY","CREDITCARD","PAYPAL","DIRECTDEBIT","WIRETRANSFER","ALIPAY","WECHAT","UNIONPAY","PURCHASEORDER","ACH","BANKTRANSFER","IDEAL","PAYU","KLARNA_INSTALLMENT","KLARNA_PAY_LATER","OTHER","ACCEL","AFFIRM","AFFIRM_QR","AFTERPAY","ALIPAY_PLUS","ALMA","AMAZONPAY","ANCV","ATOME","BALOTO","BANCONTACT","BILLIE","BIZUM","BLIK","BOLETOBANCARIO","CARNET","CARTES_BANCAIRES","CASH_APP_PAY","CLEARPAY","CREDIT_CARD","DANA","DIRECT_DEBIT","DOKU_VIRTUAL_ACCOUNTS","DRAGONPAY","DUITNOW","EPS","FISERV","FPX","GCASH","GIROCARD","GIROPAY","GIVEX","GOOGLEPAY","GOPAY","GRABPAY","INTERSOLVE","KAKAOPAY","KLARNA","KLARNA_PAY_NOW","MBWAY","MOBILE_PAY","MOMO","MULTIBANCO","NAVERPAY","OXXO","PAYBRIGHT","PAYME","PAYPAY","PAYPO","PAYTM","PAY_NOW","PIX","PROMPTPAY","PURCHASE_ORDER","RATEPAY","RIVERTY","SAMSUNG_PAY","SCALAPAY","SEPA","SOFORT","STORED_VALUE_SOLUTIONS","SWISH","TOUCH_N_GO","TWINT","UNION_PAY","VENMO","VIPPS","WIRE_TRANSFER","YANDEX","ZAVER","ZIP"],"example":"BANKTRANSFER","type":"string"}},"type":"object"},"PaymentInformationDto":{"description":"Information about the payment for this order. Please see Payment Information Model for more details.","properties":{"cardType":{"description":"The type of credit card you can choose.","enum":["VISA","MASTERCARD","JCB","AMERICANEXPRESS","DINERSCLUB","OTHER","YANDEXBANKCARD","DISCOVERCARD","CARTE_BANCAIRE"],"type":"string"},"customerPaymentAccountIdent":{"description":"The account token that can trigger the payment.","type":"string"},"paymentControl":{"description":"Determines whether Nitrobox charges the customer","enum":["CHARGE","NOCHARGE"],"type":"string"},"paymentIdent":{"description":"The payment ident.","type":"string"},"paymentProvider":{"description":"The provider that handle payment.","enum":["ADYEN","OPTILE","PAYPAL","CONTOWORKS","FIRSTDATATELECASH"],"type":"string"},"paymentReference":{"description":"The payment reference.","type":"string"},"paymentStatus":{"description":"The current payment status.","enum":["OPEN","CANCELLED","PARTIALPAID","REFUND","PAID"],"type":"string"},"paymentType":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.\n\n**NOTE:** This field also supports the legacy variants.","enum":["APPLE_PAY","CREDITCARD","PAYPAL","DIRECTDEBIT","WIRETRANSFER","ALIPAY","WECHAT","UNIONPAY","PURCHASEORDER","ACH","BANKTRANSFER","IDEAL","PAYU","KLARNA_INSTALLMENT","KLARNA_PAY_LATER","OTHER","ACCEL","AFFIRM","AFFIRM_QR","AFTERPAY","ALIPAY_PLUS","ALMA","AMAZONPAY","ANCV","ATOME","BALOTO","BANCONTACT","BILLIE","BIZUM","BLIK","BOLETOBANCARIO","CARNET","CARTES_BANCAIRES","CASH_APP_PAY","CLEARPAY","CREDIT_CARD","DANA","DIRECT_DEBIT","DOKU_VIRTUAL_ACCOUNTS","DRAGONPAY","DUITNOW","EPS","FISERV","FPX","GCASH","GIROCARD","GIROPAY","GIVEX","GOOGLEPAY","GOPAY","GRABPAY","INTERSOLVE","KAKAOPAY","KLARNA","KLARNA_PAY_NOW","MBWAY","MOBILE_PAY","MOMO","MULTIBANCO","NAVERPAY","OXXO","PAYBRIGHT","PAYME","PAYPAY","PAYPO","PAYTM","PAY_NOW","PIX","PROMPTPAY","PURCHASE_ORDER","RATEPAY","RIVERTY","SAMSUNG_PAY","SCALAPAY","SEPA","SOFORT","STORED_VALUE_SOLUTIONS","SWISH","TOUCH_N_GO","TWINT","UNION_PAY","VENMO","VIPPS","WIRE_TRANSFER","YANDEX","ZAVER","ZIP"],"example":"BANKTRANSFER","type":"string"}},"type":"object"},"PaymentInformationNoChargeUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/PaymentInformationUpdateRequest"},{"properties":{"paymentReference":{"description":"The payment reference.","type":"string"}},"type":"object"}],"description":"Payment information update request for no charge","type":"object"},"PaymentInformationUpdateRequest":{"description":"Payment information that will be used from the next billing onwards.","discriminator":{"mapping":{"CHARGE":"#/components/schemas/PaymentInformationChargeUpdateRequest","NOCHARGE":"#/components/schemas/PaymentInformationNoChargeUpdateRequest"},"propertyName":"paymentControl"},"properties":{"cardType":{"description":"The type of credit card you can choose. Only used, when paymentType is \"CREDITCARD\" or \"CREDIT_CARD\".\nMust be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","type":"string"},"paymentControl":{"description":"Determines whether Nitrobox charges the customer.\nMust be one of:\n|          |\n| -------- |\n| CHARGE   |\n| NOCHARGE |","type":"string"},"paymentType":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.\n\n**NOTE:** This field also supports the legacy variants.","example":"BANKTRANSFER","type":"string"}},"type":"object"},"PaymentTermDto":{"description":"Specifies a payment term.","properties":{"periodInDays":{"description":"Specifies the allowed period in days.","format":"int32","type":"integer"}},"required":["periodInDays"],"type":"object"},"PaymentTermRequest":{"description":"Specifies a payment term.","properties":{"periodInDays":{"description":"Specifies the allowed period in days.\nMust not be null.\nMust be greater than or equal to 0.\nMust be less than or equal to 366.","format":"int32","maximum":366,"minimum":0,"type":"integer"}},"required":["periodInDays"],"type":"object"},"PendingContractTermsRequest":{"description":"Configure terms that are applicable for the time between signing and the start of the contract.","properties":{"noticePeriod":{"$ref":"#/components/schemas/Duration"},"terminationEffect":{"description":"Defines which date the termination date of the contract will be after the notice period has been taken into account. Currently only supports months end.\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| END_OF_MONTH |","example":"END_OF_MONTH","type":"string"}},"required":["terminationEffect"],"type":"object"},"PendingContractTermsResponse":{"description":"Configure terms that are applicable for the time between signing and the start of the contract.","properties":{"noticePeriod":{"$ref":"#/components/schemas/Duration"},"terminationEffect":{"description":"Defines which date the termination date of the contract will be after the notice period has been taken into account. Currently only supports months end.\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| END_OF_MONTH |","example":"END_OF_MONTH","type":"string"}},"required":["terminationEffect"],"type":"object"},"PhaseConfigurationDto":{"description":"The phase configuration defines additional details for the transition.","properties":{"counter":{"description":"This Counter determines how many iterations a given phase will undergo before it goes to the next phase.Only applicable to the transition type 'NEXT_PHASE_AFTER_MULTIPLE_ITERATION'","format":"int64","type":"integer"},"toPhase":{"description":"The ident of the phase that will be the next phase.","type":"string"}},"type":"object"},"PhaseDto":{"description":"A plan has one or more phases. A phase contains one or more options. Phases are intended for plans that have changes in price, billing interval or included products/services at a predefined point in time.","properties":{"autoRenewal":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Phase transition should be used instead. When set to true, contracts are automatically renewed, when a term has passed","type":"boolean"},"billingConfig":{"$ref":"#/components/schemas/billingConfig"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"ident":{"description":"Unique external reference.","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the phase.","type":"string"},"noticePeriod":{"$ref":"#/components/schemas/Duration"},"options":{"deprecated":true,"description":"DEPRECATED.\ndeprecated. A list of options.","items":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionDto"},{"$ref":"#/components/schemas/OneTimeOptionDto"},{"$ref":"#/components/schemas/QuantityOptionDto"},{"$ref":"#/components/schemas/RatedUsageOptionDto"},{"$ref":"#/components/schemas/RecurringOptionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionDto"},{"$ref":"#/components/schemas/UsageOptionDto"}]},"type":"array"},"phaseId":{"description":"Unique ID of the plan phase.","format":"int64","type":"integer"},"phaseOptions":{"description":"A list of phase assigned options.","items":{"$ref":"#/components/schemas/PhaseOptionResponse"},"type":"array"},"termDuration":{"$ref":"#/components/schemas/Duration"},"termSync":{"default":true,"description":"When set to true, the contract term is synchronized with the end of the term duration unit, independent from when the contract started","example":true,"type":"boolean"},"transitions":{"description":"A list of transitions.","items":{"$ref":"#/components/schemas/PhaseTransitionDto"},"type":"array"}},"type":"object"},"PhaseLinkedOptionCreationRequest":{"description":"A list of linked options","properties":{"minimum":{"default":1,"description":"Describes the minimum count on how many times this option will be applied. Zero makes this option optional.\nMust be greater than or equal to 0.","format":"int32","minimum":0,"type":"integer"},"optionIdent":{"description":"The existing option that should be linked to the Phase.\nMust not be blank.","minLength":1,"type":"string"}},"required":["optionIdent"],"type":"object"},"PhaseOptionCreationRequest":{"description":"Add an option to a phase of a plan.","properties":{"enableForAllContracts":{"description":"For usage options and rated usage options can be used to enable them for all contracts. Default: false.","type":"boolean"},"optionIdent":{"description":"The existing option that should be linked to the phase.\nMust not be blank.","minLength":1,"type":"string"}},"required":["optionIdent"],"type":"object"},"PhaseOptionQuantityRequest":{"description":"Metadata for phases","properties":{"optionQuantity":{"description":"Quantity of options that should be applied.\nMust not be empty.","items":{"$ref":"#/components/schemas/OptionQuantityRequest"},"minItems":1,"type":"array"},"phaseIdent":{"description":"The identifier of the phase.\nMust not be blank.","minLength":1,"type":"string"}},"required":["optionQuantity","phaseIdent"],"type":"object"},"PhaseOptionQuantityResponse":{"properties":{"optionQuantity":{"description":"Quantity of options that should be applied","items":{"$ref":"#/components/schemas/OptionQuantityResponse"},"type":"array"},"phaseIdent":{"description":"The identifier of the phase","type":"string"}},"type":"object"},"PhaseOptionResponse":{"description":"A list of phase assigned options.","properties":{"minimum":{"description":"The minimum of times the option will be applied.","format":"int32","type":"integer"},"option":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionDto"},{"$ref":"#/components/schemas/OneTimeOptionDto"},{"$ref":"#/components/schemas/QuantityOptionDto"},{"$ref":"#/components/schemas/RatedUsageOptionDto"},{"$ref":"#/components/schemas/RecurringOptionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionDto"},{"$ref":"#/components/schemas/UsageOptionDto"}]}},"type":"object"},"PhaseTransitionDto":{"description":"A transition describes what should happen at the end of a phase.","properties":{"config":{"$ref":"#/components/schemas/PhaseConfigurationDto"},"type":{"description":"Type describes the transition type of a phase, which will be executed.\nMust be one of:\n|                                     |                                                                                                                        |\n| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |\n| NONE                                | contract will end according to the contract terms                                                                      |\n| AUTO_RENEWAL                        | contract will automatically enter the same phase again                                                                 |\n| NEXT_PHASE                          | after the contract term is over the contract will enter the next phase as specified in the configuration               |\n| NEXT_PHASE_AFTER_MULTIPLE_ITERATION | contract will autorenewal X times within the phase and then switch to the next phase as specified in the configuration |","type":"string"}},"type":"object"},"PhaseTransitionUpdateRequest":{"description":"A transition describes what should happen at the end of a phase.","properties":{"config":{"$ref":"#/components/schemas/PhaseConfigurationDto"},"type":{"description":"Type describes the transition type of a phase, which will be executed.\nMust be one of:\n|                                     |                                                                                                                        |\n| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |\n| NONE                                | contract will end according to the contract terms                                                                      |\n| AUTO_RENEWAL                        | contract will automatically enter the same phase again                                                                 |\n| NEXT_PHASE                          | after the contract term is over the contract will enter the next phase as specified in the configuration               |\n| NEXT_PHASE_AFTER_MULTIPLE_ITERATION | contract will autorenewal X times within the phase and then switch to the next phase as specified in the configuration |","type":"string"}},"type":"object"},"PhaseUpdateRequest":{"description":"A plan has one or more phases. A phase contains one or more options. Phases are intended for plans that have changes in price,\nbilling interval or included products/services at a predefined point in time.\nCreating options while creating a plan is deprecated: Use the Option API instead to manage Options and reference them when\ncreating a plan.\n","properties":{"autoRenewal":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Phase transition should be used instead. When set to true, contracts are automatically renewed, when a term has passed","type":"boolean"},"billingConfig":{"$ref":"#/components/schemas/billingConfig"},"ident":{"description":"Must be a unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_phaseIdent_12345","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"linkedOptions":{"description":"A list of linked options","items":{"$ref":"#/components/schemas/PhaseLinkedOptionCreationRequest"},"type":"array"},"name":{"description":"Name of the phase.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"noticePeriod":{"$ref":"#/components/schemas/Duration"},"options":{"deprecated":true,"description":"DEPRECATED","items":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionCreationRequest"},{"$ref":"#/components/schemas/OneTimeOptionCreationRequest"},{"$ref":"#/components/schemas/QuantityOptionCreationRequest"},{"$ref":"#/components/schemas/RatedUsageOptionCreationRequest"},{"$ref":"#/components/schemas/RecurringOptionCreationRequest"},{"$ref":"#/components/schemas/TimeBasedUsageOptionCreationRequest"},{"$ref":"#/components/schemas/UsageOptionCreationRequest"}]},"type":"array"},"termDuration":{"$ref":"#/components/schemas/Duration"},"termSync":{"default":true,"description":"When set to true, contracts end at the end of the interval at the end of the month, independent from when the contract started","example":true,"type":"boolean"},"transitions":{"description":"A list of transitions.","items":{"$ref":"#/components/schemas/PhaseTransitionUpdateRequest"},"type":"array"}},"type":"object"},"PlanChangeConfigurationResponse":{"description":"A plan change configuration holds information about customizable details of the migration path, e.g. option quantities set on scheduling of the plan change.","properties":{"optionQuantities":{"description":"A list of options and the quantity to use per plan phase.","items":{"$ref":"#/components/schemas/PlanChangeOptionQuantityResponse"},"title":"Option Quantities","type":"array"}},"title":"Plan Change Configuration","type":"object"},"PlanChangeCreationRequest":{"description":"A request to create a scheduled plan change based on a migration path.","properties":{"configuration":{"$ref":"#/components/schemas/PlanChangeCreationRequestConfiguration"},"migrationPathIdent":{"description":"The unique identifier for the migration path to be used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["migrationPathIdent"],"title":"Plan Change Creation Request","type":"object"},"PlanChangeCreationRequestConfiguration":{"description":"A plan change configuration holds information about how to customizable the new plan based on the migration path, e.g. option quantities.","properties":{"optionQuantities":{"description":"A list of options and the quantity to use per plan phase. Leave empty for plan defaults.","items":{"$ref":"#/components/schemas/PlanChangeCreationRequestOptionQuantity"},"title":"Option Quantities","type":"array"}},"title":"Plan Change Creation Request Configuration","type":"object"},"PlanChangeCreationRequestOptionAmount":{"description":"Definition of the option quantity used per phase","properties":{"optionIdent":{"description":"option identifier.\nMust not be blank.","minLength":1,"type":"string"},"quantity":{"description":"the amount of times the option should be applied.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","type":"integer"}},"required":["optionIdent","quantity"],"title":"Plan Change Creation Request Option Quantity","type":"object"},"PlanChangeCreationRequestOptionQuantity":{"description":"Definition of the option quantity used per phase","properties":{"optionQuantity":{"description":"Quantity of options that should be applied.\nMust not be empty.","items":{"$ref":"#/components/schemas/PlanChangeCreationRequestOptionAmount"},"minItems":1,"type":"array"},"phaseIdent":{"description":"phase identifier.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["optionQuantity","phaseIdent"],"title":"Plan Change Creation Request Option Quantity","type":"object"},"PlanChangeOptionQuantityResponse":{"description":"Definition of the option quantity used per phase","properties":{"optionQuantity":{"description":"Quantity of options that should be applied.\nMust not be empty.","items":{"$ref":"#/components/schemas/OptionQuantityResponse"},"minItems":1,"type":"array"},"phaseIdent":{"description":"The identifier of the phase.\nMust not be blank.","minLength":1,"type":"string"}},"required":["optionQuantity","phaseIdent"],"title":"Plan Change Option Quantity","type":"object"},"PlanChangeResponse":{"description":"A plan change defines when a migration from one plan to another should occur, plus additional configuration about that change.","properties":{"ident":{"description":"The unique identifier for this plan change.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"migrationPathIdent":{"description":"The unique identifier for the migration path to be used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"startDate":{"description":"The date when the plan change will become active.\nMust not be null.","format":"date","type":"string"}},"required":["ident","migrationPathIdent","startDate"],"title":"Plan Change","type":"object"},"PlanCreationRequest":{"description":"Please see request body description for more information.","properties":{"businessSegmentId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use business segment ident instead. The Id of the business segment for the Plan. The default segment will be used if not set.","format":"int64","type":"integer"},"businessSegmentIdent":{"description":"Determines to which business segment this plan belongs. Should be set, if not set the deprecated \"businessSegmentId\" needs to be set instead. ","type":"string"},"individualPlan":{"description":"If the plan is individual, it can be only assigned to one contract.","type":"boolean"},"initialPhase":{"description":"The ident of the phase that will be started at first.","type":"string"},"name":{"description":"Name of the plan.\nMust not be blank.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":"string"},"pendingContractTerms":{"$ref":"#/components/schemas/PendingContractTermsRequest"},"phases":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/PhaseUpdateRequest"},"minItems":1,"type":"array"},"planIdent":{"default":"4564-45654-2154-2324","description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"type":{"description":"The type of plan. Must be one of:.\nMust be one of:\n|          |                                                                                                |\n| -------- | ---------------------------------------------------------------------------------------------- |\n| CUSTOMER | Plans with the main goal of invoicing customers. Can't contain COMMISSION options.             |\n| PARTNER  | Plans with the main goal of crediting partners. Has to contain at least one COMMISSION option. |","type":"string"}},"required":["name","phases","planIdent"],"type":"object"},"PlanDto":{"properties":{"businessSegmentId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use business segment ident instead. The Id of the business segment for the Plan. The default segment will be used if not set.","format":"int64","type":"integer"},"businessSegmentIdent":{"description":"The Ident of the business segment for the Plan. The default segment will be used if not set.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"individualPlan":{"description":"If the plan is individual, it can be only assigned to one contract.","type":"boolean"},"initialPhase":{"description":"The ident of the phase that will be started at first.","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"lifecycleStatus":{"description":"The lifecycle status of the plan.\nMust be one of:\n|         |\n| ------- |\n| ACTIVE  |\n| RETIRED |","example":"ACTIVE","type":"string"},"modifiedPlan":{"description":"If the plan was modified, it can be only assigned to one contract and can only be changed by changing the plan modifiers of the contract.","type":"boolean"},"name":{"description":"Name of the plan.\nMust not be blank.","minLength":1,"type":"string"},"pendingContractTerms":{"$ref":"#/components/schemas/PendingContractTermsResponse"},"phases":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/PhaseDto"},"minItems":1,"type":"array"},"planId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use plan ident instead. Unique ID of the plan.","format":"int64","type":"integer"},"planIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust not be blank.","minLength":1,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"type":{"description":"The type of plan.\nMust be one of:\n|          |\n| -------- |\n| CUSTOMER |\n| PARTNER  |","example":"CUSTOMER","type":"string"}},"required":["name","phases","planIdent"],"type":"object"},"PlanModifierDto":{"description":"Modifiers to apply to a plan and its options to change i.e. the price. Are applied only to this contract.","discriminator":{"mapping":{"OPTION_PRICE_LIST":"#/components/schemas/OptionPriceListModifierDto"},"propertyName":"type"},"properties":{"type":{"description":"Type of Plan Modifier. Currently only OPTION_PRICE_LIST supported.\nMust not be null.\nMust be one of:\n|                   |\n| ----------------- |\n| OPTION_PRICE_LIST |","example":"OPTION_PRICE_LIST","type":"string"}},"required":["type"],"type":"object"},"PlanModifierListEffectivityResponse":{"description":"History of plan modifiers, including future ones.","properties":{"effectiveFrom":{"description":"Plan modifiers were created at this time.","format":"date-time","type":"string"},"planModifiers":{"description":"Plan modifiers for modification of the original plan, to customize certain plan related values e.g. option price.","items":{"oneOf":[{"$ref":"#/components/schemas/OptionPriceListModifierDto"}]},"type":"array"}},"type":"object"},"PlanUpdateRequest":{"description":"The updated plan","properties":{"businessSegmentId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use business segment ident instead. The Id of the business segment for the Plan. The default segment will be used if not set.","format":"int64","type":"integer"},"businessSegmentIdent":{"description":"Determines to which business segment this plan belongs. Should be set, if not set the deprecated \"businessSegmentId\" needs to be set instead. ","type":"string"},"individualPlan":{"description":"If the plan is individual, it can be only assigned to one contract.","type":"boolean"},"initialPhase":{"description":"The ident of the phase that will be started at first.","type":"string"},"name":{"description":"Name of the plan.\nMust not be blank.\nSize must be between 1 and 255.","maxLength":255,"minLength":1,"type":"string"},"pendingContractTerms":{"$ref":"#/components/schemas/PendingContractTermsRequest"},"phases":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/PhaseUpdateRequest"},"minItems":1,"type":"array"},"properties":{"description":"Additional plan properties.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"type":{"description":"The type of plan. Must be one of:.\nMust be one of:\n|          |                                                                                                |\n| -------- | ---------------------------------------------------------------------------------------------- |\n| CUSTOMER | Plans with the main goal of invoicing customers. Can't contain COMMISSION options.             |\n| PARTNER  | Plans with the main goal of crediting partners. Has to contain at least one COMMISSION option. |","type":"string"}},"required":["name","phases"],"type":"object"},"PostTaxItemCreationRequest":{"description":"A request to create a post tax item extra which is a representation of a multi purpose voucher. Those itemExtras don't reduce the taxAmount that has to be paid for this item.","properties":{"description":{"description":"Description of the extraItem.","type":"string"},"externalReference":{"description":"Additional reference for third party system, like voucher management system.","type":"string"},"ident":{"description":"The unique identifier of a post tax item.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"leftoverAmountGross":{"$ref":"#/components/schemas/MonetaryValue_14"},"name":{"description":"Name of the extraItem.","type":"string"},"refundabilityType":{"description":"Describes whether the voucher is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"type":{"description":"Type of the extraItem. Will be one of:.\nMust not be null.","enum":["MULTI_PURPOSE_VOUCHER"],"example":"MULTI_PURPOSE_VOUCHER","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue_13"}},"required":["type","value"],"type":"object"},"PostTaxLineItemExtraDto":{"description":"A purchase post tax item extra is a representation of a multi purpose voucher. Those itemExtras don't reduce the taxAmount that has to be paid for this item.","properties":{"description":{"description":"Description of the extraItem.","type":"string"},"externalReference":{"description":"Additional reference for third party system, like voucher management system.","type":"string"},"ident":{"description":"The unique identifier of a PurchaseItemExtra.","type":"string"},"leftoverAmountGross":{"$ref":"#/components/schemas/MonetaryValue_32"},"name":{"description":"Name of the extraItem.","type":"string"},"refundabilityType":{"description":"Describes whether the voucher is refundable.","enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"type":{"description":"Type of the extraItem. Will be one of:","enum":["MULTI_PURPOSE_VOUCHER"],"example":"MULTI_PURPOSE_VOUCHER","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue_31"}},"required":["value"],"type":"object"},"PriceAdaptationCreationRequest":{"discriminator":{"mapping":{"INDEX":"#/components/schemas/IndexPriceAdaptationCreationRequest"},"propertyName":"type"},"properties":{"description":{"description":"The price adaptation description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"ident":{"description":"The price adaptation ident. Must be unique.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"The price adaptation name.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"type":{"description":"The price adaptation type.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| INDEX |","example":"INDEX","type":"string"}},"required":["ident","name","type"],"type":"object"},"PriceAdaptationResponse":{"discriminator":{"mapping":{"INDEX":"#/components/schemas/IndexPriceAdaptationResponse"},"propertyName":"type"},"properties":{"description":{"description":"The price adaptation description.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"ident":{"description":"The price adaptation ident. Must be unique.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"The price adaptation name.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"type":{"description":"The price adaptation type.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| INDEX |","example":"INDEX","type":"string"},"values":{"description":"The price adaptation values","items":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueResponse"}]},"type":"array"}},"required":["ident","name","type"],"type":"object"},"PriceAdaptationValueCreationRequest":{"discriminator":{"mapping":{"INDEX":"#/components/schemas/IndexPriceAdaptationValueCreationRequest"},"propertyName":"type"},"properties":{"type":{"description":"Type of Price Adaptations. Currently only: INDEX.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| INDEX |","example":"INDEX","type":"string"}},"required":["type"],"type":"object"},"PriceAdaptationValueResponse":{"discriminator":{"mapping":{"INDEX":"#/components/schemas/IndexPriceAdaptationValueResponse"},"propertyName":"type"},"properties":{"type":{"description":"Type of Price Adaptations. Currently only: INDEX.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| INDEX |","example":"INDEX","type":"string"}},"required":["type"],"type":"object"},"PriceAdaptationValueUpdateRequest":{"discriminator":{"mapping":{"INDEX":"#/components/schemas/IndexPriceAdaptationValueUpdateRequest"},"propertyName":"type"},"properties":{"type":{"description":"Type of Price Adaptations. Currently only: INDEX.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| INDEX |","example":"INDEX","type":"string"}},"required":["type"],"type":"object"},"PriceCalculationBasisResponse":{"description":"Provides additional context on how the values of this billable item were calculated.","discriminator":{"mapping":{"BLOCK":"#/components/schemas/BlockPriceCalculationBasisResponse","RECURRING":"#/components/schemas/RecurringPriceCalculationBasisResponse","TIER_PROGRESSIVE":"#/components/schemas/TierProgressivePriceCalculationBasisResponse","TIER_SINGLE":"#/components/schemas/TierSinglePriceCalculationBasisResponse","TIME_BASED_USAGE":"#/components/schemas/TimeBasedUsagePriceCalculationBasisResponse"},"propertyName":"type"},"properties":{"type":{"description":"Shows what kind of calculation was performed.\nMust not be null.\nMust be one of:\n|                  |                                                                                                                                                                                      |\n| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| RECURRING        | This billable item has a temporal component which might lead it to be pro rata calculated.                                                                                           |\n| TIER_SINGLE      | Pricing is calculated based on defined usage tiers, applying a single-tier unit rate. Maps to Usage Options of type volume.                                                          |\n| TIER_PROGRESSIVE | Pricing is calculated based on defined usage tiers, applying progressive unit rates. Maps to Usage Options of type tiered.                                                           |\n| BLOCK            | Pricing is calculated based on predefined fixed-quantity blocks, each with its own total price, regardless of individual unit consumption. Maps to Usage Options of type contingent. |\n| TIME_BASED_USAGE | Pricing is calculated based on usage time, with different rates applicable for different time periods.                                                                               |","example":"RECURRING","type":"string"}},"required":["type"],"type":"object"},"PriceDto":{"description":"A price with tax details for a specific country","properties":{"criteria":{"$ref":"#/components/schemas/CriteriaDto"},"netGrossIndicator":{"description":"Indicator to define type of price.","enum":["NET","GROSS"],"example":"100","type":"string"},"price":{"$ref":"#/components/schemas/MonetaryValue"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED: use criteria instead. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"description":"It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"required":["price"],"type":"object"},"PriceTier":{"description":"A price tier ","properties":{"price":{"description":"The price that is used when this tier is calculated, either per unit or flat depending on the type provided","type":"number"},"quantity":{"description":"The quantity determines, for which range of units this price tier is used for calculating a price. How this is interpreted and how the price is calculated also depends on the pricing model used","type":"number"},"type":{"description":"The type of the price. FLAT is a fixed amount that is used as is. When PER_UNIT is used, the price is determined by multiplying the price with the unit","enum":["FLAT","PER_UNIT"],"example":"FLAT","type":"string"}},"type":"object"},"PricingGroupCriteriaRequest":{"description":"Criteria for a pricing group.","nullable":true,"properties":{"location":{"$ref":"#/components/schemas/LocationRequest"},"operatingSiteIdent":{"description":"Operating site of the option. Only predefined operating site identifiers are allowed.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"type":"object"},"PricingGroupCriteriaResponse":{"description":"Criteria for a pricing group.","nullable":true,"properties":{"location":{"$ref":"#/components/schemas/LocationRequest"},"operatingSiteIdent":{"description":"Operating site of the option. Only predefined operating site identifiers are allowed.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"type":"object"},"PricingGroupFreeQuotaRequest":{"description":"Free quota for a pricing group. If no free quota is provided, the system automatically initializes it with a default value of 0.","nullable":true,"properties":{"amount":{"default":0,"description":"Amount of free quota (in minutes).\nMust not be null.\nMust be greater than or equal to 0.","format":"int64","type":"integer"}},"required":["amount"],"type":"object"},"PricingGroupFreeQuotaResponse":{"description":"Free quota for a pricing group","properties":{"amount":{"description":"Amount of free quota (in minutes).\nMust not be null.\nMust be greater than or equal to 0.","format":"int64","type":"integer"}},"required":["amount"],"type":"object"},"PricingGroupPricingRuleRequest":{"description":"A pricing rule for a pricing group.","properties":{"criteria":{"$ref":"#/components/schemas/PricingRuleCriteriaRequest"},"freeOfCharge":{"description":"Indicates whether this pricing rule is free of charge.","type":"boolean"},"freeQuotaApplicable":{"description":"Indicates whether this pricing rule applies the free quota defined in the pricing group.\nWhen true, the free quota amount is deducted before applying this rule's pricing.\n","type":"boolean"},"price":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["criteria","price"],"type":"object"},"PricingGroupRequest":{"description":"A pricing group.","properties":{"criteria":{"$ref":"#/components/schemas/PricingGroupCriteriaRequest"},"freeOfChargeRulesExcludedFromUnitQuantity":{"description":"Indicates whether pricing rules marked as free of charge are excluded from unit quantity calculation.\n","type":"boolean"},"freeQuota":{"$ref":"#/components/schemas/PricingGroupFreeQuotaRequest"},"netGrossIndicator":{"description":"Indicates whether prices in this pricing group are net (excluding taxes) or gross (including taxes) values.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"pricingRules":{"description":"A pricing rule for a pricing group.\nMust not be empty.","items":{"$ref":"#/components/schemas/PricingGroupPricingRuleRequest"},"minItems":1,"type":"array"},"usageCap":{"$ref":"#/components/schemas/UsageCapRequest"}},"required":["netGrossIndicator","pricingRules"],"type":"object"},"PricingGroupResponse":{"description":"A pricing group.","properties":{"criteria":{"$ref":"#/components/schemas/PricingGroupCriteriaResponse"},"freeOfChargeRulesExcludedFromUnitQuantity":{"description":"Indicates whether pricing rules marked as free of charge are excluded from unit quantity calculation.\n","type":"boolean"},"freeQuota":{"$ref":"#/components/schemas/PricingGroupFreeQuotaResponse"},"netGrossIndicator":{"description":"Indicates whether prices in this pricing group are net (excluding taxes) or gross (including taxes) values.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"pricingRules":{"description":"A pricing rule for a pricing group.\nMust not be empty.","items":{"$ref":"#/components/schemas/PricingRuleResponse"},"minItems":1,"type":"array"},"usageCap":{"$ref":"#/components/schemas/UsageCapResponse"}},"required":["netGrossIndicator","pricingRules"],"type":"object"},"PricingRuleCriteria":{"description":"Criteria for a pricing rule. All time periods together have to cover the entire day.","properties":{"timePeriod":{"$ref":"#/components/schemas/PricingRuleTimePeriodResponse"}},"required":["timePeriod"],"type":"object"},"PricingRuleCriteriaRequest":{"description":"Criteria for a pricing rule. All time periods together have to cover the entire day.","properties":{"timePeriod":{"$ref":"#/components/schemas/PricingRuleTimePeriodRequest"}},"required":["timePeriod"],"type":"object"},"PricingRuleResponse":{"description":"A pricing rule for a pricing group.","properties":{"criteria":{"$ref":"#/components/schemas/PricingRuleCriteria"},"freeOfCharge":{"description":"Indicates whether this pricing rule is free of charge.","type":"boolean"},"freeQuotaApplicable":{"description":"Indicates whether this pricing rule applies the free quota defined in the pricing group.\nWhen true, the free quota amount is deducted before applying this rule's pricing.\n","type":"boolean"},"price":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["criteria","price"],"type":"object"},"PricingRuleTimePeriodRequest":{"description":"Represents a time period with start and end times for pricing rule configurations. Overlapping time periods are not allowed within the same pricing group.","properties":{"end":{"description":"End of the time period in HH:mm or HH:mm:ss format (24-hour format).\nMust not be null.","format":"time","pattern":"^([0-1]?[0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$","type":"string"},"start":{"description":"Start of the time period in HH:mm or HH:mm:ss format (24-hour format).\nMust not be null.","format":"time","pattern":"^([0-1]?[0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$","type":"string"}},"required":["end","start"],"type":"object"},"PricingRuleTimePeriodResponse":{"description":"Represents a time period with start and end times for pricing rule configurations. Overlapping time periods are not allowed within the same pricing group.","properties":{"end":{"description":"End of the time period in HH:mm or HH:mm:ss format (24-hour format).\nMust not be null.","format":"time","pattern":"^([0-1]?[0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$","type":"string"},"start":{"description":"Start of the time period in HH:mm or HH:mm:ss format (24-hour format).\nMust not be null.","format":"time","pattern":"^([0-1]?[0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$","type":"string"}},"required":["end","start"],"type":"object"},"PropertyCreationRequest":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"key":{"description":"Key of the property.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["key","value"],"type":"object"},"PropertyDto":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"propertyIdent":{"description":"Key of the property.\nMust not be blank.","minLength":1,"type":"string"},"propertyValue":{"description":"Value of the property.\nMust not be null.","type":"string"}},"required":["propertyIdent","propertyValue"],"type":"object"},"PropertyRequest":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"key":{"description":"Key of the property.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["key","value"],"type":"object"},"PropertyResponse":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"key":{"description":"Key of the property.\nMust not be blank.","minLength":1,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.","type":"string"}},"required":["key","value"],"type":"object"},"QuantityOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","deprecated":true,"description":"DEPRECATED.\nDeprecated: The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"deprecated":true,"description":"Deprecated: An option for multiple purchases or volume measures. Instead of a quantity option create a usage option with the pricing model VOLUME_PRICE andcreate one tier for this option and set the quantity to null and the price for the value that you would use for the item price net.","required":["name","type"],"type":"object"},"QuantityOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","deprecated":true,"description":"DEPRECATED.\nDeprecated: The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"deprecated":true,"description":"Deprecated: An option for multiple purchases or volume measures. Instead of a quantity option create a usage option with the pricing model VOLUME_PRICE andcreate one tier for this option and set the quantity to null and the price for the value that you would use for the item price net.","required":["name","type"],"type":"object"},"QuantityOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","deprecated":true,"description":"DEPRECATED.\nDeprecated: The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"type":"object"}],"deprecated":true,"description":"Deprecated: An option for multiple purchases or volume measures. Instead of a quantity option create a usage option with the pricing model VOLUME_PRICE andcreate one tier for this option and set the quantity to null and the price for the value that you would use for the item price net.","required":["name","type"],"type":"object"},"QuantityOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","deprecated":true,"description":"DEPRECATED.\nDeprecated: The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"}},"type":"object"}],"deprecated":true,"description":"Deprecated: An option for multiple purchases or volume measures. Instead of a quantity option create a usage option with the pricing model VOLUME_PRICE andcreate one tier for this option and set the quantity to null and the price for the value that you would use for the item price net.","required":["name"],"type":"object"},"RatedUsageOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"closeAggregationDelay":{"default":0,"description":"Delay in seconds that is added to the billing period before closing and transferring the aggregation of usages as a line item.\nCan be used for accepting delayed delivery of usages.\nPlease note: This setting delays the automatic creation or updating of the associated line items.\nThis delay may also need to be taken into account in the billing run, as otherwise billing will not take place until the following period.\nMust be greater than or equal to 0.\nMust be less than or equal to 2700000.","format":"int32","maximum":2700000,"type":"integer"}},"type":"object"}],"description":"An option containing metadata for processing aggregations of rated usages","required":["name","type"],"type":"object"},"RatedUsageOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"closeAggregationDelay":{"description":"Delay in seconds that is added to the billing period before closing and transferring the aggregation of usages as a line item.\nCan be used for accepting delayed delivery of usages.\nPlease note: This setting delays the automatic creation or updating of the associated line items.\nThis delay may also need to be taken into account in the billing run, as otherwise billing will not take place until the following period.\nMust be greater than or equal to 0.\nMust be less than or equal to 2700000.","format":"int32","maximum":2700000,"type":"integer"}},"type":"object"}],"description":"An option containing metadata for processing aggregations of rated usages","required":["name","type"],"type":"object"},"RatedUsageOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"closeAggregationDelay":{"default":0,"description":"Delay in seconds that is added to the billing period before closing and transferring the aggregation of usages as a line item.\nCan be used for accepting delayed delivery of usages.\nPlease note: This setting delays the automatic creation or updating of the associated line items.\nThis delay may also need to be taken into account in the billing run, as otherwise billing will not take place until the following period.\nMust be greater than or equal to 0.\nMust be less than or equal to 2700000.","format":"int32","maximum":2700000,"type":"integer"}},"type":"object"}],"description":"An option containing metadata for processing aggregations of rated usages","required":["name","type"],"type":"object"},"RatedUsageOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"closeAggregationDelay":{"description":"Delay in seconds that is added to the billing period before closing and transferring the aggregation of usages as a line item.\nCan be used for accepting delayed delivery of usages.\nPlease note: This setting delays the automatic creation or updating of the associated line items.\nThis delay may also need to be taken into account in the billing run, as otherwise billing will not take place until the following period.\nMust be greater than or equal to 0.\nMust be less than or equal to 2700000.","format":"int32","maximum":2700000,"type":"integer"}},"type":"object"}],"description":"An option containing metadata for processing aggregations of rated usages","required":["name"],"type":"object"},"RecurringOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"An option for purchases that are made on a recurring, regular basis.","required":["name","prices","type"],"type":"object"},"RecurringOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"An option for purchases that are made on a recurring, regular basis.","required":["name","prices","type"],"type":"object"},"RecurringOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"type":"object"}],"description":"An option for purchases that are made on a recurring, regular basis.","required":["name","prices","type"],"type":"object"},"RecurringOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"prices":{"description":"Defining the price per country.","items":{"$ref":"#/components/schemas/PriceDto"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"}},"type":"object"}],"description":"An option for purchases that are made on a recurring, regular basis.","required":["name","prices"],"type":"object"},"RecurringPriceCalculationBasisResponse":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasisResponse"},{"properties":{"price":{"$ref":"#/components/schemas/RecurringPriceResponse"},"serviceDaysInPeriod":{"description":"Indicates the actual number of days considered with this item - either days where service was provided or days that were credited.","format":"int64","type":"integer"},"totalDaysInPeriod":{"description":"Indicates the total number of days the service could have been provided within the billing period.","format":"int64","type":"integer"}},"type":"object"}],"required":["price","type"],"type":"object"},"RecurringPriceResponse":{"description":"The option base price information used for this billable item.","properties":{"cumulativeTax":{"$ref":"#/components/schemas/MonetaryValue_84"},"gross":{"$ref":"#/components/schemas/MonetaryValue_83"},"net":{"$ref":"#/components/schemas/MonetaryValue_82"},"taxInformation":{"items":{"$ref":"#/components/schemas/RecurringPriceTaxInformationResponse"},"type":"array"}},"type":"object"},"RecurringPriceTaxInformationResponse":{"properties":{"tax":{"$ref":"#/components/schemas/MonetaryValue_85"},"taxCode":{"type":"string"},"taxName":{"type":"string"},"taxRate":{"type":"number"}},"type":"object"},"RegionCreationRequest":{"description":"A request to create a region with its language settings.","properties":{"defaultLanguage":{"description":"Default language is chosen when the language sent in contract is not valid for invoice service country. One of valid languages codes in ISO 639-1 to be used as a default language.\nMust not be null.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"example":"de","type":"string"},"fallbackLanguage":{"description":"Fallback language is chosen when language sent in contract is missing. One of valid languages codes in ISO 639-1 to be used as a fallback language.\nMust not be null.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"example":"de","type":"string"},"name":{"description":"Name of the region.","example":"Germany","type":"string"},"validLanguages":{"description":"List of valid language codes in ISO 639-1 standard, appropriate for given country.\nMust not be empty.","example":"de","items":{"description":"List of valid language codes in ISO 639-1 standard, appropriate for given country.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"example":"de","type":"string"},"minItems":1,"type":"array"}},"required":["defaultLanguage","fallbackLanguage","validLanguages"],"type":"object"},"ReissueAddressUpdateRequest":{"description":"Will update the actively used shipping address for the corrected document.","properties":{"academicTitle":{"description":"Size must be between 0 and 255.","example":"Dr.","maxLength":255,"type":"string"},"addressAddition":{"description":"Optional additional address information.\nSize must be between 0 and 255.","example":"3. OG","maxLength":255,"type":"string"},"agencyProfessionTitle":{"description":"Agency Profession Title.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"city":{"description":"City.\nSize must be between 0 and 255.","example":"Hamburg","maxLength":255,"type":"string"},"company":{"description":"Company name.\nSize must be between 0 and 255.","example":"Nitrobox","maxLength":255,"type":"string"},"country":{"description":"Country code. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"department":{"description":"Department within a company.\nSize must be between 0 and 255.","example":"Finance","maxLength":255,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParameters"},"email":{"description":"Recipient's email.\nSize must be between 0 and 255.","example":"info@customercompany.com","maxLength":255,"type":"string"},"firstname":{"description":"First name of recipient.\nSize must be between 0 and 255.","example":"Max","maxLength":255,"type":"string"},"gender":{"description":"Recipient's gender. Must be one of:","enum":["MALE","FEMALE","OTHER","NOTSET"],"example":"FEMALE","type":"string"},"lastname":{"description":"Last name of recipient.\nSize must be between 0 and 255.","example":"Mustermann","maxLength":255,"type":"string"},"postOfficeBox":{"description":"Number of post office box.\nSize must be between 0 and 255.","example":"42000, böx123","maxLength":255,"type":"string"},"state":{"description":"State.\nSize must be between 0 and 255.","example":"Brandenburg","maxLength":255,"type":"string"},"stateCode":{"description":"State code. ISO 3166-2 subdivision code.\nSize must be between 0 and 255.","example":"DE-BB","maxLength":255,"type":"string"},"street":{"description":"Name of street.\nSize must be between 0 and 255.","example":"Hofweg","maxLength":255,"type":"string"},"streetNo":{"description":"Street Number.\nSize must be between 0 and 255.","example":"6","maxLength":255,"type":"string"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.\nSize must be between 0 and 32.","example":"3012034567890","maxLength":32,"type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN). An identifier used by name countries for Value Added Tax purposes to identify legal entities, especially in the EU.\nSize must be between 0 and 20.","example":"DE123456789","maxLength":20,"type":"string"},"zip":{"description":"Postcode.\nSize must be between 0 and 255.","example":"22085","maxLength":255,"type":"string"}},"type":"object"},"RelatedContractRequest":{"description":"Related contract of this contract","properties":{"contractIdent":{"description":"The ident of a contract related with this one.\nMust not be blank.","example":"contract-ident","minLength":1,"type":"string"}},"required":["contractIdent"],"type":"object"},"RelatedContractResponse":{"description":"Related contracts of this contract","properties":{"contractIdent":{"description":"The ident of a contract related with this one.\nMust not be blank.","example":"contract-ident","minLength":1,"type":"string"}},"required":["contractIdent"],"type":"object"},"ServiceBillingPeriodResponse":{"description":"The start and end date of the service billing period, which may differ from the billing period.","properties":{"end":{"description":"The end date of the service billing period.\nMust not be null.","format":"date-time","type":"string"},"start":{"description":"The start date of the service billing period.\nMust not be null.","format":"date-time","type":"string"}},"required":["end","start"],"type":"object"},"ServiceLocationRequest":{"deprecated":true,"description":"Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The location where the product or service was sold.","properties":{"country":{"description":"The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"region":{"description":"The region where the product or service was sold.","type":"string"}},"type":"object"},"ServiceLocationResponse":{"deprecated":true,"description":"The location where the product or service was sold.","properties":{"country":{"description":"The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"region":{"description":"The region where the product or service was sold.","type":"string"}},"type":"object"},"SplittingConfigDto":{"description":"The new API to configure the separation of billable items.","properties":{"businessCase":{"description":"Enable the separation according to business case. Otherwise it will be split by itemType (debit/credit).\nMust not be null.","example":true,"type":"boolean"},"businessSegment":{"description":"Enable the separation according to business segments.\nMust not be null.","example":true,"type":"boolean"},"contract":{"description":"Enable the separation according to contracts.\nMust not be null.","example":true,"type":"boolean"},"id":{"description":"Id of the Splitting Configuration","format":"int64","type":"integer"},"mandatoryFields":{"items":{"type":"string"},"type":"array"},"performanceLocation":{"description":"Enable the separation according to location where the product or service was performed.\nMust not be null.","example":true,"type":"boolean"},"serviceBillingPeriod":{"description":"Enables the separation to service billing period. Items from different service billing periods are placed on separate documents, even within the same billing run.\nMust not be null.","example":true,"type":"boolean"}},"required":["businessCase","businessSegment","contract","performanceLocation","serviceBillingPeriod"],"type":"object"},"SplittingConfigUpdateRequest":{"description":"Request to update a Splitting Configuration","properties":{"businessCase":{"description":"Enable the separation according to business case. Otherwise it will be split by itemType (debit/credit).\nMust not be null.","example":true,"type":"boolean"},"businessSegment":{"description":"Enable the separation according to business segments.\nMust not be null.","example":true,"type":"boolean"},"contract":{"description":"Enable the separation according to contracts.\nMust not be null.","example":true,"type":"boolean"},"performanceLocation":{"description":"Enable the separation according to location where the product or service was performed.\nMust not be null.","example":true,"type":"boolean"},"serviceBillingPeriod":{"description":"Enables the separation to service billing period. Items from different service billing periods are placed on separate documents, even within the same billing run.\nMust not be null.","example":true,"type":"boolean"}},"required":["businessCase","businessSegment","contract","performanceLocation","serviceBillingPeriod"],"type":"object"},"StatisticsResponse":{"properties":{"groupedBy":{"description":"The group by value of the statistic","nullable":true,"type":"object"},"value":{"description":"The value of the statistic","nullable":true,"type":"object"}},"type":"object"},"Status":{"description":"The status of the contract.","properties":{"performanceStatus":{"description":"Indicates the performance status of a contract in relation to its service period.\nMust not be null.\nMust be one of:\n|               |                                                                              |\n| ------------- | ---------------------------------------------------------------------------- |\n| PENDING_START | The contract has been agreed upon, but the service period has not yet begun. |\n| RUNNING       | The contract is currently in effect and being serviced.                      |\n| ENDED         | The service period has concluded, and the contract is no longer active.      |","type":"string"}},"required":["performanceStatus"],"type":"object"},"StatusHistory":{"description":"Status history entry","properties":{"status":{"description":"The status.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"timestamp":{"description":"The timestamp when the status occurred.\nMust not be null.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"TaxCalculationConfigDto":{"deprecated":true,"description":"Always returns default values in response. NBX_TAX_CALCULATION, NET_VALUE. For Removal after 2026-03-01","properties":{"contractTaxCalculationMethod":{"description":"Must not be null.","enum":["NET_VALUE","GROSS_VALUE"],"type":"string"},"orderTaxCalculationMethod":{"description":"Must not be null.","enum":["NET_VALUE","GROSS_VALUE"],"type":"string"},"orderTaxDetermination":{"description":"Must not be null.","enum":["TAXES_PROVIDED","NBX_TAX_CALCULATION"],"type":"string"}},"required":["contractTaxCalculationMethod","orderTaxCalculationMethod","orderTaxDetermination"],"type":"object"},"TaxClassificationDto":{"description":"Tax classification, used for filtering the correct tax rule. Provided by Debtor","properties":{"code":{"description":"The tax classification code.\nMust not be null.","type":"string"},"name":{"description":"The tax classification name","type":"string"}},"required":["code"],"type":"object"},"TaxInformationCreationRequest":{"description":"A request to create a new tax information object. Represents the details of associated tax information","properties":{"originalRowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_1"},"rowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_2"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","example":"QC","type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"Name of the tax.","example":"GST","type":"string"},"taxRate":{"description":"Tax rate.\nMust not be null.\nMust be greater than or equal to 0.","example":19,"minimum":0,"type":"number"},"unitPriceTax":{"$ref":"#/components/schemas/MonetaryValue_3"}},"required":["taxRate"],"type":"object"},"TaxInformationDto":{"description":"Represents the details of associated tax information","properties":{"originalRowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_15"},"rowTotalTax":{"$ref":"#/components/schemas/MonetaryValue_16"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxClassifications":{"description":"Tax classifications, used for filtering the correct tax rule.","items":{"$ref":"#/components/schemas/TaxClassificationDto"},"type":"array"},"taxCode":{"description":"Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","example":"QC","type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"Name of the tax.","example":"GST","type":"string"},"taxRate":{"description":"Tax rate.","example":19,"type":"number"},"unitPriceTax":{"$ref":"#/components/schemas/MonetaryValue_17"}},"type":"object"},"TenantConfigResponse":{"description":"The current billing run config.","properties":{"activeBillingRun":{"description":"Billing run is triggered in a regular interval if active","type":"boolean"}},"type":"object"},"TenantConfigUpdateRequest":{"description":"The new config.","properties":{"activeBillingRun":{"description":"Billing run is triggered in a regular interval if active","type":"boolean"}},"type":"object"},"TerminationAdaptionRequest":{"description":"This contract termination request contains information about the termination. If neither termination date nor notice date is set, it is considered to be an extraordinary termination to today.","properties":{"noticeDate":{"description":"The effective notice date which serves as the starting point for calculating the contract endDate taking the notice period into account.","format":"date-time","type":"string"},"reason":{"description":"Reason for the Termination.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"terminationDate":{"description":"Termination date, if not set the termination date will be end of today","format":"date-time","type":"string"}},"type":"object"},"TierProgressivePriceCalculationBasisResponse":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasisResponse"},{"properties":{"tiers":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/TierProgressivePriceResponse"},"minItems":1,"type":"array"}},"type":"object"}],"required":["tiers","type"],"type":"object"},"TierProgressivePriceResponse":{"properties":{"netGrossIndicator":{"description":"If the price is net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"tierQuantity":{"description":"Size of the tier.","type":"number"},"totalPrice":{"$ref":"#/components/schemas/MonetaryValue_89"},"unitPrice":{"$ref":"#/components/schemas/MonetaryValue_88"},"usedQuantity":{"description":"How much quantity is actually used in this tier.","type":"number"}},"type":"object"},"TierSinglePriceCalculationBasisResponse":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasisResponse"},{"properties":{"tiers":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/TierSinglePriceResponse"},"minItems":1,"type":"array"}},"type":"object"}],"required":["tiers","type"],"type":"object"},"TierSinglePriceResponse":{"properties":{"netGrossIndicator":{"description":"If the price is net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"tierQuantity":{"description":"Size of the tier.","type":"number"},"totalPrice":{"$ref":"#/components/schemas/MonetaryValue_87"},"unitPrice":{"$ref":"#/components/schemas/MonetaryValue_86"},"usedQuantity":{"description":"How much quantity is actually used in this tier.","type":"number"}},"type":"object"},"TimeBasedUsageOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"pricingGroups":{"description":"A list of pricing groups that are used for pricing this option.\nMust not be empty.","items":{"$ref":"#/components/schemas/PricingGroupRequest"},"minItems":1,"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"MINUTE","description":"The way in which the option's quantity is measured. Must be one of:.\nMust be one of:\n|        |           |\n| ------ | --------- |\n| PC     | Piece(s)  |\n| KWH    | kWh(s)    |\n| SECOND | Second(s) |\n| MINUTE | Minute(s) |\n| HOUR   ||           \n| DAY    ||           \n| WEEK   ||           \n| MONTH  ||           \n| YEAR   ||","example":"MINUTE","nullable":true,"type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"A time-based usage option that defines how usage is measured and priced based on quantity type.","required":["name","pricingGroups","type"],"type":"object"},"TimeBasedUsageOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"pricingGroups":{"description":"A list of pricing groups that are used for pricing this option.\nMust not be null.","items":{"$ref":"#/components/schemas/PricingGroupResponse"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"MINUTE","description":"The way in which the option's quantity is measured. Must be one of:.\nMust be one of:\n|        |           |\n| ------ | --------- |\n| PC     | Piece(s)  |\n| KWH    | kWh(s)    |\n| SECOND | Second(s) |\n| MINUTE | Minute(s) |\n| HOUR   ||           \n| DAY    ||           \n| WEEK   ||           \n| MONTH  ||           \n| YEAR   ||","example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"}},"type":"object"}],"description":"A time-based usage option that defines how usage is measured and priced based on quantity type.","required":["name","pricingGroups","type"],"type":"object"},"TimeBasedUsageOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Net price of the option excluding vat.","example":100,"type":"number"},"pricingGroups":{"description":"A list of pricing groups that are used for pricing this option.\nMust not be empty.","items":{"$ref":"#/components/schemas/PricingGroupRequest"},"minItems":1,"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"MINUTE","description":"The way in which the option's quantity is measured. Must be one of:.\nMust be one of:\n|        |           |\n| ------ | --------- |\n| PC     | Piece(s)  |\n| KWH    | kWh(s)    |\n| SECOND | Second(s) |\n| MINUTE | Minute(s) |\n| HOUR   ||           \n| DAY    ||           \n| WEEK   ||           \n| MONTH  ||           \n| YEAR   ||","example":"MINUTE","nullable":true,"type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"type":"object"}],"description":"A time-based usage option that defines how usage is measured and priced based on quantity type.","required":["name","pricingGroups","type"],"type":"object"},"TimeBasedUsageOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"pricingGroups":{"description":"A list of pricing groups that are used for pricing this option.","items":{"$ref":"#/components/schemas/PricingGroupResponse"},"type":"array"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"MINUTE","description":"The way in which the option's quantity is measured. Must be one of:.\nMust be one of:\n|        |           |\n| ------ | --------- |\n| PC     | Piece(s)  |\n| KWH    | kWh(s)    |\n| SECOND | Second(s) |\n| MINUTE | Minute(s) |\n| HOUR   ||           \n| DAY    ||           \n| WEEK   ||           \n| MONTH  ||           \n| YEAR   ||","example":"MINUTE","type":"string"}},"type":"object"}],"description":"A time-based usage option that defines how usage is measured and priced based on quantity type.","required":["name"],"type":"object"},"TimeBasedUsagePriceCalculationBasisResponse":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasisResponse"},{"properties":{"averagePriceTotalQuantity":{"$ref":"#/components/schemas/MonetaryValue_93"},"priceDetails":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/TimeBasedUsagePriceDetailResponse"},"minItems":1,"type":"array"},"quantityCap":{"description":"Quantity cap limit from the option pricing group.","type":"number"},"totalBillableQuantity":{"description":"Total billable quantity across all time slots (after free quota and quantity cap).","type":"number"},"totalCost":{"$ref":"#/components/schemas/MonetaryValue_92"},"totalQuantity":{"description":"Total quantity (actual consumption) across all time slots.","type":"number"}},"type":"object"},{"properties":{"averagePriceTotalQuantity":{"$ref":"#/components/schemas/MonetaryValue"},"priceDetails":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/TimeBasedUsagePriceDetailResponse"},"minItems":1,"type":"array"},"quantityCap":{"description":"Quantity cap limit from the option pricing group.","type":"number"},"totalBillableQuantity":{"description":"Total billable quantity across all time slots (after free quota and quantity cap).","type":"number"},"totalCost":{"$ref":"#/components/schemas/MonetaryValue"},"totalQuantity":{"description":"Total quantity (actual consumption) across all time slots.","type":"number"}},"type":"object"}],"required":["priceDetails","type"],"type":"object"},"TimeBasedUsagePriceDetailResponse":{"properties":{"freeQuota":{"description":"Free quota available within this time slot before charges apply.","type":"number"},"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"pricingRuleEndTime":{"description":"End time of the pricing rule (exclusive).","type":"string"},"pricingRuleStartTime":{"description":"Start time of the pricing rule (inclusive).","type":"string"},"quantity":{"description":"Measured usage quantity within the defined time slot (number of minutes or seconds).","type":"number"},"totalPrice":{"$ref":"#/components/schemas/MonetaryValue_95"},"unitPrice":{"$ref":"#/components/schemas/MonetaryValue_94"}},"type":"object"},"UnitQuantity":{"description":"A unit quantity describes the the way in which a unit is measured.","properties":{"unitQuantity":{"description":"The number units.\nMust not be null.\nMust be greater than 0.","type":"number"},"unitQuantityType":{"description":"The way in which the option's quantity is measured. Must be one of:.\nMust not be null.","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"}},"required":["unitQuantity","unitQuantityType"],"type":"object"},"UsageCancellationBatchRequest":{"description":"A request to cancel multiple usages together","properties":{"cancellationRequests":{"description":"Usages to be cancelled.\nMust not be empty.","items":{"$ref":"#/components/schemas/UsageCancellationRequest"},"minItems":1,"type":"array"},"reason":{"description":"The reason for cancellation.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["cancellationRequests"],"type":"object"},"UsageCancellationBatchResponse":{"description":"Container that holds cancelled usages","properties":{"successfulCancellationResponses":{"description":"Cancelled usages","items":{"$ref":"#/components/schemas/UsageCancellationResponse"},"type":"array"}},"type":"object"},"UsageCancellationRequest":{"description":"This request contains the ident of a usage that shall be cancelled","properties":{"usageIdent":{"description":"Ident of the usage that shall be cancelled.\nMust not be empty.","minLength":1,"type":"string"}},"required":["usageIdent"],"type":"object"},"UsageCancellationResponse":{"description":"Cancelled usage.","properties":{"usageIdent":{"description":"The ident of the cancelled usage.\nMust not be empty.","minLength":1,"type":"string"}},"required":["usageIdent"],"type":"object"},"UsageCapConfigRequest":{"description":"Configuration for usage cap.","properties":{"type":{"default":"QUANTITY","description":"Type of usage cap.\nMust be one of:\n|          |\n| -------- |\n| QUANTITY |","type":"string"}},"required":["type"],"type":"object"},"UsageCapRequest":{"description":"Usage Cap defines the usage limit for an option","nullable":true,"properties":{"amount":{"description":"Usage cap value of the configured Cap Type.\nMust be greater than or equal to 0.","type":"number"},"config":{"$ref":"#/components/schemas/UsageCapConfigRequest"}},"required":["amount"],"type":"object"},"UsageCapResponse":{"description":"Usage Cap defines the usage limit for an option.","nullable":true,"properties":{"amount":{"description":"Usage cap value of the configured Cap Type.\nMust be greater than or equal to 0.","type":"number"},"config":{"$ref":"#/components/schemas/UsageCapConfigRequest"}},"required":["amount","config"],"type":"object"},"UsageCreationRequest":{"description":"Please see Usage Model below for more information regarding required values and input type.","properties":{"contractId":{"description":"The contract to which this usage should belong to. When no contract is given, a debtor id is mandatory. When a contract id is given, the debtor id will be ignored.","format":"int64","type":"integer"},"debtorId":{"description":"The debtor to which this usage belongs to. When a contract is already provided, then this field is ignored. Otherwise the newest matching contract for this debtor is used.","format":"int64","type":"integer"},"description":{"description":"The usage's description.","type":"string"},"endDate":{"description":"The end date of the contract. Can be the same as the start date. Supports ISO 8601 offset information.\nMust not be null.","example":"2021-02-10T00:00:00Z","format":"date-time","type":"string"},"operatingSiteIdent":{"description":"Operating site is used for tax calculation. Only predefined operating site identifiers are allowed.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"performanceLocation":{"$ref":"#/components/schemas/UsagePerformanceLocationRequest"},"productIdent":{"description":"The productIdent links the usage to the appropriate option from a specific plan.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use taxLocation and performanceLocation instead. The usage's service country. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"startDate":{"description":"The start date of the usage. Supports ISO 8601 offset information.\nMust not be null.","example":"2021-02-10T00:00:00+01:00","format":"date-time","type":"string"},"taxLocation":{"$ref":"#/components/schemas/UsageTaxLocationRequest"},"unitQuantities":{"items":{"$ref":"#/components/schemas/UnitQuantity"},"type":"array"},"usageIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["endDate","productIdent","startDate","usageIdent"],"type":"object"},"UsageDeletionRequest":{"description":"This request contains all idents of usages that will be deleted","properties":{"idents":{"description":"Idents of usages that will be deleted.\nMust not be empty.","items":{"description":"Idents of usages that will be deleted","type":"string"},"minItems":1,"type":"array"}},"required":["idents"],"type":"object"},"UsageDto":{"description":"A usage creates a billable item based on an option in a plan. Usages must reference the contractId and productIdent to match the billable item to the correct debtor.","properties":{"cancellationStatus":{"description":"Whether the usage has been cancelled.\nMust be one of:\n|               |                                          |\n| ------------- | ---------------------------------------- |\n| CANCELLED     | The usage has been cancelled.            |\n| NOT_CANCELLED | The default, the usage is not cancelled. |","type":"string"},"contractId":{"description":"The contract to which this usage should belong to. When no contract is given, a debtor id is mandatory. When a contract id is given, the debtor id will be ignored.","format":"int64","type":"integer"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"debtorId":{"description":"The debtor to which this usage belongs to. When a contract is already provided, then this field is ignored. Otherwise the newest matching contract for this debtor is used.","format":"int64","type":"integer"},"description":{"description":"The usage's description.","type":"string"},"endDate":{"description":"The end date of the contract. Can be the same as the start date. Supports ISO 8601 offset information.\nMust not be null.","example":"2021-02-10T00:00:00Z","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"operatingSiteIdent":{"description":"Operating site is used for tax calculation. Only predefined operating site identifiers are allowed.","type":"string"},"performanceLocation":{"$ref":"#/components/schemas/UsagePerformanceLocationResponse"},"processingDate":{"description":"The ISO 8601 date at which the usage will be processed for billing. ","format":"date-time","type":"string"},"productIdent":{"description":"The productIdent links the usage to the appropriate option from a specific plan. When no option for this productIdent is found, then nothing gets billed to the customer.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"relatedBillableItemIdent":{"description":"Ident for the corresponding Billable Item of this Usage. Is set, while pooling is active, when the Billing Run is done. When Usage Quantity is 0, no BillableItem is created.","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Use taxLocation and performanceLocation instead. The usage's service country. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"startDate":{"description":"The start date of the usage. Supports ISO 8601 offset information.\nMust not be null.","example":"2021-02-10T00:00:00+01:00","format":"date-time","type":"string"},"taxLocation":{"$ref":"#/components/schemas/UsageTaxLocationResponse"},"unitQuantities":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/UnitQuantity"},"minItems":1,"type":"array"},"usageId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"usageIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["createdAt","endDate","lastModifiedAt","productIdent","serviceCountry","startDate","unitQuantities","usageIdent"],"type":"object"},"UsageOptionCreationRequest":{"allOf":[{"$ref":"#/components/schemas/OptionCreationRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"type":"number"},"priceTiers":{"description":"A list of price tiers that are used for pricing this option","items":{"$ref":"#/components/schemas/PriceTier"},"type":"array"},"pricingModel":{"description":"The pricing model that is applied to this option","enum":["CONTINGENT","TIER_PRICE","VOLUME_PRICE"],"example":"CONTINGENT","type":"string"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","description":"The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"usageCap":{"$ref":"#/components/schemas/UsageCapRequest"},"usePooling":{"description":"Enable the possibility to bill all usages together","type":"boolean"}},"type":"object"}],"description":"An option to calculate purchases that are derived from a usage","required":["name","type"],"type":"object"},"UsageOptionDto":{"allOf":[{"$ref":"#/components/schemas/OptionDtoBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"type":"number"},"priceTiers":{"description":"A list of price tiers that are used for pricing this option","items":{"$ref":"#/components/schemas/PriceTier"},"type":"array"},"pricingModel":{"description":"The pricing model that is applied to this option","enum":["CONTINGENT","TIER_PRICE","VOLUME_PRICE"],"example":"CONTINGENT","type":"string"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","description":"The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"usageCap":{"$ref":"#/components/schemas/UsageCapResponse"},"usePooling":{"description":"Enable the possibility to bill all usages together","type":"boolean"}},"type":"object"}],"description":"An option to calculate purchases that are derived from a usage","required":["name","type"],"type":"object"},"UsageOptionUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/OptionUpdateRequestBase"},{"properties":{"currency":{"default":"EUR","deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The option's currency. Must be one of:","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"invoicingAgreementType":{"default":"SALES","description":"Invoicing agreement type of an option","enum":["SALES","SELF_BILLING"],"example":"SALES","type":"string"},"itemPriceNet":{"type":"number"},"priceTiers":{"description":"A list of price tiers that are used for pricing this option","items":{"$ref":"#/components/schemas/PriceTier"},"type":"array"},"pricingModel":{"description":"The pricing model that is applied to this option","enum":["CONTINGENT","TIER_PRICE","VOLUME_PRICE"],"example":"CONTINGENT","type":"string"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","description":"The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"serviceCountry":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"taxCode":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.","type":"string"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShould now be configured in the 'pricing' section. It defines tax trading procedure of an item.","enum":["OSS","DEFAULT"],"type":"string"},"usePooling":{"description":"Enable the possibility to bill all usages together","type":"boolean"},"validFrom":{"description":"Date from when a version of the option is valid.\nDate must be in the future or null.","format":"date-time","type":"string"}},"type":"object"}],"description":"An option to calculate purchases that are derived from a usage","required":["name","type"],"type":"object"},"UsageOptionVersionDto":{"allOf":[{"$ref":"#/components/schemas/OptionVersionDtoBase"},{"properties":{"debitCreditIndicator":{"description":"Item type","enum":["DEBIT","CREDIT"],"type":"string"},"itemPriceNet":{"type":"number"},"priceTiers":{"description":"A list of price tiers that are used for pricing this option","items":{"$ref":"#/components/schemas/PriceTier"},"type":"array"},"pricingModel":{"description":"The pricing model that is applied to this option","enum":["CONTINGENT","TIER_PRICE","VOLUME_PRICE"],"example":"CONTINGENT","type":"string"},"purchaseItemOptionType":{"default":"SERVICE","deprecated":true,"description":"DEPRECATED.\nShould now be configured in 'category'. The option's purchase item type. Must be one of:","enum":["DIGITAL_PRODUCT","DIGITAL_PRODUCT_RENTAL","LABOR_COST","LOGISTIC_COST","PHYSICAL_PRODUCT","PHYSICAL_PRODUCT_RENTAL","SERVICE","VOUCHER","ELECTRICITY","ELECTRICITY_RESALE"],"example":"PHYSICAL_PRODUCT","type":"string"},"quantityType":{"default":"PC","description":"The way in which the option's quantity is measured. Must be one of:","enum":["PC","KWH","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"],"example":"MINUTE","type":"string"},"usageCap":{"$ref":"#/components/schemas/UsageCapResponse"},"usePooling":{"description":"Enable the possibility to bill all usages together","type":"boolean"}},"type":"object"}],"description":"An option to calculate purchases that are derived from a usage","required":["name"],"type":"object"},"UsagePerformanceLocationRequest":{"description":"The location where the product or service was performed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"UsagePerformanceLocationResponse":{"description":"The location where the product or service was performed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service was performed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service was performed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"UsageTaxLocationRequest":{"description":"The location where the product or service should be taxed. Note that if usage pooling is enabled, only usages where all tax location fields match will be aggregated together.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"UsageTaxLocationResponse":{"description":"The location where the product or service should be taxed.","properties":{"city":{"description":"Name of the city. Must be between 0 and 255 characters/elements.","example":"Hamburg","type":"string"},"country":{"description":"The country where the product or service should be taxed. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DE","type":"string"},"postalCode":{"description":"Postal code. Must be between 0 and 255 characters/elements.","example":"040","type":"string"},"region":{"description":"The region where the product or service should be taxed.","type":"string"},"state":{"description":"Name of the state. Must be between 0 and 255 characters/elements.","example":"Brandenburg","type":"string"},"street":{"description":"Name of street. Must be between 0 and 255 characters/elements.","example":"Hofweg","type":"string"}},"type":"object"},"UseDebtorRequest":{"allOf":[{"$ref":"#/components/schemas/DebtorOrderDetailsRequest"},{"properties":{"invoiceAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Must be the correct ID for the invoice address to which the contract will be assigned. Please use invoiceAddressIdent.","format":"int64","type":"integer"},"invoiceAddressIdent":{"description":"Must be the correct ident for the invoice address to which the contract will be assigned. Please use invoiceAddressIdent.","type":"string"},"shippingAddressId":{"deprecated":true,"description":"DEPRECATED.\nDeprecated: Optional ID of the shipping address to which the contract will be assigned. Please use shippingAddressIdent.","format":"int64","type":"integer"},"shippingAddressIdent":{"description":"Optional ident of the shipping address to which the contract will be assigned.","type":"string"}},"type":"object"}],"description":"Mixing ids and idents for addresses (e. g. id for invoice address and ident for shipping address) is not supported.","required":["debtorIdent"],"type":"object"},"WidgetStatisticsQueryParameter":{"description":"Values used for the statistic query.","properties":{"aggregationType":{"description":"The given type of aggregation.\nMust not be null.","example":"SUM","type":"string"},"dateField":{"description":"The given date field.\nMust not be null.","example":"createdAt","type":"string"},"field":{"description":"The given field to query for.\nMust not be null.","example":"IDENT","type":"string"},"groupedBy":{"description":"The given field for grouping.\nMust not be null.","example":"NONE","type":"string"},"query":{"description":"Rsql query used to limit the result set.","example":"IDENT==client123","type":"string"}},"required":["aggregationType","dateField","field","groupedBy","query"],"type":"object"},"WidgetStatisticsResponse":{"description":"Result of a statistic query.","properties":{"queryParameter":{"$ref":"#/components/schemas/WidgetStatisticsQueryParameter"},"results":{"items":{"$ref":"#/components/schemas/WidgetStatisticsResult"},"type":"array"}},"required":["queryParameter","results"],"type":"object"},"WidgetStatisticsResult":{"description":"Single result of a statistic query.","properties":{"groupedByContent":{"description":"If group by is used, this field contains the specific value of the grouping. Otherwise it is null.","example":"2025","type":"string"},"value":{"description":"Sum or Counted value.\nMust not be null.","example":3.1235,"type":"number"}},"required":["groupedByContent","value"],"type":"object"},"billingConfig":{"description":"The new API to configure billing details on phase level. \nUsing these properties will ignore the billingStrategyField from options within this phase.","properties":{"billingInterval":{"$ref":"#/components/schemas/Duration"},"delayInSeconds":{"description":"To be used in conjunction with _WITH_DELAY billing timings to indicate how many seconds after the first possible billing this plan will be billed. \nExample: Monthly synced plan that will be billed at interval end would be billed at exactly 00:00 UTC on the first of each month. If you want to wait 12h so you can provide additional services provided in the last month such as usages or additional line items, then you can set this value to 43.200 and it will be billed at 12:00UTC instead.\nMust be greater than 0.\nMust be less than or equal to 2700000.","format":"int32","maximum":2700000,"type":"integer"},"enforceBillingPeriodSync":{"description":"When set to true, the first and last billing will also by synced with the billing period. Otherwise the first and last billing is done at the start and end of the contract.","type":"boolean"},"syncBillingToBillingIntervalUnit":{"description":"Set to true the contracts will be synchronized to start at the full day, month, year, depending on the billing interval unit.\nMust not be null.","type":"boolean"},"timing":{"description":"Defines when billing occurs.\nINTERVAL_START: At the start of an interval. Example: Services provided in january will be billed at the \"start\" of january\nINTERVAL_END:  At the end of an interval. Example: Services provided in january will be billed at the end of january.\nMust not be null.","enum":["INTERVAL_START","INTERVAL_END","INTERVAL_START_WITH_DELAY","INTERVAL_END_WITH_DELAY"],"type":"string"}},"required":["billingInterval","syncBillingToBillingIntervalUnit","timing"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-contract-order-management-read":"Scope nbx-contract-order-management-read","nbx-contract-order-management-write":"Scope nbx-contract-order-management-write","nbx-customer-management-read":"Scope nbx-customer-management-read","nbx-customer-management-write":"Scope nbx-customer-management-write","nbx-document-management-read":"Scope nbx-document-management-read","nbx-document-management-write":"Scope nbx-document-management-write","nbx-internal":"Scope nbx-internal","nbx-product-management-read":"Scope nbx-product-management-read","nbx-product-management-write":"Scope nbx-product-management-write","nbx-tenant-management-read":"Scope nbx-tenant-management-read","nbx-tenant-management-write":"Scope nbx-tenant-management-write"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Billing: Plans, Contracts and Orders","title":"Billing API","version":"v2-preview-4.11.6"},"openapi":"3.0.1","paths":{"/v2/billableitems":{"get":{"deprecated":true,"description":"| &#x26A0; <b>This operation has been deprecated and will be removed in the future!</b> &#x26A0;<br>Reason: Use correct pageable query endpoint instead.<br>This operation is replaced by <a href='https://docs.nitrobox.io/reference/searchbillableitemspageable'>https://docs.nitrobox.io/reference/searchbillableitemspageable</a>. |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Deprecated since: 2025-03-31<br><p style='color:red;font-weight:bold'>Sunset at the latest: 2026-03-31</p>                                                                                                                                                                                                                           |\n| Please refer to our \"API Lifecycle Management\" and our \"API Migration Guide\" to find out more.                                                                                                                                                                                                                                       |\nReturns a list of billable items matching specified query. Billable items are sorted in descending order by billableItemId. This can be changed with the optional direction and orderBy parameters.","operationId":"searchBillableItems","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"invoiceIdent=gt=20000000","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"billableItemId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BillableItemResponse"},"type":"array"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query billable items","tags":["Billable Items"]}},"/v2/billableitems/pageable":{"get":{"description":"Returns a list of billable items matching specified query. Billable items are sorted in descending order by billableItemId. This can be changed with the optional direction and orderBy parameters.","operationId":"searchBillableItemsPageable","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"invoiceIdent=gt=20000000","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 100.","in":"query","name":"size","schema":{"default":100,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'desc'.\nDefault sorting criteria: 'billableItemId'.","in":"query","name":"sort","schema":{"default":["billableItemId"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseBillableItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query billable items","tags":["Billable Items"]}},"/v2/billing-groups":{"get":{"description":"Returns paged result with 100 billing groups by default. Billing Groups are sorted in descending order by billingGroupId. This can be changed with the optional direction and orderBy parameters.","operationId":"getBillingGroups_v3","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"billingGroupId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"billingGroupId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseBillingGroupDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Get a paged result of all billing groups","tags":["Billing Groups"]},"post":{"description":"Create a completely new billing group. Billing groups can be used to differentiate within your tenant for different business strategies. A business segment can be used to differentiate between different locales and to implement specific templates for these regions later on. If this is your only business segment then it will be set as default automatically.","operationId":"createBillingGroup_v3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create billing group","tags":["Billing Groups"]}},"/v2/billing-groups/{billingGroupIdent}":{"delete":{"operationId":"deleteBillingGroup_v3","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Delete billing group","tags":["Billing Groups"]},"get":{"description":"Get a specific billing group by ident.","operationId":"getBillingGroup","parameters":[{"description":"The unique identifier of a billing group.","example":160,"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Retrieve billing group","tags":["Billing Groups"]},"put":{"description":"Completely update a billing group by ident.","operationId":"updateBillingGroup_v3","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Update billing group","tags":["Billing Groups"]}},"/v2/billing-groups/{billingGroupIdent}/business-segments":{"post":{"description":"Create a completely new business segment. Business segments can be used to differentiate within your tenant for different business strategies. A business segment can be used to differentiate between different locales and to implement specific templates for these regions later on. If this is your only business segment then it will be set as default automatically.","operationId":"createBusinessSegment","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSegmentCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSegmentDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create business segment","tags":["Billing Groups"]}},"/v2/billing-groups/{billingGroupIdent}/business-segments/{businessSegmentIdent}":{"delete":{"operationId":"deleteBusinessSegment","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"businessSegmentIdent","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Delete business segment","tags":["Billing Groups"]},"get":{"description":"Get a specific business segment by id.","operationId":"getBusinessSegment","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of a business segment.","example":160,"in":"path","name":"businessSegmentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSegmentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Retrieve business segment","tags":["Billing Groups"]},"put":{"description":"Completely update a business segment by id.","operationId":"updateBusinessSegment","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"businessSegmentIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSegmentUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSegmentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Update business segment","tags":["Billing Groups"]}},"/v2/billing-groups/{billingGroupIdent}/business-segments/{businessSegmentIdent}/actions/set-as-default":{"post":{"description":"Set specific business segment as default segment for your tenant.","operationId":"setBusinessSegmentAsDefault","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"businessSegmentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSegmentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Set as default","tags":["Billing Groups"]}},"/v2/billing-groups/{billingGroupIdent}/splitting-config":{"put":{"description":"Completely update a splitting config by billing group ident.","operationId":"updateSplittingConfig_v3","parameters":[{"in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SplittingConfigUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SplittingConfigDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Update splitting config","tags":["Billing Groups"]}},"/v2/billing/plan-options":{"get":{"description":"Returns page with 100 plan options. Plan options are options that can be reused for multiple plans / phases.","operationId":"getAllPlanOptions_v2","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"optionId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"optionId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOptionDtoBase"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Get a page of all plan options","tags":["Plans and Options"]},"post":{"description":"An option is a product or service that should be billed in a given phase. The option can have one of the types ONETIME, QUANTITY, RECURRING, USAGE or RATED_USAGE.","operationId":"createOption_v2","requestBody":{"content":{"application/json":{"schema":{"description":"Please see request body description for more information.","oneOf":[{"$ref":"#/components/schemas/CommissionOptionCreationRequest"},{"$ref":"#/components/schemas/OneTimeOptionCreationRequest"},{"$ref":"#/components/schemas/QuantityOptionCreationRequest"},{"$ref":"#/components/schemas/RatedUsageOptionCreationRequest"},{"$ref":"#/components/schemas/RecurringOptionCreationRequest"},{"$ref":"#/components/schemas/TimeBasedUsageOptionCreationRequest"},{"$ref":"#/components/schemas/UsageOptionCreationRequest"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionDto"},{"$ref":"#/components/schemas/OneTimeOptionDto"},{"$ref":"#/components/schemas/QuantityOptionDto"},{"$ref":"#/components/schemas/RatedUsageOptionDto"},{"$ref":"#/components/schemas/RecurringOptionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionDto"},{"$ref":"#/components/schemas/UsageOptionDto"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Create option","tags":["Plans and Options"]}},"/v2/billing/plan-options/{optionIdent}":{"delete":{"description":"Only options in DRAFT status (not assigned to any plans) can be deleted.","operationId":"deleteOption_v2","parameters":[{"description":"The unique identifier for the option.","in":"path","name":"optionIdent","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Delete option","tags":["Plans and Options"]},"get":{"description":"The method returns a option, depending on the optionIdent.","operationId":"getOption_v2","parameters":[{"in":"path","name":"optionIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionDto"},{"$ref":"#/components/schemas/OneTimeOptionDto"},{"$ref":"#/components/schemas/QuantityOptionDto"},{"$ref":"#/components/schemas/RatedUsageOptionDto"},{"$ref":"#/components/schemas/RecurringOptionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionDto"},{"$ref":"#/components/schemas/UsageOptionDto"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Retrieve option","tags":["Plans and Options"]},"put":{"description":"Updates a option. If it's in DRAFT status (it's not assigned to any plans yet) the changes will be made immediately. \nIf it's in FINAL status, RatedUsageOptions cannot be updated anymore. \nFor other types of Options the new option version will be used in the billing periods following the valid_from.","operationId":"updateOption_v2","parameters":[{"in":"path","name":"optionIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"The updated option","oneOf":[{"$ref":"#/components/schemas/CommissionOptionUpdateRequest"},{"$ref":"#/components/schemas/OneTimeOptionUpdateRequest"},{"$ref":"#/components/schemas/QuantityOptionUpdateRequest"},{"$ref":"#/components/schemas/RatedUsageOptionUpdateRequest"},{"$ref":"#/components/schemas/RecurringOptionUpdateRequest"},{"$ref":"#/components/schemas/TimeBasedUsageOptionUpdateRequest"},{"$ref":"#/components/schemas/UsageOptionUpdateRequest"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CommissionOptionDto"},{"$ref":"#/components/schemas/OneTimeOptionDto"},{"$ref":"#/components/schemas/QuantityOptionDto"},{"$ref":"#/components/schemas/RatedUsageOptionDto"},{"$ref":"#/components/schemas/RecurringOptionDto"},{"$ref":"#/components/schemas/TimeBasedUsageOptionDto"},{"$ref":"#/components/schemas/UsageOptionDto"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Update option","tags":["Plans and Options"]}},"/v2/billingrun":{"post":{"description":"A billing run processes and books all available and previously unprocessed billable items. The billing run can be started for all billable items or for the billable items of a specific debtor. Overwrites an existing billing run stop for this customer. Use the debtorId and the debtorIdent to start a debtor specific billing run.All related invoices will be generated.","operationId":"billingRun","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtorBillingRunCriteriaDto"}}}},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Start billing run","tags":["Contracts"]}},"/v2/business-segments":{"get":{"description":"Get a list of all business segments. To reduce the result set, please use the RSQL query.","operationId":"getBusinessSegments","parameters":[{"description":"Zero-based page index (0..N). Defines the index of the displayed page.","in":"query","name":"page","schema":{"example":0,"type":"integer"}},{"description":"Defines the number of objects per page to be returned.","in":"query","name":"size","schema":{"example":20,"type":"integer"}},{"description":"Defines how the response is sorted. Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseBusinessSegmentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Query business segments","tags":["Billing Groups"]}},"/v2/contracts":{"post":{"description":"A request to create a new contract. It ties a preconfigured plan to an existing customer, in order to bill the services as defined in the underlying plan. ","operationId":"createContract","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Create contract","tags":["Contracts"]}},"/v2/contracts/actions/cancel":{"post":{"operationId":"cancelContracts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCancellationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel contracts","tags":["Contracts"]}},"/v2/contracts/actions/terminate":{"post":{"description":"Plan based contracts can be terminated with an optional reason.  The actual contract end date is computed based on term duration and notice period. Terminated and cancelled contracts can not be terminated again.","operationId":"terminateContracts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOrdinaryContractTerminationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Terminate contracts","tags":["Contracts"]}},"/v2/contracts/actions/terminate-extraordinarily":{"post":{"description":"Plan based contracts can be terminated extraordinarily.  Terminated and cancelled contracts can not be terminated again.","operationId":"extraordinaryTerminateContracts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchExtraOrdinaryContractTerminationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Extraordinary terminations.","tags":["Contracts"]}},"/v2/contracts/pageable":{"get":{"description":"Returns list with 100 contracts. Contracts are sorted by default in descending order by contractId. This can be changed with the optional direction and orderBy parameters.NOTE: When searching for 'taxLocation' or 'performanceLocation', the response will also include contracts that were set to the value in the past.","operationId":"queryContractsPageable","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"contractId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"contractId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}},{"description":"Whether contracts should be returned in slim variant (having no fields for attachments and purchase items).","in":"query","name":"slimResponse","schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseContractSlimDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query contracts","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/actions/activate":{"post":{"operationId":"activateContract","parameters":[{"in":"path","name":"contractIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractActivationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Activate contract","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/actions/add-options":{"post":{"description":"Request to add an option to a contract. For now only usage options can be added to a contract. An option added has to be enabled within the contracts as well.","operationId":"addOption_v2_1","parameters":[{"description":"The ident of the contract to add options.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PhaseOptionQuantityRequest"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Enable additional options for a contract.","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/actions/retry-failed-billable-items":{"post":{"description":"A request to retrigger all failed billable items of a contract. Some failed billable items might need manual work before they can be retried.","operationId":"retryFailedBillableItems_1","parameters":[{"description":"Retries all failed billable items for the given contract","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Retry failed billable items","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/actions/terminate":{"post":{"description":"A plan based contract can be terminated with an optional reason.  The actual contract end date is computed based on term duration and notice period. Terminated and cancelled contracts can not be terminated again.","operationId":"terminateContract","parameters":[{"description":"The ident of the contract to terminate","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdinaryContractTerminationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Terminate a contract","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/actions/terminate-extraordinarily":{"post":{"description":"A plan based contract can be terminated extraordinarily.  The contract will be terminated to the end of the current day. Terminated and cancelled contracts can not be terminated again.","operationId":"extraordinaryTermination","parameters":[{"description":"The ident of the contract to terminate","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtraOrdinaryContractTerminationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Extraordinary termination","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/actions/termination-adaptation":{"post":{"description":"This endpoint allows you to adjust the termination date of a terminated contract. Currently, it supports shortening","operationId":"shortTermTermination","parameters":[{"description":"The ident of the contract to terminate","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminationAdaptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Termination adaption","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/allowances":{"get":{"description":"Query for allowances of a contract.","operationId":"queryAllowances","parameters":[{"description":"The ident of the contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"optionIdent-456","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOptionAllowanceResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query allowances","tags":["Contracts"]},"post":{"description":"Create an allowance.","operationId":"createAllowance","parameters":[{"description":"The ident of the contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionAllowanceCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionAllowanceResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Create allowance","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/allowances/{allowanceIdent}":{"delete":{"description":"Delete allowance by ident. Allowances can be deleted unless already billed. Deletion can't be reverted.","operationId":"deleteAllowance","parameters":[{"description":"The ident of the contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The unique identifier of an allowance for an option of a contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"allowanceIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Delete allowance","tags":["Contracts"]},"get":{"description":"Retrieve an allowance by ident.","operationId":"retrieveOptionAllowance","parameters":[{"description":"The ident of the contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The unique identifier of an allowance for an option of a contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"allowanceIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionAllowanceResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve allowance","tags":["Contracts"]},"put":{"description":"Update an allowance.","operationId":"updateAllowance_1","parameters":[{"description":"The ident of the contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The unique identifier of an allowance for an option of a contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"allowanceIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionAllowanceUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionAllowanceResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Update allowance","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/billableitems/actions/retry-recalculation":{"post":{"description":"Retry the recalculation of all billable items in status RECALCULATION_ERROR.","operationId":"retryRecalculation","parameters":[{"description":"The ident of the contract","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Retry recalculation","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/billableitems/{billableItemIdent}/actions/cancel":{"post":{"description":"Cancel a billable item for a specific contract. ","operationId":"cancelBillableItem","parameters":[{"description":"The ident of the contract","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"The ident of the billable item","example":"nbx_billable_item_12345","in":"path","name":"billableItemIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractBillableItemCancellationRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel a billable item","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/billableitems/{billableItemIdent}/actions/correct-price":{"post":{"description":"Correct a billable item from a recurring or one time for a specific contract.","operationId":"correctBillableItem","parameters":[{"description":"The ident of the contract","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"The ident of the billable item","example":"nbx_billable_item_12345","in":"path","name":"billableItemIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractBillableItemCorrectionRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Correct a billable item","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/lineItems":{"get":{"description":"Search for line items. ","operationId":"getAllLineItems_1","parameters":[{"description":"The ident of the contract to add a line item","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==item-456","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"id","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseContractLineItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query line items","tags":["Contracts"]},"post":{"description":"A request to add new line items to an existing contract.","operationId":"addLineItem_1","parameters":[{"description":"The ident of the contract to add a line item","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContractLineItemCreationRequest"},"type":"array"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContractLineItemResponse"},"type":"array"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add line item","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/lineItems/actions/cancel":{"post":{"description":"Cancel line items with given idents. Processed items will be credited, for unprocessed items the item will never be processed. Cancellation cant be reverted.","operationId":"cancelLineItems_1","parameters":[{"description":"The ident of the contract to cancel line items","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemsCancellationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCancellationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel line items","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/lineItems/actions/prepare-documents":{"post":{"description":"Request to invoice all provided Line Items that are \"on hold\". Fails is a line item reference is provided that has been billed or canceled.","operationId":"prepareContractLineItemDocuments","parameters":[{"description":"The ident of the contract to set line items on hold","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemPrepareDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Prepare document creation for certain items","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/lineItems/actions/set-on-hold":{"post":{"description":"Sets multiple non-billed line items on hold for the contract given.","operationId":"setContractLineItemsOnHold","parameters":[{"description":"The ident of the contract to set line items on hold","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemOnHoldRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContractLineItemResponse"},"type":"array"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Hold line items for contract","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/lineItems/{lineItemIdent}":{"get":{"description":"Get a specific line item from a contract by it´s ident.","operationId":"retrieveLineItem_1","parameters":[{"description":"The ident of the contract to add a line item","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"The unique identifier of an line item, given by the Tenant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_lineItemIdent_256644","in":"path","name":"lineItemIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractLineItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve line item","tags":["Contracts"]},"put":{"description":"A request to edit an existing line item within an contract.","operationId":"editLineItem_1","parameters":[{"description":"The ident of the contract to edit a line item","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"in":"path","name":"lineItemIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractLineItemUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractLineItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Edit line item","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/plan-changes":{"get":{"description":"Find plan changes matching the given RSQL query, or all if the query is empty.","operationId":"queryPlanChange","parameters":[{"description":"The ident of the contract for the plan change.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePlanChangeResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query plan changes","tags":["preview"]},"post":{"description":"Create a plan change based on a migration path for the current plan.","operationId":"createPlanChange","parameters":[{"description":"The ident of the contract for the plan change.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanChangeCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanChangeResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Create a plan change","tags":["preview"]}},"/v2/contracts/{contractIdent}/plan-changes/{ident}":{"delete":{"description":"Remove the identified plan change.","operationId":"deletePlanChange","parameters":[{"description":"The ident of the contract for the plan change.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_migrationPathIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Remove a plan change","tags":["preview"]},"get":{"description":"Retrieve the plan change identified by contract and ident","operationId":"retrievePlanChange","parameters":[{"description":"The ident of the contract for the plan change.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_migrationPathIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanChangeResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve plan change","tags":["preview"]}},"/v2/contracts/{contractIdent}/plan-changes/{ident}/configuration":{"get":{"description":"Retrieve the configuration for the plan change identified by contract and ident","operationId":"retrievePlanChangeConfiguration","parameters":[{"description":"The ident of the contract for the plan change.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_migrationPathIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanChangeConfigurationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve plan change configuration","tags":["preview"]}},"/v2/contracts/{contractIdent}/related-contracts":{"get":{"description":"Query contracts that might have a billing impact from this contract.","operationId":"queryRelatedContracts","parameters":[{"description":"The ident of the contract to add options.","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"contractIdent-456","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseContractSlimDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"query related contracts","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/related-contracts/actions/add":{"post":{"description":"Add contracts that might have a billing impact from this contract.","operationId":"addRelatedContracts","parameters":[{"description":"The ident of the contract","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Related contracts of this contract","items":{"$ref":"#/components/schemas/RelatedContractRequest"},"type":"array"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"add related contracts to contract","tags":["Contracts"]}},"/v2/contracts/{contractIdent}/related-contracts/actions/remove":{"post":{"description":"Remove contracts so it no longer has any billing impact.","operationId":"removeRelatedContracts","parameters":[{"description":"The ident of the contract","example":"nbx_contractIdent_12345","in":"path","name":"contractIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Related contracts of this contract","items":{"$ref":"#/components/schemas/RelatedContractRequest"},"type":"array"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"remove related contracts from contract","tags":["Contracts"]}},"/v2/contracts/{contractId}":{"get":{"description":"Get a specific contract by its id. If you wish to retrieve a Contract by its ident you can query itby using rsql: GET /contracts?search=contractIdent=={{contractIdent}}.","operationId":"retrieveContract","parameters":[{"in":"path","name":"contractId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Whether the contract should be returned in slim variant (having no fields for attachments and purchase items).","in":"query","name":"slimResponse","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ContractSlimDto"},{"$ref":"#/components/schemas/ContractDto"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve contract","tags":["Contracts"]},"patch":{"description":"Updates an existing contract by its id based on the request.\nShall not be used in the way to add plan reference, start and end date in combination to expect starting a subscription.","operationId":"updateContract","parameters":[{"in":"path","name":"contractId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Update contract","tags":["Contracts"]}},"/v2/contracts/{contractId}/billableitems":{"get":{"description":"Returns a list of 100 billable items from a specific contract. Billable items are sorted in descending order by billableItemId. This can be changed with the optional direction and orderBy parameters.","operationId":"queryBillableItems_1","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"billableItemId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"billableItemId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}},{"in":"path","name":"contractId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BillableItemResponse"},"type":"array"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query billable items","tags":["Contracts"]}},"/v2/contracts/{contractId}/billableitems/{billableItemId}":{"get":{"description":"Returns a single billable item from a specific contract.","operationId":"retrieveBillableItem","parameters":[{"in":"path","name":"billableItemId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"path","name":"contractId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillableItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve billable item","tags":["Contracts"]}},"/v2/contracts/{contractId}/creditbillableitems":{"post":{"deprecated":true,"description":"| &#x26A0; <b>This operation has been deprecated and will be removed in the future!</b> &#x26A0;<br>Reason: Credit billable item have been replaced by new endpoint.<br>There is no replacement for this operation. |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Deprecated since: 2025-07-15<br><p style='color:red;font-weight:bold'>Sunset at the latest: 2026-07-14</p>                                                                                                        |\n| Please refer to our \"API Lifecycle Management\" and our \"API Migration Guide\" to find out more.                                                                                                                    |\nThis endpoint can be used to credit part of an existing debit billable item. Doing so will ensure the internal references between the billable items are correct. Only to be used to correct option based items. For Line Item corrections please use the Line Item functionalities.","operationId":"createCreditBillableItem","parameters":[{"in":"path","name":"contractId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditBillableItemCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillableItemResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Create credit billable item","tags":["Contracts (deprecated)"]}},"/v2/contracts/{ident}/attachments":{"get":{"description":"Search for attachments.","operationId":"queryAttachments_1","parameters":[{"description":"The ident of the contract.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==item-456","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAttachmentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query attachments","tags":["Contracts"]},"post":{"description":"Add an attachment.","operationId":"addAttachment_1","parameters":[{"description":"The unique identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_256644","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"}}}},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add attachment","tags":["Contracts"]}},"/v2/contracts/{ident}/attachments/{fileName}":{"delete":{"description":"Delete an attachment","operationId":"removeAttachment_1","parameters":[{"description":"The unique identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_256644","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"in":"path","name":"fileName","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Delete attachment","tags":["Contracts"]},"get":{"description":"Download the attachment","operationId":"getAttachment_1","parameters":[{"description":"The unique identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_contractIdent_256644","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"in":"path","name":"fileName","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"format":"binary","type":"string"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve attachment","tags":["Contracts"]}},"/v2/customer-configs":{"get":{"description":"Retrieve all customer configs for the tenant","operationId":"getCustomerConfigs","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'desc'.\nDefault sorting criteria: 'customerIdent'.","in":"query","name":"sort","schema":{"default":["customerIdent"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseCustomerConfigResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Retrieve all customer configs for the tenant","tags":["Customers"]}},"/v2/customer-configs/{customerIdent}":{"get":{"description":"Retrieves the customer config for the specified customerIdent-parameter.","operationId":"getCustomerConfig","parameters":[{"description":"The unique identifier of the customer.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"customerIdent","required":true,"schema":{"description":"The unique identifier of the customer.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerConfigResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Retrieve customer config for a specific customer","tags":["Customers"]},"put":{"description":"Updates the customer config for the specified customerIdent-parameter.","operationId":"updateCustomerConfig","parameters":[{"description":"The unique identifier of the customer.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"customerIdent","required":true,"schema":{"description":"The unique identifier of the customer.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerConfigUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerConfigResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Update customer config for a specific customer","tags":["Customers"]}},"/v2/documents/{documentIdent}/actions/reissue":{"post":{"description":"Reissue a specific document to have that document updated with corrected data. Within a Reissue, a document can be corrected because of the wrong invoice- or shipping address. Generally, a reissue leads always to a credit note that includes the reversed data from the corrected document and a new invoice with corrected data as the correction invoice. You can perform a reissue with new data in the request or update the customer data beforehand, but you cannot reissue the same document twice. Furthermore, the new address data sent in the request will not only update the address for the correction invoice but also update the address in the customer data. In case of shipping address correction, if the reissue address does not have a shipping address, a new shipping address will be created for the customer. The reissue can be also used to perform some template changes that are made beforehand and should be reflected on the correction invoice.","operationId":"reissuedocument","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentReissueRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-document-management-write"]}],"summary":"Reissue document","tags":["Invoices"]}},"/v2/documents/{documentIdent}/corrections":{"post":{"description":"Create a document correction by referencing a document ident and specifying item corrections.","operationId":"createDocumentCorrection","parameters":[{"description":"The ident of the document (e.g. invoice) the correction belongs to.","example":"inv_12345","in":"path","name":"documentIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCorrectionRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-document-management-write"]}],"summary":"Create a correction for a document","tags":["Invoices"]}},"/v2/documents/{documentIdent}/corrections/items":{"get":{"description":"Returns correctionability information per document item. If corrections are not supported for an item (currently only Onetime & Recurring), correctionSupported is false and amounts are returned as 0.","operationId":"retrieveDocumentCorrectionItems","parameters":[{"description":"The ident of the document (e.g. invoice) the correction belongs to.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"inv_12345","in":"path","name":"documentIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCorrectionItemsResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-document-management-read"]}],"summary":"Retrieve correctionability for all document items","tags":["Invoices"]}},"/v2/documents/{documentIdent}/corrections/{correctionIdent}":{"get":{"description":"Retrieve a document correction by document ident and correction ident (the unique external reference from creation).","operationId":"retrieveDocumentCorrection","parameters":[{"description":"The ident of the document (e.g. invoice) the correction belongs to.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"inv_12345","in":"path","name":"documentIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The unique identifier of the correction specified by the creation request.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"isx_correctionIdent_12345","in":"path","name":"correctionIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCorrectionDetailResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-document-management-read"]}],"summary":"Retrieve document correction","tags":["Invoices"]}},"/v2/orders":{"post":{"description":"Creates a new Order, for more information visit https://docs.nitrobox.io/docs/order-management-1","operationId":"createOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Create order","tags":["Orders"]}},"/v2/orders/actions/cancel":{"post":{"description":"Request to cancel multiple orders by it´s Ident. This will cancel the whole order with all regarding items.The cancellation of the order will lead to a creditnote document.","operationId":"cancelOrders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCancellationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel orders","tags":["Orders"]}},"/v2/orders/pageable":{"get":{"description":"Returns list with 100 orders. Orders are sorted by default in descending order by contractId. This can be changed with the optional direction and orderBy parameters.","operationId":"queryOrdersPageable","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"contractId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"contractId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOrderDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query orders","tags":["Orders"]}},"/v2/orders/{ident}/attachments":{"get":{"description":"Search for attachments.","operationId":"queryAttachments","parameters":[{"description":"The ident of the order.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_orderIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==item-456","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAttachmentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query attachments","tags":["Orders"]},"post":{"description":"Add an attachment.","operationId":"addAttachment","parameters":[{"description":"The unique identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_orderIdent_256644","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"}}}},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add attachment","tags":["Orders"]}},"/v2/orders/{ident}/attachments/{fileName}":{"delete":{"description":"Delete an attachment","operationId":"removeAttachment","parameters":[{"description":"The unique identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_orderIdent_256644","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"in":"path","name":"fileName","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Delete attachment","tags":["Orders"]},"get":{"description":"Download the attachment","operationId":"getAttachment","parameters":[{"description":"The unique identifier.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_orderIdent_256644","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"in":"path","name":"fileName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"binary","type":"string"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve attachment","tags":["Orders"]}},"/v2/orders/{orderIdent}":{"get":{"description":"Get a specific order by it´s ident.","operationId":"retrieveOrder","parameters":[{"description":"The unique identifier of an order, given by the Tenant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_orderIdent_256644","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve order","tags":["Orders"]},"patch":{"description":"Update order details","operationId":"updateOrder","parameters":[{"description":"The unique identifier of an order, given by the Tenant.","in":"path","name":"orderIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Update order","tags":["Orders"]}},"/v2/orders/{orderIdent}/actions/cancel":{"post":{"description":"Request to cancel a full order by it´s Ident. This will cancel the whole order with all its items.The cancellation of the order will lead to a creditnote document.","operationId":"cancelOrder","parameters":[{"description":"The unique identifier of an order, given by the Tenant.","example":"nbx_OrderIdent_334451","in":"path","name":"orderIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel order","tags":["Orders"]}},"/v2/orders/{orderIdent}/actions/prepare-documents":{"post":{"description":"Request to invoice all Line Items that where not billed immediately but are waiting for confirmation before they can be billed.","operationId":"prepareOrderDocuments","parameters":[{"description":"The unique identifier of an order.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_orderIdent_256644","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Prepare document creation for entire order","tags":["Orders"]}},"/v2/orders/{orderIdent}/actions/retry-failed-billable-items":{"post":{"description":"A request to retrigger all failed billable items of an order. Some failed billable items might need manual work before they can be retried.","operationId":"retryFailedBillableItems","parameters":[{"description":"Retries all failed billable items for the given order","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Retry failed billable items","tags":["Orders"]}},"/v2/orders/{orderIdent}/agreedDeposits":{"get":{"description":"Query agreed deposits directly on order","operationId":"getAgreedDepositsOfOrder","parameters":[{"description":"The unique identifier of an order","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOrderAgreedDepositResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query agreed order deposits","tags":["Orders"]},"post":{"description":"A request to add new agreed deposits to an existing order.","operationId":"addOrderAgreedDeposits","parameters":[{"description":"The unique identifier of an order, given by the Tenant.","in":"path","name":"orderIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderAgreedDepositCreationRequest"},"type":"array"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderAgreedDepositResponse"},"type":"array"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add multiple order agreed deposits","tags":["Orders"]}},"/v2/orders/{orderIdent}/agreedDeposits/{agreedDepositIdent}":{"delete":{"description":"A request to delete one agreed deposit assigned to an order.","operationId":"deleteOrderAgreedDeposits","parameters":[{"description":"The unique identifier of the order for which the agreed deposit should be deleted","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"The unique identifier of the order agreed deposit that should be deleted","example":"nbx_order_agreed_deposit_12345","in":"path","name":"agreedDepositIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Delete an agreed deposit that is assigned to an order","tags":["Orders"]},"put":{"description":"A request to delete one agreed deposit assigned to an order.","operationId":"updateOrderAgreedDeposits","parameters":[{"description":"The unique identifier of the order for which the agreed deposit should be deleted","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"The unique identifier of the order agreed deposit that should be updated","example":"nbx_order_agreed_deposit_12345","in":"path","name":"agreedDepositIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderAgreedDepositUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderAgreedDepositResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Update an agreed deposit that is assigned to an order","tags":["Orders"]}},"/v2/orders/{orderIdent}/allowances":{"post":{"description":"A request to add new allowances to an existing order.","operationId":"addAllowances","parameters":[{"description":"The unique identifier of an order, given by the Tenant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AllowanceCreationRequest"},"type":"array"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AllowanceResponse"},"type":"array"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add allowances","tags":["Orders"]}},"/v2/orders/{orderIdent}/allowances/actions/cancel":{"post":{"description":"Cancel allowances with given idents. Processed items will be credited, for unprocessed items the item will never be processed. Cancellation cant be reverted.","operationId":"cancelAllowances","parameters":[{"description":"The unique identifier of an order, given by the Tenant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowanceCancellationRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel allowances","tags":["Orders"]}},"/v2/orders/{orderIdent}/allowances/{allowanceIdent}":{"put":{"description":"A request to update a existing allowance.","operationId":"updateAllowance","parameters":[{"description":"The unique identifier of an order, given by the Tenant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the allowance to update.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_Ident_256644","in":"path","name":"allowanceIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowanceUpdateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowanceResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Update allowances","tags":["Orders"]}},"/v2/orders/{orderIdent}/billableitems":{"get":{"description":"Returns a list of up to 100 billable items from a specific Order. Billable items are sorted in descending order by billableItemId. This can be changed with the optional direction and orderBy parameters.","operationId":"queryBillableItems","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"billableItemId=gt=554439","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N). Defines the index of the displayed page.","in":"query","name":"pageNumber","schema":{"example":0,"type":"integer"}},{"description":"Defines the number of objects per page to be returned.","in":"query","name":"pageSize","schema":{"example":100,"type":"integer"}},{"description":"Defines the criteria by which the result is ordered.","in":"query","name":"orderBy","schema":{"example":"billableItemId","type":"string"}},{"description":"Defines the direction of the ordered response. Default order is ascending.","in":"query","name":"direction","schema":{"items":{"type":"string"},"type":"array"}},{"description":"The unique identifier of an order, given by the Tenant.","in":"path","name":"orderIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BillableItemResponse"},"type":"array"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query billable items","tags":["Orders"]}},"/v2/orders/{orderIdent}/billableitems/{billableItemId}":{"get":{"description":"Returns a single billable item by it´s ID from a specific order.","operationId":"retrieveBillableItem_1","parameters":[{"description":"The unique internal identifier for the billable item.","in":"path","name":"billableItemId","required":true,"schema":{"example":354728,"type":"string"}},{"description":"The unique identifier of an order, given by the Tenant.","in":"path","name":"orderIdent","required":true,"schema":{"example":"nbx_OrderIdent_334428","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillableItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve billable item","tags":["Orders"]}},"/v2/orders/{orderIdent}/lineItems":{"get":{"description":"Search for line items.","operationId":"getAllLineItems","parameters":[{"description":"The ident of the order to add a line item","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==item-456","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"id","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOrderLineItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query line items","tags":["Orders"]},"post":{"description":"A request to add new line items to an existing order.","operationId":"addLineItem","parameters":[{"description":"The unique identifier of an order, given by the Tenant.","in":"path","name":"orderIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderLineItemCreationRequest"},"type":"array"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderLineItemResponse"},"type":"array"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add line item","tags":["Orders"]}},"/v2/orders/{orderIdent}/lineItems/actions/cancel":{"post":{"description":"Cancel line items with given idents. Processed items will be credited, for unprocessed items the item will never be processed. Cancellation cant be reverted.","operationId":"cancelLineItems","parameters":[{"description":"The ident of the order to cancel line items","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemsCancellationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCancellationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel line items","tags":["Orders"]}},"/v2/orders/{orderIdent}/lineItems/actions/prepare-documents":{"post":{"description":"Request to invoice all provided Line Items that are \"on hold\". Fails is a line item reference is provided that has been billed or canceled.","operationId":"prepareOrderLineItemDocuments","parameters":[{"description":"The unique identifier of an order, given by the Tenant.","in":"path","name":"orderIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemPrepareDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Prepare document creation for certain items","tags":["Orders (deprecated)"]}},"/v2/orders/{orderIdent}/lineItems/actions/set-on-hold":{"post":{"description":"Sets multiple non-billed line items on hold for the order given.","operationId":"setOrderLineItemsOnHold","parameters":[{"description":"The ident of the order to set line items on hold","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemOnHoldRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderLineItemResponse"},"type":"array"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Hold line items for order","tags":["Orders (deprecated)"]}},"/v2/orders/{orderIdent}/lineItems/{lineItemIdent}":{"get":{"description":"Get a specific line item from a order by it´s ident.","operationId":"retrieveLineItem","parameters":[{"description":"The ident of the order to add a line item","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"description":"The unique identifier of an line item, given by the Tenant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_lineItemIdent_256644","in":"path","name":"lineItemIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderLineItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve line item","tags":["Orders"]},"put":{"description":"A request to edit an existing line item within an order.","operationId":"editLineItem","parameters":[{"description":"The ident of the order to edit a line item","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"in":"path","name":"lineItemIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderLineItemUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderLineItemResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Edit line item","tags":["Orders"]}},"/v2/orders/{orderIdent}/lineItems/{lineItemIdent}/agreedDeposits":{"get":{"description":"Search for agreed deposits.","operationId":"queryAgreedDepositsOfLineItem","parameters":[{"description":"The ident of the order to add aline item","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"in":"path","name":"lineItemIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"optionIdent-456","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAgreedDepositResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query agreed deposits of line item","tags":["Orders"]},"post":{"description":"A request to add new agreed deposits to line items to an existing contract.","operationId":"addAgreedDepositsToLineItem","parameters":[{"description":"The ident of the order to add aline item","example":"nbx_orderIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"in":"path","name":"lineItemIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AgreedDepositCreationRequest"},"type":"array"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderLineItemResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Add agreed deposit to line item","tags":["Orders"]}},"/v2/orders/{orderIdent}/lineItems/{lineItemIdent}/agreedDeposits/{agreedDepositIdent}":{"delete":{"description":"Delete agreed deposit by ident. Deletion can't be reverted.","operationId":"deleteAgreedDeposit","parameters":[{"description":"The ident for the Order of the Line Item with the Agreed Deposit","example":"nbx_contractIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"in":"path","name":"lineItemIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"agreedDepositIdent","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Delete agreed deposit of line item","tags":["Orders"]},"put":{"description":"A request to update agreed deposits to line items to an existing contract.","operationId":"updateAgreedDeposit","parameters":[{"description":"The ident for the Order of the Line Item with the Agreed Deposit","example":"nbx_contractIdent_12345","in":"path","name":"orderIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]+","type":"string"}},{"in":"path","name":"lineItemIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"agreedDepositIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreedDepositUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgreedDepositResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Update agreed deposit of line item","tags":["Orders"]}},"/v2/plans":{"post":{"description":"A request to create a new plan.\nA plan is the basis for a contract with recurring payments. It is not assigned to a specific debtorId and can be used across multiple contracts like a template. After a contract is assigned to a plan with phases and options, usages are created which result in billable items for the debtor.\nCreating options while creating a plan is deprecated: Use the Option API instead to manage Options and reference them when creating a plan.","operationId":"createPlan_v2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Create plan","tags":["Plans and Options"]}},"/v2/plans/pageable":{"get":{"description":"The plan list is sorted in descending order by the planId. The sorted order can be changed with help of the optional direction and orderBy parameters.","operationId":"getAllPlansPageable_v2","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"planId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"planId","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePlanDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Query plans","tags":["Plans and Options"]}},"/v2/plans/{planIdent}/migration-paths":{"get":{"description":"Find migration paths matching the given RSQL query, or all if the query is empty.","operationId":"queryMigrationPaths","parameters":[{"description":"The ident of the source plan for the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_planIdent_12345","in":"path","name":"planIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseMigrationPathResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Query migration paths","tags":["preview"]},"post":{"description":"Create a migration path with the given properties.","operationId":"createMigrationPath","parameters":[{"description":"The ident of the source plan for the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_planIdent_12345","in":"path","name":"planIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationPathCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationPathResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Create migration path","tags":["preview"]}},"/v2/plans/{planIdent}/migration-paths/{ident}":{"delete":{"description":"Delete the migration path identified by source plan and ident.","operationId":"deleteMigrationPath","parameters":[{"description":"The ident of the source plan for the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_planIdent_12345","in":"path","name":"planIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_migrationPathIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Delete migration path","tags":["preview"]},"get":{"description":"Retrieve the migration path identified by source plan and its ident.","operationId":"retrieveMigrationPath","parameters":[{"description":"The ident of the source plan for the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_planIdent_12345","in":"path","name":"planIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_migrationPathIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationPathResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Retrieve migration path","tags":["preview"]},"put":{"description":"Update the migration path identified by the source plan and its ident property. The source plan and ident properties can never be updated.","operationId":"updateMigrationPath","parameters":[{"description":"The ident of the source plan for the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_planIdent_12345","in":"path","name":"planIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"The ident of the migration path.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"nbx_migrationPathIdent_12345","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationPathUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationPathResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Update a migration path","tags":["preview"]}},"/v2/plans/{planIdent}/phases/{phaseIdent}/options":{"post":{"description":"Request to add options to a phase of a plan. Unless an option is enforced to be enabled by using enableForAllContracts (only possible for usage and rated usage options), it will be non-mandatory.\n","operationId":"addOption_v2","parameters":[{"in":"path","name":"planIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"phaseIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PhaseOptionCreationRequest"},"type":"array"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Add options to a phase of a plan","tags":["Plans and Options"]}},"/v2/plans/{planId}":{"delete":{"description":"Request to delete a plan. If a plan holds a contract, it is not possible to delete the plan.","operationId":"deletePlan_v2","parameters":[{"in":"path","name":"planId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Delete plan","tags":["Plans and Options"]},"get":{"description":"Get a specific plan by it´s id.","operationId":"getPlan_v2","parameters":[{"in":"path","name":"planId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Retrieve plan","tags":["Plans and Options"]},"put":{"description":"Request to update a plan. If a plan holds an active contract then update is limited tothe plan name and its properties - to be propagated for all future documents.","operationId":"createPlan_v2_1","parameters":[{"in":"path","name":"planId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Update plan","tags":["Plans and Options"]}},"/v2/price-adaptations":{"get":{"description":"Returns a list of price adaptation matching specified query. Price Adaptations are sorted in descending order by createdAt. This can be changed with the optional direction and orderBy parameter.\n","operationId":"queryPriceAdaptation","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"name=eq=price-adaptation-name","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 100.","in":"query","name":"size","schema":{"default":100,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'desc'.\nDefault sorting criteria: 'createdAt'.","in":"query","name":"sort","schema":{"default":["createdAt"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePriceAdaptationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Query price adaptation","tags":["Price Adaptations"]},"post":{"description":"Create price adaptation","operationId":"createPriceAdaptation","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationCreationRequest"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationResponse"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Create price adaptation","tags":["Price Adaptations"]}},"/v2/price-adaptations/{ident}":{"delete":{"description":"Delete price adaptation","operationId":"deletePriceAdaptation","parameters":[{"description":"Price adaptation ident.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"price-adaptation-ident","in":"path","name":"ident","required":true,"schema":{"description":"Price adaptation ident","example":"price-adaptation-ident","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Delete price adaptation","tags":["Price Adaptations"]},"get":{"description":"Retrieve price adaptation","operationId":"retrievePriceAdaptation","parameters":[{"description":"Price adaptation ident.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"price-adaptation-ident","in":"path","name":"ident","required":true,"schema":{"description":"Price adaptation ident","example":"price-adaptation-ident","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationResponse"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Retrieve price adaptation","tags":["Price Adaptations"]}},"/v2/price-adaptations/{ident}/values":{"get":{"description":"Query price adaptation values","operationId":"queryPriceAdaptationValue","parameters":[{"description":"Price adaptation ident.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"price-adaptation-ident","in":"path","name":"ident","required":true,"schema":{"description":"Price adaptation ident","example":"price-adaptation-ident","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'desc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePriceAdaptationValueResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Query price adaptation values","tags":["Price Adaptations"]},"post":{"description":"Create price adaptation value","operationId":"createPriceAdaptationValue","parameters":[{"description":"Price adaptation ident.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"price-adaptation-ident","in":"path","name":"ident","required":true,"schema":{"description":"Price adaptation ident","example":"price-adaptation-ident","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueCreationRequest"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueResponse"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Create price adaptation value","tags":["Price Adaptations"]}},"/v2/price-adaptations/{ident}/values/{valueIdent}":{"delete":{"description":"Delete price adaptations value","operationId":"deletePriceAdaptationValue","parameters":[{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"valueIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Delete price adaptations value","tags":["Price Adaptations"]},"get":{"description":"Retrieve price adaptations value","operationId":"retrievePriceAdaptationValue","parameters":[{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"ident","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"valueIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueResponse"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-read"]}],"summary":"Retrieve price adaptations value","tags":["Price Adaptations"]},"put":{"description":"Update price adaptations value","operationId":"updatePriceAdaptationValue","parameters":[{"description":"Price adaptation ident.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"price-adaptation-ident","in":"path","name":"ident","required":true,"schema":{"description":"Price adaptation ident","example":"price-adaptation-ident","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"valueIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueUpdateRequest"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndexPriceAdaptationValueResponse"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-product-management-write"]}],"summary":"Update price adaptations value","tags":["Price Adaptations"]}},"/v2/usages":{"delete":{"description":"Delete usages of contract, this will completely remove them from our system. Usages can be deleted as long they haven't been billed yet.","operationId":"deleteUsages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDeletionRequest"}}},"required":true},"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Delete usages","tags":["Usages"]},"post":{"operationId":"createUsage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Create usage","tags":["Usages"]}},"/v2/usages/actions/cancel":{"post":{"description":"Cancellation of multiple unpooled usages that must all be assigned to the same contract. Additionally either all usages must be processed, or all of them must be unprocessed.","operationId":"batchCancelUsages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageCancellationBatchRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageCancellationBatchResponse"}}},"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-write"]}],"summary":"Cancel usages","tags":["Usages"]}},"/v2/usages/pageable":{"get":{"description":"Returns list with 100 usages. Usages are sorted in descending order by usageId. This can be changed with the optional direction and orderBy parameters.","operationId":"queryUsages","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"contractId=gt=160","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 100.","in":"query","name":"size","schema":{"default":100,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'desc'.\nDefault sorting criteria: 'usageId'.","in":"query","name":"sort","schema":{"default":["usageId"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseUsageDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Query usages","tags":["Usages"]}},"/v2/usages/{usageId}":{"get":{"operationId":"getUsage","parameters":[{"in":"path","name":"usageId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-contract-order-management-read"]}],"summary":"Retrieve usage","tags":["Usages"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for preview","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"preview"},{"description":"endpoints for Billing Groups","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Billing Groups"},{"description":"endpoints for Orders","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Orders"},{"description":"endpoints for Plans and Options","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Plans and Options"},{"description":"endpoints for Contracts","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Contracts"},{"description":"endpoints for Usages","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Usages"},{"description":"endpoints for Billable Items","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Billable Items"},{"description":"endpoints for Invoices","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Invoices"},{"description":"endpoints for Price Adaptations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Price Adaptations"},{"description":"endpoints for Customers","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Customers"},{"description":"endpoints for Orders (deprecated)","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Orders (deprecated)"},{"description":"endpoints for Contracts (deprecated)","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Contracts (deprecated)"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}