• Array of: object Customer Bill
  Title: Customer Bill

  A customer bill, also called an invoice.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerBill"
    }
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• amountDue(required): object Money
  Title: Money

  An amount of money.
• appliedPayment: array appliedPayment
  Payments applied to the bill.
• billDate(required): string (date-time)
  Title: Bill Date

  The date the bill was generated.
• billDocument: array billDocument
  A document attached to the bill.
• billingAccount: object Billing Account Ref
  Title: Billing Account Ref

  A billing account is a detailed description of a bill structure.
• billingPeriod: object Time Period
  Title: Time Period

  A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
• billNo: string
  Title: Bill Number

  The bill's number.
• category: string
  Title: Bill Category

  The bill's category. For example, normal, duplicate, interim, last.
• financialAccount: object Financial Account Ref
  Title: Financial Account Ref

  A financial account reference.
• href(required): string
  Title: Bill Href

  The bill's href.
• id(required): string
  Title: Bill ID

  The bill's ID.
• lastUpdate: string (date-time)
  Title: Bill Last Updated Date

  The date that the bill was last updated.
• nextBillDate: string (date-time)
  Title: Next Bill Date

  The date the next bill will be generated.
• paymentDueDate(required): string (date-time)
  Title: Payment Due Date

  The bill's due date.
• paymentMethod: object Payment Method Ref
  Title: Payment Method Ref

  A payment method reference.
• relatedParty: array relatedParty
  The parties related to the bill.
• remainingAmount: object Money
  Title: Money

  An amount of money.
• runType: string
  Title: Bill Run Type

  The way the bill was generated, either onCycle (a regular billing cycle run) or offCycle (an on-demand request. For example, if requested by the customer or if the account closes.)
• state(required): string
  Title: State Value

  Allowed Values: [ "new", "partiallyPaid", "settled", "onHold", "inProgress" ]

  Possible values for a bill's state.
• taxExcludedAmount: object Money
  Title: Money

  An amount of money.
• taxIncludedAmount: object Money
  Title: Money

  An amount of money.
• taxItem: array taxItem
  Taxes on the bill.

{
    "type":"object",
    "title":"Customer Bill",
    "description":"A customer bill, also called an invoice.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bill ID",
            "description":"The bill's ID."
        },
        "href":{
            "type":"string",
            "title":"Bill Href",
            "description":"The bill's href."
        },
        "billDate":{
            "type":"string",
            "title":"Bill Date",
            "format":"date-time",
            "description":"The date the bill was generated."
        },
        "billNo":{
            "type":"string",
            "title":"Bill Number",
            "description":"The bill's number."
        },
        "category":{
            "type":"string",
            "title":"Bill Category",
            "description":"The bill's category. For example, <b>normal</b>, <b>duplicate</b>, <b>interim</b>, <b>last</b>."
        },
        "lastUpdate":{
            "type":"string",
            "title":"Bill Last Updated Date",
            "format":"date-time",
            "description":"The date that the bill was last updated."
        },
        "nextBillDate":{
            "type":"string",
            "title":"Next Bill Date",
            "format":"date-time",
            "description":"The date the next bill will be generated."
        },
        "paymentDueDate":{
            "type":"string",
            "title":"Payment Due Date",
            "format":"date-time",
            "description":"The bill's due date."
        },
        "runType":{
            "type":"string",
            "title":"Bill Run Type",
            "description":"The way the bill was generated, either <b>onCycle</b> (a regular billing cycle run) or <b>offCycle</b> (an on-demand request. For example, if requested by the customer or if the account closes.)"
        },
        "amountDue":{
            "description":"The amount due on the bill.",
            "$ref":"#/components/schemas/Money"
        },
        "appliedPayment":{
            "type":"array",
            "description":"Payments applied to the bill.",
            "items":{
                "$ref":"#/components/schemas/AppliedPayment"
            }
        },
        "billDocument":{
            "type":"array",
            "description":"A document attached to the bill.",
            "items":{
                "$ref":"#/components/schemas/AttachmentRefOrValue"
            }
        },
        "billingAccount":{
            "description":"The billing account related to the bill.",
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "billingPeriod":{
            "description":"The billing period for the bill.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "financialAccount":{
            "description":"The financial account related to the bill.",
            "$ref":"#/components/schemas/FinancialAccountRef"
        },
        "paymentMethod":{
            "description":"The bill's payment method.",
            "$ref":"#/components/schemas/PaymentMethodRef"
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties related to the bill.",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRef"
            }
        },
        "remainingAmount":{
            "description":"The remaining amount on the bill.",
            "$ref":"#/components/schemas/Money"
        },
        "state":{
            "description":"The bill's state.",
            "$ref":"#/components/schemas/stateValue"
        },
        "taxExcludedAmount":{
            "description":"The amount on the bill, excluding taxes.",
            "$ref":"#/components/schemas/Money"
        },
        "taxIncludedAmount":{
            "description":"The amount on the bill, including taxes.",
            "$ref":"#/components/schemas/Money"
        },
        "taxItem":{
            "type":"array",
            "description":"Taxes on the bill.",
            "items":{
                "$ref":"#/components/schemas/TaxItem"
            }
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "required":[
        "id",
        "href",
        "state",
        "billDate",
        "amountDue",
        "paymentDueDate"
    ]
}

