GetBillingEntityDetailsResponse
Properties
-
data(['object', 'null'])Billing entity detail data. Cannot contain additional properties.id(['string', 'null'])Billing entity identifier.parentId(['string', 'null'])Parent billing entity identifier.-
addresses(['array', 'null'])Full list of addresses.-
Items (object)Cannot contain additional properties.
address1(['string', 'null'])Address line 1.address2(['string', 'null'])Address line 2.address3(['string', 'null'])Address line 3.city(['string', 'null'])City.code(['string', 'null'])Address code.company(['string', 'null'])Company name.country(['string', 'null'])Country.emailAddress(['string', 'null'])Email address.faxNumber(['string', 'null'])Fax number.name(['string', 'null'])Address name.phoneNumber(['string', 'null'])Phone number.postalCode(['string', 'null'])Postal code.stateProvince(['string', 'null'])State or province.
-
-
customerSince(['string', 'null'])Customer since date. defaultBillToAddressCode(['string', 'null'])Default bill-to address code.defaultShipToAddressCode(['string', 'null'])Default ship-to address code.name(['string', 'null'])Billing entity name.status(['string', 'null'])Billing entity status.
-
failureMessages(array)- Items (string)
-
informationalMessages(array)- Items (string)
-
operationWasSuccessful(boolean)
Examples
{
"data": {
"id": "BE-001",
"parentId": null,
"addresses": [
{
"address1": "123 Main St",
"city": "Springfield",
"code": "MAIN",
"country": "US",
"name": "Main Office",
"postalCode": "12345",
"stateProvince": "IL"
},
{
"address1": "456 Ship St",
"city": "Springfield",
"code": "SHIP",
"country": "US",
"name": "Shipping Warehouse",
"postalCode": "12346",
"stateProvince": "IL"
}
],
"customerSince": "2020-01-15T00:00:00Z",
"defaultBillToAddressCode": "MAIN",
"defaultShipToAddressCode": "SHIP",
"name": "Main Billing Entity",
"status": "Active"
},
"failureMessages": [],
"informationalMessages": [],
"operationWasSuccessful": true
}
Quicktype Command
quicktype \
--framework SystemTextJson \
--lang cs \
--number-type double \
--src-lang schema \
--no-check-required \
--density dense \
--features complete \
--namespace OtpSchema.Api.CustomerBroker.GetBillingEntityDetailsResponse \
--src .working/build/internal/json-schema-for-cs/GetBillingEntityDetailsResponse.json -o .working/build/internal/csharp/OtpSchema/Api/CustomerBroker/GetBillingEntityDetailsResponse.cs
GetBillingEntityDetailsResponse
// <auto-generated />
//
// To parse this JSON data, add NuGet 'System.Text.Json' then do:
//
// using OtpSchema.Api.CustomerBroker.GetBillingEntityDetailsResponse;
//
// var getBillingEntityDetailsResponse = GetBillingEntityDetailsResponse.FromJson(jsonString);
#nullable enable
#pragma warning disable CS8618
#pragma warning disable CS8601
#pragma warning disable CS8603
namespace OtpSchema.Api.CustomerBroker.GetBillingEntityDetailsResponse
{
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Globalization;
using J = System.Text.Json.Serialization.JsonPropertyNameAttribute;
using N = System.Text.Json.Serialization.JsonIgnoreCondition;
public partial class GetBillingEntityDetailsResponse
{
[J("data")] public Data Data { get; set; } // Billing entity detail data.
[J("failureMessages")] public string[]? FailureMessages { get; set; }
[J("informationalMessages")] public string[]? InformationalMessages { get; set; }
[J("operationWasSuccessful")] public bool OperationWasSuccessful { get; set; }
}
public partial class Data
{
[J("addresses")] public Address[]? Addresses { get; set; } // Full list of addresses.
[J("customerSince")] public string CustomerSince { get; set; } // Customer since date.
[J("defaultBillToAddressCode")] public string DefaultBillToAddressCode { get; set; } // Default bill-to address code.
[J("defaultShipToAddressCode")] public string DefaultShipToAddressCode { get; set; } // Default ship-to address code.
[J("id")] public string Id { get; set; } // Billing entity identifier.
[J("name")] public string Name { get; set; } // Billing entity name.
[J("parentId")] public string ParentId { get; set; } // Parent billing entity identifier.
[J("status")] public string Status { get; set; } // Billing entity status.
}
public partial class Address
{
[J("address1")] public string Address1 { get; set; } // Address line 1.
[J("address2")] public string Address2 { get; set; } // Address line 2.
[J("address3")] public string Address3 { get; set; } // Address line 3.
[J("city")] public string City { get; set; } // City.
[J("code")] public string Code { get; set; } // Address code.
[J("company")] public string Company { get; set; } // Company name.
[J("country")] public string Country { get; set; } // Country.
[J("emailAddress")] public string EmailAddress { get; set; } // Email address.
[J("faxNumber")] public string FaxNumber { get; set; } // Fax number.
[J("name")] public string Name { get; set; } // Address name.
[J("phoneNumber")] public string PhoneNumber { get; set; } // Phone number.
[J("postalCode")] public string PostalCode { get; set; } // Postal code.
[J("stateProvince")] public string StateProvince { get; set; } // State or province.
}
public partial class GetBillingEntityDetailsResponse
{
public static GetBillingEntityDetailsResponse FromJson(string json) => JsonSerializer.Deserialize<GetBillingEntityDetailsResponse>(json, OtpSchema.Api.CustomerBroker.GetBillingEntityDetailsResponse.Converter.Settings);
}
public static class Serialize
{
public static string ToJson(this GetBillingEntityDetailsResponse self) => JsonSerializer.Serialize(self, OtpSchema.Api.CustomerBroker.GetBillingEntityDetailsResponse.Converter.Settings);
}
internal static class Converter
{
public static readonly JsonSerializerOptions Settings = new(JsonSerializerDefaults.General)
{
Converters =
{
new DateOnlyConverter(),
new TimeOnlyConverter(),
IsoDateTimeOffsetConverter.Singleton
},
};
}
public class DateOnlyConverter : JsonConverter<DateOnly>
{
private readonly string serializationFormat;
public DateOnlyConverter() : this(null) { }
public DateOnlyConverter(string? serializationFormat)
{
this.serializationFormat = serializationFormat ?? "yyyy-MM-dd";
}
public override DateOnly Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
var value = reader.GetString();
return DateOnly.Parse(value!);
}
public override void Write(Utf8JsonWriter writer, DateOnly value, JsonSerializerOptions options)
=> writer.WriteStringValue(value.ToString(serializationFormat));
}
public class TimeOnlyConverter : JsonConverter<TimeOnly>
{
private readonly string serializationFormat;
public TimeOnlyConverter() : this(null) { }
public TimeOnlyConverter(string? serializationFormat)
{
this.serializationFormat = serializationFormat ?? "HH:mm:ss.fff";
}
public override TimeOnly Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
var value = reader.GetString();
return TimeOnly.Parse(value!);
}
public override void Write(Utf8JsonWriter writer, TimeOnly value, JsonSerializerOptions options)
=> writer.WriteStringValue(value.ToString(serializationFormat));
}
internal class IsoDateTimeOffsetConverter : JsonConverter<DateTimeOffset>
{
public override bool CanConvert(Type t) => t == typeof(DateTimeOffset);
private const string DefaultDateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK";
private DateTimeStyles _dateTimeStyles = DateTimeStyles.RoundtripKind;
private string? _dateTimeFormat;
private CultureInfo? _culture;
public DateTimeStyles DateTimeStyles
{
get => _dateTimeStyles;
set => _dateTimeStyles = value;
}
public string? DateTimeFormat
{
get => _dateTimeFormat ?? string.Empty;
set => _dateTimeFormat = (string.IsNullOrEmpty(value)) ? null : value;
}
public CultureInfo Culture
{
get => _culture ?? CultureInfo.CurrentCulture;
set => _culture = value;
}
public override void Write(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options)
{
string text;
if ((_dateTimeStyles & DateTimeStyles.AdjustToUniversal) == DateTimeStyles.AdjustToUniversal
|| (_dateTimeStyles & DateTimeStyles.AssumeUniversal) == DateTimeStyles.AssumeUniversal)
{
value = value.ToUniversalTime();
}
text = value.ToString(_dateTimeFormat ?? DefaultDateTimeFormat, Culture);
writer.WriteStringValue(text);
}
public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
string? dateText = reader.GetString();
if (string.IsNullOrEmpty(dateText) == false)
{
if (!string.IsNullOrEmpty(_dateTimeFormat))
{
return DateTimeOffset.ParseExact(dateText, _dateTimeFormat, Culture, _dateTimeStyles);
}
else
{
return DateTimeOffset.Parse(dateText, Culture, _dateTimeStyles);
}
}
else
{
return default(DateTimeOffset);
}
}
public static readonly IsoDateTimeOffsetConverter Singleton = new IsoDateTimeOffsetConverter();
}
}
#pragma warning restore CS8618
#pragma warning restore CS8601
#pragma warning restore CS8603
GetBillingEntityDetailsResponse
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetBillingEntityDetailsResponse.json",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"description": "Billing entity detail data.",
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"id": { "description": "Billing entity identifier.", "type": ["string", "null"] },
"parentId": {
"description": "Parent billing entity identifier.",
"type": ["string", "null"]
},
"addresses": {
"description": "Full list of addresses.",
"type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"address1" : { "description": "Address line 1." , "type": ["string", "null"] },
"address2" : { "description": "Address line 2." , "type": ["string", "null"] },
"address3" : { "description": "Address line 3." , "type": ["string", "null"] },
"city" : { "description": "City." , "type": ["string", "null"] },
"code" : { "description": "Address code." , "type": ["string", "null"] },
"company" : { "description": "Company name." , "type": ["string", "null"] },
"country" : { "description": "Country." , "type": ["string", "null"] },
"emailAddress" : { "description": "Email address." , "type": ["string", "null"] },
"faxNumber" : { "description": "Fax number." , "type": ["string", "null"] },
"name" : { "description": "Address name." , "type": ["string", "null"] },
"phoneNumber" : { "description": "Phone number." , "type": ["string", "null"] },
"postalCode" : { "description": "Postal code." , "type": ["string", "null"] },
"stateProvince": { "description": "State or province.", "type": ["string", "null"] }
}
}
},
"customerSince": { "description": "Customer since date.", "type": ["string", "null"] },
"defaultBillToAddressCode": { "description": "Default bill-to address code.", "type": ["string", "null"] },
"defaultShipToAddressCode": { "description": "Default ship-to address code.", "type": ["string", "null"] },
"name": { "description": "Billing entity name.", "type": ["string", "null"] },
"status": { "description": "Billing entity status.", "type": ["string", "null"] }
}
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
"operationWasSuccessful": {"type": "boolean"}
},
"required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"],
"examples": [
{
"data": {
"id": "BE-001",
"parentId": null,
"addresses": [
{
"address1": "123 Main St",
"city": "Springfield",
"code": "MAIN",
"country": "US",
"name": "Main Office",
"postalCode": "12345",
"stateProvince": "IL"
},
{
"address1": "456 Ship St",
"city": "Springfield",
"code": "SHIP",
"country": "US",
"name": "Shipping Warehouse",
"postalCode": "12346",
"stateProvince": "IL"
}
],
"customerSince": "2020-01-15T00:00:00Z",
"defaultBillToAddressCode": "MAIN",
"defaultShipToAddressCode": "SHIP",
"name": "Main Billing Entity",
"status": "Active"
},
"failureMessages": [],
"informationalMessages": [],
"operationWasSuccessful": true
}
]
}