Skip to content

GetBillingEntitiesResponse

Properties

  • data (['array', 'null'])Optional. Array of billing entity summary data objects.

    • Items (object)Cannot contain additional properties.

      • id (['string', 'null'], required)Unique billing entity identifier.

      • defaultBillToAddress (['object', 'null'])Optional. Default billing address for this entity. Cannot contain additional properties.

        • address1 (['string', 'null'], required)
        • address2 (['string', 'null'])
        • address3 (['string', 'null'])
        • city (['string', 'null'], required)
        • code (['string', 'null'], required)
        • company (['string', 'null'])
        • country (['string', 'null'], required)
        • emailAddress (['string', 'null'])
        • faxNumber (['string', 'null'])
        • name (['string', 'null'], required)
        • phoneNumber (['string', 'null'])
        • postalCode (['string', 'null'], required)
        • stateProvince (['string', 'null'], required)

      • defaultShipToAddress (['object', 'null'])Optional. Default shipping address for this entity. Cannot contain additional properties.

        • address1 (['string', 'null'], required)
        • address2 (['string', 'null'])
        • address3 (['string', 'null'])
        • city (['string', 'null'], required)
        • code (['string', 'null'], required)
        • company (['string', 'null'])
        • country (['string', 'null'], required)
        • emailAddress (['string', 'null'])
        • faxNumber (['string', 'null'])
        • name (['string', 'null'], required)
        • phoneNumber (['string', 'null'])
        • postalCode (['string', 'null'], required)
        • stateProvince (['string', 'null'], required)

      • name (['string', 'null'], required)Billing entity name.

  • failureMessages (array)

    • Items (string)

  • informationalMessages (array)

    • Items (string)

  • operationWasSuccessful (boolean)

Examples