• unit: string
  Title: Currency

  An ISO 4217 three letter currency code.
• value: number (float)
  Title: Amount

  A positive floating point number.

{
    "type":"object",
    "title":"Money",
    "properties":{
        "unit":{
            "type":"string",
            "title":"Currency",
            "description":"An ISO 4217 three letter currency code."
        },
        "value":{
            "type":"number",
            "title":"Amount",
            "description":"A positive floating point number.",
            "format":"float"
        }
    },
    "description":"An amount of money."
}

• Array of: object Applied Payment
  Title: Applied Payment

  A payment that can be assigned to a bill.

{
    "type":"array",
    "description":"Payments applied to the bill.",
    "items":{
        "$ref":"#/components/schemas/AppliedPayment"
    }
}

• Array of: object Attachment Ref Or Value
  Title: Attachment Ref Or Value

  An attachment reference or value. The baseType, type, schemaLocation and referredType properties are related to the contained object, not the AttchmentRefOrValue.

{
    "type":"array",
    "description":"A document attached to the bill.",
    "items":{
        "$ref":"#/components/schemas/AttachmentRefOrValue"
    }
}

• @baseType: string
  The super-class when sub-classing.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-schema file that defines additional attributes and relationships.
• @type: string
  The sub-class entity name when sub-classing.
• accountNumber: string
  The account number.
• href: string
  A reference for the billing account.
• id: string
  The unique ID for the billing account.
• name: string
  The name of the billing account.

{
    "type":"object",
    "title":"Billing Account Ref",
    "description":"A billing account is a detailed description of a bill structure.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique ID for the billing account."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "href":{
            "type":"string",
            "description":"A reference for the billing account."
        },
        "name":{
            "type":"string",
            "description":"The name of the billing account."
        },
        "@baseType":{
            "type":"string",
            "description":"The super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"The sub-class entity name when sub-classing."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

• endDateTime: string (date-time)
  Title: End Time Period

  The end of the time period in IETC-RFC-3339 format.
• startDateTime: string (date-time)
  Title: Start Time Period

  The start of the time period in IETC-RFC-3339 format. If you specify this, you must also specify endDateTime.

{
    "type":"object",
    "title":"Time Period",
    "properties":{
        "endDateTime":{
            "type":"string",
            "title":"End Time Period",
            "description":"The end of the time period in IETC-RFC-3339 format.",
            "format":"date-time"
        },
        "startDateTime":{
            "type":"string",
            "title":"Start Time Period",
            "description":"The start of the time period in IETC-RFC-3339 format. If you specify this, you must also specify <b>endDateTime</b>.",
            "format":"date-time"
        }
    },
    "description":"A period of time. You can specify only <b>endDateTime</b> or both <b>endDateTime</b> and <b>startDateTime</b>."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• accountBalance: object Account Balance
  Title: Account Balance

  A balance associated with an account.
• href: string
  Title: Financial Account Href

  The account's href.
• id(required): string
  Title: Financial Account ID

  The account's ID.
• name: string
  Title: Financial Account Name

  The account's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Financial Account Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Financial Account ID",
            "description":"The account's ID."
        },
        "href":{
            "type":"string",
            "title":"Financial Account Href",
            "description":"The account's href."
        },
        "name":{
            "type":"string",
            "title":"Financial Account Name",
            "description":"The account's name."
        },
        "accountBalance":{
            "description":"The account's balance.",
            "$ref":"#/components/schemas/AccountBalance"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A financial account reference."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string
  Title: Payment Method Href

  The payment method's href.
• id(required): string
  Title: Payment Method ID

  The payment method's ID.
• name: string
  Title: Payment Method Name

  The payment method's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Payment Method Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment Method ID",
            "description":"The payment method's ID."
        },
        "href":{
            "type":"string",
            "title":"Payment Method Href",
            "description":"The payment method's href."
        },
        "name":{
            "type":"string",
            "title":"Payment Method Name",
            "description":"The payment method's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A payment method reference."
}

• Array of: object Related Party Ref
  Title: Related Party Ref

  A reference to the party related to an object.

{
    "type":"array",
    "description":"The parties related to the bill.",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRef"
    }
}

• Array of: object State Values
  Title: State Values

  A tax item.

{
    "type":"array",
    "description":"Taxes on the bill.",
    "items":{
        "$ref":"#/components/schemas/TaxItem"
    }
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• appliedAmount: object Money
  Title: Money

  An amount of money.
• payment: object Payment Ref
  Title: Payment Ref

  A payment captured as a reference on an order. Used when a payment is made immediately on an order rather than at a later billing date.

{
    "type":"object",
    "title":"Applied Payment",
    "description":"A payment that can be assigned to a bill.",
    "properties":{
        "appliedAmount":{
            "description":"The amount of the payment that has been applied.",
            "$ref":"#/components/schemas/Money"
        },
        "payment":{
            "description":"The payment.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• amount: object Money
  Title: Money

  An amount of money.
• href: string
  Title: Payment Href

  The payment reference's href.
• id(required): string
  Title: Payment ID

  The payment reference's ID.
• name: string
  Title: Payment Name

  The payment reference's name.

{
    "type":"object",
    "title":"Payment Ref",
    "description":"A payment captured as a reference on an order. Used when a payment is made immediately on an order rather than at a later billing date.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Payment ID",
            "description":"The payment reference's ID."
        },
        "href":{
            "type":"string",
            "title":"Payment Href",
            "description":"The payment reference's href."
        },
        "name":{
            "type":"string",
            "title":"Payment Name",
            "description":"The payment reference's name."
        },
        "amount":{
            "description":"The payment reference's amount.",
            "$ref":"#/components/schemas/Money"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• attachmentType: string
  Title: Attachment Type

  The attachment reference's type. For example, video or picture.
• content: string
  Title: Attachment Content

  The attachment's base64 encoded content.
• description: string
  Title: Attachment Description

  The attachment's description.
• href: string
  Title: Attachment Href

  The attachment reference's href.
• id: string
  Title: Attachment ID

  The attachment reference's ID.
• mimeType: string
  Title: Mime Type

  The attachment's mime type. For example, a file extension like jpeg or mp4.
• name: string
  Title: Attachment Name

  The attachment's name.
• size: object Quantity
  An amount in a given unit.
• url: string
  Title: Attachment Link

  A URL linking to the attachment content.
• validFor: object Time Period
  Title: Time Period

  A period of time. You can specify only endDateTime or both endDateTime and startDateTime.

{
    "type":"object",
    "title":"Attachment Ref Or Value",
    "description":"An attachment reference or value. The <b>baseType</b>, <b>type</b>, <b>schemaLocation</b> and <b>referredType</b> properties are related to the contained object, not the AttchmentRefOrValue.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Attachment ID",
            "description":"The attachment reference's ID."
        },
        "href":{
            "type":"string",
            "title":"Attachment Href",
            "description":"The attachment reference's href."
        },
        "attachmentType":{
            "type":"string",
            "title":"Attachment Type",
            "description":"The attachment reference's type. For example, <b>video</b> or <b>picture</b>."
        },
        "content":{
            "type":"string",
            "title":"Attachment Content",
            "description":"The attachment's base64 encoded content."
        },
        "description":{
            "type":"string",
            "title":"Attachment Description",
            "description":"The attachment's description."
        },
        "mimeType":{
            "type":"string",
            "title":"Mime Type",
            "description":"The attachment's mime type. For example, a file extension like <b>jpeg</b> or <b>mp4</b>."
        },
        "name":{
            "type":"string",
            "title":"Attachment Name",
            "description":"The attachment's name."
        },
        "url":{
            "type":"string",
            "title":"Attachment Link",
            "description":"A URL linking to the attachment content."
        },
        "size":{
            "description":"The attachment's size.",
            "$ref":"#/components/schemas/Quantity"
        },
        "validFor":{
            "description":"The time period for which the attachment is valid.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    }
}

• amount: number (float)
  Default Value: 1

  Numeric value in a given unit.
• units: string
  Unit

{
    "type":"object",
    "description":"An amount in a given unit.",
    "properties":{
        "amount":{
            "default":1,
            "type":"number",
            "format":"float",
            "description":"Numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"Unit"
        }
    }
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• amount(required): object Money
  Title: Money

  An amount of money.
• balanceType(required): string
  Title: Balance Type

  The balance's type. For example, deposit, disputed, loyalty, or receivable.
• validFor(required): object Time Period
  Title: Time Period

  A period of time. You can specify only endDateTime or both endDateTime and startDateTime.

{
    "required":[
        "amount",
        "balanceType",
        "validFor"
    ],
    "type":"object",
    "title":"Account Balance",
    "description":"A balance associated with an account.",
    "properties":{
        "balanceType":{
            "type":"string",
            "title":"Balance Type",
            "description":"The balance's type. For example, <b>deposit</b>, <b>disputed</b>, <b>loyalty</b>, or <b>receivable</b>."
        },
        "amount":{
            "description":"The balance's amount.",
            "$ref":"#/components/schemas/Money"
        },
        "validFor":{
            "description":"The time period for which the balance is valid.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string
  Title: Related Party Href

  The related party's href.
• id(required): string
  Title: Related Party ID

  The related party's ID.
• name: string
  Title: Related Party Name

  The related party's name.
• role: string
  Title: Related Party Role

  The related party's role.

{
    "type":"object",
    "title":"Related Party Ref",
    "description":"A reference to the party related to an object.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Related Party ID",
            "description":"The related party's ID."
        },
        "href":{
            "type":"string",
            "title":"Related Party Href",
            "description":"The related party's href."
        },
        "name":{
            "type":"string",
            "title":"Related Party Name",
            "description":"The related party's name."
        },
        "role":{
            "type":"string",
            "title":"Related Party Role",
            "description":"The related party's role."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• taxAmount: object Money
  Title: Money

  An amount of money.
• taxCategory: string
  Title: Tax Category

  The tax item's category.
• taxRate: number (float)
  Title: Tax Rate

  The tax item's applied rate.

{
    "type":"object",
    "title":"State Values",
    "description":"A tax item.",
    "properties":{
        "taxCategory":{
            "type":"string",
            "title":"Tax Category",
            "description":"The tax item's category."
        },
        "taxRate":{
            "type":"number",
            "title":"Tax Rate",
            "format":"float",
            "description":"The tax item's applied rate."
        },
        "taxAmount":{
            "description":"The tax item's amount.",
            "$ref":"#/components/schemas/Money"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• code(required): string
  Title: Error Code

  An application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More details and corrective actions related to the error.
• reason(required): string
  Title: Reason

  The reason for the error.
• referenceError: string (uri)
  Title: Reference Error

  A URI to documentation describing the error.
• status: string
  Title: Error Status

  The HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}