{
    "data": [
        {
            "id": "BE-001",
            "defaultBillToAddress": {
                "address1": "123 Main St",
                "city": "Springfield",
                "code": "MAIN",
                "country": "US",
                "name": "Main Office",
                "postalCode": "12345",
                "stateProvince": "IL"
            },
            "defaultShipToAddress": {
                "address1": "456 Ship St",
                "city": "Springfield",
                "code": "SHIP",
                "country": "US",
                "name": "Shipping Warehouse",
                "postalCode": "12346",
                "stateProvince": "IL"
            },
            "name": "Main Billing Entity"
        }
    ],
    "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.GetBillingEntitiesResponse  \
    --src .working/build/internal/json-schema-for-cs/GetBillingEntitiesResponse.json -o .working/build/internal/csharp/OtpSchema/Api/CustomerBroker/GetBillingEntitiesResponse.cs
GetBillingEntitiesResponse
// <auto-generated />
//
// To parse this JSON data, add NuGet 'System.Text.Json' then do:
//
//    using OtpSchema.Api.CustomerBroker.GetBillingEntitiesResponse;
//
//    var getBillingEntitiesResponse = GetBillingEntitiesResponse.FromJson(jsonString);
#nullable enable
#pragma warning disable CS8618
#pragma warning disable CS8601
#pragma warning disable CS8603

namespace OtpSchema.Api.CustomerBroker.GetBillingEntitiesResponse
{
    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 GetBillingEntitiesResponse
    {
        [J("data")]                   public Datum[] Data { get; set; }                   // Optional. Array of billing entity summary data objects.
        [J("failureMessages")]        public string[] FailureMessages { get; set; }      
        [J("informationalMessages")]  public string[] InformationalMessages { get; set; }
        [J("operationWasSuccessful")] public bool OperationWasSuccessful { get; set; }   
    }

    public partial class Datum
    {
        [J("defaultBillToAddress")] public DefaultBillToAddress DefaultBillToAddress { get; set; } // Optional. Default billing address for this entity.
        [J("defaultShipToAddress")] public DefaultShipToAddress DefaultShipToAddress { get; set; } // Optional. Default shipping address for this entity.
        [J("id")]                   public string Id { get; set; }                                 // Unique billing entity identifier.
        [J("name")]                 public string Name { get; set; }                               // Billing entity name.
    }

    public partial class DefaultBillToAddress
    {
        [J("address1")]      public string Address1 { get; set; }     
        [J("address2")]      public string Address2 { get; set; }     
        [J("address3")]      public string Address3 { get; set; }     
        [J("city")]          public string City { get; set; }         
        [J("code")]          public string Code { get; set; }         
        [J("company")]       public string Company { get; set; }      
        [J("country")]       public string Country { get; set; }      
        [J("emailAddress")]  public string EmailAddress { get; set; } 
        [J("faxNumber")]     public string FaxNumber { get; set; }    
        [J("name")]          public string Name { get; set; }         
        [J("phoneNumber")]   public string PhoneNumber { get; set; }  
        [J("postalCode")]    public string PostalCode { get; set; }   
        [J("stateProvince")] public string StateProvince { get; set; }
    }

    public partial class DefaultShipToAddress
    {
        [J("address1")]      public string Address1 { get; set; }     
        [J("address2")]      public string Address2 { get; set; }     
        [J("address3")]      public string Address3 { get; set; }     
        [J("city")]          public string City { get; set; }         
        [J("code")]          public string Code { get; set; }         
        [J("company")]       public string Company { get; set; }      
        [J("country")]       public string Country { get; set; }      
        [J("emailAddress")]  public string EmailAddress { get; set; } 
        [J("faxNumber")]     public string FaxNumber { get; set; }    
        [J("name")]          public string Name { get; set; }         
        [J("phoneNumber")]   public string PhoneNumber { get; set; }  
        [J("postalCode")]    public string PostalCode { get; set; }   
        [J("stateProvince")] public string StateProvince { get; set; }
    }

    public partial class GetBillingEntitiesResponse
    {
        public static GetBillingEntitiesResponse FromJson(string json) => JsonSerializer.Deserialize<GetBillingEntitiesResponse>(json, OtpSchema.Api.CustomerBroker.GetBillingEntitiesResponse.Converter.Settings);
    }

    public static class Serialize
    {
        public static string ToJson(this GetBillingEntitiesResponse self) => JsonSerializer.Serialize(self, OtpSchema.Api.CustomerBroker.GetBillingEntitiesResponse.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

GetBillingEntitiesResponse
{
  "$schema": "http://json-schema.org/draft-07/schema#", 
  "$id": "GetBillingEntitiesResponse.json", 
  "type": "object", 
  "additionalProperties": false, 
  "properties": {
    "data": {
      "description": "Optional. Array of billing entity summary data objects.", 
      "type": ["array", "null"], 
      "items": {
        "type": "object", 
        "additionalProperties": false, 
        "properties": {
          "id": {
            "description": "Unique billing entity identifier.", 
            "type": ["string", "null"]
          }, 
          "defaultBillToAddress": {
            "description": "Optional. Default billing address for this entity.", 
            "type": ["object", "null"], 
            "additionalProperties": false, 
            "properties": {
              "address1"     : { "type": ["string", "null"] }, 
              "address2"     : { "type": ["string", "null"] }, 
              "address3"     : { "type": ["string", "null"] }, 
              "city"         : { "type": ["string", "null"] }, 
              "code"         : { "type": ["string", "null"] }, 
              "company"      : { "type": ["string", "null"] }, 
              "country"      : { "type": ["string", "null"] }, 
              "emailAddress" : { "type": ["string", "null"] }, 
              "faxNumber"    : { "type": ["string", "null"] }, 
              "name"         : { "type": ["string", "null"] }, 
              "phoneNumber"  : { "type": ["string", "null"] }, 
              "postalCode"   : { "type": ["string", "null"] }, 
              "stateProvince": { "type": ["string", "null"] }
            }, 
            "required": ["address1", "city", "code", "country", "name", "postalCode", "stateProvince"]
          }, 
          "defaultShipToAddress": {
            "description": "Optional. Default shipping address for this entity.", 
            "type": ["object", "null"], 
            "additionalProperties": false, 
            "properties": {
              "address1"     : { "type": ["string", "null"] }, 
              "address2"     : { "type": ["string", "null"] }, 
              "address3"     : { "type": ["string", "null"] }, 
              "city"         : { "type": ["string", "null"] }, 
              "code"         : { "type": ["string", "null"] }, 
              "company"      : { "type": ["string", "null"] }, 
              "country"      : { "type": ["string", "null"] }, 
              "emailAddress" : { "type": ["string", "null"] }, 
              "faxNumber"    : { "type": ["string", "null"] }, 
              "name"         : { "type": ["string", "null"] }, 
              "phoneNumber"  : { "type": ["string", "null"] }, 
              "postalCode"   : { "type": ["string", "null"] }, 
              "stateProvince": { "type": ["string", "null"] }
            }, 
            "required": ["address1", "city", "code", "country", "name", "postalCode", "stateProvince"]
          }, 
          "name": { "description": "Billing entity name.", "type": ["string", "null"] }
        }, 
        "required": ["id", "name"]
      }
    }, 
    "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", 
          "defaultBillToAddress": {
            "address1": "123 Main St", 
            "city": "Springfield", 
            "code": "MAIN", 
            "country": "US", 
            "name": "Main Office", 
            "postalCode": "12345", 
            "stateProvince": "IL"
          }, 
          "defaultShipToAddress": {
            "address1": "456 Ship St", 
            "city": "Springfield", 
            "code": "SHIP", 
            "country": "US", 
            "name": "Shipping Warehouse", 
            "postalCode": "12346", 
            "stateProvince": "IL"
          }, 
          "name": "Main Billing Entity"
        }
      ], 
      "failureMessages": [], 
      "informationalMessages": [], 
      "operationWasSuccessful": true
    }
  ]
}